Listbox: API Table

class: `LionListbox`, `lion-listbox`

Fields

Name	Privacy	Type	Default	Description	Inherited From
`_feedbackConditionMeta`	protected			Allows Subclassers to add meta info for feedbackCondition	ValidateMixin
`_focusableNode`	protected	`HTMLElement`		The focusable element: could be an input, textarea, select, button or any other element with tabindex > -1	FocusMixin
`_inputNode`	protected			The interactive (form) element. Can be a native element like input/textarea/select or an element with tabindex > -1	FormControlMixin
`_listboxNode`	protected				ListboxMixin
`_listboxActiveDescendantNode`	protected	`HTMLElement`			ListboxMixin
`_listboxSlot`	protected	`HTMLElement`			ListboxMixin
`_scrollTargetNode`	protected	`HTMLElement`			ListboxMixin
`_activeDescendantOwnerNode`	protected	`HTMLElement`			ListboxMixin
`activeIndex`	public				ListboxMixin
`checkedIndex`	public	`number \| number[]`			ListboxMixin
`hasNoDefaultSelected`	public	`boolean`	`false`	When setting this to true, on initial render, no option will be selected. It is advisable to override `_noSelectionTemplate` method in the select-invoker to render some kind of placeholder initially	ListboxMixin
`orientation`	public	`string`	`'vertical'`	Informs screen reader and affects keyboard navigation. By default 'vertical'	ListboxMixin
`rotateKeyboardNavigation`	public	`boolean`	`false`	Will give first option active state when navigated to the next option from last option.	ListboxMixin
`selectionFollowsFocus`	public	`boolean`	`false`	When true, will synchronize activedescendant and selected element on arrow key navigation. This behavior can usually be seen on <select> on the Windows platform. Note that this behavior cannot be used when multiple-choice is true. See: https://www.w3.org/TR/wai-aria-practices/#kbd_selection_follows_focus	ListboxMixin
`_noTypeAhead`	public	`boolean`	`false`	When false, a user can type on which the focus will jump to the matching option	ListboxMixin
`_typeAheadTimeout`	protected	`number`	`1000`	The pending char sequence that will set active list item	ListboxMixin
`_listboxActiveDescendant`	protected	`number \| null`	`null`		ListboxMixin
`_repropagationRole`	public	`'child'\|'choice-group'\|'fieldset'`	`'choice-group'`	Based on the role, details of handling model-value-changed repropagation differ.	FormControlMixin
`_listboxReceivesNoFocus`	protected	`boolean`	`false`	When listbox is coupled to a textbox (in case we are dealing with a combobox), spaces should not select an element (they need to be put in the textbox)	ListboxMixin
`_oldModelValue`	protected	`string \| string[] \| undefined`	`undefined`		ListboxMixin
`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
`modelValue`	public				FormControlMixin
`serializedValue`	public				ChoiceGroupMixin
`formattedValue`	public				ChoiceGroupMixin
`operationMode`	public	`OperationMode`		Types of input interaction of the FormControl (for instance 'enter'\|'select'\|'upload')	ValidateMixin
`multipleChoice`	public	`boolean`	`false`	When false (default), modelValue and serializedValue will reflect the currently selected choice (usually a string). When true, modelValue will and serializedValue will be an array of strings.	ChoiceGroupMixin
`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
`_isFormOrFieldset`	protected	`boolean`	`false`	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
`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
`focused`	public	`boolean`	`false`	Whether the focusable element within (`._focusableNode`) is focused. Reflects to attribute '[focused]' as a styling hook	FocusMixin
`focusedVisible`	public	`boolean`	`false`	Whether the focusable element within (`._focusableNode`) matches ':focus-visible' Reflects to attribute '[focused-visible]' as a styling hook See: https://developer.mozilla.org/en-US/docs/Web/CSS/:focus-visible	FocusMixin
`autofocus`	public	`boolean`	`false`		FocusMixin
`touched`	public	`boolean`	`false`	True when user has focused and left(blurred) the field.	InteractionStateMixin
`dirty`	public	`boolean`	`false`	True when user has changed the value of the field.	InteractionStateMixin
`prefilled`	public	`boolean`	`false`	True when user has left non-empty field or input is prefilled. The name must be seen from the point of view of the input field: once the user enters the input field, the value is non-empty.	InteractionStateMixin
`filled`	public	`boolean`	`false`	True when the modelValue is non-empty (see _isEmpty in FormControlMixin)	InteractionStateMixin
`_leaveEvent`	protected	`string`	`'blur'`	The event that triggers the touched state	InteractionStateMixin
`_valueChangedEvent`	protected	`string`	`'model-value-changed'`	The event that triggers the dirty state	InteractionStateMixin
`submitted`	public				InteractionStateMixin
`_allValidators`	protected	`Validator[]`		Combination of validators provided by Application Developer and the default validators	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
`defaultValidators`	public	`Validator[]`	`[]`	Used by Subclassers to add default Validators to a particular FormControl. A date input for instance, always needs the isDate validator.	ValidateMixin
`_visibleMessagesAmount`	protected	`number`	`1`	The amount of feedback messages that will visible in LionValidationFeedback	ValidateMixin
`_requestedToBeDisabled`	protected	`boolean`	`false`		DisabledMixin
`disabled`	public	`boolean`	`false`		DisabledMixin

Methods

Name	Privacy	Description	Parameters	Return	Inherited From
`_inputGroupInputTemplate`	protected			`TemplateResult`	FormControlMixin
`setCheckedIndex`	public	If an array is passed for multiple-choice, it will check the indexes in array, and uncheck the rest If a number is passed, the item with the passed index is checked without unchecking others For single choice, __onChildCheckedChanged we ensure that we uncheck siblings	`index: number\|number[]`		ListboxMixin
`addFormElement`	public		`child: FormControlHost & LionOption, indexToInsertAt: Number`		FormRegistrarMixin
`resetInteractionState`	public	Resets touched and dirty, and recomputes prefilled			InteractionStateMixin
`reset`	public				ListboxMixin
`clear`	public				ChoiceGroupMixin
`_handleTypeAhead`	protected		`ev: KeyboardEvent, { setAsChecked }, options: {setAsChecked:boolean}`		ListboxMixin
`_getCheckedElements`	protected				ChoiceGroupMixin
`_setupListboxNode`	protected				ListboxMixin
`_onListboxContentChanged`	protected	A Subclasser can perform additional logic whenever the elements inside the listbox are updated. For instance, when a combobox does server side autocomplete, we want to match highlighted parts client side.			ListboxMixin
`_teardownListboxNode`	protected				ListboxMixin
`_getNextEnabledOption`	protected		`currentIndex: number, offset: number`		ListboxMixin
`_getPreviousEnabledOption`	protected		`currentIndex: number, offset: number`		ListboxMixin
`_onChildActiveChanged`	protected		`{ target }, ev: Event & { target: LionOption }`		ListboxMixin
`_listboxOnKeyDown`	protected		`ev: KeyboardEvent`		ListboxMixin
`_listboxOnClick`	protected		`ev: MouseEvent`		ListboxMixin
`_listboxOnKeyUp`	protected		`ev: KeyboardEvent`		ListboxMixin
`_onLabelClick`	protected				FormControlMixin
`_scrollIntoView`	protected		`el: HTMLElement, scrollTargetEl: HTMLElement`		ListboxMixin
`_uncheckChildren`	protected		`exclude: LionOption\|LionOption[]`		ListboxMixin
`_triggerInitialModelValueChangedEvent`	protected				FormControlMixin
`_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
`_inputGroupTemplate`	protected			`TemplateResult`	FormControlMixin
`_inputGroupBeforeTemplate`	protected			`TemplateResult`	FormControlMixin
`_inputGroupPrefixTemplate`	protected			`TemplateResult \| nothing`	FormControlMixin
`_inputGroupSuffixTemplate`	protected			`TemplateResult \| nothing`	FormControlMixin
`_inputGroupAfterTemplate`	protected			`TemplateResult`	FormControlMixin
`_feedbackTemplate`	protected			`TemplateResult`	FormControlMixin
`_isEmpty`	protected	Used for Required validation and computation of interaction states	`modelValue: any`	`boolean`	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
`_completeRegistration`	protected	Resolves the registrationComplete promise. Subclassers can delay if needed			FormRegistrarMixin
`_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`	ChoiceGroupMixin
`_getFromAllFormElements`	protected	Implicit :(	`property: string, filterFn: (el: FormControl, property?: string) => boolean`	`{[name:string]: any}`	ChoiceGroupMixin
`_throwWhenInvalidChildModelValue`	protected		`child: FormControl`		ChoiceGroupMixin
`_checkSingleChoiceElements`	protected		`ev: CustomEvent & {target:FormControl}`		ChoiceGroupMixin
`_setCheckedElements`	protected		`value: string \| any[], check: Function`		ChoiceGroupMixin
`isRegisteredFormElement`	public		`el: ElementWithParentFormGroup`		FormRegistrarMixin
`removeFormElement`	public		`child: FormControlHost`		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
`focus`	public	Calls `focus()` on focusable element within			FocusMixin
`blur`	public	Calls `blur()` on focusable element within			FocusMixin
`initInteractionState`	public	Evaluations performed on connectedCallback. This method is public, so it can be called at a later moment (when we need to wait for registering children for instance) as well. Since this method will be called twice in last mentioned scenario, it must stay idempotent.			InteractionStateMixin
`_iStateOnLeave`	protected	Sets touched value to true and reevaluates prefilled state. When false, on next interaction, user will start with a clean state.			InteractionStateMixin
`_iStateOnValueChange`	protected	Sets dirty value and validates when already touched or invalid			InteractionStateMixin
`_onTouchedChanged`	protected	Dispatches event on touched state change			InteractionStateMixin
`_onDirtyChanged`	protected	Dispatches event on touched state change			InteractionStateMixin
`_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: InteractionStates`		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
`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
`model-value-changed`	`CustomEvent`		FormControlMixin
`form-element-name-changed`	`CustomEvent`		FormControlMixin
`focus`	`Event`		FocusMixin
`blur`	`Event`		FocusMixin
`focusin`	`Event`		FocusMixin
`focusout`	`Event`		FocusMixin
`touched-changed`	`Event`		InteractionStateMixin
`dirty-changed`	`Event`		InteractionStateMixin
`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
`orientation`	orientation	ListboxMixin
`selection-follows-focus`	selectionFollowsFocus	ListboxMixin
`rotate-keyboard-navigation`	rotateKeyboardNavigation	ListboxMixin
`has-no-default-selected`	hasNoDefaultSelected	ListboxMixin
`_noTypeAhead`	_noTypeAhead	ListboxMixin
`readonly`	readOnly	FormControlMixin
`label`	label	FormControlMixin
`label-sr-only`	labelSrOnly	FormControlMixin
`help-text`	helpText	FormControlMixin
`multiple-choice`	multipleChoice	ChoiceGroupMixin
`_isFormOrFieldset`	_isFormOrFieldset	FormRegistrarMixin
`focused`	focused	FocusMixin
`focused-visible`	focusedVisible	FocusMixin
`autofocus`	autofocus	FocusMixin
`touched`	touched	InteractionStateMixin
`dirty`	dirty	InteractionStateMixin
`filled`	filled	InteractionStateMixin
`shows-feedback-for`	showsFeedbackFor	ValidateMixin
`is-pending`	isPending	ValidateMixin
`disabled`	disabled	DisabledMixin

class: `LionOption`, `lion-option`

Fields

Name	Privacy	Type	Default	Description	Inherited From
`active`	public	`boolean`	`false`
`_requestedToBeDisabled`	protected	`boolean`	`false`		DisabledMixin
`disabled`	public	`boolean`	`false`	Boolean indicating whether or not this element is disabled.	ChoiceInputMixin
`choiceValue`	public	`string\|any`		The value that will be registered to the modelValue of the parent ChoiceGroup. Recommended to be a string	ChoiceInputMixin
`modelValue`	public	`{value:string\|any,checked:boolean}`	`{ value: '', checked: false }`	Whereas 'normal' `.modelValue`s usually store a complex/typed version of a view value, choice inputs have a slightly different approach. In order to remain their Single Source of Truth characteristic, choice inputs store both the value and 'checkedness', in the format { value: 'x', checked: true } Different from the platform, this also allows to serialize the 'non checkedness', allowing to restore form state easily and inform the server about unchecked options.	ChoiceInputMixin
`checked`	public	`boolean`			ChoiceInputMixin
`value`	public			The view value. Will be delegated to `._inputNode.value`	FormatMixin
`formatOn`	protected	`string`	`'change'`	Event that will trigger formatting (more precise, visual update of the view, so the user sees the formatted value) Default: 'change'	FormatMixin
`formatOptions`	public		`({})`	Configuration object that will be available inside the formatter function	FormatMixin
`formattedValue`	public	`string\|undefined`	`undefined`	The view value is the result of the formatter function (when available). The result will be stored in the native _inputNode (usually an input[type=text]). Examples: - For a date input, this would be '20/01/1999' (dependent on locale). - For a number input, this could be '1,234.56' (a String representation of modelValue 1234.56)	FormatMixin
`serializedValue`	public	`string\|undefined`	`undefined`	The serialized version of the model value. This value exists for maximal compatibility with the platform API. The serialized value can be an interface in context where data binding is not supported and a serialized string needs to be set. Examples: - For a date input, this would be the iso format of a date, e.g. '1999-01-20'. - For a number input this would be the String representation of a float ('1234.56' instead of 1234.56) When no parser is available, the value is usually the same as the formattedValue (being _inputNode.value)	FormatMixin
`_isPasting`	protected	`boolean`	`false`	Whether the user is pasting content. Allows Subclassers to do this in their subclass:	FormatMixin
`_isHandlingUserInput`	protected	`boolean`	`false`	Flag that will be set when user interaction takes place (for instance after an 'input' event). Will be added as meta info to the `model-value-changed` event. Depending on whether a user is interacting, formatting logic will be handled differently.	FormatMixin
`name`	public	`string`	`''`	The name the element will be registered with to the .formElements collection of the parent. Also, it serves as the key of key/value pairs in modelValue/serializedValue objects	FormRegisteringMixin
`_parentFormGroup`	protected	`FormRegistrarHost \| undefined`	`undefined`	The registrar this FormControl registers to, Usually a descendant of FormGroup or ChoiceGroup	FormRegisteringMixin
`allowCrossRootRegistration`	public	`boolean`	`false`	To encourage accessibility best practices, `form-element-register` events do not pierce through shadow roots. This forces the developer to create form groups and fieldsets that automatically allow the creation of accessible relationships in the same dom tree. Use this option if you know what you're doing. It will then be possible to nest FormControls inside shadow dom. See https://lion.js.org/fundamentals/rationales/accessibility/#shadow-roots-and-accessibility	FormRegisteringMixin

Methods

Name	Privacy	Description	Parameters	Return	Inherited From
`makeRequestToBeDisabled`	public				DisabledMixin
`retractRequestToBeDisabled`	public				DisabledMixin
`click`	public				DisabledMixin
`_choiceGraphicTemplate`	protected				ChoiceInputMixin
`_afterTemplate`	protected				ChoiceInputMixin
`_preventDuplicateLabelClick`	protected	The native platform fires an event for both the click on the label, and also the redispatched click on the native input element. This results in two click events arriving at the host, but we only want one. This method prevents the duplicate click and ensures the correct isTrusted event with the correct event.target arrives at the host.	`ev: Event`		ChoiceInputMixin
`_toggleChecked`	protected		`ev: Event`		ChoiceInputMixin
`_syncNameToParentFormGroup`	protected	Override this in case of extending ChoiceInputMixin and requiring to sync differently with parent form group name Right now it checks tag name match where the parent form group tagname should include the child field tagname ('checkbox' is included in 'checkbox-group')			ChoiceInputMixin
`_proxyInputEvent`	protected	This can be called whenever the view value should be updated. Dependent on component type ("input" for <input> or "change" for <select>(mainly for IE)) a different event should be used as source for the "user-input-changed" event (which can be seen as an abstraction layer on top of other events (input, change, whatever))			FormatMixin
`_onModelValueChanged`	protected	Responds to modelValue changes in the synchronous cycle (most subclassers should listen to the asynchronous cycle ('modelValue' in the .updated lifecycle))	`{ modelValue }, old: { modelValue:unknown }, newV: { modelValue:unknown }`		FormatMixin
`parser`	public	Converts viewValue to modelValue For instance, a localized date to a Date Object	`v: string, opts: FormatOptions`	`*`	FormatMixin
`formatter`	public	Converts modelValue to formattedValue (formattedValue will be synced with `._inputNode.value`) For instance, a Date object to a localized date.	`modelValue: ChoiceInputModelValue`	`string`	FormatMixin
`clear`	public				ChoiceInputMixin
`_isEmpty`	protected	Used for required validator.			ChoiceInputMixin
`_syncValueUpwards`	protected	Synchronization from `._inputNode.value` to `LionField` (flow [2]) Downwards syncing should only happen for `LionField`.value changes from 'above'. This triggers _onModelValueChanged and connects user input to the parsing/formatting/serializing loop.			FormatMixin
`preprocessor`	public	Preprocessors could be considered 'live formatters'. Their result is shown to the user on keyup instead of after blurring the field. The biggest difference between preprocessors and formatters is their moment of execution: preprocessors are run before modelValue is computed (and work based on view value), whereas formatters are run after the parser (and are based on modelValue) Automatically formats code while typing. It depends on a preprocessro that smartly updates the viewValue and caret position for best UX.	`v: string, opts: FormatOptions & { prevViewValue: string; currentCaretIndex: number }`	`{ viewValue:string; caretIndex:number; }\|string\|undefined`	FormatMixin
`serializer`	public	Converts `.modelValue` to `.serializedValue` For instance, a Date object to an iso formatted date string	`v: ?`	`string`	FormatMixin
`deserializer`	public	Converts `.serializedValue` to `.modelValue` For instance, an iso formatted date string to a Date object	`v: ?`	`?`	FormatMixin
`_calculateValues`	protected	Responsible for storing all representations(modelValue, serializedValue, formattedValue and value) of the input value. Prevents infinite loops, so all value observers can be treated like they will only be called once, without indirectly calling other observers. (in fact, some are called twice, but the __preventRecursiveTrigger lock prevents the second call from having effect).	`{ source }, config: {source:'model'\|'serialized'\|'formatted'\|null}`		FormatMixin
`_dispatchModelValueChangedEvent`	protected	This is wrapped in a distinct method, so that parents can control when the changed event is fired. For objects, a deep comparison might be needed.	`args: { modelValue: unknown; }[]`		FormatMixin
`_reflectBackFormattedValueToUser`	protected	Synchronization from `LionField.value` to `._inputNode.value` - flow [1] will always be reflected back - flow [2] will not be reflected back when this flow was triggered via `@user-input-changed` (this will happen later, when `formatOn` condition is met)			FormatMixin
`_reflectBackOn`	protected	Every time .formattedValue is attempted to sync to the view value (on change/blur and on modelValue change), this condition is checked. When enhancing it, it's recommended to call via `return this._myExtraCondition && super._reflectBackOn()`		`boolean`	FormatMixin
`_onUserInputChanged`	protected				FormatMixin
`__onCompositionEvent`	protected		`{ type }, event: Event`		FormatMixin

Events

Name	Type	Inherited From
`active-changed`	`Event`
`model-value-changed`	`CustomEvent`	FormatMixin
`user-input-changed`	`Event`	FormatMixin
`form-element-register`	`CustomEvent`	FormRegisteringMixin

Attributes

Name	Field	Inherited From
`active`	active
`disabled`	disabled	ChoiceInputMixin
`checked`	checked	ChoiceInputMixin
`modelValue`	modelValue	ChoiceInputMixin
`choiceValue`	choiceValue	ChoiceInputMixin
`name`	name	FormRegisteringMixin
`allow-cross-root-registration`	allowCrossRootRegistration	FormRegisteringMixin

class: `LionOptions`, `lion-options`

Fields

Name	Privacy	Type	Default	Description	Inherited From
`tabIndex`	public	`number`	`0`
`registrationTarget`	public	`(FormRegistrarPortalHost & HTMLElement) \| undefined`	`undefined`	Registration target: an element, usually in the body of the dom, that captures events and redispatches them on host	FormRegistrarPortalMixin

Attributes

Name	Field	Inherited From
`tabindex`	tabIndex

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

Listbox: API Table

class: LionListbox, lion-listbox

Fields

Methods

Events

Attributes

class: LionOption, lion-option

Fields

Methods

Events

Attributes

class: LionOptions, lion-options

Fields

Attributes

class: `LionListbox`, `lion-listbox`

class: `LionOption`, `lion-option`

class: `LionOptions`, `lion-options`