SignatureElement ​

<SignatureElement :modes="['upload', 'draw']" ... />

The available signature modes in the given order. Possible values: draw, type, upload. If only one is provided, the mode selector will become invisible. If empty it falls back to draw.

<SignatureElement :fonts="['Satisfy@400', 'Zeyada@400']" ... />

The available fonts the user can choose from in type mode. If only one is provided the typeface selector will become invisible. If none is provided it will fallback to cursive font.

You can list the fonts in Font Family@weight or Font Family format. Google Fonts are automatically loaded unless autoload is disabled.

<SignatureElement :autoload="false" ... />

Autoloads Google Fonts that are defined in the fonts options. If you are not planning to load Google Fonts, you might set this to false.

<SignatureElement :min-font-size="20" ... />
<SignatureElement :min-font-size="30" ... />

The minimum font size the signature text can have in type mode.

<SignatureElement :max-font-size="50" ... />
<SignatureElement :max-font-size="90" ... />

The maximum font size the signature text can have in type mode.

<SignatureElement :colors="['#e81416', '#ffa500', '#faeb36', '#79c314', '#487de7', '#4b369d', '#70369d']" ... />

The available signature colors. If only one is provided the color selector will become invisible. If none is provided it will fallback to #000000.

<SignatureElement
  :colors="['#000000', '#222222', '#777777']"
  :invert-colors="['#000000', '#222222']"
... />

The colors that should be inverted in dark mode. While the color in the palette and the signature display is inverted, the final image will contain the original color.

<SignatureElement :max-width="300" ... />

The maximum width of the signature area in pixels. The value auto will make it 100%.

<SignatureElement :height="240" ... />

The height of the signature area in pixels.

<SignatureElement :upload-width="600" ... />

The width (px) of the image created from the signature that will be sent when submitting the form.

<SignatureElement :upload-height="200" ... />

The height (px) of the image created from the signature that will be sent when submitting the form.

<SignatureElement :max-size="4096" ... />

The maximum size (kB) of the selected file in upload mode.

<SignatureElement :accept="['jpg', 'png']" ... />

The type of files to accept in upload mode. Possible values are: jpg, png and svg.

<SignatureElement :line="false" ... />

Whether to show a line for the signature.

<SignatureElement :can-clear="false" ... />

Whether the user can clear the signature (drawn, typed, uploaded or loaded).

<SignatureElement :can-undo="false" ... />

Whether the user can undo/redo changes in draw mode.

<SignatureElement :can-drop="false" ... />

Whether the user can drop files in upload mode.

The name of the element. Does not have effect on anything.

<SignatureElement id="field-id" ... />

Sets the id attribute of the signature wrapper.

<SignatureElement :readonly="true" ... />
<SignatureElement :readonly="prop" ... /> <!-- computed / data (ref) prop -->
<SignatureElement :readonly="[['text', 'value']]" ... /> <!-- conditional -->
<SignatureElement :readonly="(el$, form$) => { return /* boolean */ }" ... />

Makes the signature pad read-only.

If can be a boolean value.

It can be a computed / data (ref) prop.

It can be an array of conditions. When all conditions are met the element will become readonly.

It can be a function that receives the el$ element instance and form$ form instance params and expected to return a boolean.

<SignatureElement :readonly="true" ... />
<SignatureElement :disabled="prop" ... /> <!-- computed / data (ref) prop -->
<SignatureElement :disabled="[['text', 'value']]" ... /> <!-- conditional -->
<SignatureElement :disabled="(el$, form$) => { return /* boolean */ }" ... />

Makes the signature pad disabled.

If can be a boolean value.

It can be a computed / data (ref) prop.

It can be an array of conditions. When all conditions are met the element will become disabled.

It can be a function that receives the el$ element instance and form$ form instance params and expected to return a boolean.

Sets a label for the element. Can be defined as a string, a Vue component object with a render function or as a function that receives el$ as its first a param.

Can also be defined via #label slot.

<SignatureElement placeholder="Your signature" ... />

The placeholder of the signature space. Use false or to disable. The default value comes from the locale file (vueform.elements.signature.placeholder).

