tab$ - <FormTab>
Component used by tabs$ to render tab.
#Properties
Name | Type | Default | Description |
---|---|---|---|
name | string|number |
- | Name of tab within tabs object. required |
tab | object |
- | Tab schema within tabs object. required |
elements$ | object |
- | Form element components. |
events | array |
[] |
Helper property used to store available events. |
active | boolean |
false |
Determines whether the tab is active. |
available | mixed |
- | Whether the element has any unmet conditions. |
visible | boolean |
- | Determines whether the tab is visible. |
label | string |
- | Label of tab. |
invalid | boolean |
- | Determines whether the tab has any invalid elements. |
children$ | object |
- | Returns the components of elements within the tab. |
conditions | array |
[] |
Returns the conditions of the tab. |
#Methods
# .on(event, callback)
Parameters
event
string : event to listen for.callback
function : callback to run when the event is triggered. Thethis
variable refers to the component the listener is set for.
Adds a listener for an event.
# .off(event)
Parameters
event
string : event to remove the listeners for.
Removes all listeners for an event.
# .fire(event, args) @returns {any}
Parameters
event
string : event to fire.args
object : arguments to pass for the event's listeners.
Fires an event.
# .__(expr, data) @returns {string}
Parameters
expr
string : expression to be translated using.
dot syntax.data
object : data to be passed for the expression
Translates an expression to current locale.
# .select()
Selects the tab to become the active tab.
# .activate()
Activates the tab.
# .deactivate()
Deactivates the step.
#Events
# active
Triggered when the tab becomes active using activate or select method.
# inactive
Triggered when the tab becomes active using inactivate on the current or select method for an other tab.