Toggle

Actions

Represents an action or option that stays pressed until it is toggled again.

React · copy into your project · light and dark themes

Try it

Variant

Unpinned

Loading preview…

Take it with you

Copy the example, API and usage notes for your editor or AI assistant.

Add to your project

Terminal

npx shadcn@latest add https://luv-jeri.github.io/cojeev-ui/r/toggle.json

The command includes the component’s shared dependencies. Your project keeps editable source files.

Include the complete example

This example also composes icon, typography. Install its parts together:

Terminal

npx shadcn@latest add https://luv-jeri.github.io/cojeev-ui/r/toggle.json https://luv-jeri.github.io/cojeev-ui/r/icon.json https://luv-jeri.github.io/cojeev-ui/r/typography.json

Using toggle

Use pressed and onPressedChange for controlled state or defaultPressed for a local default.
Use a stable action label for formatting or view options that can be enabled independently.

API

Compose the exported parts below. The prop types are read from the React source during the registry build.

Native element or underlying primitive props are inherited where declared, including accessible labels, event handlers and refs.

ToggleProps

Prop	Type	Required
`variant`	`"circle" \| "default" \| "pink" \| "pressed" \| null \| undefined`	No

ToggleWellProps

Accepts the native or primitive props declared by its exported TypeScript type.

Accessibility

Keep the accessible name stable so aria-pressed communicates the changing state; name icon-only toggles explicitly.

States and appearance

onresthoverfocusactivedisabled

For conditional content, keep a MotionPresence boundary around keyed MotionSurface children. The shared entrance and exit states work with native primitives and respect your motion preference.

Try pointer and keyboard interaction, and switch the appearance control in the navigation to compare light and dark mode. Motion respects reduced motion preferences.