# useNavigationItems

Retrieve the registered navigation items from the FireflyRuntime instance.

const navigationItems = useNavigationItems(options?: { menuId? })

• options: An optional object literal of options:
  • menuId: An optional id to retrieve the navigation menu for a specific menu.

An array of NavigationLink | NavigationSection.

Accept any properties of a React Router Link component with the addition of:

• $id: An optional identifier for the link. Usually used as the React element key property.
• $label: The link label. Could either by a string or a ReactNode.
• $canRender: An optional function accepting an object and returning a boolean indicating whether or not the link should be rendered.
• $additionalProps: An optional object literal of additional props to apply to the link component.

• $id: An optional identifier for the section. Usually used to nest navigation items under a specific section and as the React element key property.
• $label: The section label. Could either by a string or a ReactNode.
• $canRender: An optional function accepting an object and returning a boolean indicating whether or not the section should be rendered.
• $additionalProps: An optional object literal of additional props to apply to the section component.
• children: The section items.

import { useNavigationItems } from "@squide/firefly";

const items = useNavigationItems();

import { useNavigationItems } from "@squide/firefly";

const items = useNavigationItems({ menuId: "my-custom-menu" });