<SignatureElement label="Info" info="Info" ... />

Renders an ElementInfo component next to the element's label. By default the icon shows the value of info when hovered, which can contain plain text or HTML. The element needs to have a label defined in order for info to be rendered.

Can be also defined via #info slot.

<SignatureElement label="Top" info="Top" info-position="top" ... />
<SignatureElement label="Right" info="Right" info-position="right" ... />
<SignatureElement label="Left" info="Left" info-position="left" ... />
<SignatureElement label="Bottom" info="Bottom" info-position="bottom" ... />

Sets the position of the info tooltip.

Can be also defined via #info slot.

<SignatureElement description="Lorem ipsum dolor sit amet" ... />

Renders the contents of description prop in the ElementDescription component below the input field. It can contain plain text or HTML.

Can be also defined via #description slot.

<SignatureElement before="Before" ... />

Renders the contents of before in a ElementText component before the input field. It can contain plain text or HTML.

Can be also defined via #before slot.

<SignatureElement description="Description" between="Between" ... />

Renders the contents of between in a ElementText component between the input field and the description. It can contain plain text or HTML.

Can be also defined via #between slot.

<SignatureElement description="Description" rules="required" after="After" ... />

Renders the contents of after in a ElementText component after the description and error. It can contain plain text or HTML.

Can be also defined via #after slot.

<SignatureElement default="/images/signature-example.png" ... />

The default value of the signature that points to an image.

<SignatureElement :format-data="(n, v) => ({[n]: /* transformed value */ })" ... />

Formats the element's requestData.

The first param is the element's name, the second is the value. The return value should be an object, which only contains one item with the element's name as key and the transformed value as value.

<SignatureElement :format-load="(v) => /* transformed value */" ... />

Formats the data being loaded to the element when using load(data, format: true). It receives the value being loaded to the element as its first param and should return the formatted value of the element.

<SignatureElement :submit="false" ... />

If set to false the element's data will not be included in requestData and will not be submitted.

<SignatureElement rules="required" ... />
<SignatureElement :rules="['required']" ... />

The validation rules to be applied for the element.

The list of rules can be defined as a string separated by | or as an array, where each item should be a single validation rule.

<SignatureElement field-name="Field name" rules="required" ... />

Sets the name of the field in validation rule messages.

<SignatureElement floating="Without debounce" rules="required" ... />
<SignatureElement floating="With debounce" :debounce="500" rules="required" ... />

The milliseconds to wait before the validation triggers after the user changed the value (unless the value is empty). Applies to each validation rule.

If you only want debounce for a specific rule, you can use: rules="required:debounce=500"

Note that SignatureElement has a 500 ms debounce out of the box as the value, so this adds on top of that.

<SignatureElement rules="required" :messages="{ required: 'Please fill in' }" ... />

Overrides the default messages for the element's validation rules. The value is an object where each key is the name of a validation rule and the value is the error message that will be displayed when the rule fails.

You can override validation messages on form level with messages.

<SignatureElement :display-errors="false" ... />

Whether element errors should be displayed.

<!-- field1 - type 'show' -->
<TextElement name="field1" ... />

<!-- field2 - only if field1 == 'show' -->
<SignatureElement name="field2" :conditions="[['field1', 'show']]" ... />

<!-- field3 - only if field1 != 'show' -->
<SignatureElement name="field3" :conditions="[['field1', '!=', 'show']]" ... />

<!-- field4 - only if field1 == 'show' -->
<SignatureElement name="field4" :conditions="[
  (form$, el$) => form$.el$('field1')?.value === 'show'
]" ... />

Shows or hides an element based on the provided conditions.

If an element's conditions are unmet the element will be hidden and its available property will become false. If hidden, its value will not be part of requestData.

Conditions can be provided as an array, where each item has to be either an array or a function. The element will only become available if all the conditions are fulfilled.

If a condition is provided as an array, the first value must be the path of an other field which value should be watched. The second is an operator that defines the type of comparison. The third is the expected value of the other field.

<SignatureElement name="field" :conditions="[['other_field', '==', 'expected_value']]" ... />

Hint: In case you want to check for equality you might leave the operator and pass the expected value as the second param:

