cotton-heroicons

Name	cotton-heroicons JSON
Version	0.1.1 JSON
	download
home_page	None
Summary	A Django Cotton Component Library of Heroicons
upload_time	2024-10-24 12:19:57
maintainer	None
docs_url	None
author	None
requires_python	>=3.8
license	None
keywords	component cotton django heroicons library
VCS
bugtrack_url
requirements	No requirements were recorded.
Travis-CI	No Travis.
coveralls test coverage	No coveralls.

            # cotton-heroicons

A [Django Cotton](https://django-cotton.com/) Component Library of [Heroicons](https://heroicons.com/)

## Usage

To use the icons in your templates, simply add the component tag with the icon name as the tag name. The default variant
is 'outline', but you can specify a different variant using the 'variant' attribute. You can also add additional classes
using the 'class' attribute.

```html
<!-- The default variant is 'outline' -->
<c-heroicon.cloud/>

<!-- Specify the variant with the 'variant' attribute -->
<c-heroicon.shopping-bag variant="mini"/>

<!-- Add additional classes using the 'class' attribute -->
<c-heroicon.square-3-stack-3d class="text-violet-700"/>
```

## Installation

```bash
pip install cotton-heroicons
```

Update Django settings:

```python
INSTALLED_APPS = [
    ...
    'django_cotton',
    'cotton_heroicons',
    ...
]
```

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "cotton-heroicons",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.8",
    "maintainer_email": null,
    "keywords": "component, cotton, django, heroicons, library",
    "author": null,
    "author_email": null,
    "download_url": "https://files.pythonhosted.org/packages/e4/5c/81dbd8517f30aa42b6e583f59e4d531d9a13c3bb4d09678d8b6143759726/cotton_heroicons-0.1.1.tar.gz",
    "platform": null,
    "description": "# cotton-heroicons\n\nA [Django Cotton](https://django-cotton.com/) Component Library of [Heroicons](https://heroicons.com/)\n\n## Usage\n\nTo use the icons in your templates, simply add the component tag with the icon name as the tag name. The default variant\nis 'outline', but you can specify a different variant using the 'variant' attribute. You can also add additional classes\nusing the 'class' attribute.\n\n```html\n<!-- The default variant is 'outline' -->\n<c-heroicon.cloud/>\n\n<!-- Specify the variant with the 'variant' attribute -->\n<c-heroicon.shopping-bag variant=\"mini\"/>\n\n<!-- Add additional classes using the 'class' attribute -->\n<c-heroicon.square-3-stack-3d class=\"text-violet-700\"/>\n```\n\n## Installation\n\n```bash\npip install cotton-heroicons\n```\n\nUpdate Django settings:\n\n```python\nINSTALLED_APPS = [\n    ...\n    'django_cotton',\n    'cotton_heroicons',\n    ...\n]\n```\n",
    "bugtrack_url": null,
    "license": null,
    "summary": "A Django Cotton Component Library of Heroicons",
    "version": "0.1.1",
    "project_urls": {
        "Homepage": "https://github.com/snopoke/cotton-heroicons"
    },
    "split_keywords": [
        "component",
        " cotton",
        " django",
        " heroicons",
        " library"
    ],
    "urls": [
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "959d8b41193f21c46cced0a0d803c43fda773dc6cc29f06f3ef7de10b016294f",
                "md5": "172718b6dc0653b0b87cbd88336aa4b4",
                "sha256": "ec1c5d6783ad9ac62bbcd47a0ab252649f22cfa8da3705be6242df5d92b6680c"
            },
            "downloads": -1,
            "filename": "cotton_heroicons-0.1.1-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "172718b6dc0653b0b87cbd88336aa4b4",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.8",
            "size": 371856,
            "upload_time": "2024-10-24T12:19:54",
            "upload_time_iso_8601": "2024-10-24T12:19:54.192769Z",
            "url": "https://files.pythonhosted.org/packages/95/9d/8b41193f21c46cced0a0d803c43fda773dc6cc29f06f3ef7de10b016294f/cotton_heroicons-0.1.1-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "e45c81dbd8517f30aa42b6e583f59e4d531d9a13c3bb4d09678d8b6143759726",
                "md5": "ed18b29e060aac0ad022edbf52e5af34",
                "sha256": "1525cda0ea7bbb36ff55f354bb1b97d8bccaae0bc46d7a35e2c47e3cf3256273"
            },
            "downloads": -1,
            "filename": "cotton_heroicons-0.1.1.tar.gz",
            "has_sig": false,
            "md5_digest": "ed18b29e060aac0ad022edbf52e5af34",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.8",
            "size": 151403,
            "upload_time": "2024-10-24T12:19:57",
            "upload_time_iso_8601": "2024-10-24T12:19:57.417300Z",
            "url": "https://files.pythonhosted.org/packages/e4/5c/81dbd8517f30aa42b6e583f59e4d531d9a13c3bb4d09678d8b6143759726/cotton_heroicons-0.1.1.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-10-24 12:19:57",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "snopoke",
    "github_project": "cotton-heroicons",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": false,
    "lcname": "cotton-heroicons"
}