{"_id":"@aargon-ui/switch","name":"@aargon-ui/switch","dist-tags":{"latest":"1.0.0-beta.1"},"versions":{"1.0.0-beta.1":{"name":"@aargon-ui/switch","version":"1.0.0-beta.1","description":"Animated switch component for React Native","main":"lib/index.js","types":"lib/index.d.ts","scripts":{"build":"tsc","build:watch":"tsc --watch","dev":"tsc --watch","type-check":"tsc --noEmit","lint":"eslint src --ext .ts,.tsx","clean":"rm -rf lib","release":"npm publish --otp=$OTP --access public"},"keywords":["react-native","switch","animated","ui","component"],"author":{"name":"Md Muhaiminul"},"license":"MIT","repository":{"type":"git","url":"git+https://github.com/aargon007/aargon-ui.git","directory":"packages/switch"},"homepage":"https://github.com/aargon007/aargon-ui/packages/switch#readme","bugs":{"url":"https://github.com/aargon007/aargon-ui/issues"},"peerDependencies":{"react":">=19.0.0","react-native":">=0.81.0","react-native-reanimated":">=3.0.0"},"devDependencies":{"@types/react":"~19.1.10","@types/react-native":"^0.72.8","typescript":"~5.9.2"},"_id":"@aargon-ui/switch@1.0.0-beta.1","gitHead":"92091459196e85a243093de4c3c95c8ef84026c3","_nodeVersion":"22.16.0","_npmVersion":"10.9.2","dist":{"integrity":"sha512-GkRfyNN2PHAHnrymN83GGpXRjswzFkQCp8cIk06DRL5qIjT2rpz4WGSyQk6JX/7zwG3j9etZsC9J0QgkjcqS0Q==","shasum":"6d4c4fd1e8de7c55a7ff73046c8c6578c0c3dd2f","tarball":"https://registry.npmjs.org/@aargon-ui/switch/-/switch-1.0.0-beta.1.tgz","fileCount":10,"unpackedSize":17296,"signatures":[{"keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U","sig":"MEUCIQDs0GXY/fJTv+R26aXSQxLFf2yN/lQNJjcMqG+YlJMD1gIgYsHN2CJmS7lwxnJkY+8COIw2zESomLP4ShnfOLGlWKo="}]},"_npmUser":{"name":"aargon007","email":"muhaiminul032@gmail.com"},"directories":{},"maintainers":[{"name":"aargon007","email":"muhaiminul032@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages-npm-production","tmp":"tmp/switch_1.0.0-beta.1_1759207002496_0.36020091718321945"},"_hasShrinkwrap":false}},"time":{"created":"2025-09-30T04:36:42.330Z","1.0.0-beta.1":"2025-09-30T04:36:42.680Z","modified":"2025-09-30T04:36:43.016Z"},"maintainers":[{"name":"aargon007","email":"muhaiminul032@gmail.com"}],"description":"Animated switch component for React Native","homepage":"https://github.com/aargon007/aargon-ui/packages/switch#readme","keywords":["react-native","switch","animated","ui","component"],"repository":{"type":"git","url":"git+https://github.com/aargon007/aargon-ui.git","directory":"packages/switch"},"author":{"name":"Md Muhaiminul"},"bugs":{"url":"https://github.com/aargon007/aargon-ui/issues"},"license":"MIT","readme":"# Aargon Switch\r\n\r\nA highly customizable, animated switch component for React Native with smooth animations and modern design.\r\n\r\n[![npm version](https://badge.fury.io/js/@aargon-ui/switch.svg)](https://www.npmjs.com/package/@aargon-ui/switch)\r\n[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)\r\n\r\n## Features\r\n\r\n- 🎨 **Multiple Variants** - Default, filled, and outlined styles\r\n- 📏 **Size Options** - Small, medium, and large sizes\r\n- ⚡ **Smooth Animations** - Spring, timing, and bounce animations\r\n- 🎯 **Accessibility** - Full accessibility support with proper ARIA attributes\r\n- 🎨 **Customizable Themes** - Complete theming system with colors and styling\r\n- 🔧 **Flexible API** - Easy to use with comprehensive props\r\n- 📱 **React Native** - Built specifically for React Native with Reanimated\r\n- 🌟 **TypeScript** - Full TypeScript support with comprehensive types\r\n\r\n## Installation\r\n\r\n```bash\r\nnpm install @aargon-ui/switch\r\n# or\r\nyarn add @aargon-ui/switch\r\n```\r\n\r\n### Peer Dependencies\r\n\r\nMake sure you have the required peer dependencies installed:\r\n\r\n```bash\r\nnpm install react react-native react-native-reanimated\r\n```\r\n\r\n## Quick Start\r\n\r\n```tsx\r\nimport React, { useState } from 'react';\r\nimport { View, Text } from 'react-native';\r\nimport { AnimatedSwitch } from '@aargon-ui/switch';\r\n\r\nexport default function App() {\r\n    const [enabled, setEnabled] = useState(false);\r\n\r\n    return (\r\n        <View>\r\n            <AnimatedSwitch value={enabled} onValueChange={setEnabled} />\r\n        </View>\r\n    );\r\n}\r\n```\r\n\r\n## Basic Usage\r\n\r\n### Simple Switch\r\n\r\n```tsx\r\nconst [enabled, setEnabled] = useState(false);\r\n\r\n<AnimatedSwitch value={enabled} onValueChange={setEnabled} />;\r\n```\r\n\r\n### With Label\r\n\r\n```tsx\r\n<AnimatedSwitch value={enabled} onValueChange={setEnabled} label=\"Enable notifications\" />\r\n```\r\n\r\n### Disabled Switch\r\n\r\n```tsx\r\n<AnimatedSwitch value={enabled} onValueChange={setEnabled} disabled={true} />\r\n```\r\n\r\n## Variants\r\n\r\n### Default Variant\r\n\r\n```tsx\r\n<AnimatedSwitch variant=\"default\" value={enabled} onValueChange={setEnabled} />\r\n```\r\n\r\n### Filled Variant\r\n\r\n```tsx\r\n<AnimatedSwitch variant=\"filled\" value={enabled} onValueChange={setEnabled} />\r\n```\r\n\r\n### Outlined Variant\r\n\r\n```tsx\r\n<AnimatedSwitch variant=\"outlined\" value={enabled} onValueChange={setEnabled} />\r\n```\r\n\r\n## Sizes\r\n\r\n```tsx\r\n<AnimatedSwitch size=\"sm\" value={enabled} onValueChange={setEnabled} />\r\n<AnimatedSwitch size=\"md\" value={enabled} onValueChange={setEnabled} />\r\n<AnimatedSwitch size=\"lg\" value={enabled} onValueChange={setEnabled} />\r\n```\r\n\r\n## Animation Types\r\n\r\n### Spring Animation (Default)\r\n\r\n```tsx\r\n<AnimatedSwitch animationType=\"spring\" value={enabled} onValueChange={setEnabled} />\r\n```\r\n\r\n### Timing Animation\r\n\r\n```tsx\r\n<AnimatedSwitch animationType=\"timing\" duration={500} value={enabled} onValueChange={setEnabled} />\r\n```\r\n\r\n### Bounce Animation\r\n\r\n```tsx\r\n<AnimatedSwitch animationType=\"bounce\" value={enabled} onValueChange={setEnabled} />\r\n```\r\n\r\n## Custom Styling\r\n\r\n### Custom Theme\r\n\r\n```tsx\r\nconst customTheme = {\r\n    colors: {\r\n        background: '#E5E7EB',\r\n        active: '#3B82F6',\r\n        thumb: '#FFFFFF',\r\n    },\r\n    borderRadius: 16,\r\n};\r\n\r\n<AnimatedSwitch theme={customTheme} value={enabled} onValueChange={setEnabled} />;\r\n```\r\n\r\n### With Shadow\r\n\r\n```tsx\r\n<AnimatedSwitch shadow={true} value={enabled} onValueChange={setEnabled} />\r\n```\r\n\r\n## Advanced Usage\r\n\r\n### Custom Colors\r\n\r\n```tsx\r\n<AnimatedSwitch value={enabled} onValueChange={setEnabled} activeColor=\"#10B981\" inactiveColor=\"#E5E7EB\" thumbColor=\"#FFFFFF\" />\r\n```\r\n\r\n### Custom Thumb\r\n\r\n```tsx\r\n<AnimatedSwitch value={enabled} onValueChange={setEnabled} customThumb={<Text>{enabled ? 'ON' : 'OFF'}</Text>} />\r\n```\r\n\r\n### Switch Group\r\n\r\n```tsx\r\nconst [settings, setSettings] = useState({\r\n    notifications: false,\r\n    darkMode: true,\r\n    location: false,\r\n});\r\n\r\n<View>\r\n    <AnimatedSwitch\r\n        value={settings.notifications}\r\n        onValueChange={value => setSettings(prev => ({ ...prev, notifications: value }))}\r\n        label=\"Notifications\"\r\n    />\r\n    <AnimatedSwitch\r\n        value={settings.darkMode}\r\n        onValueChange={value => setSettings(prev => ({ ...prev, darkMode: value }))}\r\n        label=\"Dark Mode\"\r\n    />\r\n    <AnimatedSwitch\r\n        value={settings.location}\r\n        onValueChange={value => setSettings(prev => ({ ...prev, location: value }))}\r\n        label=\"Location\"\r\n    />\r\n</View>;\r\n```\r\n\r\n## API Reference\r\n\r\n### Props\r\n\r\n| Prop            | Type                                  | Default     | Description                               |\r\n| --------------- | ------------------------------------- | ----------- | ----------------------------------------- |\r\n| `value`         | `boolean`                             | `false`     | Whether the switch is enabled             |\r\n| `onValueChange` | `(value: boolean) => void`            | -           | Function called when switch value changes |\r\n| `label`         | `string`                              | -           | Label text                                |\r\n| `variant`       | `\"default\" \\| \"filled\" \\| \"outlined\"` | `\"default\"` | Visual variant                            |\r\n| `size`          | `\"sm\" \\| \"md\" \\| \"lg\"`                | `\"md\"`      | Size of the switch                        |\r\n| `animationType` | `\"timing\" \\| \"spring\" \\| \"bounce\"`    | `\"spring\"`  | Type of animation                         |\r\n| `duration`      | `number`                              | `300`       | Animation duration in milliseconds        |\r\n| `activeColor`   | `string`                              | -           | Color when switch is active               |\r\n| `inactiveColor` | `string`                              | -           | Color when switch is inactive             |\r\n| `thumbColor`    | `string`                              | -           | Color of the thumb                        |\r\n| `disabled`      | `boolean`                             | `false`     | Whether the switch is disabled            |\r\n| `customThumb`   | `React.ReactNode`                     | -           | Custom thumb element                      |\r\n| `theme`         | `SwitchTheme`                         | -           | Custom theme object                       |\r\n| `shadow`        | `boolean`                             | `false`     | Whether to show shadow effect             |\r\n\r\n### Types\r\n\r\n```tsx\r\ninterface SwitchTheme {\r\n    colors: {\r\n        background: string;\r\n        active: string;\r\n        inactive: string;\r\n        thumb: string;\r\n        shadow: string;\r\n    };\r\n    borderRadius: number;\r\n    fontFamily?: string;\r\n}\r\n\r\ntype SwitchVariant = 'default' | 'filled' | 'outlined';\r\ntype SwitchSize = 'sm' | 'md' | 'lg';\r\ntype AnimationType = 'timing' | 'spring' | 'bounce';\r\n```\r\n\r\n## Accessibility\r\n\r\nThe switch component includes full accessibility support:\r\n\r\n- **ARIA attributes** - Proper `role=\"switch\"` and `aria-checked` attributes\r\n- **Keyboard navigation** - Supports keyboard interaction\r\n- **Screen reader support** - Announces state changes to screen readers\r\n- **Focus management** - Proper focus handling for keyboard users\r\n\r\n## Requirements\r\n\r\n- React Native 0.81.0+\r\n- React 19.0.0+\r\n- react-native-reanimated 3.0.0+\r\n\r\n## Contributing\r\n\r\nContributions are welcome! Please feel free to submit a Pull Request.\r\n\r\n## License\r\n\r\nThis project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.\r\n\r\n## Support\r\n\r\nIf you have any questions or need help, please:\r\n\r\n1. Check the [documentation](https://github.com/aargon007/aargon-ui#readme)\r\n2. Search [existing issues](https://github.com/aargon007/aargon-ui/issues)\r\n3. Create a [new issue](https://github.com/aargon007/aargon-ui/issues/new)\r\n\r\n## Changelog\r\n\r\nSee [CHANGELOG.md](CHANGELOG.md) for a list of changes and version history.\r\n\r\n---\r\n\r\nMade with ❤️ by [Aargon](https://github.com/aargon007)\r\n","readmeFilename":"README.md","_rev":"1-a7be0a9531e6accfc71eb55b22d54c7b"}