# Dash Iconify
Dash Iconify based on Iconify is a Dash component library which brings over 100,000 vector icons.
## Table of contents
- [Installation](#installation)
- [Quickstart](#quickstart)
- [Using with dmc](#using-with-dmc)
- [Keyword Arguments](#keyword-arguments)
## Installation
```bash
pip install dash-iconify
```
## Quickstart
```python
from dash_iconify import DashIconify
from dash import Dash
app = Dash(__name__)
app.layout = DashIconify(
icon="ion:logo-github",
width=30,
height=30,
rotate=1,
flip="horizontal",
)
if __name__ == "__main__":
app.run_server(debug=True)
```
## Using with dmc
[Dash Mantine Components](https://github.com/snehilvj/dash-mantine-components) enables using icons natively.
```python
import dash_mantine_components as dmc
from dash_iconify import DashIconify
button = dmc.Button("Send Mail", leftIcon=[
DashIconify(icon="fluent:folder-mail-16-filled")
])
```
## Keyword Arguments
Visit this site to browse all the available icons: <https://icon-sets.iconify.design/>
```git
Keyword arguments:
- id (string; optional):
The ID used to identify this component in Dash callbacks.
- color (string; optional):
Color.
- flip (a value equal to: "horizontal", "vertical"; optional):
Flip the icon horizontally or vertically.
- height (number; optional):
Icon height.
- icon (string; optional):
Icon name is a string, which has 3 parts: @api-provider : icon-prefix : icon-name
provider points to API source. Starts with "@", can be empty (empty value is used for public Iconify API).
prefix is name of icon set.
name is name of icon.
- inline (boolean; optional):
Toggles inline or block mode.
- rotate (a value equal to: 0, 1, 2, 3; optional):
Rotates icon, 0: 0 deg, 1: 90 deg, 2: 180 deg, 3: 270 deg.
- style (dict; optional):
Inline style.
- width (number; optional):
Icon width.
```
Raw data
{
"_id": null,
"home_page": "https://github.com/snehilvj/dash-iconify",
"name": "dash-iconify",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "",
"author": "Snehil Vijay <snehilvj@outlook.com>",
"author_email": "snehilvj@outlook.com",
"download_url": "https://files.pythonhosted.org/packages/49/d2/03483ed3278cd476c34064bec43675fb6da84a6908e995a699eed76ab32d/dash_iconify-0.1.2.tar.gz",
"platform": null,
"description": "# Dash Iconify\n\nDash Iconify based on Iconify is a Dash component library which brings over 100,000 vector icons.\n\n## Table of contents\n\n- [Installation](#installation)\n- [Quickstart](#quickstart)\n- [Using with dmc](#using-with-dmc)\n- [Keyword Arguments](#keyword-arguments)\n\n## Installation\n\n```bash\npip install dash-iconify\n```\n\n## Quickstart\n\n```python\nfrom dash_iconify import DashIconify\nfrom dash import Dash\n\napp = Dash(__name__)\n\napp.layout = DashIconify(\n icon=\"ion:logo-github\",\n width=30,\n height=30,\n rotate=1,\n flip=\"horizontal\",\n)\n\nif __name__ == \"__main__\":\n app.run_server(debug=True)\n\n```\n\n## Using with dmc\n\n[Dash Mantine Components](https://github.com/snehilvj/dash-mantine-components) enables using icons natively.\n\n```python\nimport dash_mantine_components as dmc\nfrom dash_iconify import DashIconify\n\nbutton = dmc.Button(\"Send Mail\", leftIcon=[\n DashIconify(icon=\"fluent:folder-mail-16-filled\")\n])\n```\n\n## Keyword Arguments\n\nVisit this site to browse all the available icons: <https://icon-sets.iconify.design/>\n\n```git\nKeyword arguments:\n\n- id (string; optional):\n The ID used to identify this component in Dash callbacks.\n\n- color (string; optional):\n Color.\n\n- flip (a value equal to: \"horizontal\", \"vertical\"; optional):\n Flip the icon horizontally or vertically.\n\n- height (number; optional):\n Icon height.\n\n- icon (string; optional):\n Icon name is a string, which has 3 parts: @api-provider : icon-prefix : icon-name\n provider points to API source. Starts with \"@\", can be empty (empty value is used for public Iconify API).\n prefix is name of icon set.\n name is name of icon.\n\n- inline (boolean; optional):\n Toggles inline or block mode.\n\n- rotate (a value equal to: 0, 1, 2, 3; optional):\n Rotates icon, 0: 0 deg, 1: 90 deg, 2: 180 deg, 3: 270 deg.\n\n- style (dict; optional):\n Inline style.\n\n- width (number; optional):\n Icon width.\n```\n\n\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Iconify for Plotly Dash",
"version": "0.1.2",
"project_urls": {
"Homepage": "https://github.com/snehilvj/dash-iconify"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "d263f10cc18533cc9ab899ea81deca9759b3eebe47d01ad95c4e67b6acdada97",
"md5": "f9ad4357d27422a465a6400e8d519101",
"sha256": "9ab0eda19bb4514e177bf1f8f36947bb9e5b44aba6ce947f22a1cf0f1a45fc14"
},
"downloads": -1,
"filename": "dash_iconify-0.1.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "f9ad4357d27422a465a6400e8d519101",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 18928,
"upload_time": "2022-04-21T14:39:57",
"upload_time_iso_8601": "2022-04-21T14:39:57.491720Z",
"url": "https://files.pythonhosted.org/packages/d2/63/f10cc18533cc9ab899ea81deca9759b3eebe47d01ad95c4e67b6acdada97/dash_iconify-0.1.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "49d203483ed3278cd476c34064bec43675fb6da84a6908e995a699eed76ab32d",
"md5": "ed1393902d260b800c55b477fca847ce",
"sha256": "564774be6b11b0ac3a8999b7137c3d17a1d351d69b673aa313c7228eacc9d143"
},
"downloads": -1,
"filename": "dash_iconify-0.1.2.tar.gz",
"has_sig": false,
"md5_digest": "ed1393902d260b800c55b477fca847ce",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 17347,
"upload_time": "2022-04-21T14:40:00",
"upload_time_iso_8601": "2022-04-21T14:40:00.794728Z",
"url": "https://files.pythonhosted.org/packages/49/d2/03483ed3278cd476c34064bec43675fb6da84a6908e995a699eed76ab32d/dash_iconify-0.1.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2022-04-21 14:40:00",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "snehilvj",
"github_project": "dash-iconify",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"requirements": [
{
"name": "dash",
"specs": [
[
">=",
"1.15.0"
]
]
}
],
"lcname": "dash-iconify"
}
JSON
