@gluestack-ui/switch

@gluestack-ui/switch

Installation

To use @gluestack-ui/switch, all you need to do is install the @gluestack-ui/switch package:

$ yarn add @gluestack-ui/switch

# or

$ npm i @gluestack-ui/switch

Usage

The Switch component offers a stylish alternative to the Checkbox, allowing users to enable or disable an option with a sleek sliding motion. This component is perfect for adding a touch of elegance and interactivity to your user interface. Here's an example how to use this package to create one:

import { createSwitch } from '@gluestack-ui/switch';
import { Root } from './styled-components';

export const Switch = createSwitch({
  Root,
});

Customizing the Switch:

Default styling of all these components can be found in the components/core/switch file. For reference, you can view the source code of the styled Switch components.

// import the styles
import { Root } from '../components/core/switch/styled-components';

// import the createSwitch function
import { createSwitch } from '@gluestack-ui/switch';

// Understanding the API
const Switch = createSwitch({
  Root,
});

// Using the switch component
export default () => <Switch />;

More guides on how to get started are available here.