Metadata-Version: 2.1
Name: cotton-icons
Version: 0.2.0
Summary: Heroicons and Tabler Icons for Django Cotton
Home-page: https://github.com/wrabit/cotton-icons
License: MIT
Keywords: django,cotton,heroicons,svg,icons
Author: William Abbott
Author-email: willabb83@gmail.com
Requires-Python: >=3.8,<4.0
Classifier: Development Status :: 5 - Production/Stable
Classifier: Framework :: Django
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Requires-Dist: django-cotton
Project-URL: Documentation, https://github.com/wrabit/cotton-icons#readme
Project-URL: Repository, https://github.com/wrabit/cotton-icons
Description-Content-Type: text/markdown

A package to provide popular icon packs for use with [Django Cotton](https://github.com/wrabit/django-cotton).
Currently, [Heroicons](https://heroicons.com/), [Tabler Icons](https://tabler.io/icons), and [Lucide Icons](https://lucide.dev/) are supported.

## Supported Icon Libraries

*   **Heroicons:** `v2.2.0`
*   **Tabler Icons:** `v3.37.1`
*   **Lucide Icons:** `v0.575.0` 

## Install

**1. Install from pypi**

```
pip install cotton-icons
```

**2. Install into your django project**

```python
# settings.py
INSTALLED_APPS = [
  'cotton_icons'
]
```

**3. Use in template**

| Library | Syntax | Variants | Default |
|---------|--------|----------|---------|
| Heroicons | `<c-heroicon.icon-name />` | `outline`, `solid`, `mini`, `micro` | `outline` |
| Tabler | `<c-tablericon.icon-name />` | `outline`, `filled` | `outline` |
| Lucide | `<c-lucideicon.icon-name />` | - | - |

All attributes pass through to the `<svg>` tag. For stroke-based icons you can also pass `stroke-width`, `stroke-linecap`, and `stroke-linejoin`.

**Examples:**

```html
<c-heroicon.chevron-down class="size-5" />
<c-heroicon.chevron-down variant="solid" class="size-5" />
<c-heroicon.chevron-down variant="mini" class="size-5" />

<c-tablericon.graph class="size-5" />
<c-tablericon.graph variant="filled" class="size-5" />

<c-lucideicon.arrow-down class="size-5" />
<c-lucideicon.search class="size-5" stroke-width="3" />
```

### Roadmap

- [x] Add [Tabler Icons](https://tabler-icons.io/)
- [x] Add [Lucide Icons](https://lucide.dev/)



