glintly-ui 1.0.0 → 1.0.2

package/README.md

@@ -1,93 +1,715 @@
-# aero_ui_lib
+# Glintly UI Library
+
+[![npm version](https://badge.fury.io/js/glintly-ui.svg)](https://badge.fury.io/js/glintly-ui)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+[![TypeScript](https://img.shields.io/badge/TypeScript-5.8-blue.svg)](https://www.typescriptlang.org/)
+[![React](https://img.shields.io/badge/React-18+-blue.svg)](https://reactjs.org/)
+[![styled-components](https://img.shields.io/badge/styled--components-6.1-blue.svg)](https://styled-components.com/)
+
+A modern, accessible, and customizable React UI component library built with TypeScript and styled-components. Glintly UI provides a comprehensive set of components designed for building beautiful, responsive web applications with a consistent design system.
+
+## ✨ Features
+
+- **🎨 Modern Design System**: Built with a comprehensive theme system supporting light/dark modes
+- **🔧 TypeScript First**: Full TypeScript support with excellent type definitions
+- **🎭 Styled Components**: Built with styled-components for flexible styling
+- **📱 Responsive**: Mobile-first design approach with responsive breakpoints
+- **♿ Accessible**: WCAG compliant components with proper ARIA attributes
+- **🎯 Customizable**: Extensive theming and customization options
+- **📦 Tree Shakeable**: Optimized bundle size with tree shaking support
+- **🚀 Performance**: Optimized components with minimal re-renders
+
+## 🚀 Installation
+
+```bash
+npm install glintly-ui
+# or
+yarn add glintly-ui
+# or
+pnpm add glintly-ui
+```
+
+## 📦 Peer Dependencies
+
+```json
+{
+  "react": ">=18.0.0",
+  "react-dom": ">=18.0.0"
+}
+```
+
+## 🎯 Quick Start
+
+```tsx
+import React from 'react';
+import { ThemeProvider, Button, Input, Card } from 'glintly-ui';
+
+function App() {
+  return (
+    <ThemeProvider>
+      <div>
+        <Card>
+          <h2>Welcome to Glintly UI</h2>
+          <Input placeholder="Enter your name" />
+          <Button variant="primary">Get Started</Button>
+        </Card>
+      </div>
+    </ThemeProvider>
+  );
+}
+```
+
+## 🎨 Theme System
+
+Glintly UI comes with a powerful theme system that allows you to customize colors, typography, spacing, and more.
+
+```tsx
+import { ThemeProvider, useTheme } from 'glintly-ui';
+
+const customTheme = {
+  colors: {
+    primary: {
+      500: '#6366f1',
+      600: '#4f46e5',
+    },
+    // ... more custom colors
+  },
+  typography: {
+    fontFamily: '"Inter", sans-serif',
+  },
+};
+
+function App() {
+  return (
+    <ThemeProvider theme={customTheme}>
+      <YourApp />
+    </ThemeProvider>
+  );
+}
+
+function ThemedComponent() {
+  const { theme, mode, toggleMode } = useTheme();
+  
+  return (
+    <div>
+      <button onClick={toggleMode}>
+        Current mode: {mode}
+      </button>
+    </div>
+  );
+}
+```
+
+## 🧩 Components
+
+### 🎯 Core Components
+
+#### Button
+Versatile button component with multiple variants, sizes, and states.
+
+```tsx
+import { Button } from 'glintly-ui';
+
+<Button variant="primary" size="lg" shade="500">
+  Click Me
+</Button>
+
+<Button variant="secondary" size="sm" disabled>
+  Disabled Button
+</Button>
+```
+
+**Variants**: `primary`, `secondary`, `gray`, `transparent`  
+**Sizes**: `xs`, `sm`, `md`, `lg`, `xl`  
+**Shades**: `50`, `100`, `200`, `300`, `400`, `500`, `600`, `700`, `800`, `900`
+
+#### Input
+Comprehensive input components with validation and styling.
+
+```tsx
+import { Input } from 'glintly-ui';
+
+<Input.TextInput 
+  placeholder="Enter text" 
+  size="md" 
+  hasError={false}
+/>
+
+<Input.PasswordInput 
+  placeholder="Enter password" 
+  showToggle={true}
+/>
+
+<Input.SelectInput 
+  options={[
+    { value: '1', label: 'Option 1' },
+    { value: '2', label: 'Option 2' }
+  ]}
+/>
+```
+
+**Types**: `TextInput`, `PasswordInput`, `SelectInput`, `CheckboxInput`, `RadioInput`, `DateInput`, `TimeInput`, `PhoneInput`, `FileInput`  
+**Sizes**: `xs`, `sm`, `md`, `lg`
+
+#### Card
+Flexible card component for content organization.
+
+```tsx
+import { Card } from 'glintly-ui';
+
+<Card>
+  <h3>Card Title</h3>
+  <p>Card content goes here</p>
+</Card>
+```
+
+### 📊 Data Display
+
+#### DataTable
+Advanced data table with sorting, pagination, and selection.
+
+```tsx
+import { DataTable } from 'glintly-ui';
+
+const columns = [
+  { key: 'name', label: 'Name', sortable: true },
+  { key: 'email', label: 'Email' },
+  { key: 'role', label: 'Role' }
+];
+
+const data = [
+  { id: 1, name: 'John Doe', email: 'john@example.com', role: 'Admin' }
+];
+
+<DataTable
+  data={data}
+  columns={columns}
+  pagination={{
+    currentPage: 1,
+    totalPages: 10,
+    onPageChange: (page) => console.log(page)
+  }}
+  checkboxSelection={true}
+/>
+```
+
+#### Table
+Simple table component for basic data display.
+
+```tsx
+import { Table, TableHead, TableBody, TableRow, TableCell } from 'glintly-ui';
+
+<Table>
+  <TableHead>
+    <TableRow>
+      <TableCell>Name</TableCell>
+      <TableCell>Email</TableCell>
+    </TableRow>
+  </TableHead>
+  <TableBody>
+    <TableRow>
+      <TableCell>John Doe</TableCell>
+      <TableCell>john@example.com</TableCell>
+    </TableRow>
+  </TableBody>
+</Table>
+```
+
+### 🎨 Layout & Navigation
+
+#### Grid
+Flexbox-based grid system for responsive layouts.
+
+```tsx
+import { Row, Col } from 'glintly-ui';
+
+<Row>
+  <Col xs={12} md={6} lg={4}>
+    <div>Column 1</div>
+  </Col>
+  <Col xs={12} md={6} lg={4}>
+    <div>Column 2</div>
+  </Col>
+  <Col xs={12} md={12} lg={4}>
+    <div>Column 3</div>
+  </Col>
+</Row>
+```
+
+#### Navbar
+Responsive navigation component.
+
+```tsx
+import { Navbar } from 'glintly-ui';
+
+<Navbar>
+  <Navbar.Brand>Glintly UI</Navbar.Brand>
+  <Navbar.Nav>
+    <Navbar.NavItem>Home</Navbar.NavItem>
+    <Navbar.NavItem>About</Navbar.NavItem>
+  </Navbar.Nav>
+</Navbar>
+```
+
+#### Container
+Responsive container for content centering.
+
+```tsx
+import { Container } from 'glintly-ui';
+
+<Container>
+  <h1>Centered Content</h1>
+  <p>This content is centered within the viewport</p>
+</Container>
+```
+
+### 🔄 Interactive Components
+
+#### Tabs
+Tabbed interface component.
+
+```tsx
+import { Tabs } from 'glintly-ui';
+
+<Tabs>
+  <Tabs.Tab label="Tab 1">Content for tab 1</Tabs.Tab>
+  <Tabs.Tab label="Tab 2">Content for tab 2</Tabs.Tab>
+  <Tabs.Tab label="Tab 3">Content for tab 3</Tabs.Tab>
+</Tabs>
+```
+
+#### Accordion
+Collapsible content sections.
+
+```tsx
+import { Accordion } from 'glintly-ui';
+
+<Accordion>
+  <Accordion.Item>
+    <Accordion.Header>Section 1</Accordion.Header>
+    <Accordion.Body>Content for section 1</Accordion.Body>
+  </Accordion.Item>
+  <Accordion.Item>
+    <Accordion.Header>Section 2</Accordion.Header>
+    <Accordion.Body>Content for section 2</Accordion.Body>
+  </Accordion.Item>
+</Accordion>
+```
+
+#### Stepper
+Step-by-step process indicator.
+
+```tsx
+import { Stepper, Step, StepLabel, StepContent } from 'glintly-ui';
+
+<Stepper activeStep={1}>
+  <Step>
+    <StepLabel>Step 1</StepLabel>
+    <StepContent>Complete step 1</StepContent>
+  </Step>
+  <Step>
+    <StepLabel>Step 2</StepLabel>
+    <StepContent>Complete step 2</StepContent>
+  </Step>
+</Stepper>
+```
+
+#### Modal
+Overlay dialog component.
+
+```tsx
+import { Modal } from 'glintly-ui';
+
+<Modal isOpen={isOpen} onClose={() => setIsOpen(false)}>
+  <Modal.Header>Modal Title</Modal.Header>
+  <Modal.Body>Modal content goes here</Modal.Body>
+  <Modal.Footer>
+    <Button onClick={() => setIsOpen(false)}>Close</Button>
+  </Modal.Footer>
+</Modal>
+```
+
+### 🎭 Feedback & Status
+
+#### Spinner
+Loading indicators with multiple variants.
+
+```tsx
+import { Spinner } from 'glintly-ui';
+
+<Spinner size="md" color="#3b82f6" />
+<Spinner.BouncingBallLoader />
+<Spinner.CubeLoader />
+<Spinner.PyramidLoader />
+<Spinner.ThreeDBoxLoader />
+```
+
+#### Toast
+Notification system for user feedback.
+
+```tsx
+import { toast, ToastContainer } from 'glintly-ui';
+
+// Show a toast
+toast.success('Operation completed successfully!');
+toast.error('Something went wrong!');
+toast.info('Here is some information');
+toast.warning('Please be careful');
 
+// Include ToastContainer in your app
+<ToastContainer />
+```
+
+#### Badge
+Status indicators and labels.
 
+```tsx
+import { Badge, BadgeGroup } from 'glintly-ui';
 
-## Getting started
+<Badge variant="success">Active</Badge>
+<Badge variant="error">Error</Badge>
+<Badge variant="warning">Warning</Badge>
 
-To make it easy for you to get started with GitLab, here's a list of recommended next steps.
+<BadgeGroup>
+  <Badge>Tag 1</Badge>
+  <Badge>Tag 2</Badge>
+</BadgeGroup>
+```
 
-Already a pro? Just edit this README.md and make it your own. Want to make it easy? [Use the template at the bottom](#editing-this-readme)!
+### 🎨 Media & Content
 
-## Add your files
+#### Avatar
+User profile images with fallbacks.
 
-- [ ] [Create](https://docs.gitlab.com/ee/user/project/repository/web_editor.html#create-a-file) or [upload](https://docs.gitlab.com/ee/user/project/repository/web_editor.html#upload-a-file) files
-- [ ] [Add files using the command line](https://docs.gitlab.com/topics/git/add_files/#add-files-to-a-git-repository) or push an existing Git repository with the following command:
+```tsx
+import { Avatar } from 'glintly-ui';
 
+<Avatar src="/user.jpg" alt="User" size="lg" />
+<Avatar name="John Doe" size="md" />
+<Avatar icon="user" size="sm" />
 ```
-cd existing_repo
-git remote add origin https://gitlab.com/aero-app/aero_ui_lib.git
-git branch -M main
-git push -uf origin main
+
+#### Carousel
+Image and content carousel.
+
+```tsx
+import { Carousel, CarouselItem, CarouselCaption } from 'glintly-ui';
+
+<Carousel>
+  <CarouselItem>
+    <img src="/image1.jpg" alt="Image 1" />
+    <CarouselCaption>
+      <h3>First Slide</h3>
+      <p>Description for first slide</p>
+    </CarouselCaption>
+  </CarouselItem>
+  <CarouselItem>
+    <img src="/image2.jpg" alt="Image 2" />
+    <CarouselCaption>
+      <h3>Second Slide</h3>
+      <p>Description for second slide</p>
+    </CarouselCaption>
+  </CarouselItem>
+</Carousel>
 ```
 
-## Integrate with your tools
+#### CodeViewer
+Syntax-highlighted code display.
 
-- [ ] [Set up project integrations](https://gitlab.com/aero-app/aero_ui_lib/-/settings/integrations)
+```tsx
+import { CodeViewer } from 'glintly-ui';
 
-## Collaborate with your team
+<CodeViewer
+  code={`function hello() {
+  console.log("Hello, World!");
+}`}
+  language="javascript"
+  theme="dark"
+/>
+```
+
+### 🛠️ Utility Components
 
-- [ ] [Invite team members and collaborators](https://docs.gitlab.com/ee/user/project/members/)
-- [ ] [Create a new merge request](https://docs.gitlab.com/ee/user/project/merge_requests/creating_merge_requests.html)
-- [ ] [Automatically close issues from merge requests](https://docs.gitlab.com/ee/user/project/issues/managing_issues.html#closing-issues-automatically)
-- [ ] [Enable merge request approvals](https://docs.gitlab.com/ee/user/project/merge_requests/approvals/)
-- [ ] [Set auto-merge](https://docs.gitlab.com/user/project/merge_requests/auto_merge/)
+#### Tooltip
+Contextual information on hover.
 
-## Test and Deploy
+```tsx
+import { Tooltip } from 'glintly-ui';
+
+<Tooltip content="This is a helpful tooltip">
+  <Button>Hover me</Button>
+</Tooltip>
+```
 
-Use the built-in continuous integration in GitLab.
+#### Offcanvas
+Side panel component.
+
+```tsx
+import { Offcanvas } from 'glintly-ui';
+
+<Offcanvas isOpen={isOpen} onClose={() => setIsOpen(false)}>
+  <Offcanvas.Header>Side Panel</Offcanvas.Header>
+  <Offcanvas.Body>Side panel content</Offcanvas.Body>
+</Offcanvas>
+```
+
+#### Pagination
+Page navigation component.
+
+```tsx
+import { Pagination } from 'glintly-ui';
+
+<Pagination
+  currentPage={1}
+  totalPages={10}
+  onPageChange={(page) => console.log(page)}
+  showFirstLast={true}
+  showPrevNext={true}
+/>
+```
 
-- [ ] [Get started with GitLab CI/CD](https://docs.gitlab.com/ee/ci/quick_start/)
-- [ ] [Analyze your code for known vulnerabilities with Static Application Security Testing (SAST)](https://docs.gitlab.com/ee/user/application_security/sast/)
-- [ ] [Deploy to Kubernetes, Amazon EC2, or Amazon ECS using Auto Deploy](https://docs.gitlab.com/ee/topics/autodevops/requirements.html)
-- [ ] [Use pull-based deployments for improved Kubernetes management](https://docs.gitlab.com/ee/user/clusters/agent/)
-- [ ] [Set up protected environments](https://docs.gitlab.com/ee/ci/environments/protected_environments.html)
+### 🔍 Toolbars
+
+#### SearchBar
+Search functionality component.
+
+```tsx
+import { SearchBar } from 'glintly-ui';
+
+<SearchBar
+  placeholder="Search..."
+  onSearch={(query) => console.log(query)}
+  debounceMs={300}
+/>
+```
+
+#### FilterBar
+Data filtering interface.
+
+```tsx
+import { FilterBar } from 'glintly-ui';
+
+<FilterBar
+  filters={[
+    { key: 'status', label: 'Status', options: ['Active', 'Inactive'] },
+    { key: 'role', label: 'Role', options: ['Admin', 'User'] }
+  ]}
+  onFilterChange={(filters) => console.log(filters)}
+/>
+```
+
+#### SortBar
+Data sorting interface.
+
+```tsx
+import { SortBar } from 'glintly-ui';
+
+<SortBar
+  sortOptions={[
+    { key: 'name', label: 'Name' },
+    { key: 'email', label: 'Email' },
+    { key: 'createdAt', label: 'Created Date' }
+  ]}
+  onSortChange={(sort) => console.log(sort)}
+/>
+```
+
+## 🎨 Theming
+
+Glintly UI provides a comprehensive theming system with:
+
+- **Color Palettes**: Primary, secondary, gray, success, warning, error scales
+- **Typography**: Font families, sizes, weights, and line heights
+- **Spacing**: Consistent spacing scale
+- **Border Radius**: Configurable border radius values
+- **Shadows**: Light and dark mode shadow systems
+- **Breakpoints**: Responsive design breakpoints
+
+### Custom Theme Example
+
+```tsx
+import { ThemeProvider } from 'glintly-ui';
+
+const customTheme = {
+  colors: {
+    primary: {
+      50: '#eff6ff',
+      100: '#dbeafe',
+      500: '#3b82f6',
+      600: '#2563eb',
+      900: '#1e3a8a',
+    },
+    secondary: {
+      500: '#8b5cf6',
+      600: '#7c3aed',
+    },
+    gray: {
+      50: '#f9fafb',
+      100: '#f3f4f6',
+      500: '#6b7280',
+      900: '#111827',
+    },
+  },
+  typography: {
+    fontFamily: '"Inter", "Segoe UI", sans-serif',
+    fontSize: {
+      xs: '0.75rem',
+      sm: '0.875rem',
+      md: '1rem',
+      lg: '1.125rem',
+      xl: '1.25rem',
+    },
+  },
+  spacing: {
+    xs: '0.25rem',
+    sm: '0.5rem',
+    md: '1rem',
+    lg: '1.5rem',
+    xl: '2rem',
+  },
+  borderRadius: {
+    sm: '0.25rem',
+    md: '0.375rem',
+    lg: '0.5rem',
+    xl: '0.75rem',
+  },
+};
+
+<ThemeProvider theme={customTheme}>
+  <YourApp />
+</ThemeProvider>
+```
 
-***
+## 🚀 Getting Started
 
-# Editing this README
+### 1. Install the package
+
+```bash
+npm install glintly-ui
+```
+
+### 2. Wrap your app with ThemeProvider
+
+```tsx
+import React from 'react';
+import { ThemeProvider } from 'glintly-ui';
+
+function App() {
+  return (
+    <ThemeProvider>
+      <YourApp />
+    </ThemeProvider>
+  );
+}
+```
+
+### 3. Import and use components
+
+```tsx
+import { Button, Input, Card } from 'glintly-ui';
+
+function MyComponent() {
+  return (
+    <Card>
+      <Input placeholder="Enter your name" />
+      <Button variant="primary">Submit</Button>
+    </Card>
+  );
+}
+```
+
+## 📱 Responsive Design
+
+All components are built with mobile-first responsive design:
+
+- **xs**: Extra small devices (portrait phones)
+- **sm**: Small devices (landscape phones)
+- **md**: Medium devices (tablets)
+- **lg**: Large devices (desktops)
+- **xl**: Extra large devices (large desktops)
+
+## ♿ Accessibility
+
+Glintly UI components are built with accessibility in mind:
+
+- Proper ARIA attributes
+- Keyboard navigation support
+- Screen reader compatibility
+- High contrast support
+- Focus management
+
+## 🔧 Development
+
+### Prerequisites
+
+- Node.js >= 18.0.0
+- npm, yarn, or pnpm
+
+### Setup
+
+```bash
+git clone https://github.com/abhimanyuyadav0/glintly-ui-lib.git
+cd glintly-ui-lib
+npm install
+```
+
+### Available Scripts
+
+```bash
+npm run dev          # Start development server
+npm run build        # Build the library
+npm run lint         # Run ESLint
+npm run preview      # Preview the build
+npm run clean        # Clean build directory
+```
+
+### Building
+
+```bash
+npm run build
+```
 
-When you're ready to make this README your own, just edit this file and use the handy template below (or feel free to structure it however you want - this is just a starting point!). Thanks to [makeareadme.com](https://www.makeareadme.com/) for this template.
+The build output will be in the `dist/` directory.
 
-## Suggestions for a good README
+## 📦 Bundle Information
 
-Every project is different, so consider which of these sections apply to yours. The sections used in the template are suggestions for most open source projects. Also keep in mind that while a README can be too long and detailed, too long is better than too short. If you think your README is too long, consider utilizing another form of documentation rather than cutting out information.
+- **Main**: `./dist/glintly-ui.umd.cjs` (CommonJS)
+- **Module**: `./dist/glintly-ui.js` (ES Module)
+- **Types**: `./dist/glintly-ui.d.ts` (TypeScript definitions)
+- **Browser**: `./dist/glintly-ui.umd.cjs` (UMD)
 
-## Name
-Choose a self-explaining name for your project.
+## 🤝 Contributing
 
-## Description
-Let people know what your project can do specifically. Provide context and add a link to any reference visitors might be unfamiliar with. A list of Features or a Background subsection can also be added here. If there are alternatives to your project, this is a good place to list differentiating factors.
+We welcome contributions! Please see our [Contributing Guide](CONTRIBUTING.md) for details.
 
-## Badges
-On some READMEs, you may see small images that convey metadata, such as whether or not all the tests are passing for the project. You can use Shields to add some to your README. Many services also have instructions for adding a badge.
+### Development Guidelines
 
-## Visuals
-Depending on what you are making, it can be a good idea to include screenshots or even a video (you'll frequently see GIFs rather than actual videos). Tools like ttygif can help, but check out Asciinema for a more sophisticated method.
+1. Fork the repository
+2. Create a feature branch
+3. Make your changes
+4. Add tests if applicable
+5. Submit a pull request
 
-## Installation
-Within a particular ecosystem, there may be a common way of installing things, such as using Yarn, NuGet, or Homebrew. However, consider the possibility that whoever is reading your README is a novice and would like more guidance. Listing specific steps helps remove ambiguity and gets people to using your project as quickly as possible. If it only runs in a specific context like a particular programming language version or operating system or has dependencies that have to be installed manually, also add a Requirements subsection.
+## 📄 License
 
-## Usage
-Use examples liberally, and show the expected output if you can. It's helpful to have inline the smallest example of usage that you can demonstrate, while providing links to more sophisticated examples if they are too long to reasonably include in the README.
+This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
 
-## Support
-Tell people where they can go to for help. It can be any combination of an issue tracker, a chat room, an email address, etc.
+## 🙏 Acknowledgments
 
-## Roadmap
-If you have ideas for releases in the future, it is a good idea to list them in the README.
+- [React](https://reactjs.org/) - The JavaScript library for building user interfaces
+- [styled-components](https://styled-components.com/) - Visual primitives for the component age
+- [TypeScript](https://www.typescriptlang.org/) - Typed JavaScript at any scale
 
-## Contributing
-State if you are open to contributions and what your requirements are for accepting them.
+## 📞 Support
 
-For people who want to make changes to your project, it's helpful to have some documentation on how to get started. Perhaps there is a script that they should run or some environment variables that they need to set. Make these steps explicit. These instructions could also be useful to your future self.
+- **Issues**: [GitHub Issues](https://github.com/abhimanyuyadav0/glintly-ui-lib/issues)
+- **Discussions**: [GitHub Discussions](https://github.com/abhimanyuyadav0/glintly-ui-lib/discussions)
+- **Documentation**: [GitHub Wiki](https://github.com/abhimanyuyadav0/glintly-ui-lib/wiki)
 
-You can also document commands to lint the code or run tests. These steps help to ensure high code quality and reduce the likelihood that the changes inadvertently break something. Having instructions for running tests is especially helpful if it requires external setup, such as starting a Selenium server for testing in a browser.
+## 🌟 Star History
 
-## Authors and acknowledgment
-Show your appreciation to those who have contributed to the project.
+If you find this library helpful, please consider giving it a star on GitHub!
 
-## License
-For open source projects, say how it is licensed.
+---
 
-## Project status
-If you have run out of energy or time for your project, put a note at the top of the README saying that development has slowed down or stopped completely. Someone may choose to fork your project or volunteer to step in as a maintainer or owner, allowing your project to keep going. You can also make an explicit request for maintainers.
+Made with ❤️ by [Abhimanyu Yadav](https://github.com/abhimanyuyadav0)