Skip to main content

Toggle

On/off switch component. Alternative to checkbox for boolean states.

Import​

import { Toggle } from '@scaffald/ui';

Basic Usage​

Live Preview
<ThemeProvider initialTheme="light">
<Toggle label="Enable notifications" />
</ThemeProvider>

Props​

See the TypeScript definitions for the complete props API.

Common Props​

All Toggle components accept standard React Native View props.

Variants​

See component props for available variants.

Examples​

Live Preview
<ThemeProvider initialTheme="light">
<Stack gap={12}>
  <Toggle label="Default toggle" />
  <Toggle label="Pre-checked" checked={true} />
  <Toggle label="Disabled" disabled />
  <Toggle label="Small size" size="sm" />
  <Toggle label="With helper" helperText="Receive email updates" />
</Stack>
</ThemeProvider>

Accessibility​

  • Keyboard navigation support
  • Screen reader compatible
  • ARIA attributes included
  • Focus management

Design Tokens​

This component uses the following design tokens:

  • Colors: colors.{semantic}.{theme}.{variant}
  • Spacing: spacing.*
  • Typography: typography.*

See Design Tokens for more information.

No related components.

Changelog​

See GitHub Releases for version history.