- Notifications
You must be signed in to change notification settings - Fork69
A plugin for Strapi Headless CMS that provides navigation / menu builder feature with their possibility to control the audience and different output structure renderers like (flat, tree and RFR - ready for handling by Redux First Router)
License
VirtusLab-Open-Source/strapi-plugin-navigation
Folders and files
| Name | Name | Last commit message | Last commit date | |
|---|---|---|---|---|
Repository files navigation
Create consumable navigation with a simple and straightforward visual builder
A plugin forStrapi Headless CMS that provides navigation / menu builder feature with their possibility to control the audience and different output structure renderers:
- Flat
- Tree (nested)
- RFR (ready for handling by Redux First Router)
(Useyarn to install this plugin within your Strapi project (recommended).Install yarn with these docs.)
yarn add strapi-plugin-navigation@latest-v3
After successful installation you've to build a fresh package that includes plugin UI. To archive that simply use:
yarn buildyarn develop
or just run Strapi in the development mode with--watch-admin option:
yarn develop --watch-admin
TheUI Navigation plugin should appear in thePlugins section of Strapi sidebar after you run app again.
Enjoy 🎉
Complete installation requirements are exact same as for Strapi itself and can be found in the documentation underInstallation Requirements.
Supported Strapi versions:
- Strapi v3.6.8 (recently tested)
- Strapi v3.x
(This plugin may work with the older Strapi versions, but these are not tested nor officially supported at this time.)
We recommend always using the latest version of Strapi to start your new projects.
- Navigation Public API: Simple and ready for use API endpoint for getting the navigation structure you've created
- Visual builder: Elegant and easy to use visual builder
- Any Content Type relation: Navigation can by linked to any of your Content Types by default. Simply, you're controlling it and also limiting available content types by configuration props
- Customizable: Possibility to customize the options like: available Content Types, Maximum level for "attach to menu", Additional fields (audience)
- Audit log: integration with Strapi Molecules Audit Log plugin that provides changes track record
We can define inconfig/plugins.js
navigation:{ ...relatedContentTypes:['application::pages.pages'], ...},
To setup the plugin properly we recommend to put following snippet as part ofconfig/plugins.js orconfig/<env>/plugins.js file. If you've got already configurations for other plugins stores by this way, use just thenavigation part within exisingplugins item.
...navigation:{additionalFields:['audience'],allowedLevels:2,contentTypesNameFields:{'blog_posts':['altTitle'],'pages':['title'],},gql:{ ...}}, ...
additionalFields- Additional fields: 'audience', more in the futureallowedLevels- Maximum level for which your're able to mark item as "Menu attached"contentTypesNameFields- Definition of content type title fields like'content_type_name': ['field_name_1', 'field_name_2'], if not set titles are pulled from fields like['title', 'subject', 'name']gql- If you're using GraphQL that's the right place to put all necessary settings. More here
To properly configure GQL to work with navigation you should providegql prop which should contain union types which will be used for define GQL response format for your data while fetching:
master:Intitems: [NavigationItem]related:NavigationRelated
as follows:
gql:{navigationItemRelated:'union NavigationRelated = <your GQL related entities>',},
for example:
gql:{navigationItemRelated:'union NavigationRelated = Pages | UploadFile',},
wherePages andUploadFile are your types to theContent Types you're referring by navigation items relations.
{ "id": 1, "title": "News", "type": "INTERNAL", "path": "news", "externalPath": null, "uiRouterKey": "News", "menuAttached": false, "parent": 8, // Parent Navigation Item 'id', null in case of root level "master": 1, // Navigation 'id' "created_at": "2020-09-29T13:29:19.086Z", "updated_at": "2020-09-29T13:29:19.128Z", "related": [ <Content Type model > ], "audience": []}{ "title": "News", "menuAttached": true, "path": "/news", "type": "INTERNAL", "uiRouterKey": "news", "slug": "benefits", "external": false, "related": { <Content Type model > }, "items": [ { "title": "External url", "menuAttached": true, "path": "http://example.com", "type": "EXTERNAL", "uiRouterKey": "generic", "external": true }, < Tree Navigation Item models > ]}{ "id": "News", "title": "News", "templateName": "pages:1", "related": { "contentType": "page", "collectionName": "pages", "id": 1 }, "path": "/news", "slug": "news", "parent": null, // Parent Navigation Item 'id', null in case of root level "menuAttached": true}GET <host>/navigation/render/<idOrSlug>?type=<type>
Return a rendered navigation structure depends on passed type (tree,rfr or nothing to render asflat/raw).
Note: The ID of navigation by default is1, that's for future extensions and multi-navigation feature.
Example URL:https://localhost:1337/navigation/render/1
Example response body
[ { "id": 1, "title": "News", "type": "INTERNAL", "path": "news", "externalPath": null, "uiRouterKey": "News", "menuAttached": false, "parent": null, "master": 1, "created_at": "2020-09-29T13:29:19.086Z", "updated_at": "2020-09-29T13:29:19.128Z", "related": [{ "__contentType": "Page", "id": 1, "title": "News", ... }] }, ...]Example URL:https://localhost:1337/navigation/render/1?type=tree
Example response body
[ { "title": "News", "menuAttached": true, "path": "/news", "type": "INTERNAL", "uiRouterKey": "news", "slug": "benefits", "external": false, "related": { "__contentType": "Page", "id": 1, "title": "News", ... }, "items": [ { "title": "External url", "menuAttached": true, "path": "http://example.com", "type": "EXTERNAL", "uiRouterKey": "generic", "external": true }, ... ] }, ...]Example URL:https://localhost:1337/navigation/render/1?type=rfr
Example response body
{ "pages": { "News": { "id": "News", "title": "News", "templateName": "pages:1", "related": { "contentType": "page", "collectionName": "pages", "id": 1 }, "path": "/news", "slug": "news", "parent": null, "menuAttached": true }, "Community": { "id": "Community", "title": "Community", "templateName": "pages:2", "related": { "contentType": "page", "collectionName": "pages", "id": 2 }, "path": "/community", "slug": "community", "parent": null, "menuAttached": true }, "Highlights": { "id": "Highlights", "title": "Highlights", "templateName": "pages:3", "related": { "contentType": "page", "collectionName": "pages", "id": 3 }, "path": "/community/highlights", "slug": "community-highlights", "parent": "Community", "menuAttached": false }, ... }, "nav": { "root": [ { "label": "News", "type": "internal", "page": "News" }, { "label": "Community", "type": "internal", "page": "Community" }, { "label": "External url", "type": "external", "url": "http://example.com" }, ... ], "Community": [ { "label": "Highlights", "type": "internal", "page": "Highlights" }, ... ], ... }}Depending on a content typetemplateName will be resolved differently
For collection types it will be read from content type's attribute nametemplate holding a component which definition has option namedtemplateName.
For single types a global name of this content type will be used as a template name or it can be set manually with an option namedtemplateName.
If you would like to use theStrapi Molecules Audit Log plugin you've to first install and then add in youconfig/middleware.js following section enable it:
{'audit-log':{enabled:true,exclude:[],map:[{pluginName:'navigation',serviceName:'navigation',Class:Navigation,},]}}
As a last step you've to provide the Navigation class to let Audit Log use it. To not provide external & hard dependencies we've added the example of class code in theexamples/audit-log-integration.js .
Live example of plugin usage can be found in theVirtusLab Strapi Examples repository.
Q: I've recognizedNavigation Item andNavigation collection types in the Collections sidebar section, but they are not working properly. What should I do?
A: As an authors of the plugin we're not supporting any editing of mentioned content types via built-in Strapi Content Manager. Plugin delivers highly customized & extended functionality which might be covered only by dedicated editor UI accessible viaPlugins Section > UI Navigation. Only issues that has been recognized there, are in the scope of support we've providing.
Feel free to fork and make a Pull Request to this plugin project. All the input is warmly welcome!
For general help using Strapi, please refer tothe official Strapi documentation. For additional help, you can use one of these channels to ask a question:
- Slack We're present on official Strapi slack workspace. Look for @cyp3r and DM.
- Slack - VirtusLab Open Source We're present on a public channel #strapi-molecules
- GitHub (Bug reports, Contributions, Questions and Discussions)
- E-mail - we will respond back as soon as possible
MIT License Copyright (c)VirtusLab Sp. z o.o. &Strapi Solutions.
About
A plugin for Strapi Headless CMS that provides navigation / menu builder feature with their possibility to control the audience and different output structure renderers like (flat, tree and RFR - ready for handling by Redux First Router)
Topics
Resources
License
Uh oh!
There was an error while loading.Please reload this page.
Stars
Watchers
Forks
Uh oh!
There was an error while loading.Please reload this page.