No project description provided
Project description
Wagtail Icons
Wagtail Icons is package that allows you to add icons (in svg format) on your page, divide them on groups, resize and style displayed icons.
Install
pip install wagtail-svg-icons
Then add wagtailextraicons
to your installed apps:
INSTALLED_APPS = [
...
'wagtail_icons'
]
Usage
IconsField and IconsChooserPanel
IconsField - Subclass of ForeignKey Field with many-to-one relationship with Icon model. Have all arguments of ForeignKey with defaults:
- on_delete=models.SET_NULL
- null=True
- blank=True
Extra (optional) argument:
- group - title or slug of the group from which icons can be choosen. If not specified all available icons will be displayed.
from wagtail.core.models import Page
from wagtail_icons.edit_handlers import IconsChooserPanel
from wagtail_icons.fields import IconsField
class iconsPage(Page):
template_name = 'yourapp/yourtemplate'
icon = IconsField(group='example_group_title')
content_panels = Page.content_panels + [
IconsChooserPanel('icon'),
]
How to use Icons in templates
The 'icon' tag inserts svg element into page, setting its size and custom_class (if specified). To use 'icon' tag load 'wagtail_icons_tags'
{% load wagtail_icons_tags %}
Icon tag required arguments:
- icon - instance of Icon model
Icon tag optional arguments:
- size - icon resize given in format "HEIGHTxWIDTH"
- class_name - icon class name that can be used to css styling
- color - custom icon color
Example usage
<!-- Display original size icon -->
{% icon self.icon %}
<!-- Display icon scaled to width 200 and height 250 -->
{% icon self.icon size='250x200' class_name='filter-green' %}
<!-- Display icon scaled to width 200 and height 200 and with class 'my-icon'-->
{% icon self.icon size='200x200' class_name='my-icon' %}
<!-- Display icon scaled to width 200 and height 200 and in color #81b29a-->
{% icon self.icon size='200x200' class_name='my-icon' color='#81b29a' %}
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
wagtail-svg-icons-0.0.1.tar.gz
(25.9 kB
view hashes)
Built Distribution
Close
Hashes for wagtail_svg_icons-0.0.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 1f734ad381f66d2b8e48362e861e0c834fa1c01fb3374737ab9032f785a0f9cd |
|
MD5 | 852ae8c0820e453e170765c4eccb7d6f |
|
BLAKE2b-256 | d2ade2d054f6628a543ce300c8d5551e00d47154531e6cf68ef93bd3e51f11ae |