NavigationTreeDirectives
Implementation of the navigationTree directive for templates and markup blocks.
This directive supports the generation of navigation trees which can be any combination of auto-generated trees from the input tree and manual entries, optionally to external targets, too.
For full documentation see the section about the navigationTree Directive in the manual.
Type members
Classlikes
The configuration for an automatically generated navigation tree.
The configuration for an automatically generated navigation tree.
- Value parameters:
- depth
the depth to recurse from the root node
- excludeRoot
indicates whether the root node should be excluded in which case the first-level children will be inserted into the parent node
- excludeSections
indicates whether sections within documents should be excluded in automatic entries
- target
the target to use as the root node for navigation tree based on a relative or absolute path in the virtual input tree
- title
the title for this entry when getting rendered as a link
The configuration for a manual entry in the navigation tree. The entry can have further children which may in turn be either manual or automatically generated nodes.
The configuration for a manual entry in the navigation tree. The entry can have further children which may in turn be either manual or automatically generated nodes.
- Value parameters:
- entries
the children of this node, either manual or automatically generated
- target
the external link for this node (if missing this node just generates a navigation header as a separator within the tree)
- title
the title for this entry when getting rendered as a link
A block resolver that replaces itself with a navigation list according to this instances configuration. The resulting navigation tree can either be automatically generated from specified root nodes of the input tree or by specifying entries manually (or a combination of both).
A block resolver that replaces itself with a navigation list according to this instances configuration. The resulting navigation tree can either be automatically generated from specified root nodes of the input tree or by specifying entries manually (or a combination of both).
Serves as the implementation for the navigationTree directive, but can also be inserted into the AST manually.
- Value parameters:
- defaultDepth
the depth for automatically generated entries (unless overridden in the entries' config)
- entries
the list of manual and automatic entries to insert into the navigation tree
- excludeRoot
indicates whether the root node should be excluded in automatic entries (may be overridden in the entries' config)
- excludeSections
indicates whether sections within documents should be excluded in automatic entries (may be overridden in the entries' config)
- excludeSelf
indicates whether the current document should be included
- itemStyles
the styles to apply to all navigation items in the list as a render hint
- options
optional styles and/or an id for the final navigation list
- source
the source fragment that produced this navigation builder, for error reporting
- Companion:
- object
Companion with a decoder for obtaining instances from HOCON.
Companion with a decoder for obtaining instances from HOCON.
- Companion:
- class
Companion with a decoder for obtaining instances from HOCON.
Companion with a decoder for obtaining instances from HOCON.
- Companion:
- class
Represents the configuration for a single node in a navigation tree.
Represents the configuration for a single node in a navigation tree.
- Companion:
- object
Value members
Concrete fields
Implementation of the navigationTree directive for block elements in markup documents.
Implementation of the navigationTree directive for block elements in markup documents.