- Django >= 3.2
- Wagtail >= 3.0
- Bootstrap >= 4
This installation assumes that you already have Django 3.2+ and Wagtail 3.0+ installed as part of your project.
Wagtail Gridder can then be installed like most Django apps. First, install it into your
pip install wagtailgridder
wagtailgridder to your list of
INSTALLED_APPS in your Django settings file. You will also need to add
wagtail.contrib.modeladmin, if you haven't already. Your final settings may look something like this:
WAGTAIL_APPS = [ 'taggit', 'modelcluster', 'wagtail.core', 'wagtail.admin', 'wagtail.documents', 'wagtail.snippets', 'wagtail.users', 'wagtail.images', 'wagtail.embeds', 'wagtail.search', 'wagtail.sites', ] WAGTAIL_CONTRIB_APPS = [ 'wagtailgridder', 'wagtail.contrib.modeladmin', ] INSTALLED_APPS = INSTALLED_APPS + WAGTAIL_APPS + WAGTAIL_CONTRIB_APPS
This Wagtail Gridder template extends
base.html, with the hope that this allows inclusion or your site's top and bottom navigation without much effort. There is an example base.html provided.
Then log into the Wagtail admin, and you should see a "Grid Layouts" section of the menu. The first thing you will want to do is add some "Grid Categories." After that, you can create "Grid Items" (the cards, pictured below) and put them together on a "Grid Index Page."
WAGTAILGRIDDER_CLEAR_CACHE = False
The default Wagtail Gridder template caches the grid display area to reduce the number of queries performed. Setting
WAGTAILGRIDDER_CLEAR_CACHE = True in your Django settings will clear the entire Django cache after a page is edited. This approach is necessary, as Django does not currently support deletion from the cache by pattern. Setting this to
True will clear your cache every time you save a Wagtail page. If anyone knows of a better solution that works for Django's supported cache systems, please let us know!
WAGTAILGRIDDER_GRID_ITEM_PARENT_PAGE_TYPES = ["GridIndexPage"]
By default, GridItem pages may only be created as children of GridIndexPage pages. To
allow GridItem pages under any parent, set
WAGTAILGRIDDER_GRID_ITEM_PARENT_PAGE_TYPES = None. See the Wagtail Documentation
WAGTAILGRIDDER_GRID_INDEX_PAGE_SUBPAGE_TYPES = ["GridItem"]
By default, GridIndexPage pages may only have GridItem pages as children. To allow GridIndexPage pages to have other child types, set
WAGTAILGRIDDER_GRID_INDEX_PAGE_SUBPAGE_TYPES = None. See the Wagtail Documentation for more details.
GridIndexPage is inherited from an abstract model, GridIndexPageAbstract, which you may wish to customize.
Grid Index Page:
Grid Index Page, with Grid Item expanded:
Optional featured hero region:
Grid Item landing page:
Editing a Grid Item:
Editing a Grid Index Page:
This package is maintained by the staff of Wharton Research Data Services. We are thrilled that The Wharton School allows us a certain amount of time to contribute to open-source projects. We add features as they are necessary for our projects, and try to keep up with Issues and Pull Requests as best we can. Due to constraints of time (our full time jobs!), Feature Requests without a Pull Request may not be implemented, but we are always open to new ideas and grateful for contributions and our package users.