Description

The NavigationTree API provides components that can be used to generate a navigation tree, which is then used to display, e.g., the navigation tree on the left sidebar of Cristal pages, and the space selector during page creation.

Developers

Reference

The navigation tree reference is now located in XWiki's documentation.

Even though there is a default implementation in DefaultNavigationTreeSource, it is expected that any backend should implement their own NavigationTreeSource with logic specific to the backend. E.g.,

/**
 * Implementation of NavigationTreeSource for the XWiki backend.
 **/
@injectable()
class XWikiNavigationTreeSource implements NavigationTreeSource {
  // XWiki specific implementation.
}

Each backend-specific implementation should be registered with the name of the backend that they support, and will then be available through DefaultNavigationTreeSourceProvider.get() whenever the backend is in use.