ICheckboxBtnSlots

interface
Form & Input

Slot signatures for <OrigamCheckboxBtn>. Extends ICommonsComponentSlots with a label slot and an input slot that exposes the underlying props, icon and color state for full customisation.

TypeScript

Definition

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

typescript

Inheritance

Extends

Parent interfaces this one inherits from. Their properties are available on every consumer of this interface.

API

Properties

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

label
() => any
Replaces the default label text. Use for rich label content (links, icons, formatted text).
input
(data: { props: any, icon?: TIcon, textColorStyles?: TColor, backgroundColorStyles?: TColor, model: any }) => any
Replaces the entire checkbox visual (box + icon). Receives props, the resolved icon, text/background color style maps, and the current model value.

Ecosystem

Used by

Components and composables that extend or consume this interface.

Usage

Examples

Ready-to-paste code snippets using this interface.

Custom label slot with a link

vue