ListElement
Repeats other elements.
Basic Usage
<ListElement>
component can be used in a <Vueform>
component to repeat a single element:
<template>
<Vueform>
<ListElement name="list">
<template #default="{ index }">
<TextElement
:name="index"
placeholder="To-do"
/>
</template>
</ListElement>
</Vueform>
</template>
It can also be used to render multiple elements in an <ObjectElement>
:
<template>
<Vueform>
<ListElement name="list">
<template #default="{ index }">
<ObjectElement
:name="index"
:label="`To-do #${index+1}`
">
<TextElement
name="todo"
placeholder="To-do"
/>
<CheckboxElement
name="ready"
text="Ready"
add-class="-mt-2"
/>
</ObjectElement>
</template>
</ListElement>
</Vueform>
</template>
Important: the element in
<ListElement>
must always useindex
asname
from slot scope.
Configuration options can be passed over as regular component props. Check out Options section for available configuration options.
Options
Find below the list of options that can use to configure ListElement
component. Options can be passed to the component via props in inline templates, or in the element's object when using schema
.
element
- Type:
object
- Default:
null
<ListElement :element="{ type: 'text', placeholder: 'To-do' }"... />
Defines a single element that gets repeated within the list. It can by any type of element except group
.
Alternatively you can use the #default
slot to render a single element:
<ListElement name="todos">
<template #default="{ index }">
<TextElement :name="index" placeholder="To-do (inline)" />
</template>
</ListElement>
Important: When using inline element, its name has to equal to default slot's
index
scope.
If you would like to repeat multiple elements use object
.
object
- Type:
object
- Default:
null
<ListElement :object="{
label: 'To-do',
schema: {
todo: { type: 'text', placeholder: 'To-do' },
ready: { type: 'checkbox', text: 'Ready' },
}
}" ... />
Defines an ObjectElement
with multiple elements that gets repeated within the list. The object
can contain any options an ObjectElement
would and will be applied to each instance.
Alternatively you can use the #default
slot to render multiple elements in an ObjectElement
:
<ListElement name="todos">
<template #default="{ index }">
<ObjectElement :name="index">
<TextElement name="todo" placeholder="To-do (inline)" />
<CheckboxElement name="ready" text="Ready" />
</ObjectElement>
</template>
</ListElement>
Important: When using inline object, its name has to equal to default slot's
index
scope.
initial
- Type:
number
- Default:
1
<ListElement :initial="3" ... />
The initial number of items the list should have.
min
- Type:
number
- Default:
-1
<ListElement :min="2" :initial="3" ... />
The minimum number of elements the list should have. List items can't be removed if their number is <= min
. The -1
value turns off the requirement.
max
- Type:
number
- Default:
-1
<ListElement :max="4" :initial="3" ... />
The maximum number of elements the list can have. Can't add new items if their number is >= max
. The -1
value turns off the limit.
addText
- Type:
string
- Default:
locale.elements.list.add
<ListElement add-text="Add to-do" ... />
The label of add button.
sort
- Type:
boolean
- Default:
false
<ListElement :sort="true" :default="[1,2,3]" ... />
Whether the list elements can be sorted.
controls
- Type:
object
- Default:
{
"add": true,
"remove": true,
"sort": true
}
<!-- Can't add --->
<ListElement :sort="true" :controls="{ add: false }" ... />
<!-- Can't remove --->
<ListElement :sort="true" :controls="{ remove: false }" ... />
<!-- Can't sort --->
<ListElement :sort="true" :controls="{ sort: false }" ... />
Defines the available list controls in an object. Object properties:
add
- enables/disables adding a new itemremove
- enables/disables removing itemssort
- enables/disables sorting whensort
is enabled
storeOrder
- Type:
string
- Default:
null
<ListElement :sort="true" store-order="order" :object="{
schema: {
name: { type: 'text', floating: 'Name', columns: 9 },
order: { type: 'text', columns: 3 },
}
}" @mounted="el$ => el$.load([
{ name: 'John', order: 1 },
{ name: 'Stephen', order: 2 },
{ name: 'Mary', order: 3 },
])" ... />
The name of the element that stores the order value when using sort
and object
. The element is recommended to be HiddenElement
.
order
- Type:
string
- Default:
null
<!-- Using `element` --->
<ListElement order="asc" :element="{
type: 'text',
placeholder: 'To-do',
}" @mounted="el$ => el$.load([3,1,2])" ... />
<!-- Using `object` and `orderBy` --->
<ListElement order="desc" order-by="age" :object="{
schema: {
name: { type: 'text', floating: 'Name', columns: 6 },
age: { type: 'text', floating: 'Age', columns: 6 },
}
}" @mounted="el$ => el$.load([
{ name: 'John', age: 17, },
{ name: 'Stephen', age: 32, },
{ name: 'Mary', age: 25, },
])" ... />
Automatically sorts the list when data is loaded. Possible values: 'asc|desc'
.
If the list is using an element
it will be sorted based on its value.
If the list is using an object
it should be used in conjunction with orderBy
which defines the name of the object property that contains the order.
orderBy
- Type:
string
- Default:
null
<ListElement order="desc" order-by="age" :object="{
schema: {
name: { type: 'text', floating: 'Name', columns: 6 },
age: { type: 'text', floating: 'Age', columns: 6 },
}
}" @mounted="el$ => el$.load([
{ name: 'John', age: 17, },
{ name: 'Stephen', age: 32, },
{ name: 'Mary', age: 25, },
])" ... />
The name of the object property that determines the order when using order
and object
.
name
- Type:
string|number
- Default:
undefined
- Required:
true
<ListElement name="element" ... />
Sets the element's name.
id
- Type:
string
- Default:
null
<ListElement id="field-id" ... />
Sets the id
attribute of the list.
disabled
- Type:
boolean|function|array|object
- Default:
false
<ListElement :disabled="true"... />
<ListElement :disabled="prop" ... /> <!-- computed / data (ref) prop -->
<ListElement :disabled="[['text', 'value']]" ... /> <!-- conditional -->
<ListElement :disabled="(el$, form$) => { return /* boolean */ }" ... />
Disables adding new list items 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
.
label
- Type:
string|object|function
- Default:
null
- Localizable:
true
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.
info
- Type:
string|object
- Default:
null
- Localizable:
true
<ListElement 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.
infoPosition
- Type:
string
- Default:
right
<ListElement label="Top" info="Top" info-position="top" ... />
<ListElement label="Right" info="Right" info-position="right" ... />
<ListElement label="Left" info="Left" info-position="left" ... />
<ListElement label="Bottom" info="Bottom" info-position="bottom" ... />
Sets the position of the info
tooltip.
Can be also defined via
#info
slot.
description
- Type:
string|object
- Default:
null
- Localizable:
true
<ListElement description="Lorem ipsum dolor sit amet" ... />
Renders the contents of description
prop in the ElementDescription
component below the list. It can contain plain text or HTML.
Can be also defined via
#description
slot.
before
- Type:
object|string|number
- Default:
null
- Localizable:
true
<ListElement before="Before" ... />
Renders the contents of before
in a ElementText
component before the list. It can contain plain text or HTML.
Can be also defined via
#before
slot.
between
- Type:
object|string|number
- Default:
null
- Localizable:
true
<ListElement description="Description" between="Between" ... />
Renders the contents of between
in a ElementText
component between the list and the description. It can contain plain text or HTML.
Can be also defined via
#between
slot.
after
- Type:
object|string|number
- Default:
null
- Localizable:
true
<ListElement 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.
default
- Type:
array
- Default:
undefined
<ListElement :default="['Write tests', 'Do refact', 'Publish docs']" ... />
Sets children with default values.
formatData
- Type:
function
- Default:
null
<ListElement :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.
formatLoad
- Type:
function
- Default:
null
<ListElement :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.
submit
- Type:
boolean
- Default:
true
<ListElement :submit="false" ... />
If set to false
the element's data will not be included in requestData
and will not be submitted.
rules
- Type:
array|string|object
- Default:
null
<ListElement rules="required|min:2" ... />
<ListElement :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.
fieldName
- Type:
string
- Default:
name|label
<ListElement field-name="Field name" rules="required" ... />
Sets the name of the field in validation rule messages.
messages
- Type:
object
- Default:
{}
<ListElement rules="required" :messages="{ required: 'The list must have at least one item' }" ... />
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
.
conditions
- Type:
array
- Default:
[]
<!-- field1 - type 'show' -->
<TextElement name="field1" ... />
<!-- Group 1 - only if field1 == 'show' -->
<ListElement :conditions="[['field1', 'show']]" ... />
<!-- Group 2 - only if field1 != 'show' -->
<ListElement" :conditions="[['field1', '!=', 'show']]" ... />
<!-- Group 3 - only if field1 == 'show' -->
<ListElement :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.
<ListElement 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:
<ListElement 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 containin
- expect to be among an array of valuesnot_in
- expect not to be among an array of valuestoday
- expect to be todaybefore
- expect to be before a date (value can be aYYYY-MM-DD
date string ortoday
)after
- expect to be after a date (value can be aYYYY-MM-DD
date string ortoday
)
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.
columns
- Type:
object|string|number
- Default:
null
<ListElement 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 bothlabel
andwrapper
label
contains the labelwrapper
contains the list.
container: 12
label: 3
wrapper: 12
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 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 list the rest. In case the label
has full width (12
) the list will also take up full space instead of becoming zero.
The value of wrapper
defines the size of the 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 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
):
<ListElement label="Label" :columns="{ container: 12, label: 4, wrapper: 12 }" ... />
<ListElement label="Label" :columns="{ container: 12, label: 4, wrapper: 6 }" ... />
Note that while the size of the 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:
<ListElement
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
:
<ListElement 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:
<ListElement 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 usingcolumns
.
inline
- Type:
boolean
- Default:
false
<ListElement :inline="true" ... />
Renders the element and all of its components in a single <span>
without applying columns
.
size
- Type:
string
- Default:
undefined
<ListElement size="sm" ... />
<ListElement ... /> <!-- Default size: 'md' -->
<ListElement size="lg" ... />
The size of the element and its child components.
view
- Type:
string
- Default:
undefined
<ListElement 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.
views
- Type:
object
- Default:
{}
<ListElement :views="{
ComponentName: 'alt'
}" ... />
The name of the views for the child components.
Learn more about views here.
addClasses
- Type:
object|function
- Default:
{}
<ListElement :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.:
<ListElement :add-classes="(form$) => ({
ComponentName: {
classname: [
{ 'class-value': form$.el$('other_field')?.value === 'some_value' }
],
}
})" ... />
Learn more about adding classes here.
addClass
- Type:
array|object|string|function
- Default:
null
<ListElement :add-class="{
classname: 'class-value',
classname: ['class-value'],
classname: [{'class-value': true}],
}" ... />
Adds classes to any of ListElement
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.:
<ListElement :add-class="(form$) => ({
classname: [
{ 'class-value': form$.el$('other_field')?.value === 'some_value' }
],
})" ... />
Learn more about adding classes here.
removeClasses
- Type:
object|function
- Default:
{}
<ListElement :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.:
<ListElement :remove-classes="(form$) => ({
ComponentName: {
classname: form$.el$('other_field')?.value === 'some_value'
? ['class-value-1', 'class-value-2']
: [],
}
})" ... />
Learn more about removing classes here.
removeClass
- Type:
array|object|function
- Default:
null
<ListElement :remove-class="{
classname: ['class-value-1', 'class-value-2']
}" ... />
Removes classes from any of ListElement
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.:
<ListElement :remove-class="(form$) => ({
classname: form$.el$('other_field')?.value === 'some_value'
? ['class-value-1', 'class-value-2']
: [],
})" ... />
Learn more about removing classes here.
replaceClasses
- Type:
object|function
- Default:
{}
<ListElement :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.:
<ListElement :replace-classes="(form$) => ({
ComponentName: {
classname: form$.el$('other_field')?.value === 'some_value' ? {
'from-class': 'to-class'
} : {},
}
})" ... />
Learn more about replacing classes here.
replaceClass
- Type:
object|function
- Default:
null
<ListElement :replace-class="{
classname: {
'from-class': 'to-class',
'from-class': ['to-class'],
'from-class': [{'to-class': true}],
}
}" ... />
Replaces the classes of any class names of ListElement
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.:
<ListElement :replace-class="(form$) => ({
classname: form$.el$('other_field')?.value === 'some_value' ? {
'from-class': 'to-class'
} : {},
})" ... />
Learn more about replacing classes here.
overrideClasses
- Type:
object|function
- Default:
{}
<ListElement :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.:
<ListElement :override-classes="(form$) => ({
ComponentName: form$.el$('other_field')?.value === 'some_value' ? {
classname: 'class-value'
} : {}
})" ... />
Learn more about overriding classes here.
overrideClass
- Type:
array|object|string|function
- Default:
null
<ListElement :override-classes="{
ComponentName: {
classname: 'class-value',
classname: ['class-value'],
classname: [{'class-value': true}],
}
}" ... />
Overrides the classes of any of ListElement
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.:
<ListElement :override-class="(form$) => (form$.el$('other_field')?.value === 'some_value' ? {
classname: 'class-value'
} : {})" ... />
Learn more about overriding classes here.
templates
- Type:
object
- Default:
{}
<template>
<div id="app">
<Vueform>
<ListElement :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.
presets
- Type:
array
- Default:
[]
<ListElement :presets="['preset1', 'preset2']" ... />
The presets to be applied for the component.
Learn more about presets classes here.
slots
- Type:
object
- Default:
{}
<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: 'list',
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.
Properties
Properties include data
, computed
and inject
properties of the component. You can use them by reaching the element's Vue component instance via form$
's el$(path)
method or directly via this
in options API or el$
in Composition API.
aria
- Type:
object
- Group:
computed
The aria-*
attributes of the input.
addLabel
- Type:
string
- Group:
computed
The label of add button.
isRequired
- Type:
boolean
- Group:
computed
Whether the element is required (has required rule).
isDefault
- Type:
boolean
- Group:
computed
Whether the element has its default value.
value
- Type:
any
- Group:
computed
The value of the element.
model
- Type:
any
- Group:
computed
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.
data
- Type:
object
- Group:
computed
The value of the element in {[name]: value}
value format. This gets merged with the parent component's data.
requestData
- Type:
object
- Group:
computed
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).
empty
- Type:
boolean
- Group:
computed
Whether the element has no value filled in.
path
- Type:
string
- Group:
computed
The path of the element using dot .
syntax.
dataPath
- Type:
string
- Group:
computed
The path of the element's data using dot .
syntax.
parent
- Type:
VNode
- Group:
computed
The parent component of the element.
children$
- Type:
object
- Group:
computed
Child element components.
hasAdd
- Type:
boolean
- Group:
computed
Whether adding new items is allowed. Will return false
if the element has isDisabled: true
or have reached max
items. Can be disabled manually by setting controls.add
to false
.
hasRemove
- Type:
boolean
- Group:
computed
Whether remove items is allowed. Will return false
if the element has isDisabled: true
or has <= min
items. Can be disabled manually by setting controls.remove
to false
.
hasSort
- Type:
boolean
- Group:
computed
Whether list items should be sortable. Can be enabled by setting sort
to true
, but will return false
if the element has isDisabled: true
.
sorting
- Type:
boolean
- Group:
data
Whether the list is currently being sorted (an item is dragged).
isSortable
- Type:
boolean
- Group:
computed
Whether the list is sortable. Can be enabled with sort
option, but it will disabled if isDisabled
is true
.
orderByName
- Type:
string
- Group:
computed
The name of the child (when using object
) by which the items should be ordered.
validated
- Type:
boolean
- Group:
computed
Whether the element and all of its children was already validated at least once.
invalid
- Type:
boolean
- Group:
computed
Whether the element or any of its children has any failing rules.
dirty
- Type:
boolean
- Group:
computed
Whether the element's or any of its children's value was modified.
pending
- Type:
boolean
- Group:
computed
Whether the element or any of its children has any async rules in progress.
debouncing
- Type:
boolean
- Group:
computed
Whether the element or any of its children have a validation rule with pending debounce.
busy
- Type:
boolean
- Group:
computed
Whether the element or any of its children is pending
or debouncing
.
messageBag
- Type:
MessageBag
- Default:
MessageBag
- Group:
data
Instance of MessageBag service. Custom errors and messages can be added.
errors
- Type:
array
- Group:
computed
All the errors of MessageBag
.
error
- Type:
string
- Group:
computed
The first error of MessageBag
.
available
- Type:
boolean
- Group:
computed
Whether no conditions
are defined or they are all fulfilled.
hidden
- Type:
boolean
- Default:
false
- Group:
data
visible
- Type:
boolean
- Group:
computed
Whether the element is visible. It's false
when available
or active
is false
or hidden
is true
.
isDisabled
- Type:
boolean
- Group:
computed
Whether the element is disabled.
container
- Type:
HTMLElement
- Group:
data
The ref to the outermost DOM of the element.
fieldId
- Type:
string
- Group:
computed
hasLabel
- Type:
boolean
- Group:
computed
Whether the element has a label
option, a #label slot or Vueform
component's forceLabels
option is true
.
Size
- Type:
string
- Group:
computed
The resolved size of the element and all of its child components.
View
- Type:
string
- Group:
computed
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.
template
- Type:
object
- Group:
computed
The component's template.
classes
- Type:
object
- Group:
computed
The component's classes.
theme
- Type:
object
- Group:
inject
The global theme object, which contains all the default templates and classes.
form$
- Type:
Vueform
- Group:
inject
The root form's component.
el$
- Type:
VueformElement
- Group:
computed
The element's component.
mounted
- Type:
boolean
- Default:
true
- Group:
data
Whether the element has been already mounted.
Methods
The methods
of the component that you can use by reaching the element's Vue component instance via form$
's el$(path)
method or directly via this
in options API or el$
in Composition API.
add
- Arguments:
{any} value*
- value of the appended element (optional)
- Returns:
number
Appends a new item.
remove
- Arguments:
{number} index*
- index of items to be removed
- Returns:
void
Removes an items by its index.
clearMessages
- Returns:
void
Clears the manually added messages from the messageBag
.
load
- Arguments:
{any} value*
- the value to be loaded{boolean} format*
- whether the loaded value should be formatted withformatLoad
before setting the value of the element (default:false
)
- Returns:
void
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
.
update
- Arguments:
{any} value*
- the value to be set
- Returns:
void
Updates the value of the element similarly to load
, only that it can't format data.
clear
- Returns:
void
Clears the element's value.
reset
- Returns:
void
Resets the element's value to default
(or empty if default
is not provided). Also resets all the validation state for the element.
disable
- Returns:
void
Disables the element.
enable
- Returns:
void
Enables the element even if it is disabled by disabled
option.
on
- Arguments:
{string} event*
- name of the event to listen for{function} callback*
- callback to run when the event is triggered
- Returns:
void
Adds a listener for an event.
off
- Arguments:
{string} event*
- name of the event to remove
- Returns:
void
Removes all listeners for an event.
fire
- Arguments:
{any} args*
- list of arguments to pass over to the event callback
- Returns:
void
Fires and emits an event.
validate
- Returns:
Promise
Checks each validation rule for the element and validates children (async).
validateValidators
- Returns:
Promise
Checks each validation rule for the element (async).
validateChildren
- Returns:
Promise
Validates every child (async).
clean
- Returns:
void
Removes the element's dirty
state.
resetValidators
- Returns:
void
Sets the validators to default state.
reinitValidation
- Returns:
void
Re-initializes validators when rules have changed.
hide
- Returns:
void
Hides the element.
show
- Returns:
void
Shows the element if it was hidden with hide()
method.
Events
With events you can subscribe to different events broadcasted by the element. It can be used inline as regular Vue event listeners with @event
format. In schema
it can be used in PascalCase format prefixed with on
(eg. onChange
).
<template>
<Vueform>
<ListElement @{eventName}="handler" ... />
</Vueform>
</template>
<script>
import { Vueform, useVueform } from '@vueform/vueform'
export default {
mixins: [Vueform],
setup: useVueform,
data: () => ({
vueform: {
schema: {
element: {
type: 'list',
on{EventName}() {
// ...
}
}
}
}
})
}
</script>
You can also use on(event, callback)
method to subscribe to events.
change
- Params:
{string} newValue
- the new value{string} oldValue
- the old value{component} el$
- the element's component
Triggered when the element's value is changed.
add
- Params:
{number} index
- the index of the added item{any} addedValue
- the added value{array} newValue
- the element value after the item is added
Triggered when a new item is added to the list.
remove
- Params:
{number} index
- the index of the removed item{array} value
- the element's value after the item is removed
Triggered when a new item is removed from the list.
sort
- Params:
{array} value
- the element's value after sorting{number} oldIndex
- the old index of the moved element{number} newIndex
- the new index of the moved element{component} el$
- the moved element's component
Triggered when items are being sorted by the user, when sort: true
.
beforeCreate
- Params:
{component} el$
- the element's component
Triggered in beforeCreate hook.
created
- Params:
{component} el$
- the element's component
Triggered in created hook.
beforeMount
- Params:
{component} el$
- the element's component
Triggered in beforeMount hook.
mounted
- Params:
{component} el$
- the element's component
Triggered in mounted hook.
beforeUpdate
- Params:
{component} el$
- the element's component
Triggered in beforeUpdate hook.
updated
- Params:
{component} el$
- the element's component
Triggered in updated hook.
beforeUnmount
- Params:
{component} el$
- the element's component
Triggered in beforeUnmount (or beforeDestroy in Vue 2) hook.
unmounted
- Params:
{component} el$
- the element's component
Triggered in unmounted (or destroyed in Vue 2) hook.
Slots
Slots can be used inline or in slots
option object when used in schema
:
<template>
<Vueform>
<ListElement ... >
<template #{slot-name}="scope">
<!-- ... --->
</template>
</ListElement>
</Vueform>
</template>
<script>
import { Vueform, useVueform } from '@vueform/vueform'
export default {
mixins: [Vueform],
setup: useVueform,
data: () => ({
vueform: {
schema: {
element: {
type: 'list',
slots: {
{slotName}: // implementation
}
}
}
}
})
}
</script>
label
- Scope:
{component} el$
- the element's component
Renders a label for the element in ElementLabel
component.
info
- Scope:
{component} el$
- the element's 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.
required
description
- Scope:
{component} el$
- the element's component
Renders description for the element in ElementDescription
component.
before
- Scope:
{component} el$
- the element's component
Renders an ElementText
component before the list.
between
- Scope:
{component} el$
- the element's component
Renders an ElementText
component after the list and before description.
after
- Scope:
{component} el$
- the element's component
Renders an ElementText
component after the description and error.