<SignatureElement name="field" :conditions="[['other_field', 'expected_value']]" ... />

Available operators:

• == - expect equality
• != - expect inequality
• > - expect the other element's value(s) to be higher
• >=- expect the other element's value(s) to be higher or equal
• < - expect the other element's value(s) to be lower
• <= - expect the other element's value(s) to be lower or equal
• ^ - expect the other element's value to start with
• $ - expect the other element's value to end with
• * - expect the other element's value to contain
• in - expect to be among an array of values
• not_in - expect not to be among an array of values
• today - expect to be today
• before - expect to be before a date (value can be a YYYY-MM-DD date string or today)
• after - expect to be after a date (value can be a YYYY-MM-DD date string or today)

The expected value can also be defined as an array in which case any of its values will fulfill the condition.

Conditions can be defined with OR relation or as function. Learn more about conditions here.

<SignatureElement label="Label" :columns="{ container: 12, label: 3, wrapper: 12 }" ... />

Sets the size of the container, label and wrapper using the theme's grid system, where the:

• container is the outermost DOM that contains both label and wrapper
• label contains the label
• wrapper contains the input field.

The value of container defines the size of the element's container. 12 will result in full width, 6 in half, 4 in third and so on.

The value of label defines the amount of space the label should take up within the container. If the container is 12 and label is 6 the label is going to take up half the space and the input field will the other half (which is calculated automatically). If the container is 6 and label is 6, the label will only take up one forth and the input field the rest. In case the label has full width (12) the input field will also take up full space instead of becoming zero.

The value of wrapper defines the size of the input field wrapper within the space left for it in the container after subtracting the size of the label. If the container is 12 and label is 4 the space left for the input field is 8. In this case if the wrapper value is 12 it will take up the full space left for it (which is 8) while if it is changed to 6 it will only take up half the space left for it (4):

<SignatureElement label="Label" :columns="{ container: 12, label: 4, wrapper: 12 }" ... />
<SignatureElement label="Label" :columns="{ container: 12, label: 4, wrapper: 6 }" ... />

Note that while the size of the input field wrapper changes, the size of extras like a description or error won't be limited to the wrapper's space. Instead it will take up the full space in the container left after subtracting the size of the label:

<SignatureElement
  label="Label"
  :columns="{ container: 12, label: 4, wrapper: 6 }" 
  description="Lorem ipsum dolor sit amet, consectetur adipiscing elit"
... />

You can set the value of columns as a number in which case the container will receive its value without affecting the default settings of label and wrapper:

<SignatureElement label="Label" :columns="6" ... /> <!-- { container: 6, label: 3, wrapper: 12 } -->

You can as well define column values for different breakpoints using the theme system's breakpoints like sm, md, etc. as keys:

<SignatureElement label="Label" :columns="{
  xs: { container: 12, label: 12, wrapper: 12 },
  sm: { container: 12, label: 4, wrapper: 12 },
  md: 12,
  lg: { container: 12, label: 2, wrapper: 12 }
}" ... />

Default column sizes can be defined globally in vueform.config.js or on form level using columns.

<SignatureElement :inline="true" ... />

Renders the element and all of its components in a single <span> without applying columns.

<SignatureElement size="sm" ... />
<SignatureElement ... /> <!-- Default size: 'md' -->
<SignatureElement size="lg" ... />

The size of the element and its child components. Currently all sizes are displayed the same for SignatureElement.

<SignatureElement view="alt" ... />

The name of the view to be used for the element and by default for its child components. If undefined the default view will be used. Child component views can be overridden with views option.

Learn more about views here.

<SignatureElement :views="{
  ComponentName: 'alt'
}" ... />

The name of the views for the child components.

Learn more about views here.

<SignatureElement :add-classes="{
  ComponentName: {
    classname: 'class-value',
    classname: ['class-value'],
    classname: [{'class-value': true}],
  }
}" ... />

Adds classes to any component's class names. The classes can have string or array values. When Vue style classes are used object values must be wrapped in an array.

Conditional classes can be passed as a function with form$ param, eg.:

