# Astral UI

UI Library for Cloudwick

Version - 5.2.0

## Installation

Install the package in your project directory with:

```sh
# With npm:
npm i @cloudwick/astral-ui

# With yarn:
yarn add @cloudwick/astral-ui
```

## Requirements

This package has the following peer dependencies:
- React ^18.3.1
- React DOM ^18.3.1

## Available Components

Astral UI provides the following components:

- Accordion
- ADPIcon
- Avatar
- AvatarGroup
- Badge
- Breadcrumbs
- Button
- Card
- Checkbox
- CheckboxGroup
- CTAGroup
- DataTable
- DatePicker
- Dropdown
- EmptyState
- FileUpload
- Loader
- Modal
- OtpInput
- Pagination
- Panel
- PanelGroup
- PasswordField
- Progress
- Radio
- RadioGroup
- Scrollbar
- Select
- Tabs
- Textarea
- TextCopy
- TextField
- Toast
- Toggle
- Tooltip
- Truncate

## Tailwind CSS Configuration

Astral UI is built with Tailwind CSS. The library exports a Tailwind theme configuration that you can use in your project:

```js
// In your tailwind.config.js
import { tailwindThemeConfig } from '@cloudwick/astral-ui';

export default {
  // Your existing config
  theme: {
    // Add Astral UI theme
    ...tailwindThemeConfig
  }
}
```

The theme includes configuration for:
- Colors (primary, secondary, gray, error, success, warning)
- Font families
- Font sizes
- Spacing
- Border radius
- Box shadows
- Animations
- And more

## Documentation

For detailed documentation and examples of each component, please visit [the documentation site](https://www.astral-ui.amorphic.link/).

## Import Paths

You can import components as follows:

```js
// Import from the main package
import { Button, Accordion, TextField } from '@cloudwick/astral-ui';
```

If you need tree-shaking, the main import still allows for proper tree-shaking by most modern bundlers.