Download the PHP package belugadigital/kirby-navigation without Composer
On this page you can find all versions of the php package belugadigital/kirby-navigation. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download belugadigital/kirby-navigation
More information about belugadigital/kirby-navigation
Files in belugadigital/kirby-navigation
Package kirby-navigation
Short Description Kirby 4 field for hierarchical menus with drag & drop level indentation.
License MIT
Homepage https://github.com/chrisbeluga/kirby-navigation
FAQ
Example:
In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
- Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
- To use Composer is sometimes complicated. Especially for beginners.
- Composer needs much resources. Sometimes they are not available on a simple webspace.
- If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
- Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Informations about the package kirby-navigation
Kirby Navigation Field
A Navigation field for Kirby CMS.
Preview
Installation & Usage
Copy plugin files to your plugin's directory or install via composer with composer require belugadigital/kirby-navigation
Note that this Composer package name (belugadigital/kirby-navigation) differs from the GitHub repository URL (chrisbeluga/kirby-navigation).
Kirby compatibility table
| Kirby version | Compatible plugin version |
|---|---|
| ^4.0 | ^4.0 |
| ^3.7 | ^3.0 |
| ^3.6 | ^2.0 |
| ^3.5 | ^1.0 |
Usage
Add the following blueprint to wherever you would like the navigation field to appear:
Or use the following minimalist blueprint without extra options:
The following example shows how you can output a menu from a template file, regardless of how many levels deep the menu is. This example assumes that the "site" blueprint contains a navigation field called "navigation":
If using the site as a headless CMS or would like to consume your menu in JS you can use the following field method to return a nested array of menu items:
Or when using Kirby Query language
If you want full control over your menu and want to customize the markup, you can copy the navigation.php and navigation_item.php files from the plugin's snippets directory to your /site/snippets directory, and customize them there. This is the recommended way of markup customization. For example, to add class="navigation-item navigation-item-X" to each link item, where X is the depth level of the given link, you can add the following line to your copy of navigation_item.php:
If you prefer to use a foreach to create the menu, or if you are upgrading from an older version of this plugin, the foreach loop could look something like this:
Nesting limit
Nesting limit is set to 10 by default. To adjust the maximum number of levels, use the "levels" option in the blueprint.
Multi-language support
The plugin supports multiple languages in two ways.
- In "normal" mode, the navigation field functions like any other content field: you need to add the necessary links to the field for each language, and set the link text and link title for each language (translating). For example, if you have 3 languages and a navigation field with 5 links, you will need to add the 5 links 3 times.
- In "multilang" mode, add the "multilang: true" option to the field blueprint. This allows you to add the necessary links only once for all languages, and edit the link text and link title separately for each language. For example, if you have 3 languages and a navigation field with 5 links, you will only need to add the 5 links once, and they will be shared across all languages. You can still translate the link text and link title, if needed.
This means that if you simply add 5 Kirby pages to the field in multilang mode and don't edit the links, the link text will be displayed in the language of the current page, and will link to the corresponding page URL in that language.
The plugin allows you to add "Kirby Pages" and "Custom Links" to the navigation field. For "Kirby Pages", the page title will be the default value of the link text, if no custom link text is entered. This means that if you simply add 5 Kirby pages to the field in multilang mode and don't edit the links, you will see the language-specific page title and page URL in the generated markup.
What is new in version 4.0?
Changes worth mentioning:
- It works with Kirby 4
- New feature: Multi-language support, as described earlier
- New feature: The plugin now uses permanent page IDs to identify pages, instead of using the 'id' (slug) as identification. This allows pages to be renamed or moved without breaking the page links.
- Data: the structure of the field content has been changed to support permanent page IDs and multiple languages. However, the 4.0 version of the plugin is backwards compatible with the field content saved by the 3.7 version of the plugin.
- UI: The "edit" button has been moved out of the options dropdown menus.
- UI: Better icons are now used for editing the links.
- UI: The 'id' and 'url' values of 'Kirby page' links are no longer editable.
- Markup: the current language and the actual values of the page title and page URL are taken into account when generating the markup for the field in the template.
- Markup: link text and link attributes are properly escaped to prevent potential issues
Contributing
Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.