<SignatureElement :add-classes="(form$) => ({
  ComponentName: {
    classname: [
      { 'class-value': form$.el$('other_field')?.value === 'some_value' }
    ],
  }
})" ... />

Learn more about adding classes here.

<SignatureElement :add-class="{
  classname: 'class-value',
  classname: ['class-value'],
  classname: [{'class-value': true}],
}" ... />

Adds classes to any of SignatureElement component's class names. Classes can have string or array values. When Vue style classes are used object values must be wrapped in an array.

Conditional classes can be passed as a function with form$ param, eg.:

<SignatureElement :add-class="(form$) => ({
  classname: [
    { 'class-value': form$.el$('other_field')?.value === 'some_value' }
  ],
})" ... />

Learn more about adding classes here.

<SignatureElement :remove-classes="{
  ComponentName: {
    classname: ['class-value-1', 'class-value-2']
  }
}" ... />

Removes classes from any class names of any components. The classes to be removed must be listed in an array.

Conditional classes can be passed as a function with form$ param, eg.:

<SignatureElement :remove-classes="(form$) => ({
  ComponentName: {
    classname: form$.el$('other_field')?.value === 'some_value'
      ? ['class-value-1', 'class-value-2']
      : [],
  }
})" ... />

Learn more about removing classes here.

<SignatureElement :remove-class="{
  classname: ['class-value-1', 'class-value-2']
}" ... />

Removes classes from any of SignatureElement component's class names. The classes to be removed must be listed in an array.

Conditional classes can be passed as a function with form$ param, eg.:

<SignatureElement :remove-class="(form$) => ({
  classname: form$.el$('other_field')?.value === 'some_value'
    ? ['class-value-1', 'class-value-2']
    : [],
})" ... />

Learn more about removing classes here.

<SignatureElement :replace-classes="{
  ComponentName: {
    classname: {
      'from-class': 'to-class',
      'from-class': ['to-class'],
      'from-class': [{'to-class': true}],
    }
  }
}" ... />

Replaces classes of any class names of any component. The keys are the original class names and the values are the replacements. The keys can only be single classes, while values can contain multiple ones in string or an array. When Vue style classes are used object values must be wrapped in an array.

Conditional classes can be passed as a function with form$ param, eg.:

<SignatureElement :replace-classes="(form$) => ({
  ComponentName: {
    classname: form$.el$('other_field')?.value === 'some_value' ? {
      'from-class': 'to-class'
    } : {},
  }
})" ... />

Learn more about replacing classes here.

<SignatureElement :replace-class="{
  classname: {
    'from-class': 'to-class',
    'from-class': ['to-class'],
    'from-class': [{'to-class': true}],
  }
}" ... />

Replaces the classes of any class names of SignatureElement component. The keys are the original class names and the values are the replacements. The keys can only be single classes, while values can contain multiple ones in string or an array. When Vue style classes are used object values must be wrapped in an array.

Conditional classes can be passed as a function with form$ param, eg.:

<SignatureElement :replace-class="(form$) => ({
  classname: form$.el$('other_field')?.value === 'some_value' ? {
    'from-class': 'to-class'
  } : {},
})" ... />

Learn more about replacing classes here.

<SignatureElement :override-classes="{
  ComponentName: {
    classname: 'class-value',
    classname: ['class-value'],
    classname: [{'class-value': true}],
  }
}" ... />

Overrides the classes of any component's class names. The classes can have string or array values. When Vue style classes are used object values must be wrapped in an array.

Conditional classes can be passed as a function with form$ param, eg.:

<SignatureElement :override-classes="(form$) => ({
  ComponentName: form$.el$('other_field')?.value === 'some_value' ? {
    classname: 'class-value'
  } : {}
})" ... />

Learn more about overriding classes here.

<SignatureElement :override-classes="{
  ComponentName: {
    classname: 'class-value',
    classname: ['class-value'],
    classname: [{'class-value': true}],
  }
}" ... />

Overrides the classes of any of SignatureElement component's class names. The classes can have string or array values. When Vue style classes are used object values must be wrapped in an array.

Conditional classes can be passed as a function with form$ param, eg.:

