mirror of
https://github.com/wagtail/wagtail.git
synced 2024-12-01 11:41:20 +01:00
83 lines
2.7 KiB
Markdown
83 lines
2.7 KiB
Markdown
|
(icons)=
|
||
|
|
|
||
|
|
# Icons
|
||
|
|
|
||
|
|
Wagtail comes with an SVG icon set. The icons are used throughout the admin interface.
|
||
|
|
|
||
|
|
Elements that use icons are:
|
||
|
|
|
||
|
|
- [Register Admin Menu Item](register_admin_menu_item)
|
||
|
|
- [Client-side components](extending_clientside_components)
|
||
|
|
- [Rich text editor toolbar buttons](extending_the_draftail_editor)
|
||
|
|
- [ModelAdmin menu](modeladmin_menu_icon)
|
||
|
|
- [StreamField blocks](custom_streamfield_blocks)
|
||
|
|
|
||
|
|
This document describes how to choose, add and customise icons.
|
||
|
|
|
||
|
|
## Available icons and their names
|
||
|
|
|
||
|
|
An icon name corresponds with the value of `id` in the SVG file: `<svg id="<name>"`.
|
||
|
|
|
||
|
|
Icons are SVG files in the [Wagtail admin template folder](https://github.com/wagtail/wagtail/tree/main/wagtail/admin/templates/wagtailadmin/icons).
|
||
|
|
|
||
|
|
Alternatively, enable the [styleguide](styleguide) to view the available icons and their names.
|
||
|
|
|
||
|
|
## Add a custom icon
|
||
|
|
|
||
|
|
Draw or download an icon and save it in a template folder:
|
||
|
|
|
||
|
|
```xml
|
||
|
|
# app/templates/app_name/toucan.svg
|
||
|
|
|
||
|
|
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 800 800" id="icon-toucan">
|
||
|
|
<!-- This work is licensed under a CC0 license. https://creativecommons.org/publicdomain/zero/1.0/ -->
|
||
|
|
<path fill="currentColor" d="M321 662v1a41 41 0 1 1-83-2V470c0-129 71-221 222-221 122 0 153-42 153-93 0-34-18-60-53-72v-4c147 23 203 146 203 257 0 107-80 247-277 247v79a41 41 0 1 1-82-1v46a41 41 0 0 1-83 0v-46Z"/>
|
||
|
|
<path fill="currentColor" d="M555 136a23 23 0 1 0-46 0 23 23 0 0 0 46 0Zm-69-57H175c-60 0-137 36-137 145l9-8 367 6 72 18V79Z"/>
|
||
|
|
</svg>
|
||
|
|
```
|
||
|
|
|
||
|
|
The `svg` tag should:
|
||
|
|
|
||
|
|
- Set the `id="icon-<name>"` attribute, icons are referenced by this name
|
||
|
|
- Set the `xmlns="http://www.w3.org/2000/svg"` attribute
|
||
|
|
- Set the `viewBox="..."` attribute
|
||
|
|
- Include license information, if applicable.
|
||
|
|
|
||
|
|
Set `<path fill="currentColor"` to give the icon the current color.
|
||
|
|
|
||
|
|
Add the icon with the `register_icons` hook.
|
||
|
|
|
||
|
|
```python
|
||
|
|
@hooks.register("register_icons")
|
||
|
|
def register_icons(icons):
|
||
|
|
return icons + ['app_name/toucan.svg']
|
||
|
|
```
|
||
|
|
|
||
|
|
## Icon template tag
|
||
|
|
|
||
|
|
Use an icon in a custom template:
|
||
|
|
|
||
|
|
```html+django
|
||
|
|
{% load wagtailadmin_tags %}
|
||
|
|
{% icon name="toucan" classname="..." title="..." %}
|
||
|
|
```
|
||
|
|
|
||
|
|
## Changing icons via hooks
|
||
|
|
|
||
|
|
```python
|
||
|
|
@hooks.register("register_icons")
|
||
|
|
def register_icons(icons):
|
||
|
|
icons.remove("wagtailadmin/icons/time.svg") # Remove the original icon
|
||
|
|
icons.append("path/to/time.svg") # Add the new icon
|
||
|
|
return icons
|
||
|
|
```
|
||
|
|
|
||
|
|
## Changing icons via template override
|
||
|
|
|
||
|
|
When several applications provide different versions of the same template, the application listed first in `INSTALLED_APPS` has precedence.
|
||
|
|
|
||
|
|
Place your app before any Wagtail apps in `INSTALLED_APPS`.
|
||
|
|
|
||
|
|
Wagtail icons live in `wagtail/admin/templates/wagtailadmin/icons/`.
|
||
|
|
Place your own SVG files in `<your_app>/templates/wagtailadmin/icons/`.
|