Add extra icons to your Wagtail project.
Project description
Wagtail Extra Icons
Add extra icons to your Wagtail project.
Install
pip install wagtailextraicons
Then add wagtailextraicons
to your installed apps:
INSTALLED_APPS = [
...
'wagtailextraicons'
]
Usage
The full list of icons is available at docs/icons.md.
All icons are namespaced as extraicons--
to avoid clashing with existing Wagtail icons. You can add the extra icons to
your StreamField blocks like any other:
content = StreamField([
(
'paragraph',
blocks.RichTextBlock(icon='extraicons--paragraph')
),
])
You can also add the extra icons to your own custom StructBlock
classes:
class PersonBlock(blocks.StructBlock):
person = SnippetChooserBlock('app.Person')
text = blocks.RichTextBlock()
class Meta:
icon = 'extraicons--person'
Reference the Wagtail docs for all the ways to include icons.
Authors
- Sam Costigan Octave
Contributing
The icon fonts are compiled from the list of SVG files in static_src/wagtailextraicons/extraicons. This makes it very easy to add new icons. All that's needed is an appropriate SVG file, so pull requests with new icons are always welcome. There are a few constraints on the icons however:
- The icons must fit within their view box. Icons which don't will cause the fonts view box to have negative values, which results in invalid .ttf and .woff files.
- Try to avoid using strokes, rects, etc. in your SVG. Some of these may work, but plain paths will always work, so prefer paths where possible.
- Don't set colours on your SVG.
Code pull requests are also welcome.
License
This project is licensed under the BSD License - see the LICENSE.md file for details
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for wagtailextraicons-0.1.7-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 2faf30dcfedf68d7298ce915d6f684fd4934db17f9be5d35d91128ce880dc322 |
|
MD5 | a228377368e66e81ec433a91fdab9c9f |
|
BLAKE2b-256 | 0a7e6f71fcd55542c080b3e837c61bb5d0043ee070325f78ba428e9bc05479d0 |