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 Distributions
Built Distribution
Hashes for wagtailextraicons-0.1.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | c7bb4c1f15d8b1e1fdf18dabdcceb64c64794dbe6f0a429a5810a9811dc431bc |
|
MD5 | 8ba6a5afc0060f39690aef0837c00713 |
|
BLAKE2b-256 | d3bf0327357e9575616c198a6c27b1cd8111515456768499028755a3278fb08d |