Concepts
OverviewCompositionTestingLayout
Aspect RatioBleedBoxCenterContainerDividerFlexFloatGridLink OverlayScrollableStackWrapComponents
AccordionAdmonitionAvatarButtonCheckboxComboboxConfirm ModalCTAModalDate PickerDialogFieldFieldsetFile UploaderIcon ButtonInputLoading StatesMenuNotificationsProgressPrompt ModalRadioRatingSelectSwitchTableTabsTagTextTextareaToggleTooltipUtilities
Feature FlagsForLocal StoragePortalShowsplitPropsThemeThe Toggle
component is a two-state button that allows users to toggle between states via an action.
1import { ToggleParts } from '@cerberus/react'
Usage
The Toggle component is unstyled to fit any scenario you may need.
Primitives
You can utilize the primitive components or the css
prop to customize the toggle.
Component | Description |
---|---|
ToggleRoot | The context provider for the Toggle parts |
ToggleIndicator | The indicator shown based on the toggle state |
API
Parts
The ToggleParts
API is an Object containing the full family of components.
Name | Description |
---|---|
Root | The ToggleRoot component which is the Provider for the family. |
Indicator | The ToggleIndicator component which displays based on the pressed state. |
On this page