Create interactive navigation menus anywhere in your help center.
The Navigation extension allows you to create dynamic, interactive navigation elements anywhere in your help center quickly and easily without being limited by Zendesk’s native page template and objects.
The Navigation extension is bundled into all of our themes by default, so you can start using it straight away. You can find the source code for the extension within the extension-navigation.(min.)js file in the theme’s Assets folder.
Our themes allow you to add pre-built navigation menus on the Category, Section and Article pages using theme settings.
In Zendesk Guide, click the Customize design icon () in the sidebar.
Click Customize on the theme you want to edit.
Expand the Category page elements, Section page elements or Article page elements sections and select a navigation style from the sidebar navigation setting.
If data attributes are used you will need to ensure that the allow unsafe HTML setting is enabled within Zendesk Guide.
When using a custom micro-template, each object has an additional property (isActive) which specifies whether it’s active (meaning it, or one of its child or descendant objects, is being viewed).
This is useful if you’re creating navigation menus with nested subsections, where two or more sections may have an isActive value of true, as activeSectionId represents the section actually being viewed (if any).
Additional custom data can be supplied to the template using the templateData option described below.
An object containing an array of objects representing categories, sections, articles, topics and/or posts. If the collection is not provided, the extension will fetch the objects specified in the option below from the Zendesk REST API.
[ 'categories', 'sections', 'articles' ]
The list of object types to fetch from the REST API and make available to the template.