Strapi v4 - Navigation plugin
+Strapi - Navigation plugin
Create consumable navigation with a simple and straightforward visual builder
@@ -30,6 +30,7 @@ Strapi Navigation Plugin provides a website navigation / menu builder feature fo
- Tree (nested)
- RFR (ready for handling by Redux First Router)
+
### Table of Contents
1. [💎 Versions](#-versions)
2. [✨ Features](#-features)
@@ -54,8 +55,8 @@ Strapi Navigation Plugin provides a website navigation / menu builder feature fo
17. [👨💻 Community support](#-community-support)
## 💎 Versions
-- **Strapi v5** - [v3.x](https://github.com/VirtusLab-Open-Source/strapi-plugin-navigation/tree/v5)
-- **Strapi v4** - (current) [v2.x](https://github.com/VirtusLab-Open-Source/strapi-plugin-navigation)
+- **Strapi v5** - (current) [v3.x](https://github.com/VirtusLab-Open-Source/strapi-plugin-navigation)
+- **Strapi v4** - [v2.x](https://github.com/VirtusLab-Open-Source/strapi-plugin-navigation/tree/strapi-v4)
- **Strapi v3** - [v1.x](https://github.com/VirtusLab-Open-Source/strapi-plugin-navigation/tree/strapi-v3)
## ✨ Features
@@ -70,14 +71,9 @@ Strapi Navigation Plugin provides a website navigation / menu builder feature fo
- **Customizable:** Possibility to customize the options like: available Content Types, Maximum level for "attach to menu", Additional fields (audience)
- **[Audit log](https://github.com/VirtusLab/strapi-molecules/tree/master/packages/strapi-plugin-audit-log):** integration with Strapi Molecules Audit Log plugin that provides changes track record
-## ⚙️ Versions
-
-- **Strapi v4** - (current) - [v2.x](https://github.com/VirtusLab-Open-Source/strapi-plugin-navigation)
-- **Strapi v3** - [v1.x](https://github.com/VirtusLab-Open-Source/strapi-plugin-navigation/tree/strapi-v3)
-
## ⏳ Installation
-### Via Strapi Markerplace
+### Via Strapi Marketplace
As a ✅ **verified** plugin by Strapi team we're available on the [**Strapi Marketplace**](https://market.strapi.io/plugins/strapi-plugin-navigation) as well as **In-App Marketplace** where you can follow the installation instructions.
@@ -90,7 +86,7 @@ As a ✅ **verified** plugin by Strapi team we're available on the [**Strapi Mar
It's recommended to use **yarn** to install this plugin within your Strapi project. [You can install yarn with these docs](https://yarnpkg.com/lang/en/docs/install/).
```bash
-yarn add strapi-plugin-navigation@latest
+yarn add strapi-plugin-navigation@beta
```
After successful installation you've to re-build your Strapi instance. To archive that simply use:
@@ -100,12 +96,6 @@ yarn build
yarn develop
```
-or just run Strapi in the development mode with `--watch-admin` option:
-
-```bash
-yarn develop --watch-admin
-```
-
The **UI Navigation** plugin should appear in the **Plugins** section of Strapi sidebar after you run app again.
You can manage your multiple navigation containers by going to the **Navigation** manage view by clicking "Manage" button.
@@ -124,20 +114,18 @@ Complete installation requirements are exact same as for Strapi itself and can b
**Supported Strapi versions**:
-- Strapi v4.25.11 (recently tested)
-- Strapi v4.x
+- Strapi v5.5.1 (recently tested)
+- Strapi v5.x
-> This plugin is designed for **Strapi v4** and is not working with v3.x. To get version for **Strapi v3** install version [v1.x](https://github.com/VirtusLab-Open-Source/strapi-plugin-navigation/tree/strapi-v3).
+> This plugin is designed for **Strapi v5** and is not working with v4.x. To get version for **Strapi v4** install version [v4.x](https://github.com/VirtusLab-Open-Source/strapi-plugin-navigation/tree/strapi-v4).
**We recommend always using the latest version of Strapi to start your new projects**.
## 🔧 Configuration
-To start your journey with **Navigation plugin** you must first setup it using the dedicated Settings page (`v2.0.3` and newer) or for any version, put your configuration in `config/plugins.js`. Anyway we're recommending the click-through option where your configuration is going to be properly validated.
-
-### In `v2.0.3` and newer
+To start your journey with **Navigation plugin** you must first setup it using the dedicated Settings page or for any version, put your configuration in `config/plugins.js`. Anyway we're recommending the click-through option where your configuration is going to be properly validated.
-Version `2.0.3` introduces the intuitive **Settings** page which you can easily access via `Strapi Settings -> Section: Navigation Plugin -> Configuration`.
+### Settings page
On the dedicated page, you will be able to set up all crucial properties which drive the plugin and customize each individual collection for which **Navigation plugin** should be enabled.
@@ -148,15 +136,10 @@ On the dedicated page, you will be able to set up all crucial properties which d
> *Note*
> The default configuration for your plugin is fetched from `config/plugins.js` or, if the file is not there, directly from the plugin itself. If you would like to customize the default state to which you might revert, please follow the next section.
-### In `v2.0.2` and older + default configuration state for `v2.0.3` and newer
+### File
Config for this plugin is stored as a part of the `config/plugins.js` or `config/
-
- onItemRemove(item)}
- onItemEdit={() => onItemEdit({
- ...item,
- isMenuAllowedLevel,
- isParentAttachedToMenu,
- isSearchActive: false,
- }, levelPath, isParentAttachedToMenu)}
- onItemRestore={() => onItemRestore(item)}
- dragRef={refs.dragRef}
- removed={removed}
- canUpdate={canUpdate}
- isSearchActive={isSearchActive}
- />
-
-
-
-
- {!isEmpty(item.items) && onItemToggleCollapse(item)} collapsed={collapsed} itemsCount={item.items.length}/>}
- {canUpdate && (
- {getMessage("components.navigationItem.action.newItem")}
-
- )}
-
- {relatedItemLabel && (
-
- {isHandledByPublishFlow && (
- {getMessage({id: `components.navigationItem.badge.${isPublished ? 'published' : 'draft'}`})}
- )}
- {relatedTypeLabel} /
- {relatedItemLabel}
- }>
- )
- }
-
- )}
-
-
+
+
+
+
+
+ {!isEmpty(item.items) && (
+ onItemToggleCollapse({ ...item, viewParentId })}
+ collapsed={mappedItem.collapsed}
+ itemsCount={item.items?.length ?? 0}
+ />
+ )}
+ {canUpdate && isNextMenuAllowedLevel && (
+
+ {formatMessage(getTrad('components.navigationItem.action.newItem'))}
+
+
+ )}
+
+ {mappedItem.type === 'INTERNAL' && mappedItem.related && !relatedItem.id ? (
+
+
+ {relatedTypeLabel} /
+
+
+ {formatMessage(getTrad('components.navigationItem.related.localeMissing'))}
+
+
+ ) : null}
+ {relatedItemLabel && (
+
+ {isHandledByPublishFlow && (
+
+ {formatMessage(
+ getTrad(
+ `components.navigationItem.badge.${isPublished ? 'published' : 'draft'}`
+ )
+ )}
+
+ )}
+
+ {relatedTypeLabel} /
+
+
+ {relatedItemLabel}
+
+ }
+ >
+
+
+
+ )}
+
+
+ )}
+
+ |
+ |
+
+ |
+
+ |
+
+ |
+
+ |
+
+ {configQuery.data?.isCacheEnabled ? (
+ |
+
|---|---|---|---|---|---|
|
+ |
+
+ |
+
+ |
+
+ |
+
+ |
+
+ |
+