BbSwitch

Sets autofocus on page load.

Defines the input as checked.

Paints the control from state you own elsewhere and wins over modelValue until you unset it — so it is display-driven or bound, never both. Narrowed to a plain boolean in v3: the v2 checked="false" no longer compiles, where it used to turn the switch on.

Descriptive text displayed below the label and above the input. Unlike the hint it is always visible, and it is linked to the input via aria-describedby (after any errors / warnings, before the hint).

Always visible and tied to the control through aria-describedby. On a settings row it is where the consequence of flipping the switch belongs.

Direction of the layout of the component. Can either be a predefined value or a pattern separated by a space like xx xxxxx.

Disables the component.

Can be a string or an array of string containing the messages to display. They render in an aria-live="polite" region (announced when they appear) and, while the list is non-empty, are referenced FIRST from the control's aria-describedby, so the reason the field is invalid is re-read whenever the control regains focus.

Value of the input when unchecked. It handles any kind of serializable object.

Define if the component should be in an error state. It usually attaches a CSS class for styling purposes.

Define if the component should be in a warning state. Same chrome as errors with --bb-warn; errors take priority.

Visually hides the label of the input while maintaining accessibility.

Text box to be displayed near the input, usually to indicate instructions.

The identifier of the component.

Sets the input in an indeterminate state.

Parks the thumb midway, for a master switch whose children disagree. Visual only — the model keeps its value, and the component re-asserts the state after clicks because the DOM resets it natively.

Sets the alignment of the input. Since inputs are inline block they can be aligned just as text can.

Text content of the label of the element.

Required — it is the accessible name of the switch. Do not add ARIA of your own: the control already exposes role="switch" and its state.

Sets the text alignment of the label.

Used by v-model. Can be any serializable type.

Defines the name of the input.

Keeps the hint displayed.

Passthrough, object form: the same keys as the pt:* attributes without the prefix. See the pt:<part> row.

Sets the input in a readonly state.

The right state for a switch whose change is in flight, and for admin-locked settings. It sets no native disabled attribute, so do not target :disabled in CSS or tests — .bb-base-switch--readonly is the hook.

Sets the input as required.

Reverses the layout: in every direction the order of the label and the input is swapped from the standard arrangement.

Its meaning inverted in v3 and the compiler cannot see it. The default rendering is unchanged, but a v2 :reverse="false" becomes a bare reverse — which is the label-first settings row, so most switches that set it are affected.

Will submit "falseValue" if the input is not checked. Otherwise "trueValue" will be submitted.

Only for classic form posts: an unchecked switch otherwise submits nothing. The full value contract is shared with BbCheckbox.

Value of the input when checked. It handles any kind of serializable object.

Point it and false-value at the two members of an enum and the model stops needing a translation layer on either side of the request.

Warning messages to display beneath the field, in their own aria-live region and amber (--bb-text-warn). A string or array; a non-empty list implies the warning state. Errors suppress warnings when both are set. While displayed they are also referenced from the control's aria-describedby, after any errors and before the description/hint.

Carries the mapped true-value / false-value. Use :model-value with @update:model-value instead of v-model when a failed save has to put the previous value back.

The hook for a live switch that saves itself: write optimistically here, hold the control readonly while the request is in flight, and restore the previous value on failure.

Replaces the description text. Provided alone (no description prop) it still renders the description region and wires it into aria-describedby.

Replaces the default toggle track visual inside the switch. Receives the switch state plus the label text.

Replaces the entire track and thumb, not a glyph inside them — a bare icon here leaves no track at all. Keep it when only the visual is wrong; when the whole row is wrong, drop to BbBaseSwitchIcon.

Replaces the default label text rendered next to the switch.