MultifileElement ​

<MultifileElement :drop="true" ... />

Whether DragAndDrop component should be used to select file(s) instead of a button.

<MultifileElement :sort="true" view="gallery" ... />

Whether the files can be sorted.

<!-- Can't add --->
<MultifileElement :sort="true" :controls="{ add: false }" ... />

<!-- Can't remove --->
<MultifileElement :sort="true" :controls="{ remove: false }" ... />

<!-- Can't sort --->
<MultifileElement :sort="true" :controls="{ sort: false }" ... />

Defines the available controls. Object properties:

• add - enables/disables adding a new file
• remove - enables/disables removing files
• sort - enables/disables sorting when sort is enabled

<MultifileElement :object="false" ... />
<MultifileElement :object="true" ... />

Whether the file instances should be objects, where the file's value is contained in the storeFile object property (storeFile defaults to 'file').

When using storeOrder or fields options, instances will automatically have object: true.

<MultifileElement store-file="logo" ... />

The name of the object property that contains the file value when using object: true.

<MultifileElement view="image" :fields="{
  label: { type: 'text', floating: 'File label' }
}"... />

Additional fields for each file instance. Can be any field type.

If fields is defined the MultifileElement's value will no longer be a plain array of file values. It will become an array of objects where the file's value is contained in the storeFile object property (storeFile defaults to 'file').

<MultifileElement
  view="image"
  :sort="true"
  store-order="order"
  :fields="{
    order: { type: 'hidden' }
  }"
  :default="[
    { file: 'image.jpeg', order: 1 },
    { file: 'image2.jpeg', order: 2 },
    { file: 'image3.jpeg', order: 3 },
  ]"
... />

The name of the element that stores the order value when using sort. When storeOrder is defined object will be automatically set to true and the file's value will be contained in storeFile object-property.

The element that contains the store is recommended to be HiddenElement.

<!-- Using `object: false` --->
<MultifileElement order="asc" :object="false" @mounted="el$ => el$.load([
  'image3.jpeg',
  'image.jpeg',
  'image2.jpeg',
])" ... />

<!-- Using `object: true` and `orderBy` --->
<MultifileElement order="desc" order-by="order" :object="true" @mounted="el$ => el$.load([
  { file: 'image3.jpeg', order: 3 },
  { file: 'image.jpeg', order: 1 },
  { file: 'image2.jpeg', order: 2 },
])" ... />

Automatically sorts the files when data is loaded. Possible values: 'asc|desc'.

If object: false it will be sorted based on filenames (when uploaded files are loaded).

If object: true it should be used in conjunction with orderBy which defines the name of the object property that contains the order.

<MultifileElement order="asc" order-by="order" :object="true"
  @mounted="el$ => el$.load([
    { file: 'images/image3.jpeg', order: 3 },
    { file: 'images/image.jpeg', order: 1 },
    { file: 'images/image2.jpeg', order: 2 },
  ])
" ... />

The name of the object property that determines the order when using order. Defining this option automatically sets object to true and adds an a hidden element with the same name to fields if it is not defined yet.

<MultifileElement :file="{ rules: 'max:1024' }"... /> <!-- File max size: 1 MB -->

Additional options for each file instance that you would define for FileElement.

<MultifileElement accept=".jpg,.png,.gif" view="image" ... />

Resticts the accepted file types. To specify more than one value, separate the values with a comma (e.g. 'audio/*,video/*,image/*') or use an array (e.g. ['.jpg','.png','.gif']).

Possible values:

• file_extension - specify the file extension(s) (e.g: .gif, .jpg, .png, .doc) the user can pick from
• 'audio/*' - the user can pick all sound files
• 'video/*' - the user can pick all video files
• 'image/*' - the user can pick all image files
• media_type - a valid media type, with no parameters (look at IANA Media Types for a complete list of standard media types)

<MultifileElement :default="['image.jpeg']" view="image" :clickable="true" ... />
<MultifileElement :default="['image.jpeg']" view="image" :clickable="false" ... />

Whether the uploaded file should be clickable. If true the filename in the url will be prefixed with the value of the url option.

The file is only considered uploaded once its value is a string that contains the filename. Selected or temporarily uploaded files cannot be clicked.

<!-- Relative path -->
<MultifileElement url="/images/" ... />