<SignatureElement :override-class="(form$) => (form$.el$('other_field')?.value === 'some_value' ? {
  classname: 'class-value'
} : {})" ... />

Learn more about overriding classes here.

<template>
  <div id="app">
    <Vueform>
      <SignatureElement :templates="{ ElementError }" ... />
    </Vueform>
  </div>
</template>

<script>
import { markRaw } from 'vue'
import CustomElementError from './CustomElementError.vue'

export default {
  data() {
    return {
      ElementError: markRaw(CustomElementError),
    }
  }
}
</script>

Overrides templates used by the component.

Learn more about overriding templates here.

<SignatureElement :presets="['preset1', 'preset2']" ... />

The presets to be applied for the component.

Learn more about presets classes here.

<script>
import { Vueform, useVueform } from '@vueform/vueform';
import CustomDescriptionSlot from 'path/to/CustomDescriptionSlot.vue';

export default {
  mixins: [Vueform],
  setup: useVueform,
  data: () => ({
    vueform: {
      schema: {
        element: {
          type: 'signature',
          slots: {
            label: '<span>Label</span>',
            description: CustomDescriptionSlot,
          }
        }
      }
    }
  })
}
</script>

With this option you can define slot values in a schema based form that you would normally just write inline. The value of a slot can be a plain string, HTML or a component with render function.

While this option can be also used in inline forms, it's primarily intended for schema based forms.

The signature mode selector.

The font style selector.

The input field when mode is type.

The canvas that shows the preview of an uploaded signature when mode is upload.

The canvas that allows drawning signature when mode is draw.

