\n A comprehensive icon library designed for modern web applications, featuring 880 beautifully crafted icons across multiple styles.\n
\n\n
\n \n \n \n
\n\n## ✨ Features\n\n- **900+ Total Icons** - Comprehensive collection for all your UI needs\n- **5 Distinct Styles** - Linear, Bold, Duotone, Brand, and 3D icons\n- **288 Unique Icons** - Each available in multiple styles\n- **32 3D Icons** - Modern three-dimensional style icons\n- **18 Brand Icons** - Popular company and service logos\n- **Framework Support** - Official React and Vue packages\n- **TypeScript Support** - Fully typed for better developer experience\n- **Tree Shakeable** - Import only the icons you need\n- **Customizable** - Easy to style with CSS or utility classes\n- **Accessible** - Built with accessibility in mind\n\n## 📦 Installation\n\n### React\n\n```bash\nnpm install @astraicons/react\n# or\nyarn add @astraicons/react\n# or\npnpm add @astraicons/react\n```\n\n### Vue\n\n```bash\nnpm install @astraicons/vue\n# or\nyarn add @astraicons/vue\n# or\npnpm add @astraicons/vue\n```\n\n## 🚀 Quick Start\n\n### React\n\n```jsx\nimport { HomeIcon } from '@astraicons/react/linear';\nimport { HeartIcon } from '@astraicons/react/bold';\nimport { StarIcon } from '@astraicons/react/duotone';\nimport { AppleIcon } from '@astraicons/react/brand';\nimport { CubeIcon } from '@astraicons/react/3d';\n\nfunction MyComponent() {\n return (\n
\n \n \n \n \n \n
\n );\n}\n```\n\n### Vue\n\n```vue\n\n
\n \n \n \n \n \n
\n\n\n\n```\n\n### Direct SVG Usage\n\nCopy the SVG source from [uiastra.com](https://uiastra.com) and embed it directly into your HTML:\n\n```html\n\n \n \n \n \n \n \n\n```\n\n## 🎨 Icon Styles\n\n### Linear\n\nOutline style icons with consistent 1.5px stroke width. Perfect for modern, minimalist interfaces.\n\n```jsx\nimport { ActivityIcon, BellIcon, CameraIcon } from '@astraicons/react/linear';\n```\n\n### Bold\n\nFilled or bold stroke icons for emphasis and better visibility at smaller sizes.\n\n```jsx\nimport { ActivityIcon, BellIcon, CameraIcon } from '@astraicons/react/bold';\n```\n\n### Duotone\n\nTwo-tone icons that combine filled and outline styles for depth and visual interest.\n\n```jsx\nimport { ActivityIcon, BellIcon, CameraIcon } from '@astraicons/react/duotone';\n```\n\n### Brand\n\nCompany and service logos including social media platforms and popular brands.\n\n```jsx\nimport { AppleIcon, GoogleIcon, TwitterIcon } from '@astraicons/react/brand';\n```\n\n### 3D\n\nModern three-dimensional style icons with depth and perspective for contemporary interfaces.\n\n```jsx\nimport { CubeIcon, FolderIcon, BoxIcon } from '@astraicons/react/3d';\n```\n\n## 📋 Icon Naming Convention\n\nIcons follow a consistent naming pattern:\n\n- Upper camel case (PascalCase)\n- Always end with `Icon` suffix\n- Descriptive names for easy discovery\n\nExamples:\n\n- `HomeIcon`\n- `ShoppingCartIcon`\n- `ArrowRightIcon`\n- `UserProfileIcon`\n\n## 🔧 Customization\n\n### Using Tailwind CSS\n\n```jsx\n\n```\n\n### Using Inline Styles\n\n```jsx\n\n```\n\n### Using CSS\n\n```css\n.custom-icon {\n width: 2rem;\n height: 2rem;\n color: #3B82F6;\n}\n```\n\n```jsx\n\n```\n\n## 📚 Documentation\n\n- [Full Icon List](./ICON_LIST.md) - Complete alphabetical list of all 877 icons\n- [Icons by Category](./ICON_CATEGORIES.md) - Icons organized by functional groups\n- [Browse React Icons](https://unpkg.com/browse/@astraicons/react/) - View all React icons on UNPKG\n- [Browse Vue Icons](https://unpkg.com/browse/@astraicons/vue/) - View all Vue icons on UNPKG\n- [Interactive Gallery](https://uiastra.com) - Search and preview all icons\n\n## 🌐 Browser Support\n\n- Chrome (latest)\n- Firefox (latest)\n- Safari (latest)\n- Edge (latest)\n- Opera (latest)\n\n## 📦 Package Details\n\n### React Package\n- **Package**: `@astraicons/react`\n- **Version**: 1.0.1\n- **Size**: ~14MB unpacked\n- **Files**: 3,524 (JS + TypeScript definitions)\n- **Tree-shakeable**: ✅\n- **TypeScript**: ✅\n- **Peer Dependencies**: React >= 16\n\n### Vue Package\n- **Package**: `@astraicons/vue`\n- **Version**: 1.0.1\n- **Size**: ~14MB unpacked\n- **Files**: 3,524 (JS + TypeScript definitions)\n- **Tree-shakeable**: ✅\n- **TypeScript**: ✅\n- **Peer Dependencies**: Vue >= 3\n\n## 🤝 Contributing\n\nWe welcome contributions to improve the library! However, please note:\n\n- ✅ **Bug fixes** - Report or fix issues with existing icons\n- ✅ **TypeScript improvements** - Enhance type definitions\n- ✅ **Documentation** - Improve guides and examples\n- ✅ **Performance** - Optimize build process or package size\n- ❌ **New icons** - We're not accepting new icon contributions at this time\n\n### Development Setup\n\n```bash\n# Clone the repository\ngit clone https://github.com/uiastra/astraicons.git\ncd astraicons\n\n# Install dependencies\nnpm install\n\n# Build all packages\nnpm run build\n\n# Build specific style\nnpm run build-linear\nnpm run build-bold\nnpm run build-duotone\nnpm run build-brand\nnpm run build-3d\n```\n\n## 🙏 Credits\n\n- Icon design and curation by [UI Astra](https://uiastra.com)\n- Build system inspired by [Heroicons](https://github.com/tailwindlabs/heroicons)\n- Created with ❤️ for the developer community\n\n## 📄 License\n\nThis library is MIT licensed. See [LICENSE](./LICENSE) for details.\n\n---\n\n
![\"AstraIcons\"](\"https://raw.githubusercontent.com/uiastra/astraicons/HEAD/.github/light.jpg\")
\n ![\"npm](\"https://img.shields.io/npm/v/@astraicons/react?label=@astraicons/react&color=blue\")
![\"npm](\"https://img.shields.io/npm/v/@astraicons/vue?label=@astraicons/vue&color=green\")
![\"License\"](\"https://img.shields.io/badge/license-MIT-blue.svg\"){kind=icon}
\n