Skip to content

Latest commit

richardhand @releng - 2.8.0 Pre-release - Documentation (#868)
- adds 2.8.0 to README and VERSIONS.
- adds 2.8.0 to Component Library.
- formatting fixes.
- comment fixes.
Latest commit 9ee5102 Dec 5, 2019

Files

Permalink
Type Name Latest commit message Commit time
..
Failed to load latest commit information.
_cq_design_dialog [Navigation] Exclude root levels options #151 (#249) (#836) Dec 2, 2019
_cq_dialog @releng - 2.8.0 Pre-release - Documentation (#868) Dec 5, 2019
clientlibs Migrate unit test to aem mocks 2.7 (#708) Aug 30, 2019
.content.xml Migrate unit test to aem mocks 2.7 (#708) Aug 30, 2019
README.md [Navigation] Exclude root levels options #151 (#249) (#836) Dec 2, 2019
group.html Migrate unit test to aem mocks 2.7 (#708) Aug 30, 2019
item.html
itemContent.html Migrate unit test to aem mocks 2.7 (#708) Aug 30, 2019
navigation.html Migrate unit test to aem mocks 2.7 (#708) Aug 30, 2019

README.md

Navigation (v1)

Navigation component written in HTL that renders a website navigation tree.

Features

  • Can be used on both templates and pages
  • Defines a configurable navigation root, navigation root depth and structure depth to allow flexibility in building the navigation tree
  • Automatically filters out pages that should be hidden from navigation
  • Automatically handles redirect targets defined on pages

Use Object

The Navigation component uses the com.adobe.cq.wcm.core.components.models.Navigation Sling model as its Use-object.

Component Policy Configuration Properties

The following configuration properties are used:

  1. ./navigationRoot - the root page from which to build the navigation. It can be a blueprint master, language master or regular page.
  2. ./structureStart - the start level of the navigation structure relative to the navigation root.
  3. ./skipNavigationRoot - deprecated; if true, excludes the navigation root in the resulting tree, including its descendants only.
  4. ./collectAllPages - if true, collects all pages that are descendants of the ./navigationRoot. Overrides ./structureDepth.
  5. ./structureDepth - the depth of the navigation structure, relative to the navigation root.

Edit Dialog Properties

The following properties are written to JCR for the Navigation component and are expected to be available as Resource properties:

  1. ./navigationRoot - the root page from which to build the navigation. It can be a blueprint master, language master or regular page.
  2. ./structureStart - the start level of the navigation structure relative to the navigation root.
  3. ./skipNavigationRoot - deprecated; if true, excludes the navigation root in the resulting tree, including its descendants only.
  4. ./collectAllPages - if true, collects all pages that are descendants of the ./navigationRoot. Overrides ./structureDepth.
  5. ./structureDepth - the depth of the navigation structure, relative to the navigation root.
  6. ./accessibilityLabel - defines an accessibility label for the navigation.

Client Libraries

The component provides a core.wcm.components.navigation.v1.editor editor client library category that includes JavaScript handling for dialog interaction. It is already included by its edit and design dialogs.

BEM Description

BLOCK cmp-navigation
    ELEMENT cmp-navigation__group
    ELEMENT cmp-navigation__item
        MOD cmp-navigation__item--active
        MOD cmp-navigation__item--level-*
    ELEMENT cmp-navigation__item-link

Information

You can’t perform that action at this time.