Get Started
Components
Dev Tools
More Guides
Switch
A Switch component is a UI element that allows users to toggle between two states, typically representing an on/off or enabled/disabled choice. It is visually represented as a sliding toggle or checkbox and provides immediate feedback when the user interacts with it. Switch components are commonly used for settings, preferences, and feature activations in applications, enhancing user experience by simplifying the selection process.
# Demo
# Attributes
Name | Type | Default | Details |
---|---|---|---|
className | string | ' ' | You can customise by passing tailwind classes. |
labelClassName | string | ' ' | You can customise by passing tailwind classes. |
switchClassName | string | ' ' | You can customise by passing tailwind classes. |
label | string | ' ' | You can pass label to switch. |
enabled | boolean | false | You can pass enabled to switch. |
disabled | boolean | false | You can pass disabled to switch. |
onChange | (enabled: boolean) => void | Required | You can get callback when switch changed. |
# Usage
import { useState } from 'react';
import { NSwitch } from 'nayan';
const Switch = () => {
const [enabled, setEnabled] = useState(false);
return <NSwitch label="Is Dark Mode" enabled={enabled} onChange={setEnabled} />;
};
export default Switch;
# Tags