Skip to main content
The application navigation is built from plugin metadata. If your plugin exposes a user-facing page, add the navigation metadata to its info.yaml manifest. These fields are part of the plugin metadata convention. They are not an API belonging to a particular navigation plugin.

​
Page metadata

The following metadata fields define a navigation entry: Entry must be a URL served by the plugin’s HTTP or static transport. The navigation UI loads this URL in an iframe, so the page and its assets must be reachable through the application’s URL space. For example, a manifest can declare page metadata like this:
The navigation system only creates an entry when all of the following conditions hold:
  • The plugin has an Entry value.
  • The plugin status is running or degraded.
  • The plugin name is not excluded by the host’s navigation configuration.
Discovery alone is not enough. A plugin that is installed but not running is not shown in the navigation.

​
Ordering and visibility

The current navigation implementation reads its behavior from [Plugins.navigator.Params] in the application configuration. These settings control how the host presents plugin entries; they do not replace the page metadata in your manifest. Names in order and ignore are plugin Name values, not display labels. Whitespace around comma-separated values is ignored. Empty values are ignored. If no language is configured, the navigation UI uses en. The order parameter does not hide plugins that are not listed. It only moves listed plugins ahead of the remaining visible entries.

​
Icon behavior

Icons are referenced by public URL. The current navigation implementation uses Icon for inactive entries and IconSolid for the selected entry. If no icon is declared, it uses a default navigation icon. Use an icon URL that remains available for as long as the navigation entry is visible. The icon file should be provided through a static mount or another stable public resource path.