Select Rich: API Table
class: LionSelectInvoker, lion-select-invoker
Fields
| Name | Privacy | Type | Default | Description | Inherited From |
|---|---|---|---|---|---|
active | public | boolean | false | LionButton | |
hostElement | public | LionSelectRich | null | null | The LionSelectRich element this invoker is part of. Will be set on connectedCallback of LionSelectRich | |
readOnly | public | boolean | false | When the connected LionSelectRich instance is readOnly, this should be reflected in the invoker as well | |
selectedElement | public | LionOption | null | null | The option element that is currently selected | |
singleOption | public | boolean | false | When the connected LionSelectRich instance has only one option, this should be reflected in the invoker as well | |
slots | public | ||||
type | public | string | 'button' | LionButton | |
_contentWrapperNode | protected |
Methods
| Name | Privacy | Description | Parameters | Return | Inherited From |
|---|---|---|---|---|---|
_afterTemplate | protected | ||||
_beforeTemplate | protected | ||||
_contentTemplate | protected | TemplateResult|Node[]|string|null | |||
_noSelectionTemplate | protected | To be overriden for a placeholder, used when `hasNoDefaultSelected` is true on the select rich | TemplateResult |
Attributes
| Name | Field | Inherited From |
|---|---|---|
selectedElement | selectedElement | |
hostElement | hostElement | |
readonly | readOnly | |
single-option | singleOption | |
active | active | LionButton |
type | type | LionButton |
class: LionSelectRich, lion-field-with-select
Fields
| Name | Privacy | Type | Default | Description | Inherited From |
|---|---|---|---|---|---|
interactionMode | public | 'windows/linux'|'mac'|'auto' | 'auto' | Aligns behavior for ‘selectionFollowFocus’ and ‘navigateWithinInvoker’ with platform. When ‘auto’ (default), platform is automatically detected | |
navigateWithinInvoker | public | Boolean | false | When invoker has focus, up and down arrow keys changes active state of listbox, without opening overlay. | |
singleOption | public | boolean | false | ||
slots | public | SlotsMap | |||
_arrowWidth | protected | number | 28 | ||
_feedbackConditionMeta | protected | LionListbox | |||
_focusableNode | protected | LionListbox | |||
_invokerNode | protected | LionSelectInvoker | |||
_overlayContentNode | protected | ||||
_overlayInvokerNode | protected | ||||
_scrollTargetNode | protected |
Methods
| Name | Privacy | Description | Parameters | Return | Inherited From |
|---|---|---|---|---|---|
addFormElement | public | child: LionOption & FormControlHost, indexToInsertAt: Number | |||
removeFormElement | public | child: FormRegisteringHost | |||
_alignInvokerWidth | protected | Align invoker width with content width Make sure display is not set to “none” while calculating the content width | |||
_defineOverlayConfig | protected | ||||
_getCheckedElements | protected | In the select disabled options are still going to a possible value for example when prefilling or programmatically setting it. | |||
_inputGroupInputTemplate | protected | ||||
_listboxOnClick | protected | ||||
_listboxOnKeyDown | protected | ev: KeyboardEvent | |||
_noDefaultSelectedInheritsWidth | protected | With no selected element, we should override the inheritsReferenceWidth in most cases. By default, we will set it to ‘min’, and then set it back to what it was initially when something is selected. As a subclasser you can override this behavior. | |||
_onFormElementsChanged | protected | ||||
_onLabelClick | protected | ||||
_scrollIntoView | protected | el: HTMLElement, scrollTargetEl: HTMLElement | |||
_setupListboxNode | protected | ||||
_setupOverlayCtrl | protected | ||||
_teardownListboxNode | protected | ||||
_teardownOverlayCtrl | protected |
Events
| Name | Type | Description | Inherited From |
|---|---|---|---|
blur | Event |
Attributes
| Name | Field | Inherited From |
|---|---|---|
navigate-within-invoker | navigateWithinInvoker | |
interaction-mode | interactionMode | |
single-option | singleOption |