Fieldset: API Table

class: `LionFieldset`, `lion-fieldset`

Fields

Name	Privacy	Type	Default	Description	Inherited From
`_isFormOrFieldset`	protected	`boolean`	`true`	Flag that determines how ".formElements" should behave. For a regular fieldset (see LionFieldset) we expect ".formElements" to be accessible as an object. In case of a radio-group, a checkbox-group or a select/listbox, it should act like an array (see ChoiceGroupMixin). Usually, when false, we deal with a choice-group (radio-group, checkbox-group, (multi)select)	FormRegistrarMixin
`_repropagationRole`	public	`'child'\|'choice-group'\|'fieldset'`	`'fieldset'`	Based on the role, details of handling model-value-changed repropagation differ.	FormControlMixin
`_inputNode`	protected			The host element with role group (or radio-group or form) containing necessary aria attributes	FormControlMixin
`modelValue`	public			Object keyed by formElements names, containing formElements' modelValues	FormControlMixin
`serializedValue`	public			Object keyed by formElements names, containing formElements' serializedValues	FormGroupMixin
`formattedValue`	public			Object keyed by formElements names, containing formElements' formattedValues	FormGroupMixin
`prefilled`	public	`boolean`		True when all of the children are prefilled (see InteractionStateMixin for more details.)	FormGroupMixin
`_initialModelValue`	protected			Gathers initial model values of all children. Used when resetGroup() is called.	FormGroupMixin
`value`	public	`string`	`''`		FormGroupMixin
`disabled`	public	`boolean`	`false`	Disables all formElements in group	DisabledMixin
`submitted`	public	`boolean`	`false`	True when parent form is submitted	FormGroupMixin
`dirty`	public	`boolean`	`false`	True when any of the children is dirty (see InteractionStateMixin for more details.)	FormGroupMixin
`touched`	public	`boolean`	`false`	True when the group as a whole is blurred (see InteractionStateMixin for more details.)	FormGroupMixin
`focused`	public	`boolean`	`false`	True when any of the children is focused.	FormGroupMixin
`defaultValidators`	public	`Validator[]`	`[new FormElementsHaveNoError()]`	Used by Subclassers to add default Validators to a particular FormControl. A date input for instance, always needs the isDate validator.	ValidateMixin
`__descriptionElementsInParentChain`	protected		`new Set()`		FormGroupMixin
`__pendingValues`	protected	`{modelValue?:{[key:string]: any}, serializedValue?:{[key:string]: any}}`	`{ modelValue: {}, serializedValue: {} }`		FormGroupMixin
`formElements`	public	`FormControlsCollection`	`new FormControlsCollection()`	Closely mimics the natively supported HTMLFormControlsCollection. It can be accessed both like an array and an object (based on control/element names).	FormRegistrarMixin
`initComplete`	public	`Promise<any>`	`new Promise((resolve, reject) => { this.__resolveInitComplete = resolve; this.__rejectInitComplete = reject; })`	initComplete resolves after all pending initialization logic (for instance `<form-group .serializedValue=$>`) is executed	FormRegistrarMixin
`registrationComplete`	public	`Promise<any> & {done?:boolean}`	`new Promise((resolve, reject) => { this.__resolveRegistrationComplete = resolve; this.__rejectRegistrationComplete = reject; })`	registrationComplete waits for all children formElements to have registered	FormRegistrarMixin
`done`	public	`boolean`	`false`		FormRegistrarMixin
`label`	public	`string`	`''`	The label text for the input node. When no value is defined, textContent of [slot=label] will be used	FormControlMixin
`helpText`	public	`string`	`''`	The helpt text for the input node. When no value is defined, textContent of [slot=help-text] will be used	FormControlMixin
`fieldName`	public	`string`		Will be used in validation messages to refer to the current field	FormControlMixin
`_labelNode`	protected			Element where label will be rendered to	FormControlMixin
`_helpTextNode`	protected			Element where help text will be rendered to	FormControlMixin
`_feedbackNode`	protected			Element where validation feedback will be rendered to	FormControlMixin
`readOnly`	public	`boolean`	`false`	A Boolean attribute which, if present, indicates that the user should not be able to edit the value of the input. The difference between disabled and readonly is that read-only controls can still function, whereas disabled controls generally do not function as controls until they are enabled. (From: https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input#attr-readonly)	FormControlMixin
`labelSrOnly`	public	`boolean`	`false`	The label will only be visible for srceen readers when true	FormControlMixin
`_inputId`	protected	`string`		Unique id that can be used in all light dom	FormControlMixin
`_ariaLabelledNodes`	public	`HTMLElement[]`	`[]`	Contains all elements that should end up in aria-labelledby of `._inputNode`	FormControlMixin
`_ariaDescribedNodes`	public	`HTMLElement[]`	`[]`	Contains all elements that should end up in aria-describedby of `._inputNode`	FormControlMixin
`_isRepropagationEndpoint`	public	`boolean`	`false`	By default, a field with _repropagationRole 'choice-group' will act as an 'endpoint'. This means it will be considered as an individual field: for a select, individual options will not be part of the formPath. They will. Similarly, components that (a11y wise) need to be fieldsets, but 'interaction wise' (from Application Developer perspective) need to be more like fields (think of an amount-input with a currency select box next to it), can set this to true to hide private internals in the formPath.	FormControlMixin
`operationMode`	public	`OperationMode`		Types of input interaction of the FormControl (for instance 'enter'\|'select'\|'upload')	ValidateMixin
`_allValidators`	protected	`Validator[]`		Combination of validators provided by Application Developer and the default validators	ValidateMixin
`_feedbackConditionMeta`	protected			Allows Subclassers to add meta info for feedbackCondition	ValidateMixin
`hasFeedbackFor`	public	`ValidationType[]`	`[]`	As soon as validation happens (after modelValue/validators/validator param change), this array is updated with the active ValidationTypes ('error'\|'warning'\|'success'\|'info' etc.). Notice the difference with `.showsFeedbackFor`, which filters `.hasFeedbackFor` based on `.feedbackCondition()`. For styling purposes, will be reflected to [has-feedback-for="error warning"]. This can be useful for subtle visual feedback on keyup, like a red/green border around an input.	ValidateMixin
`showsFeedbackFor`	public	`ValidationType[]`	`[]`	Based on outcome of feedbackCondition, this array decides what ValidationTypes should be shown in validationFeedback, based on meta data like interaction states. For styling purposes, it reflects it `[shows-feedback-for="error warning"]`	ValidateMixin
`validationStates`	public	`ValidationStates`	`{}`	The outcome of a validation 'round'. Keyed by ValidationType and Validator name	ValidateMixin
`isPending`	public	`boolean`	`false`	Flag indicating whether async validation is pending. Creates attribute [is-pending] as a styling hook	ValidateMixin
`validators`	public	`Validator[]`	`[]`	Used by Application Developers to add Validators to a FormControl.	ValidateMixin
`_visibleMessagesAmount`	protected	`number`	`1`	The amount of feedback messages that will visible in LionValidationFeedback	ValidateMixin
`_requestedToBeDisabled`	protected	`boolean`	`false`		DisabledMixin

Methods

Name	Privacy	Description	Parameters	Return	Inherited From
`__initInteractionStates`	protected				FormGroupMixin
`_triggerInitialModelValueChangedEvent`	protected				FormControlMixin
`__setupOutsideClickHandling`	protected				FormGroupMixin
`_checkForOutsideClick`	protected		`event: Event`		FormGroupMixin
`__requestChildrenToBeDisabled`	protected				FormGroupMixin
`__retractRequestChildrenToBeDisabled`	protected				FormGroupMixin
`_inputGroupTemplate`	protected			`TemplateResult`	FormControlMixin
`submitGroup`	public	Handles interaction state 'submitted'. This allows children to enable visibility of validation feedback			FormGroupMixin
`resetGroup`	public	Resets to initial/prefilled values and interaction states of all FormControls in group,			FormGroupMixin
`clearGroup`	public	Clears all values and resets all interaction states of all FormControls in group,			FormGroupMixin
`resetInteractionState`	public	Resets all interaction states for all formElements			FormGroupMixin
`_getFromAllFormElementsFilter`	protected	A filter function which will exclude a form field when returning false By default, exclude form fields which are disabled The type is be passed as well for more fine grained control, e.g. distinguish the filter when fetching modelValue versus serializedValue	`el: FormControl, type: string`	`boolean`	FormGroupMixin
`_getFromAllFormElements`	protected	Gets a keyed be name object for requested property (like modelValue/serializedValue)	`property: string, filterFn: (el: FormControl, property?: string) => boolean`	`{[name:string]: any}`	FormGroupMixin
`_setValueForAllFormElements`	protected	Sets the same value for requested property in all formElements	`property: string \| number, value: any`		FormGroupMixin
`_setValueMapForAllFormElements`	protected	Allows to set formElements values via a keyed object structure	`property: string, values: { [x: string]: any; }`		FormGroupMixin
`_anyFormElementHas`	protected	Returns true when one of the formElements has requested	`property: string`		FormGroupMixin
`_anyFormElementHasFeedbackFor`	protected		`state: string`		FormGroupMixin
`_everyFormElementHas`	protected	Returns true when all of the formElements have requested property	`property: string`		FormGroupMixin
`__onChildValidatePerformed`	protected	Gets triggered by event 'validate-performed' which enabled us to handle 2 different situations - react on modelValue change, which says something about the validity as a whole (at least two checkboxes for instance) and nothing about the children's values - children validity states have changed, so fieldset needs to update itself based on that	`ev: Event`		FormGroupMixin
`_syncFocused`	protected				FormGroupMixin
`_onFocusOut`	protected		`ev: Event`		FormGroupMixin
`_syncDirty`	protected				FormGroupMixin
`__storeAllDescriptionElementsInParentChain`	protected	Traverses the _parentFormGroup tree, and gathers all aria description elements (feedback) that should be provided to children. In the example below, when the input for 'street' has focus, a screenreader user would hear the #group-error. In case one of the inputs was in error state as well, the SR user would first hear the local error, followed by #group-error			FormGroupMixin
`__linkParentMessages`	protected		`child: FormControl`		FormGroupMixin
`__unlinkParentMessages`	protected		`child: FormControl`		FormGroupMixin
`addFormElement`	public		`child: FormControl & {serializedValue:string\|object}, indexToInsertAt: number`		FormRegistrarMixin
`removeFormElement`	public		`el: FormRegisteringHost & FormControl`		FormRegistrarMixin
`_isEmpty`	protected	Used for Required validation and computation of interaction states	`modelValue: any`	`boolean`	FormControlMixin
`_completeRegistration`	protected	Resolves the registrationComplete promise. Subclassers can delay if needed			FormRegistrarMixin
`isRegisteredFormElement`	public		`el: ElementWithParentFormGroup`		FormRegistrarMixin
`_onRequestToAddFormElement`	protected	Hook for Subclassers to perform logic before an element is added	`ev: CustomEvent`		FormRegistrarMixin
`_onRequestToChangeFormElementName`	protected		`ev: CustomEvent`		FormRegistrarMixin
`_onRequestToRemoveFormElement`	protected		`ev: CustomEvent`		FormRegistrarMixin
`_enhanceLightDomClasses`	protected				FormControlMixin
`_enhanceLightDomA11y`	protected				FormControlMixin
`_enhanceLightDomA11yForAdditionalSlots`	protected	Enhances additional slots(prefix, suffix, before, after) defined by developer. When boolean attribute data-label or data-description is found, the slot element will be connected to the input via aria-labelledby or aria-describedby	`additionalSlots: string[]`		FormControlMixin
`__reflectAriaAttr`	protected	Will handle help text, validation feedback and character counter, prefix/suffix/before/after (if they contain data-description flag attr). Also, contents of id references that will be put in the <lion-field>._ariaDescribedby property from an external context, will be read by a screen reader.	`attrName: string, nodes: Element[], reorder: boolean\|undefined`		FormControlMixin
`_groupOneTemplate`	protected			`TemplateResult`	FormControlMixin
`_groupTwoTemplate`	protected			`TemplateResult`	FormControlMixin
`_labelTemplate`	protected			`TemplateResult`	FormControlMixin
`_helpTextTemplate`	protected			`TemplateResult`	FormControlMixin
`_inputGroupBeforeTemplate`	protected			`TemplateResult`	FormControlMixin
`_inputGroupPrefixTemplate`	protected			`TemplateResult \| nothing`	FormControlMixin
`_inputGroupInputTemplate`	protected			`TemplateResult`	FormControlMixin
`_inputGroupSuffixTemplate`	protected			`TemplateResult \| nothing`	FormControlMixin
`_inputGroupAfterTemplate`	protected			`TemplateResult`	FormControlMixin
`_feedbackTemplate`	protected			`TemplateResult`	FormControlMixin
`_getAriaDescriptionElements`	protected	This function exposes descripion elements that a FormGroup should expose to its children. See FormGroupMixin.__getAllDescriptionElementsInParentChain()		`Array.<HTMLElement>`	FormControlMixin
`addToAriaLabelledBy`	public	Allows to add extra element references to aria-labelledby attribute.	`element: HTMLElement, { idPrefix = '', reorder = true }, customConfig: {idPrefix?:string; reorder?: boolean}`		FormControlMixin
`removeFromAriaLabelledBy`	public	Allows to remove element references from aria-labelledby attribute.	`element: HTMLElement`		FormControlMixin
`addToAriaDescribedBy`	public	Allows to add element references to aria-describedby attribute.	`element: HTMLElement, { idPrefix = '', reorder = true }, customConfig: {idPrefix?:string; reorder?: boolean}`		FormControlMixin
`removeFromAriaDescribedBy`	public	Allows to remove element references from aria-describedby attribute.	`element: HTMLElement`		FormControlMixin
`__getDirectSlotChild`	protected		`slotName: string`	`HTMLElement \| undefined`	FormControlMixin
`_dispatchInitialModelValueChangedEvent`	protected				FormControlMixin
`_onBeforeRepropagateChildrenValues`	protected	Hook for Subclassers to add logic before repropagation	`ev: CustomEvent`		FormControlMixin
`__repropagateChildrenValues`	protected		`ev: CustomEvent`		FormControlMixin
`_repropagationCondition`	protected	Based on provided target, this condition determines whether received model-value-changed event should be repropagated	`target: FormControlHost`		FormControlMixin
`_onLabelClick`	protected				FormControlMixin
`updateSync`	public		`name: string, oldValue: ?`		ValidateMixin
`validate`	public	Triggered by: - modelValue change - change in the 'validators' array - change in the config of an individual Validator Three situations are handled: - a1) the FormControl is empty: further execution is halted. When the Required Validator (being mutually exclusive to the other Validators) is applied, it will end up in the validation result (as the only Validator, since further execution was halted). - a2) there are synchronous Validators: this is the most common flow. When modelValue hasn't changed since last async results were generated, 'sync results' are merged with the 'async results'. - a3) there are asynchronous Validators: for instance when server side evaluation is needed. Executions are scheduled and awaited and the 'async results' are merged with the 'sync results'. - b) there are MetaValidators. After steps a1, a2, or a3 are finished, the holistic MetaValidators (evaluating the total result of the 'regular' (a1, a2 and a3) validators) will be run... Situations a2 and a3 are not mutually exclusive and can be triggered within one `validate()` call. Situation b will occur after every call.	`{ clearCurrentResult = false }, opts: { clearCurrentResult?: boolean }`		ValidateMixin
`__executeValidators`	protected				ValidateMixin
`_onValidatorUpdated`	protected		`e: Event\|CustomEvent`		ValidateMixin
`_updateFeedbackComponent`	protected	Responsible for retrieving messages from Validators and (delegation of) rendering them. For `._feedbackNode` (extension of LionValidationFeedback): - retrieve messages from highest prio Validators - provide the result to custom feedback node and let the custom node decide on their renderings In both cases: - we compute the 'show' flag (like 'hasErrorVisible') for all types - we set the customValidity message of the highest prio Validator - we set aria-invalid="true" in case hasErrorVisible is true			ValidateMixin
`_showFeedbackConditionFor`	protected	Default feedbackCondition condition, used by Subclassers, that will be used when `feedbackCondition()` is not overridden by Application Developer. Show the validity feedback when returning true, don't show when false	`type: string, meta: object`		ValidateMixin
`feedbackCondition`	public	Allows the Application Developer to specify when a feedback message should be shown	`type: string, meta: object, currentCondition: ((type: string, meta: object) => boolean)`	`boolean`	ValidateMixin
`_hasFeedbackVisibleFor`	protected	Used to translate `.hasFeedbackFor` and `.shouldShowFeedbackFor` to `.showsFeedbackFor`	`type: string`		ValidateMixin
`_updateShouldShowFeedbackFor`	protected				ValidateMixin
`_prioritizeAndFilterFeedback`	protected	Orders all active validators in this.__validationResult. Can also filter out occurrences (based on interaction states)	`{ validationResult }, opts: { validationResult: Validator[] }`	`Validator[]`	ValidateMixin
`makeRequestToBeDisabled`	public				DisabledMixin
`retractRequestToBeDisabled`	public				DisabledMixin
`click`	public				DisabledMixin

