Skip to content

wrabit/cotton-icons

Repository files navigation

A package to provide popular icon packs for use with Django Cotton. Currently, Heroicons, Tabler Icons, and Lucide Icons 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

# 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:

<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

About

Plug and play Heroicons, Tabler and Lucide icons for Django Cotton.

Topics

Resources

Stars

Watchers

Forks

Packages

 
 
 

Contributors