The file input field when mode is upload (it's invisible).

The DOM that contains upload related parts.

The upload button.

The current signature mode (draw, type or upload).

The current font family.

The current font weight.

The hex code of the current signature color.

The input value used when mode is type.

The current font size.

The Signature Pad instance.

The file (image) selected by the user when mode is upload.

Whether the image preview is already created when mode is upload.

Whether the image preview is being created when mode is upload.

Whether a file is being dragged over the element when mode is upload.

Whether the canvas contains any drawn signature when mode is draw.

Whether a signature is currently being drawn when mode is draw.

The list of available redos.

The number available undos.

The current width of the signature element.

The last width of the element.

The aria-* attributes of the input.

The localized placeholder of the element.

Whether the element is readonly.

The available font families.

The available font weights.

Whether the uploaded file is being processed for preview.

Whether drop is enabled and browser supports dragging.

The list of modes formatted for mode selector.

The list of fonts formatted for fonts selector.

The list of MIME types formatted for the file input attribute.

Whether the signature line should be shown.

Whether the signature text input should be shown.

Whether the signature placeholder should be shown.

Whether the upload container should be shown.

Whether the file upload controllers should be shown.

Whether file upload preview should be shown.

Whether signature draw pad should be shown.

Whether undo and redo buttons should be shown.

Whether color selector should be shown.

Whether mode selector should be shown.

Whether font selector should be shown.

Whether clear button should be shown.

The tabindex of focusable DOM parts.

The text of the placeholder.

The text of the drag and drop area.

The text of the upload button.

The text of the img alt attribute.

The text of the img title attribute.

The current text of font selector options.

The undo button's title.

The redo button's title.

The aria attributes of the mode selector.

The aria attributes of the font selector.

The aria label of the signature wrapper.

The aria label of the text input field.

The aria label of the signature pad.

The aria label of a color.

The aria label of the clear button.

The width of signature pad.

The height of signature pad.

The style attributes of the signature pad.

The style attributes of the signature wrapper.

The style attributes of the signature input when mode is type.

The style attributes of the signature line.

Whether the element is required (has required rule).

Whether the element should use a custom logic for checking if it is filled when validating.

Whether the element is filled is useCustomFilled is true.

Whether the element has its default value.

Whether a signature (as URL) was loaded to the element.

The value of the element.

Intermediary value between element's value and field's v-model. It is required when we need to transform the value format between the element and its field.

The value of the element in {[name]: value} value format. This gets merged with the parent component's data.

Same as data property except that it only includes the element's value if submit is not disabled and available is true (has no conditions or they are fulfilled).

Whether the element has no value filled in.

The path of the element using dot . syntax.

The path of the element's data using dot . syntax.

The parent component of the element.

Whether the element was already validated at least once.

Whether the element has any failing rules.

Whether the element's value was modified.

Whether the element has any async rules in progress.

Whether the element is pending.

Instance of MessageBag service. Custom errors and messages can be added.

All the errors of MessageBag.

The first error of MessageBag.

Whether no conditions are defined or they are all fulfilled.

Whether the element was hidden programmatically with show() or hide() methods.

Whether the element is visible. It's false when available or active is false or hidden is true.

Whether the element is focused.

Whether the element is disabled.

Whether the element has been filled in successfully.

Whether the element has errors.

The ref to the outermost DOM of the element.

The main input field of the element.

The id of the input field. If id is not provided path will be used.

Whether the element has a label option, a #label slot or Vueform component's forceLabels option is true.

The resolved size of the element and all of its child components.

The name of the resolved view for the component and the default view for its child components. Child component views can be overridden with views option. This one should be used to determine the component's view in class functions.

The component's template.

The component's classes.

The global theme object, which contains all the default templates and classes.

The root form's component.

The element's component.

Whether the element has been already mounted.

Initalizes the Signature Pad.

Resizes the signature pad to the current max width and clears any drawings.

Sets the element value as Blob from the current drawing.

Sets the element value as Blob from the currently typed signature.

Sets the element value as Blob from the currently uploaded signature.

Undoes the last drawing when mode is draw.

Redoes the last drawing when mode is draw.

Clears the signature in all forms (drawn, typed, uploaded, loaded).

Clears the drawn signature.

Loads Google Fonts dynamically by adding <link> tags to <head>.

Sets the drawing color of the signature pad.

Adjusts the typed signature's font size to fit into the input without overflow until minSize or maxSize is reached.

Converts a HEX color to RGB.

Checks if a file complies with accept list and throws an alert if not.

Checks if a file is under the allowed maxSize and throws an alert if not.

Sets the width to the current element width.

Sets the lastWidth to the current element width.

Sets the mode to the first available mode from modes. If none found, draw will be set.

Sets the fontFamily and fontWeight to the first available from fonts. If none found, cursive and 400 will be set.

Sets the color to the first available color from colors. If none found, #000000 will be set.

Sets the fontFamily and fontWeight by the index of a font from fonts.

Handles the input event of the input field.

Handles the mode select.

Handles the color select.

Handles the font select.

Handle the clear button action.

Handles the undo button action.

Handles the redo button action.

Handles the file select button action.

Handles the file selection.

Handles the drop event.

Handles the mouse leave event of the wrapper.

Handles the window resize event.

Clears the manually added messages from the messageBag.

Loads value to the element using optional formatLoad formatter. This is the method that gets called for each element when loading data to the form with format: true.

Updates the value of the element similarly to load, only that it can't format data.

Clears the element's value.

Resets the element's value to default (or empty if default is not provided). Also resets all the validation state for the element.

Disables the element.

Enables the element even if it is disabled by disabled option.

Adds a listener for an event.

Removes all listeners for an event.

Fires and emits an event.

Checks each validation rule for the element (async).

Removes the element's dirty state.

Sets the validators to default state.

Re-initializes validators when rules have changed.

Hides the element.

Shows the element if it was hidden with hide() method.

Triggered when the element's value is changed.

Triggered in beforeCreate hook.

Triggered in created hook.

Triggered in beforeMount hook.

Triggered in mounted hook.

Triggered in beforeUpdate hook.

Triggered in updated hook.

Triggered in beforeUnmount (or beforeDestroy in Vue 2) hook.

Triggered in unmounted (or destroyed in Vue 2) hook.

Renders a label for the element in ElementLabel component.

Renders an info icon in ElementInfo component next the the element label. When the icon is hovered it shows the content of this slot. The element needs to have a label to render this.

Renders description for the element in ElementDescription component.

Renders an ElementText component before the input field.

Renders an ElementText component after the input field and before description.

Renders an ElementText component after the description and error.

Prepends an addon to the input field.

Appends an addon to the input field.