janbuecker/sculpin-meta-navigation-bundle

Sculpin Meta Navigation Bundle

v0.9 2022-08-26 12:04 UTC

This package is auto-updated.

Last update: 2023-01-26 12:56:21 UTC


README

This bundle creates a multidimensional array based on meta options of pages. It can be implemented using the page.menu twig variable.

Setup

Add this bundle in your composer.json file by requiring it:

composer require janbuecker/sculpin-meta-navigation-bundle ^0.7

Now you can register the bundle in your SculpinKernel class available on app/SculpinKernel.php file:

class SculpinKernel extends \Sculpin\Bundle\SculpinBundle\HttpKernel\AbstractKernel
{
    protected function getAdditionalSculpinBundles()
    {
        return [
           'Janbuecker\Sculpin\Bundle\MetaNavigationBundle\SculpinMetaNavigationBundle'
        ];
    }
}

Usage

All files in source will be recognized as a Content Type Page. A Twig variable page.menu can be looped to automatically generate a menu. This menu is limited to 3 dimensions.

To make a menu item visible, you have to add a menu_title to the page.

Options

  • menu_title
    Menu item title
  • menu_order
    Position of the item, low number equals top position
  • menu_style
    An additional variable to set the list style option
  • menu_chapter
    Simple boolean to inform the menu that it is a simple text
  • group
    Parent menu item title on the first dimension (root)
  • subgroup
    Parent menu item title on the second dimension

License

The MIT License (MIT). Please see License File for more information.