{"_id":"@aargon-ui/skeleton","name":"@aargon-ui/skeleton","dist-tags":{"latest":"1.0.0-beta.1"},"versions":{"1.0.0-beta.1":{"name":"@aargon-ui/skeleton","version":"1.0.0-beta.1","description":"Animated skeleton 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","publish":"npm publish"},"keywords":["react-native","skeleton","animated","ui","component"],"author":{"name":"Md Muhaiminul"},"license":"MIT","repository":{"type":"git","url":"git+https://github.com/aargon007/aargon-ui.git","directory":"packages/skeleton"},"homepage":"https://github.com/aargon007/aargon-ui/packages/skeleton#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/skeleton@1.0.0-beta.1","gitHead":"92091459196e85a243093de4c3c95c8ef84026c3","_nodeVersion":"22.16.0","_npmVersion":"10.9.2","dist":{"integrity":"sha512-2v/sNIZyak2VGKPeR2c+3+9tOhc7/r8uGT4/XxUKUE3RbWueplxOuVteQDdWFtVjlNcrn9G7r4LzB+V1zVEQ4g==","shasum":"6b7551d3aec12276a1491988386741177c7c718a","tarball":"https://registry.npmjs.org/@aargon-ui/skeleton/-/skeleton-1.0.0-beta.1.tgz","fileCount":10,"unpackedSize":28855,"signatures":[{"keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U","sig":"MEQCIAd/K8vjwP0lLVFbaFLhXVcnBQ9GG971Z7PbRboMx1IDAiArg9mho/CH/dOwfZCqMZvOVhRpkSaU2VpePJJW1JY/qA=="}]},"_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/skeleton_1.0.0-beta.1_1759206907430_0.46668109919376044"},"_hasShrinkwrap":false}},"time":{"created":"2025-09-30T04:35:07.362Z","1.0.0-beta.1":"2025-09-30T04:35:07.659Z","modified":"2025-09-30T04:35:07.911Z"},"maintainers":[{"name":"aargon007","email":"muhaiminul032@gmail.com"}],"description":"Animated skeleton component for React Native","homepage":"https://github.com/aargon007/aargon-ui/packages/skeleton#readme","keywords":["react-native","skeleton","animated","ui","component"],"repository":{"type":"git","url":"git+https://github.com/aargon007/aargon-ui.git","directory":"packages/skeleton"},"author":{"name":"Md Muhaiminul"},"bugs":{"url":"https://github.com/aargon007/aargon-ui/issues"},"license":"MIT","readme":"# Aargon Skeleton\r\n\r\nA highly customizable, animated skeleton loading component for React Native with smooth animations and modern design.\r\n\r\n[](https://www.npmjs.com/package/@aargon-ui/skeleton)\r\n[](https://opensource.org/licenses/MIT)\r\n\r\n## Features\r\n\r\n- 🎨 **Multiple Variants** - Text, rectangular, circular, and custom shapes\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/skeleton\r\n# or\r\nyarn add @aargon-ui/skeleton\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 from 'react';\r\nimport { View } from 'react-native';\r\nimport { AnimatedSkeleton } from '@aargon-ui/skeleton';\r\n\r\nexport default function App() {\r\n return (\r\n \r\n \r\n \r\n );\r\n}\r\n```\r\n\r\n## Basic Usage\r\n\r\n### Text Skeleton\r\n\r\n```tsx\r\n\r\n```\r\n\r\n### Rectangular Skeleton\r\n\r\n```tsx\r\n\r\n```\r\n\r\n### Circular Skeleton\r\n\r\n```tsx\r\n\r\n```\r\n\r\n### Custom Skeleton\r\n\r\n```tsx\r\n\r\n \r\n\r\n```\r\n\r\n## Variants\r\n\r\n### Text Variant\r\n\r\n```tsx\r\n\r\n```\r\n\r\n### Rectangular Variant\r\n\r\n```tsx\r\n\r\n```\r\n\r\n### Circular Variant\r\n\r\n```tsx\r\n\r\n```\r\n\r\n### Custom Variant\r\n\r\n```tsx\r\n\r\n \r\n\r\n```\r\n\r\n## Sizes\r\n\r\n```tsx\r\n\r\n\r\n\r\n```\r\n\r\n## Animation Types\r\n\r\n### Spring Animation (Default)\r\n\r\n```tsx\r\n\r\n```\r\n\r\n### Timing Animation\r\n\r\n```tsx\r\n\r\n```\r\n\r\n### Bounce Animation\r\n\r\n```tsx\r\n\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 highlight: '#F3F4F6',\r\n },\r\n borderRadius: 4,\r\n};\r\n\r\n;\r\n```\r\n\r\n### With Shadow\r\n\r\n```tsx\r\n\r\n```\r\n\r\n## Advanced Usage\r\n\r\n### Multiple Lines\r\n\r\n```tsx\r\n\r\n \r\n \r\n \r\n\r\n```\r\n\r\n### Card Skeleton\r\n\r\n```tsx\r\n\r\n \r\n \r\n \r\n\r\n```\r\n\r\n### Disabled State\r\n\r\n```tsx\r\n\r\n```\r\n\r\n### Custom Animation\r\n\r\n```tsx\r\n\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| `variant` | `\"text\" \\| \"rect\" \\| \"circle\" \\| \"custom\"` | `\"text\"` | Visual variant |\r\n| `size` | `\"sm\" \\| \"md\" \\| \"lg\"` | `\"md\"` | Size of the skeleton |\r\n| `width` | `number \\| string` | - | Width of the skeleton |\r\n| `height` | `number \\| string` | - | Height of the skeleton |\r\n| `animationType` | `\"timing\" \\| \"spring\" \\| \"bounce\"` | `\"spring\"` | Type of animation |\r\n| `duration` | `number` | `300` | Animation duration in milliseconds |\r\n| `disabled` | `boolean` | `false` | Whether the skeleton is disabled |\r\n| `theme` | `SkeletonTheme` | - | Custom theme object |\r\n| `shadow` | `boolean` | `false` | Whether to show shadow effect |\r\n| `children` | `React.ReactNode` | - | Custom content (for custom variant) |\r\n\r\n### Types\r\n\r\n```tsx\r\ninterface SkeletonTheme {\r\n colors: {\r\n background: string;\r\n highlight: string;\r\n shadow: string;\r\n };\r\n borderRadius: number;\r\n fontFamily?: string;\r\n}\r\n\r\ntype SkeletonVariant = 'text' | 'rect' | 'circle' | 'custom';\r\ntype SkeletonSize = 'sm' | 'md' | 'lg';\r\ntype AnimationType = 'timing' | 'spring' | 'bounce';\r\n```\r\n\r\n## Accessibility\r\n\r\nThe skeleton component includes full accessibility support:\r\n\r\n- **ARIA attributes** - Proper `role=\"progressbar\"` and `aria-label` attributes\r\n- **Screen reader support** - Announces loading state to screen readers\r\n- **High contrast support** - Works well with system accessibility settings\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-ee38dd0dad6339cde5b406f6cd5e4dca"}