ICheckboxSlots

interface
Form & Input

Slot signatures for <OrigamCheckbox>. Provides a default slot for full layout control, a label slot for rich label content, and an input slot for replacing the checkbox visual itself.

TypeScript

Definition

The TypeScript interface definition as found in the origam source. Click the copy icon to copy the snippet.

typescript

API

Properties

Every property declared by this interface, with its type, optionality and default.

default
(data?: { id?: string, messagesId?: string, isDisabled?: boolean, isReadonly?: boolean, isValid?: boolean }) => any
Full layout override. Receives the generated ids and derived boolean state flags.
label
() => any
Replaces the label text. Use for rich content (links, icons, formatted text).
input
(data: { props: any, icon?: TIcon, textColorStyles?: TColor, backgroundColorStyles?: TColor, model: any }) => any
Replaces the checkbox visual (box + icon). Receives the resolved props, icon, color style maps, and the current model.

Ecosystem

Used by

Components and composables that extend or consume this interface.

Usage

Examples

Ready-to-paste code snippets using this interface.

Default slot for a completely custom layout

vue