# Reflex Simple Icons
A Reflex wrapper for [Simple Icons](https://simpleicons.org/), the best library of SVG icons from the most popular brands.
## Installation
```bash
pip install reflex-simpleicons
```
## Usage
Import like so:
```python
from reflex_simpleicons import simpleicons
```
Search for the logo you want to use on [Simple Icons](https://simpleicons.org/) and click on the name. This will copy its name and you can paste it into the component.
Use in your Reflex UI:
By default it will have the color of the main text, switching automatically between light and dark mode. The default size is 48px.
```python
simpleicons("python")
```
## Styling
You can customize the color and size of the icon by passing the color and size properties.
```python
simpleicons("python"),
simpleicons("python", color="#3776AB", size=24),
simpleicons("python", color="red", size=48),
simpleicons("python", color="#ECD53F", size=67),
simpleicons("python", color="#5F259F", size=97),
```
## Example
If you want to use the default HEX color of the brand you can add the property:
```python
brand_color=True
```
```python
import reflex as rx
from reflex_simpleicons import simpleicons
def demo_brands() -> rx.Component:
return rx.el.div(
simpleicons("7zip", brand_color=True, size=90),
simpleicons(tag="Dell", brand_color=True, size=90),
simpleicons(tag="Microsoft", brand_color=True, size=90),
simpleicons(tag="Amazon", brand_color=True, size=90),
simpleicons(tag="Apple", brand_color=True, size=90),
simpleicons(tag="Spotify", brand_color=True, size=90),
simpleicons(tag="3m", brand_color=True, size=90),
simpleicons(tag="bitwarden", brand_color=True, size=90),
simpleicons(tag="Dotenv", brand_color=True, size=90),
class_name="demo-brands"
)
```
## Disclaimer
By using this wrapper to access and use logos, you agree to the following terms and conditions:
1. Intellectual property: Logos and trademarks found in this wrapper are the property of their respective owners. You do not acquire any ownership rights to the logos by using this plugin.
2. Responsible use: You agree to use the logos responsibly and in accordance with intellectual property laws. You may not modify, distribute, reproduce, or use the logos in any way that may infringe the rights of their owners.
3. Owner's permission: You are responsible for obtaining permission from the trademark owner before using their logo in any commercial or advertising context. The plugin does not give you permission to use the logos in this way.
4. Limitation of liability: The plugin creators are not responsible for the misuse of logos by users. You are solely responsible for any damage or harm you may cause to brand owners by misusing logos.
5. Indemnity: You agree to indemnify and hold harmless the wrapper creators from any claims, damages, or losses that may arise from your misuse of logos.
By using this wrapper, you represent that you have read and agree to the terms and conditions of this disclaimer.
Recommendation: It is recommended that users research the logo usage policies of the brands they are interested in before using their logos.
Raw data
{
"_id": null,
"home_page": null,
"name": "reflex-simpleicons",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": "reflex, reflex-custom-components",
"author": null,
"author_email": "cllatser <carlos@llatser.dev>",
"download_url": "https://files.pythonhosted.org/packages/75/fb/ff1bd6af869ba85d328688e91bc865a0c0a6cda57e4b358971d90111a7b3/reflex-simpleicons-0.0.5.tar.gz",
"platform": null,
"description": "# Reflex Simple Icons\r\n\r\nA Reflex wrapper for [Simple Icons](https://simpleicons.org/), the best library of SVG icons from the most popular brands. \r\n\r\n## Installation\r\n\r\n```bash\r\npip install reflex-simpleicons\r\n```\r\n\r\n## Usage\r\n\r\nImport like so:\r\n\r\n```python\r\nfrom reflex_simpleicons import simpleicons\r\n```\r\n\r\nSearch for the logo you want to use on [Simple Icons](https://simpleicons.org/) and click on the name. This will copy its name and you can paste it into the component.\r\n\r\n\r\n\r\nUse in your Reflex UI:\r\n\r\nBy default it will have the color of the main text, switching automatically between light and dark mode. The default size is 48px.\r\n\r\n```python\r\nsimpleicons(\"python\")\r\n```\r\n\r\n\r\n## Styling\r\n\r\nYou can customize the color and size of the icon by passing the color and size properties.\r\n\r\n```python\r\nsimpleicons(\"python\"),\r\nsimpleicons(\"python\", color=\"#3776AB\", size=24),\r\nsimpleicons(\"python\", color=\"red\", size=48),\r\nsimpleicons(\"python\", color=\"#ECD53F\", size=67),\r\nsimpleicons(\"python\", color=\"#5F259F\", size=97),\r\n```\r\n\r\n\r\n## Example\r\n\r\nIf you want to use the default HEX color of the brand you can add the property:\r\n\r\n```python\r\nbrand_color=True\r\n```\r\n\r\n```python\r\nimport reflex as rx\r\nfrom reflex_simpleicons import simpleicons\r\n\r\n\r\ndef demo_brands() -> rx.Component:\r\n return rx.el.div(\r\n simpleicons(\"7zip\", brand_color=True, size=90),\r\n simpleicons(tag=\"Dell\", brand_color=True, size=90),\r\n simpleicons(tag=\"Microsoft\", brand_color=True, size=90),\r\n simpleicons(tag=\"Amazon\", brand_color=True, size=90),\r\n simpleicons(tag=\"Apple\", brand_color=True, size=90),\r\n simpleicons(tag=\"Spotify\", brand_color=True, size=90),\r\n simpleicons(tag=\"3m\", brand_color=True, size=90),\r\n simpleicons(tag=\"bitwarden\", brand_color=True, size=90),\r\n simpleicons(tag=\"Dotenv\", brand_color=True, size=90),\r\n class_name=\"demo-brands\"\r\n )\r\n```\r\n\r\n\r\n## Disclaimer\r\n\r\nBy using this wrapper to access and use logos, you agree to the following terms and conditions:\r\n\r\n1. Intellectual property: Logos and trademarks found in this wrapper are the property of their respective owners. You do not acquire any ownership rights to the logos by using this plugin.\r\n\r\n2. Responsible use: You agree to use the logos responsibly and in accordance with intellectual property laws. You may not modify, distribute, reproduce, or use the logos in any way that may infringe the rights of their owners.\r\n\r\n3. Owner's permission: You are responsible for obtaining permission from the trademark owner before using their logo in any commercial or advertising context. The plugin does not give you permission to use the logos in this way.\r\n\r\n4. Limitation of liability: The plugin creators are not responsible for the misuse of logos by users. You are solely responsible for any damage or harm you may cause to brand owners by misusing logos.\r\n\r\n5. Indemnity: You agree to indemnify and hold harmless the wrapper creators from any claims, damages, or losses that may arise from your misuse of logos.\r\n\r\nBy using this wrapper, you represent that you have read and agree to the terms and conditions of this disclaimer.\r\n\r\nRecommendation: It is recommended that users research the logo usage policies of the brands they are interested in before using their logos.\r\n",
"bugtrack_url": null,
"license": "Apache-2.0",
"summary": "Reflex custom component simpleicons",
"version": "0.0.5",
"project_urls": {
"Homepage": "https://github.com/cllatser/reflex-simpleicons"
},
"split_keywords": [
"reflex",
" reflex-custom-components"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "fa3992e72791272d3b293451fd3ba32a2d5770f9ca3fad59099f337652759359",
"md5": "24607adf92679ae7436fd38b9546b47a",
"sha256": "e3755e8c33f389e4e9ad2aa015a9c9445f0503e522997716d7db4b9dd7c752fc"
},
"downloads": -1,
"filename": "reflex_simpleicons-0.0.5-py3-none-any.whl",
"has_sig": false,
"md5_digest": "24607adf92679ae7436fd38b9546b47a",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 2013010,
"upload_time": "2024-04-02T21:21:52",
"upload_time_iso_8601": "2024-04-02T21:21:52.287876Z",
"url": "https://files.pythonhosted.org/packages/fa/39/92e72791272d3b293451fd3ba32a2d5770f9ca3fad59099f337652759359/reflex_simpleicons-0.0.5-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "75fbff1bd6af869ba85d328688e91bc865a0c0a6cda57e4b358971d90111a7b3",
"md5": "08ce9dbb53662f086c2ad9611167e376",
"sha256": "21650f092dea36ef9b4785c4cfee7ca88dda15a11b0232bc8b9dff01daa4b97f"
},
"downloads": -1,
"filename": "reflex-simpleicons-0.0.5.tar.gz",
"has_sig": false,
"md5_digest": "08ce9dbb53662f086c2ad9611167e376",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 2005157,
"upload_time": "2024-04-02T21:21:54",
"upload_time_iso_8601": "2024-04-02T21:21:54.627463Z",
"url": "https://files.pythonhosted.org/packages/75/fb/ff1bd6af869ba85d328688e91bc865a0c0a6cda57e4b358971d90111a7b3/reflex-simpleicons-0.0.5.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-02 21:21:54",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "cllatser",
"github_project": "reflex-simpleicons",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "reflex-simpleicons"
}
JSON
