TriStateToggle

API reference and demos for TriStateToggle.

Source

Import

import { TriStateToggle } from "@flanksource/clicky-ui/components";

Demos

No dedicated Storybook demo is available for this component yet.

The props table documents the component-specific surface. Standard DOM attributes inherited from React, such as className, event handlers, and accessibility attributes, may also be accepted when the component’s prop type extends a native element.

Props

Prop	Type	Default	Description
className	string	—	—
disabled	boolean	—	—
id	string	—	DOM id of the toggle button, so an external `<label htmlFor>` can target it.
label*	string	—	Accessible name — the field this toggle stands for.
labels	TriStateLabels	—	Per-state wording used in the tooltip and accessible description.
onChange*	(…) => void	—	Receives the next state in the unset → on → off → unset cycle.
size	enum	sm	—
value*	TriState	—	Controlled value: true, false, or undefined for unset.