Skip to main content

Toggle

Example

import { Bold } from "lucide-react"

import { Toggle } from "@databricks/appkit-ui/react"

export default function ToggleExample() {
return (
<Toggle aria-label="Toggle bold">
<Bold className="h-4 w-4" />
</Toggle>
)
}

Toggle

Source: packages/appkit-ui/src/react/ui/toggle.tsx

Props

PropTypeRequiredDefaultDescription
pressedboolean-The controlled state of the toggle.
defaultPressedboolean-The state of the toggle when initially rendered. Use defaultPressed if you do not need to control the state of the toggle. @defaultValue false
onPressedChange((pressed: boolean) => void)-The callback that fires when the state of the toggle changes.
asChildboolean--
variant"default" | "outline" | null--
size"default" | "sm" | "lg" | null--

Usage

import { Toggle } from '@databricks/appkit-ui';

<Toggle /* props */ />