<!-- Different domain -->
<MultifileElement url="https://cdn.domain.com/images/" ... />

<!-- Turn off -->
<MultifileElement :url="false" ... />

The url prefix for clickable files. Set to false to disable url prefix.

<MultifileElement preview-url="/images/previews/" ... />

The url prefix for uploaded image/gallery previews. If not defined the url will be used, unless url is set to false.

<MultifileElement :auto="false" ... />

Whether files should automatically uploaded when they are selected.

<MultifileElement upload-temp-endpoint="/upload-file" ... />

The endpoint where files should be uploaded.

It can be a simple url like /upload-file but also an object containing url and method:

<!-- Using an object as endpoint -->
<MultifileElement :upload-temp-endpoint="{
  url: '/files',
  method: 'POST'
}" ... />

It can be a named endpoint that references an endpoint in vueform.config.js:

// vueform.config.js

export default {
  endpoints: {
    upload_file: {
      url: '/files',
      method: 'POST'
    }
  }
}

<!-- Using a named endpoint -->
<MultifileElement upload-temp-endpoint="upload_file" ... />

It can be an async function that handles the file upload and returns an object with data:

<!-- Using a function to upload file -->
<MultifileElement :upload-temp-endpoint="async function(file, el$){
  let data = el$.form$.convertFormData({
    file,
  }) // befomes `FormData` object

  /* upload file */

  return {
    tmp: '...', // the temp file identifier
    originalName: '...', // the original name of the file that will be displayed to the user
  }
}" ... />

If the temporary uploading should be skipped the endpoint should return a string with the filename instead of an object. Eg:

<!-- Using a function to upload file without temp upload -->
<MultifileElement :upload-temp-endpoint="async function(file, el$){
  let data = el$.form$.convertFormData({
    file,
  }) // befomes `FormData` object

  /* upload file */

  return 'filename.jpg'
}" ... />

If the file(s) should be sent with the all other form data upon submission (completely skipping temp uploading), the endpoint can be disabled with false:

<!-- Using a function to upload file without temp upload -->
<MultifileElement :upload-temp-endpoint="false" ... />

More info in File Uploads guide.

<MultifileElement remove-temp-endpoint="/remove-temp-file" ... />

The endpoint where temp file remove requests should be submitted.

It can be a simple url like /remove-temp-file but also an object containing url and method:

<!-- Using an object as endpoint -->
<MultifileElement :remove-temp-endpoint="{
  url: '/temp-files',
  method: 'DELETE'
}" ... />

It can be a named endpoint that references an endpoint in vueform.config.js:

// vueform.config.js

export default {
  endpoints: {
    remove_temp_file: {
      url: '/temp-files',
      method: 'DELETE'
    }
  }
}

<!-- Using a named endpoint -->
<MultifileElement remove-temp-endpoint="remove_temp_file" ... />

It can be an async function that handles the remove and receives an object as first param containing tmp and originalName properties:

<!-- Using a function to remove temp file -->
<MultifileElement :remove-temp-endpoint="async function(file, el$){
  const { tmp, originalName } = file

  /* remove temp file */
}" ... />

More info in File Uploads guide.

<MultifileElement remove-endpoint="/remove-file" ... />

The endpoint where file remove requests should be submitted.

It can be a simple url like /remove-file but also an object containing url and method:

<!-- Using an object as endpoint -->
<MultifileElement :remove-endpoint="{
  url: '/files',
  method: 'DELETE'
}" ... />

It can be a named endpoint that references an endpoint in vueform.config.js:

// vueform.config.js

export default {
  endpoints: {
    remove_file: {
      url: '/files',
      method: 'DELETE'
    }
  }
}

<!-- Using a named endpoint -->
<MultifileElement remove-endpoint="remove_file" ... />

It can be an async function that handles the remove and receives the name of the uploaded file as first param:

<!-- Using a function to remove file -->
<MultifileElement :remove-temp-endpoint="async function(file, el$){
  const filename = file // eg. background-image.png

  /* remove file */
}" ... />

More info in File Uploads guide.

<MultifileElement :params="{ extra_param: 'value' }" ... />

Params to be sent along with HTTP requests.

<MultifileElement :soft-remove="true" ... />

Whether removeTemp and remove endpoints should be called upon removing temp or uploaded file.

