From 8aa0bf9275efd90b58cae431c26de4e3ceef34f3 Mon Sep 17 00:00:00 2001 From: Thibaud Colas Date: Fri, 14 Apr 2023 05:57:26 +0100 Subject: [PATCH] Release notes for #10303 --- CHANGELOG.txt | 1 + CONTRIBUTORS.rst | 1 + docs/releases/5.0.md | 55 +++++++++++++++++++++++++++++++++++++++----- 3 files changed, 51 insertions(+), 6 deletions(-) diff --git a/CHANGELOG.txt b/CHANGELOG.txt index 4afe4b04a1..88638d3a66 100644 --- a/CHANGELOG.txt +++ b/CHANGELOG.txt @@ -34,6 +34,7 @@ Changelog * Move the help text of fields and blocks directly below their label for easier reading (Thibaud Colas) * Allow filters on snippet and generic index views to be customised through the `list_filter` attribute (Sage Abdullah) * The select all checkbox in simple translation's submit translation page will now be in sync with other checkbox changes (Hanoon) + * Update Wagtail’s default icon set to Font Awesome 6 (Thibaud Colas) * Fix: Ensure `label_format` on StructBlock gracefully handles missing variables (Aadi jindal) * Fix: Adopt a no-JavaScript and more accessible solution for the 'Reset to default' switch to Gravatar when editing user profile (Loveth Omokaro) * Fix: Ensure `Site.get_site_root_paths` works on cache backends that do not preserve Python objects (Jaap Roes) diff --git a/CONTRIBUTORS.rst b/CONTRIBUTORS.rst index f4b3ce614a..d9fe50dff3 100644 --- a/CONTRIBUTORS.rst +++ b/CONTRIBUTORS.rst @@ -705,6 +705,7 @@ Contributors * Babitha Kumari * Mansi Gundre * Hanoon +* Steve Steinwand Translators =========== diff --git a/docs/releases/5.0.md b/docs/releases/5.0.md index 83664ad074..bd0f266fdb 100644 --- a/docs/releases/5.0.md +++ b/docs/releases/5.0.md @@ -27,6 +27,20 @@ The image library can now be configured to allow uploading SVG images. These are Support for adding custom validation logic to StreamField blocks has been formalised and simplified. For most purposes, raising a `ValidationError` from the block's `clean` method is now sufficient; more complex behaviours (such as attaching errors to a specific child block) are possible through block-specific subclasses of `ValidationError`. For more details, see [](streamfield_validation). This feature was developed by Matt Westcott. +### Customisable SVG icons + +Wagtail’s icon set is now fully updated, customisable, and extendable. Built-in icons are now based on the latest [FontAwesome](https://fontawesome.com/) visuals, with capabilities to both customise existing icons as well as add new ones. In particular, this includes: + + * A new `{% icon %}` icon template tag to reuse icons in custom templates. + * A `register_icons` hook to register new icons and override existing ones. + * A always-up-to-date list of icons in the styleguide, showcasing the icons available on the current site. + * A list of [all built-in icons](icons) within our developer documentation. + * Support for customising icons for snippets via `SnippetViewSet.icon`. + +For more details, see our new [icons documentation](icons). + +This has been made possible thanks to a multi-year refactoring effort to migrate all icons to SVG. Thank you to all contributors who participated in this effort: Coen van der Kamp, LB (Ben) Johnston, Dan Braghis, Daniel Kirkham, Sage Abdullah, Thibaud Colas, Scott Cranfill, Storm Heg, Steve Steinwand, Jérôme Lebleu, Abayomi Victory. + ### Other features * Add `WAGTAILIMAGES_EXTENSIONS` setting to restrict image uploads to specific file types (Aman Pandey, Ananjan-R) @@ -45,11 +59,9 @@ Support for adding custom validation logic to StreamField blocks has been formal * Add the ability to [disable model indexing](wagtailsearch_disable_indexing) by setting `search_fields = []` (Daniel Kirkham) * Enhance `wagtail.search.utils.parse_query_string` to allow inner single quotes for key/value parsing (Aman Pandey) * Add helpful properties to [`Locale`](locale_model_ref) for more convenient usage within templates, see [](i18n_basic_example) (Andy Babic) - * Allow customising icons for snippets via `SnippetViewSet.icon` (Daniel Kirkham, Sage Abdullah) * Allow customising the base URL and URL namespace for snippet views (Sage Abdullah) * Allow customising the number of items per page for snippet listing views (Sage Abdullah) * Re-label "StreamField blocks" option in block picker to "Blocks" (Thibaud Colas) - * Re-implement styleguide icons list as an auto-generated sequence of tables (Thibaud Colas) * Switch styleguide navigation to use panel components and minimap (Thibaud Colas) * Explicitly specify `MenuItem.name` for Snippets, Reports, and Settings menu items (Sage Abdullah) * Move the help text of fields and blocks directly below their label for easier reading (Thibaud Colas) @@ -93,7 +105,6 @@ Support for adding custom validation logic to StreamField blocks has been formal ### Documentation * Add code block to make it easier to understand contribution docs (Suyash Singh) - * Add new "Icons" page for icons customisation and reuse across the admin interface (Coen van der Kamp, Thibaud Colas) * Fix broken formatting for MultiFieldPanel / FieldRowPanel permission kwarg docs (Matt Westcott) * Add helpful troubleshooting links and refine wording for getting started with development (Loveth Omokaro) * Ensure search autocomplete overlay on mobile does not overflow the viewport (Ayman Makroo) @@ -131,9 +142,6 @@ Support for adding custom validation logic to StreamField blocks has been formal * Improve performance of determining live page URLs across the admin interface using [`pageurl` template tag](performance_page_urls) (Satvik Vashisht) * Migrate `window.initSlugAutoPopulate` behaviour to a Stimulus Controller `w-sync` (Loveth Omokaro) * Rename `status` classes to `w-status` to align with preferred CSS class naming conventions (Mansi Gundre) - * Remove unused `icon-help` and `help-inverse` code (Thibaud Colas) - * Migrate privacy switch, FileFields, history buttons, error messages, Datetimepicker, ordering icons, thumbnails, ModelAdmin, page listings, workflows, and user creation form controls to SVG icons (Thibaud Colas) - * Switch form submission listings to use the same ordering icons as other listings (Thibaud Colas) * Include wagtail-factories in `wagtail.test.utils` to avoid cross-dependency issues (Matt Westcott) * Fix search tests to correctly reflect behaviour of search backends other than the fallback backend (Matt Westcott) * Migrate select all checkbox in simple translation's submit translation page to Stimulus controller `w-bulk`, remove inline script usage (Hanoon) @@ -373,3 +381,38 @@ Note that a new template tag has been built for usage within the admin that may {% status "live" url="/test-url/" title=trans_title hidden_label=trans_hidden_label classname="w-status--primary" attrs='target="_blank" rel="noreferrer"' %} {% status status_label classname="w-status--primary" %} ``` + +### Deprecated icon font + +The Wagtail icon font has been deprecated and will be removed in a future release, as it is now unused in Wagtail itself. There are no changes to make for any icons usage via dedicated APIs such as `icon` class properties. Any direct icon font usage needs to be converted to SVG icons instead, as documented in our [icons overview](icons). + +To check whether your project uses the icon font, check for occurrences of: + +* Loading of the `wagtail.woff` font file. +* Usage of `font-family: wagtail` in CSS. +* `icon-` CSS classes outside of SVG elements. + +### Deprecated icons + +The following icons are unused in Wagtail itself and will be removed in a future release. If you are using any of these icons, please replace them with an alternative (see our full [list of icons](icons)), or re-add the icon to your own project. + +| Icon name | Alternative | +| -------------------- | ---------------------------- | +| `angle-double-left` | `arrow-left` | +| `angle-double-right` | `arrow-right` | +| `arrow-down-big` | `arrow-down` | +| `arrow-up-big` | `arrow-up` | +| `arrows-up-down` | `order` | +| `chain-broken` | `link` | +| `chevron-down` | `arrow-down` (identical) | +| `dots-vertical` | `dots-horizontal` | +| `download-alt` | `download` (identical) | +| `duplicate` | `copy` (identical) | +| `ellipsis-v` | `dots-horizontal` | +| `horizontalrule` | `minus` | +| `repeat` | `rotate` | +| `reset` | `rotate` | +| `tick` | `check` (identical) | +| `undo` | `rotate` | +| `uni52` | `folder-inverse` (identical) | +| `wagtail-inverse` | `wagtail-icon` |