westerveltco/wagtail-heroicons

Add Heroicons to the Wagtail admin.

wagtail-heroicons's Issues

"TypeError: '<' not supported between instances of 'PosixPath' and 'str'" whenever using wagtail_heroicons

Adding "wagtail_heroicons" to INSTALLED_APPS gives the following error (on the latest version of Wagtail, on linux)

  File "/home/reijer/.pyenv/versions/clean-test/lib/python3.10/site-packages/wagtail/admin/views/home.py", line 388, in sprite
    return HttpResponse(icons())
  File "/home/reijer/.pyenv/versions/clean-test/lib/python3.10/site-packages/wagtail/admin/views/home.py", line 368, in icons
    all_icons = sorted(
TypeError: '<' not supported between instances of 'PosixPath' and 'str'

Steps to reproduce

• Create clean python virtual environment. (I used Python 3.10.11)
• Install wagtail pip install wagtail
• Create empty project wagtail start mysite
• In mysite, run migrations.
• Add "wagtail_heroicons" to INSTALLED_APPS
• python manage.py runserver gives the above error.

Changing line 14 of src/wagtail_heroicons/wagtail_hooks.py to read icons.append(str(icon.path)) instead of icons.append(icon.path) fixes the issue.

Explore writing a custom Template loader to load from zip file

Related to #28, in the heroicon package the icons are actually stored in a zip file to save space. This poses a problem for how Wagtail deals with SVG icons, as it expects the SVG to be a template somewhere where a template loader can find it.

As far as I can tell, Django does not come with a way to load templates from a zip. We may need to write a custom one, utilizing heroicons._load_icon or heroicons._render_icon in some way.

https://docs.djangoproject.com/en/4.1/ref/templates/api/#custom-loaders

Write initial documentation and create docs site on Read The Docs

This will always be a simple package and we could get away with having no separate documentation outside the README, however I always find it comforting when trying out a new package that it has documentation, even if it's a small package.

Explore migrating to using @adamchainz's `heroicon` package

https://github.com/adamchainz/heroicons