NavigationBuilderContext
laika.ast.NavigationBuilderContext
case class NavigationBuilderContext(refPath: Path, itemStyles: Set[String], maxLevels: Int, currentLevel: Int, excludeSections: Boolean, excludeSelf: Boolean)
The context of a navigation builder that can get passed down in recursive calls to the various types that have an asNavigationItem method.
Value parameters
- currentLevel
-
the current level of the navigation tree being built
- excludeSections
-
indicates whether the recursion should exclude sections of documents even when maxLevels has not been reached yet
- itemStyles
-
the styles to assign to each navigation item as a render hint
- maxLevels
-
the number of levels of sub-trees, documents or sections to create navigation info for
- refPath
-
the path of document from which this document will be linked (for creating a corresponding relative path)
Attributes
- Graph
-
- Supertypes
-
trait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass Any
Members list
In this article