mirror of
https://github.com/pyapp-kit/superqt.git
synced 2025-12-16 03:00:05 +01:00
docs: add iconify docs
This commit is contained in:
36
docs/utilities/iconify.md
Normal file
36
docs/utilities/iconify.md
Normal file
@@ -0,0 +1,36 @@
|
|||||||
|
# QIconifyIcon
|
||||||
|
|
||||||
|
[Iconify](https://iconify.design/) is an icon library that includes 150,000+
|
||||||
|
icons from most major icon sets including Bootstrap, FontAwesome, Material
|
||||||
|
Design, and many more; each available as individual SVGs. Unlike the
|
||||||
|
[`superqt.fonticon` module](./fonticon.md), `superqt.QIconifyIcon` does not require any additional
|
||||||
|
dependencies or font files to be installed. Icons are downloaded (and cached)
|
||||||
|
on-demand from the Iconify API, using [pyconify](https://github.com/pyapp-kit/pyconify)
|
||||||
|
|
||||||
|
Search availble icons at <https://icon-sets.iconify.design>
|
||||||
|
Once you find one you like, use the key in the format `"prefix:name"` to create an
|
||||||
|
icon: `QIconifyIcon("bi:bell")`.
|
||||||
|
|
||||||
|
## Basic Example
|
||||||
|
|
||||||
|
```python
|
||||||
|
from qtpy.QtCore import QSize
|
||||||
|
from qtpy.QtWidgets import QApplication, QPushButton
|
||||||
|
|
||||||
|
from superqt import QIconifyIcon
|
||||||
|
|
||||||
|
app = QApplication([])
|
||||||
|
|
||||||
|
btn = QPushButton()
|
||||||
|
btn.setIcon(QIconifyIcon("fluent-emoji-flat:alarm-clock"))
|
||||||
|
btn.setIconSize(QSize(60, 60))
|
||||||
|
btn.show()
|
||||||
|
|
||||||
|
app.exec()
|
||||||
|
```
|
||||||
|
|
||||||
|
{{ show_widget(225) }}
|
||||||
|
|
||||||
|
::: superqt.QIconifyIcon
|
||||||
|
options:
|
||||||
|
heading_level: 3
|
||||||
@@ -12,6 +12,12 @@
|
|||||||
| [`IconOpts`](./fonticon.md#superqt.fonticon.IconOpts) | Options for rendering an icon |
|
| [`IconOpts`](./fonticon.md#superqt.fonticon.IconOpts) | Options for rendering an icon |
|
||||||
| [`Animation`](./fonticon.md#superqt.fonticon.Animation) | Base class for adding animations to a font-icon. |
|
| [`Animation`](./fonticon.md#superqt.fonticon.Animation) | Base class for adding animations to a font-icon. |
|
||||||
|
|
||||||
|
## SVG Icons
|
||||||
|
|
||||||
|
| Object | Description |
|
||||||
|
| ----------- | --------------------- |
|
||||||
|
| [`QIconifyIcon`](./iconify.md) | QIcons backed by the [Iconify](https://iconify.design/) icon library. |
|
||||||
|
|
||||||
## Threading tools
|
## Threading tools
|
||||||
|
|
||||||
| Object | Description |
|
| Object | Description |
|
||||||
|
|||||||
@@ -32,8 +32,8 @@ markdown_extensions:
|
|||||||
- attr_list
|
- attr_list
|
||||||
- md_in_html
|
- md_in_html
|
||||||
- pymdownx.emoji:
|
- pymdownx.emoji:
|
||||||
emoji_index: !!python/name:materialx.emoji.twemoji
|
emoji_index: !!python/name:material.extensions.emoji.twemoji
|
||||||
emoji_generator: !!python/name:materialx.emoji.to_svg
|
emoji_generator: !!python/name:material.extensions.emoji.to_svg
|
||||||
- toc:
|
- toc:
|
||||||
permalink: "#"
|
permalink: "#"
|
||||||
|
|
||||||
|
|||||||
@@ -67,11 +67,11 @@ dev = [
|
|||||||
"types-Pygments",
|
"types-Pygments",
|
||||||
]
|
]
|
||||||
docs = [
|
docs = [
|
||||||
"mkdocs-macros-plugin",
|
"mkdocs-macros-plugin ==1.3.7",
|
||||||
"mkdocs-material",
|
"mkdocs-material ==9.5.49",
|
||||||
"mkdocstrings[python]",
|
"mkdocstrings ==0.27.0",
|
||||||
"pint",
|
"mkdocstrings-python ==1.13.0",
|
||||||
"cmap",
|
"superqt[font-fa5, cmap, quantity]",
|
||||||
]
|
]
|
||||||
quantity = ["pint"]
|
quantity = ["pint"]
|
||||||
cmap = ["cmap >=0.1.1"]
|
cmap = ["cmap >=0.1.1"]
|
||||||
|
|||||||
Reference in New Issue
Block a user