Events

Name	Type	Description	Inherited From
`form-element-name-changed`	`CustomEvent`		FormControlMixin
`model-value-changed`	`CustomEvent`		FormControlMixin
`showsFeedbackForChanged`	`Event`		ValidateMixin
	`Event`		ValidateMixin
`shouldShowFeedbackForChanged`	`Event`		ValidateMixin
`validate-performed`	`Event`	private event that should be listened to by LionFieldSet	ValidateMixin

Attributes

Name	Field	Inherited From
`submitted`	submitted	FormGroupMixin
`focused`	focused	FormGroupMixin
`dirty`	dirty	FormGroupMixin
`touched`	touched	FormGroupMixin
`prefilled`	prefilled	FormGroupMixin
`_isFormOrFieldset`	_isFormOrFieldset	FormRegistrarMixin
`readonly`	readOnly	FormControlMixin
`label`	label	FormControlMixin
`label-sr-only`	labelSrOnly	FormControlMixin
`help-text`	helpText	FormControlMixin
`shows-feedback-for`	showsFeedbackFor	ValidateMixin
`is-pending`	isPending	ValidateMixin
`disabled`	disabled	DisabledMixin

Caught a mistake or want to contribute to the documentation? Edit this page on GitHub!

Fieldset: API Table

class: LionFieldset, lion-fieldset

Fields

Methods

Events

Attributes

class: `LionFieldset`, `lion-fieldset`