<MultifileElement name="element" ... />

Sets the element's name.

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

Sets the id attribute of the file list.

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

Disables uploading new files and removing/sorting existing ones.

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.

<MultifileElement 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.

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

Sets the position of the info tooltip.

Can be also defined via #info slot.

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

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

Can be also defined via #description slot.

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

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

Can be also defined via #before slot.

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

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

Can be also defined via #between slot.

<MultifileElement 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.

<MultifileElement :default="['image.jpeg', 'image2.jpeg']" ... />

Sets a list of default files.

<MultifileElement :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.

<MultifileElement :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.

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

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

<MultifileElement rules="required|min:2" ... />
<MultifileElement :rules="['required', 'min:2']" ... />

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.

To apply rules for each file, you can define rules in file option:

<MultifileElement rules="required|max:2" :file="{ rules: 'max:1024' }" ... />

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

Sets the name of the field in validation rule messages.

<MultifileElement rules="required" :messages="{ required: 'Please select at least one file' }" ... />

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.

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

Whether element errors should be displayed.

<MultifileElement :conditions="[
  ['foo', 'bar'],
  'AGE(birthday) > 18',
  (form$) => !!form$?.el$('terms').value
]" ... />

Shows or hides an element based on the provided conditions.

<MultifileElement 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 wrapper DOM that contains both label and wrapper
• label contains the label
• wrapper contains the file list.

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 file list 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 file list the rest. In case the label has full width (12) the file list will also take up full space instead of becoming zero.

The value of wrapper defines the size of the file list 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 file list 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):

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

Note that while the size of the file list 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:

<MultifileElement
  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:

<MultifileElement 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:

<MultifileElement 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.

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

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

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

The size of the element and its child components.

<MultifileElement 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.

Views can be found at Views section.

Learn more about views here.

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

The name of the views for the child components.

Learn more about views here.

<MultifileElement :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.:

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

Learn more about adding classes here.

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

Adds classes to any of MultifileElement 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.:

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

Learn more about adding classes here.

<MultifileElement :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.:

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

Learn more about removing classes here.

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

Removes classes from any of MultifileElement 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.:

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

Learn more about removing classes here.

<MultifileElement :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.:

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

Learn more about replacing classes here.

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

Replaces the classes of any class names of MultifileElement 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.:

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

Learn more about replacing classes here.

<MultifileElement :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.:

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

Learn more about overriding classes here.

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

Overrides the classes of any of MultifileElement 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.:

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

Learn more about overriding classes here.

<template>
  <div id="app">
    <Vueform>
      <MultifileElement :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.

<MultifileElement :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: 'multifile',
          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 aria-* attributes of the input.

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 any of the files are currently being uploaded to the server (initiated by the user).

Whether any of the files are currently being uploaded to the server (initiated by form submit).

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.

Child element components.

Whether adding new files is allowed. Will return false if the element has isDisabled: true. Can be disabled manually by setting controls.add to false.

Whether remove files is allowed. Will return false if the element has isDisabled: true or a temporary file upload is in progress. Can be disabled manually by setting controls.remove to false.

Whether list files should be sortable. Can be enabled by setting sort to true, but will return false if the element has isDisabled: true or a temporary file upload is in progress.

Whether the list is currently being sorted (an item is dragged).

Whether the list is sortable. Can be enabled with sort option, but it will disabled if isDisabled is true.

The name of the field (when using fields) by which the files should be ordered.

Whether the element and all of its children was already validated at least once.

Whether the element or any of its children has any failing rules.

Whether the element's or any of its children's value was modified.

Whether the element or any of its children has any async rules in progress.

Whether the element or any of its children have a validation rule with pending debounce.

Whether the element or any of its children is pending or debouncing.

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 disabled.

The ref to the outermost DOM of the element.

The main input field of the element.

The id of the file list. 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.

Appends a new item.

Removes an items by its index.

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 and validates children (async).

Checks each validation rule for the element (async).

Validates every child (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 input is resetted.

Triggered when the input is cleared.

Triggered when the element's value is changed.

Triggered when a new item is added to the list.

Triggered when an item is removed from the list.

Triggered when items are being sorted by the user, when sort: true.

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 file list.

Renders an ElementText component after the file list and before description.

Renders an ElementText component after the description and error.