You are viewing Pre-Alpha documentation. See the roadmap for updates.

Theme

Mode

Palettes

Accessibility

Button API

API reference for the Button components.

Button.Root

Props

disabled

boolean

Disables the button — fully non-interactive, removed from tab order

Default: false

readonly

boolean

Non-clickable but looks normal, remains focusable/hoverable

passive

boolean

Non-clickable, looks disabled via [data-passive], remains focusable/hoverable

Default: false

loading

boolean

Triggers loading state with grace period before visual indicator

Default: false

grace

number

Duration in ms before loading UI appears (0 to show immediately)

Default: 0

value

V

Value for use inside Button.Group

namespace

string

Namespace for context provision to children

Default: "v0:button:root"

groupNamespace

string

Namespace for connecting to parent Button.Group

Default: "v0:button:group"

name

string

Form field name — auto-renders HiddenInput when set

form

string

Associate with form by ID

ariaLabel

string

Accessible label for the button

Slots

default

ButtonRootSlotProps

Button.Content

Props

id

ID

Unique identifier for ticket registration

Default: useId()

namespace

string

Namespace for context injection from parent Button.Root

Default: "v0:button:root"

Slots

default

ButtonContentSlotProps

Button.Group

Props

namespace

string

Namespace for dependency injection

Default: "v0:button:group"

disabled

boolean

Disables the entire button group

Default: false

multiple

boolean

Single (default) or multi-select

Default: false

mandatory

boolean | "force"

Controls mandatory selection behavior: - false (default): No mandatory enforcement - true: Prevents deselecting the last selected item - `force`: Automatically selects the first non-disabled item on registration

Default: false

label

string

Accessible name for the group

ariaLabelledby

string

ID of element that labels this group

ariaDescribedby

string

ID of element that describes this group

modelValue

T | T[]

Events

update:model-value

[value: T | T[]]

Slots

default

ButtonGroupSlotProps

Button.HiddenInput

Props

value

string

Submitted value (defaults to 'on')

name

string

Form field name

namespace

string

Namespace for context injection from parent Button.Root

Default: "v0:button:root"

form

string

Associate with form by ID

Button.Icon

Props

namespace

string

Namespace for context injection from parent Button.Root

Default: "v0:button:root"

Slots

default

ButtonIconSlotProps

Button.Loading

Props

id

ID

Unique identifier for ticket registration

Default: useId()

namespace

string

Namespace for context injection from parent Button.Root

Default: "v0:button:root"

Slots

default

ButtonLoadingSlotProps

Was this page helpful?