Skip to main content

Wagtail Nav Menus is a app to provide highly customizable menus in wagtail by leveraging StreamFields.

Project description

Wagtail Nav Menus is a app to provide highly customizable menus in wagtail by leveraging StreamFields.

Why

Remember when websites had tree structures with logical menus that followed the same structure? For many those days are gone. We are asked to create arbitrary menu items, place value props in menus that aren’t even links, and build highly interactive menus with Javascript.

Wagtail Nav Menus addresses this by using stream fields to support arbitrary items in the menu and gives you options to render the menus as both django templates or json for your js tooling to consume.

demo.png

Built in Components

  • Nav Category - a grouping of other components - for things like sub navigation

  • Page Link - Link to a wagtail Page

  • External Link - Django URLField link

  • Django Link - Reverse django view lookups

  • Relative URL - Regex enforced relative links

  • Image

  • Html

Install

  1. Install wagtail-nav-menus with pip.

  2. Add wagtail_nav_menus to INSTALLED_APPS.

Settings

You can add other streamfields like this:

from wagtail_nav_menus.defaults import WAGTAIL_NAV_MENU_TYPES_DEFAULT

WAGTAIL_NAV_MENU_TYPES = WAGTAIL_NAV_MENU_TYPES_DEFAULT + [
    ('page_link_with_image', 'nav_menus_ext.models', 'InternalPageImageBlock'),
    ('page_link_with_image', 'nav_menus_ext.models', 'NavAdvertBlock'),
]

The schema here is (‘name’, ‘module_path’, ‘class name’)

Edit menu name choices. The default is top and footer. These represent different menus for your webpage. The names are arbitrary - but you will look them up by name in templates.

WAGTAIL_NAV_MENU_CHOICES_DEFAULT = (
    ("top", "Top"),
    ("footer", "Footer"),
)

Usage

Nav Menus should appear in wagtail’s settings sidebar tab. CMS uses can control them here.

You may use some template tags to use these in your site.

get_nav_menu

Use this to insert the menu using django templates:

{% load nav_menu_tags %}
{% get_nav_menu 'footer' %}

See the [templates folder](wagtail_nav_menus/templates/) in this repo for examples of rendering the menu. You will want to copy these into your project’s template folder to extend them.

get_nav_menu_json

Use this to get the menu as a json object.

{% load nav_menu_tags %}
{% get_nav_menu_json 'top' as top %}
<div data-menu='{{ top }}'></div>

API Usage

If using Django Rest Framework to access the menu data, this module provides some tools to get started.

Add NavMenuViewSet to your Rest Framework Router.

from wagtail_nav_menus.viewsets import NavMenuViewSet

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

wagtail_nav_menus-3.13.2.tar.gz (15.1 kB view details)

Uploaded Source

Built Distribution

wagtail_nav_menus-3.13.2-py3-none-any.whl (21.1 kB view details)

Uploaded Python 3

File details

Details for the file wagtail_nav_menus-3.13.2.tar.gz.

File metadata

  • Download URL: wagtail_nav_menus-3.13.2.tar.gz
  • Upload date:
  • Size: 15.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.3

File hashes

Hashes for wagtail_nav_menus-3.13.2.tar.gz
Algorithm Hash digest
SHA256 8434caaae3f9b31c45daded4d23ced1aa4609f7860eaa059d08beecdf3369422
MD5 c7662c92e51399cfcb0765f19b6c5d27
BLAKE2b-256 73735165bfaef380ab9b81df5e07db1df73d24bf4783401b55095789c5ec3777

See more details on using hashes here.

Provenance

The following attestation bundles were made for wagtail_nav_menus-3.13.2.tar.gz:

Publisher: .gitlab-ci.yml on thelabnyc/wagtail-nav-menus

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file wagtail_nav_menus-3.13.2-py3-none-any.whl.

File metadata

File hashes

Hashes for wagtail_nav_menus-3.13.2-py3-none-any.whl
Algorithm Hash digest
SHA256 f88557af4cab2a15582008d3e14e36cf28de9c091498ecb911d398ab3e878abb
MD5 e74f57b956aaf7d46b8bec5e5f1aade9
BLAKE2b-256 09e96f349aaf3d9ba5a4e4959843e6ef089948d5d3fe31e12c3bc152f7c02a26

See more details on using hashes here.

Provenance

The following attestation bundles were made for wagtail_nav_menus-3.13.2-py3-none-any.whl:

Publisher: .gitlab-ci.yml on thelabnyc/wagtail-nav-menus

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page