PHPackages dutchheight/craft-navie - PHPackages - PHPackages [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register) 1. [Directory](/) 2. / 3. [Utility & Helpers](/categories/utility) 4. / 5. dutchheight/craft-navie ActiveCraft-plugin[Utility & Helpers](/categories/utility) dutchheight/craft-navie ======================= Navigation plugin for Craft CMS 3 1.2.3(6y ago)23.5k1[3 issues](https://github.com/dutchheight/craft-navie/issues)proprietaryPHPCI failing Since Jun 12Pushed 5y ago1 watchersCompare [ Source](https://github.com/dutchheight/craft-navie)[ Packagist](https://packagist.org/packages/dutchheight/craft-navie)[ RSS](/packages/dutchheight-craft-navie/feed)WikiDiscussions master Synced 2w ago READMEChangelog (10)Dependencies (1)Versions (15)Used By (0) Navie plugin for Craft CMS 3.x ============================== [](#navie-plugin-for-craft-cms-3x) Navigation plugin for Craft CMS 3 with GraphQL and custom field support. Navie allow's you to add custom fields to your navigation items. [![Screenshot](resources/img/plugin-logo.png)](resources/img/plugin-logo.png) [![Add custom fields](resources/img/add-custom-fields.png)](resources/img/add-custom-fields.png) Add custom fields [![Add link](resources/img/create-new-list-item.png)](resources/img/create-new-list-item.png) Add link to list [![Use custom fields](resources/img/create-a-new-list-tem-custom-field.png)](resources/img/create-a-new-list-tem-custom-field.png) Use custom fields Requirements ------------ [](#requirements) This plugin requires Craft CMS 3.0.0 or later. Installation ------------ [](#installation) To install the plugin, follow these instructions. 1. Open your terminal and go to your Craft project: ``` cd /path/to/project ``` 2. Then tell Composer to load the plugin: ``` composer require dutchheight/craft-navie ``` 3. In the Control Panel, go to Settings → Plugins and click the “Install” button for Navie. 4. Create a list 5. Render in template. See [Display a navie list](#display-a-navie-list) Navie Features -------------- [](#navie-features) - Multiple menus/lists - Multisite support - GraphQL support - Default linktypes (Entry, Url, Category, Asset) - Add custom linktypes per menu by adding fields - Rich API - Editable plugin name - Permissions (manage lists and edit settings) - Permissions for each list (show, create, edit and delete) - Eager loading (Entry, Category, Asset) Using Navie with Twig --------------------- [](#using-navie-with-twig) ### Display a navie list [](#display-a-navie-list) `craft.navie.render(handle, options)` is used to display a list. You can provide styling options. AttributeTypeRequiredDescriptionhandlestringtruehandle specified in the settingsoptionsobjectfalseFor more info see [Available Options](#available-options)#### Available Options [](#available-options) ``` { ulClass: 'class', ulAttributes: { 'style': 'margin-top: 10;' }, ulChildClass: 'class', ulChildAttributes: { 'style': 'margin-top: 10;' }, listClass: 'class', listAttributes: { 'style': 'margin-top: 10;' }, linkClass: 'class', linkAttributes: { 'style': 'margin-top: 10;' }, linkActiveClass: 'active' } ``` #### Examples [](#examples) Render a navie list: ``` {{  craft.navie.render('main', { ulChildAttributes: { 'style': 'margin-top: 0.25rem;', 'data-option': 'custom data option', } })  }} ``` --- ### Get navie list items raw [](#get-navie-list-items-raw) `craft.navie.items(criteria)` is used to get a list items. This allows you [Check Craft Element queries for more info](https://docs.craftcms.com/v3/dev/element-queries/). Each item AttributeTypeRequiredDescriptioncriteriaarrayfalseCraft entry criteria#### Examples [](#examples-1) Get all items ``` {% set items = craft.navie.items() .list('main') .all() %} ``` Get items limited by level ``` {% set items = craft.navie.items() .list('main') .level(1) %} ``` Get all items Eager loaded ``` {% set items = craft.navie.items() .list('main') .with(['entry', 'category', 'asset']) .all() %} ``` Now you are able to use `items.getElement().title` without extra queries. This is also posible without eager loading but at a peformance cost. --- Using Navie with GraphQL ------------------------ [](#using-navie-with-graphql) Navie has built-in support for accessing lists and items via GraphQL use native [Craft CMS 3.3 GraphQL](https://docs.craftcms.com/v3/graphql.html). ``` { listItems(list: "main", level: 1) { id, title, url, target, children { id, url, title, target, ... on main_List { # Main is list handle classes } } } } ``` Using Navie with CraftQL Plugin ------------------------------- [](#using-navie-with-craftql-plugin) Navie has built-in support for accessing lists and items via GraphQL use the [CraftQL plugin](https://github.com/markhuot/craftql). You can retrieve all the lists with their fields: ``` { navie { lists { id, structureId, fieldLayoutId, maxLevels, name, handle, uid, propagate } } } ``` You can also retrieve all list items with their fields and even the custom fields on the list ``` { navie { items(list: main) { title, url, target, children { title, url, target ... on MainList { classes } }, ... on MainList { classes } } } } ``` --- Navie Roadmap ------------- [](#navie-roadmap) Some things to do, and ideas for potential features: - Settings for available link types - Support Project.yaml - Custom link type registration Brought to you by [Dutch Height](https://www.dutchheight.com) ### Health Score 28 — LowBetter than 51% of packages Maintenance0 Infrequent updates — may be unmaintained Popularity20 Limited adoption so far Community11 Small or concentrated contributor base Maturity68 Established project with proven stability Bus Factor1 Top contributor holds 70.5% of commits — single point of failure How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window. **Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores. **Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement. **Maturity (30%)** — Project age, version count, PHP version support, and release stability. ### Release Activity Cadence Every ~21 days Total 12 Last Release 2384d ago ### Community Maintainers ![](https://avatars.githubusercontent.com/u/35805643?v=4)[Dutch Height](/maintainers/dutchheight)[@dutchheight](https://github.com/dutchheight) --- Top Contributors [![freimutt](https://avatars.githubusercontent.com/u/11332285?v=4)](https://github.com/freimutt "freimutt (31 commits)")[![KevinBeckers](https://avatars.githubusercontent.com/u/4037137?v=4)](https://github.com/KevinBeckers "KevinBeckers (10 commits)")[![KevinBeckersDH](https://avatars.githubusercontent.com/u/207697977?v=4)](https://github.com/KevinBeckersDH "KevinBeckersDH (3 commits)") --- Tags cmsCraftcraftcmscraft-pluginnavie ### Embed Badge ![Health badge](/badges/dutchheight-craft-navie/health.svg) ``` [![Health](https://phpackages.com/badges/dutchheight-craft-navie/health.svg)](https://phpackages.com/packages/dutchheight-craft-navie) ``` ### Alternatives [verbb/formie The most user-friendly forms plugin for Craft. 101400.6k78](/packages/verbb-formie)[nystudio107/craft-seomatic SEOmatic facilitates modern SEO best practices & implementation for Craft CMS 5. It is a turnkey SEO system that is comprehensive, powerful, and flexible. 1741.5M73](/packages/nystudio107-craft-seomatic)[verbb/hyper A user-friendly links field for Craft. 24153.5k14](/packages/verbb-hyper)[verbb/vizy A flexible visual editor field for Craft. 4251.5k1](/packages/verbb-vizy)[verbb/comments Add comments to your site. 13754.0k1](/packages/verbb-comments)[verbb/navigation Create navigation menus for your site. 90711.5k20](/packages/verbb-navigation) PHPackages © 2026 [Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)