Toggle

A button with a pressed state.

Preparing the playground…

Text and Markdown example

Toggle · Example

1<Toggle aria-label="Bold" variant="outline">B</Toggle>

Read documentation in Markdown

How to use it

Use pressed and onPressedChange for formatting tools or preferences. Text or aria-label must explain the action.

Import

React / Next.js

1import { Toggle } from "@kivora/nextjs";

Interactive examples run inside a component with "use client". The playground's Copy button includes the imports needed for the current example.

API reference 0.2.0

Types from the installed published version, including component properties and common HTML attributes. “Optional” does not imply a default value; omitting a property lets the component decide.

Property	Type	Description
`aria-label`	`string`	Accessible name of the control.
`asChild`	`boolean`	Apply props and behavior to a single compatible child element.
`children`	`ReactNode \| ((pressed: boolean) => ReactNode)`	Content or child elements of the component.
`className`	`string`	Additional CSS classes to customize the element.
`defaultChecked`	`boolean`	Initial selection of the control.
`defaultPressed`	`boolean`	Initial pressed state.
`defaultValue`	`string \| number \| readonly string[]`	Initial value when the component manages its own state.
`disabled`	`boolean`	Disable interaction with the control.
`id`	`string`	Element identifier; associates labels and descriptions.
`name`	`string`	Name used to identify the control in forms.
`onChange`	`ChangeEventHandler<HTMLButtonElement, Element>`	Change event. Check the type: some controls return an object, others a DOM event.
`onClick`	`MouseEventHandler<HTMLButtonElement>`	Action performed when the element is activated.
`onPressedChange`	`((pressed: boolean) => void)`	Receives pressed-state changes.
`onSubmit`	`SubmitEventHandler<HTMLButtonElement>`	Form submission event.
`pressed`	`boolean`	Controlled pressed state.
`role`	`AriaRole`	Semantic role of the element. Keep the default role unless a change is justified.
`size`	`"default" \| "sm" \| "lg" \| "icon" \| null`	Visual size of the component.
`style`	`CSSProperties`	React inline styles.
`tabIndex`	`number`	Keyboard focus order and availability.
`title`	`string`	Title or supplementary information.
`type`	`"button" \| "submit" \| "reset"`	Operation type or mode; values depend on the component.
`value`	`string \| number \| readonly string[]`	Controlled value. Update it from the change callback.
`variant`	`"default" \| "outline" \| "ghost" \| null`	Visual variant. Use a value supported by this component.

TypeScript definition

Review each component's properties and published declaration. Native and accessibility attributes are inherited from the element specified by its type.

Toggle23 properties

Toggle · TypeScript

1Toggle: React.ForwardRefExoticComponent<ToggleProps & React.RefAttributes<HTMLButtonElement>>

API generated from @kivora/nextjs 0.2.0View package