--- parts: - API Table - Checkbox Group title: 'Checkbox Group: API Table' eleventyNavigation: key: API Table >> Checkbox Group title: API Table order: 90 parent: Checkbox Group --- # Checkbox Group: API Table ## class: `LionCheckbox`, `lion-checkbox` ### Fields | Name | Privacy | Type | Default | Description | Inherited From | | ---------------------------- | --------- | ----------------------------------------- | ------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------- | | `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 | | `autocomplete` | public | `string \| undefined` | `undefined` | Delegates this property to input/textarea/select. | NativeTextFieldMixin | | `autofocus` | public | `boolean` | `false` | | FocusMixin | | `checked` | public | `boolean` | | | ChoiceInputMixin | | `choiceValue` | public | `string\|any` | | The value that will be registered to the modelValue of the parent ChoiceGroup. Recommended to be a string | ChoiceInputMixin | | `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 | | `dirty` | public | `boolean` | `false` | True when user has changed the value of the field. | InteractionStateMixin | | `disabled` | public | `boolean` | `false` | Boolean indicating whether or not this element is disabled. | DisabledMixin | | `fieldName` | public | `string` | | Will be used in validation messages to refer to the current field | FormControlMixin | | `filled` | public | `boolean` | `false` | True when the modelValue is non-empty (see \_isEmpty in FormControlMixin) | InteractionStateMixin | | `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 | | `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 | | `({ mode: 'auto' })` | 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 | | `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 | | `helpText` | public | `string` | | The helpt text for the input node. When no light dom defined via \[slot=help-text], this value will be used | FormControlMixin | | `isPending` | public | `boolean` | `false` | Flag indicating whether async validation is pending. Creates attribute \[is-pending] as a styling hook | ValidateMixin | | `label` | public | `string` | | The label text for the input node. When no light dom defined via \[slot=label], this value will be used. | FormControlMixin | | `labelSrOnly` | public | `boolean` | `false` | The label will only be visible for srceen readers when true | FormControlMixin | | `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. | FormControlMixin | | `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 | | `operationMode` | public | `OperationMode` | | Types of input interaction of the FormControl (for instance 'enter'\|'select'\|'upload') | ValidateMixin | | `placeholder` | public | `string` | `''` | | LionInput | | `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 | | `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 | | `selectionEnd` | public | `number` | | | NativeTextFieldMixin | | `selectionStart` | public | `number` | | | NativeTextFieldMixin | | `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 | | `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 | | `submitted` | public | | | | InteractionStateMixin | | `touched` | public | `boolean` | `false` | True when user has focused and left(blurred) the field. | InteractionStateMixin | | `type` | public | `string` | `'text'` | | LionInput | | `validationStates` | public | `ValidationStates` | `{}` | The outcome of a validation 'round'. Keyed by ValidationType and Validator name | ValidateMixin | | `validators` | public | `Validator[]` | `[]` | Used by Application Developers to add Validators to a FormControl. | ValidateMixin | | `value` | public | | | The view value. Will be delegated to \`.\_inputNode.value\` | FormatMixin | | `_allValidators` | protected | `(Validator \| MetaValidator)[]` | | Combination of validators provided by Application Developer and the default validators | ValidateMixin | | `_ariaDescribedNodes` | public | `HTMLElement[]` | `[]` | Contains all elements that should end up in aria-describedby of \`.\_inputNode\` | FormControlMixin | | `_ariaLabelledNodes` | public | `HTMLElement[]` | `[]` | Contains all elements that should end up in aria-labelledby of \`.\_inputNode\` | FormControlMixin | | `_feedbackConditionMeta` | protected | | | Allows Subclassers to add meta info for feedbackCondition | LionField | | `_feedbackNode` | protected | | | Element where validation feedback will be rendered to | FormControlMixin | | `_focusableNode` | protected | `HTMLElement` | | The focusable element: could be an input, textarea, select, button or any other element with tabindex > -1 | LionField | | `_helpTextNode` | protected | | | Element where help text will be rendered to | FormControlMixin | | `_inputId` | protected | `string` | | Unique id that can be used in all light dom | FormControlMixin | | `_inputNode` | protected | `HTMLInputElement \| HTMLTextAreaElement` | | The interactive (form) element. Can be a native element like input/textarea/select or an element with tabindex > -1 | FormControlMixin | | `_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 | | `_isPasting` | protected | `boolean` | `false` | Whether the user is pasting content. Allows Subclassers to do this in their subclass: | FormatMixin | | `_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 | | `_labelNode` | protected | | | Element where label will be rendered to | FormControlMixin | | `_leaveEvent` | protected | `string` | `'blur'` | The event that triggers the touched state | InteractionStateMixin | | `_parentFormGroup` | protected | `FormRegistrarHost \| undefined` | `undefined` | The registrar this FormControl registers to, Usually a descendant of FormGroup or ChoiceGroup | FormRegisteringMixin | | `_repropagationRole` | public | `'child'\|'choice-group'\|'fieldset'` | `'child'` | Based on the role, details of handling model-value-changed repropagation differ. | FormControlMixin | | `_requestedToBeDisabled` | protected | `boolean` | `false` | | DisabledMixin | | `_valueChangedEvent` | protected | `string` | `'model-value-changed'` | The event that triggers the dirty state | InteractionStateMixin | | `_visibleMessagesAmount` | protected | `number` | `1` | The amount of feedback messages that will visible in LionValidationFeedback | ValidateMixin | ### Methods | Name | Privacy | Description | Parameters | Return | Inherited From | | ---------------------------------------- | --------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------- | --------------------- | | `addToAriaDescribedBy` | public | Allows to add element references to aria-describedby attribute. | `element: HTMLElement, { idPrefix = '', reorder = true }, customConfig: {idPrefix?:string; reorder?: boolean}` | | FormControlMixin | | `addToAriaLabelledBy` | public | Allows to add extra element references to aria-labelledby attribute. | `element: HTMLElement, { idPrefix = '', reorder = true }, customConfig: {idPrefix?:string; reorder?: boolean}` | | FormControlMixin | | `blur` | public | Calls \`blur()\` on focusable element within | | | FocusMixin | | `clear` | public | Clears modelValue. Interaction states are not cleared (use resetInteractionState for this) | | | LionField | | `click` | public | | | | DisabledMixin | | `deserializer` | public | Converts \`.serializedValue\` to \`.modelValue\` For instance, an iso formatted date string to a Date object | `v: ?` | `?` | FormatMixin | | `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 | | `focus` | public | Calls \`focus()\` on focusable element within | | | FocusMixin | | `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 | | `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 | | `makeRequestToBeDisabled` | public | | | | DisabledMixin | | `parser` | public | Converts viewValue to modelValue For instance, a localized date to a Date Object | `v: string, opts: FormatOptions` | `*` | 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 | | `removeFromAriaDescribedBy` | public | Allows to remove element references from aria-describedby attribute. | `element: HTMLElement` | | FormControlMixin | | `removeFromAriaLabelledBy` | public | Allows to remove element references from aria-labelledby attribute. | `element: HTMLElement` | | FormControlMixin | | `reset` | public | Resets modelValue to initial value. Interaction states are cleared | | | LionField | | `resetInteractionState` | public | Resets touched and dirty, and recomputes prefilled | | | LionField | | `retractRequestToBeDisabled` | public | | | | DisabledMixin | | `serializer` | public | Converts \`.modelValue\` to \`.serializedValue\` For instance, a Date object to an iso formatted date string | `v: ?` | `string` | FormatMixin | | `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 | | `_afterTemplate` | protected | | | | ChoiceInputMixin | | `_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 | | `_choiceGraphicTemplate` | protected | | | | ChoiceInputMixin | | `_dispatchInitialModelValueChangedEvent` | protected | | | | FormControlMixin | | `_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 | | `_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 | | `_enhanceLightDomClasses` | protected | | | | FormControlMixin | | `_feedbackTemplate` | protected | | | `TemplateResult` | FormControlMixin | | `_getAriaDescriptionElements` | protected | This function exposes descripion elements that a FormGroup should expose to its children. See FormGroupMixin.\_\_getAllDescriptionElementsInParentChain() | | `Array.` | FormControlMixin | | `_groupOneTemplate` | protected | | | `TemplateResult` | FormControlMixin | | `_groupTwoTemplate` | protected | | | `TemplateResult` | FormControlMixin | | `_hasFeedbackVisibleFor` | protected | Used to translate \`.hasFeedbackFor\` and \`.shouldShowFeedbackFor\` to \`.showsFeedbackFor\` | `type: string` | | ValidateMixin | | `_helpTextTemplate` | protected | | | `TemplateResult` | FormControlMixin | | `_inputGroupAfterTemplate` | protected | | | `TemplateResult` | FormControlMixin | | `_inputGroupBeforeTemplate` | protected | | | `TemplateResult` | FormControlMixin | | `_inputGroupInputTemplate` | protected | | | `TemplateResult` | FormControlMixin | | `_inputGroupPrefixTemplate` | protected | | | `TemplateResult \| nothing` | FormControlMixin | | `_inputGroupSuffixTemplate` | protected | | | `TemplateResult \| nothing` | FormControlMixin | | `_inputGroupTemplate` | protected | | | `TemplateResult` | FormControlMixin | | `_isEmpty` | protected | Used for required validator. | `modelValue: any` | `boolean` | FormControlMixin | | `_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 | | `_labelTemplate` | protected | | | `TemplateResult` | FormControlMixin | | `_onBeforeRepropagateChildrenValues` | protected | Hook for Subclassers to add logic before repropagation | `ev: CustomEvent` | | FormControlMixin | | `_onChange` | protected | Dispatches custom bubble event | `ev: Event=` | | LionField | | `_onDirtyChanged` | protected | Dispatches event on touched state change | | | InteractionStateMixin | | `_onLabelClick` | protected | | | | FormControlMixin | | `_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 | | `_onTouchedChanged` | protected | Dispatches event on touched state change | | | InteractionStateMixin | | `_onUserInputChanged` | protected | | | | FormatMixin | | `_onValidatorUpdated` | protected | | `e: Event\|CustomEvent` | | ValidateMixin | | `_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 | | `_prioritizeAndFilterFeedback` | protected | Orders all active validators in this.\_\_validationResult. Can also filter out occurrences (based on interaction states) | `{ validationResult }, opts: { validationResult: Validator[] }` | `Validator[]` | ValidateMixin | | `_proxyInputEvent` | protected | This can be called whenever the view value should be updated. Dependent on component type ("input" for \ or "change" for \ or "change" for \