Skip to content

GemNavList

GemNavList renders a vertical navigation list, e.g. for a sidebar menu. It arranges navigation entries such as GemNavItem between an optional header and footer.

GUI Model

component GemNavList(
  List<GUIViewElement> components,
  GUIViewElement header = null,
  GUIViewElement footer = null,

  String width = "auto",
  String height = "100%",
  Boolean collapsed = false,
  String collapsedWidth = "4rem",
  Event<Void> collapsedChange
)
Name Type Description Default value
components List<GUIViewElement> Navigation entries displayed in the list, e.g. GemNavItem instances.
header GUIViewElement Optional element displayed above the list of entries. null
footer GUIViewElement Optional element displayed below the list of entries. null
width String Width of the list. "auto"
height String Height of the list. "100%"
collapsed Boolean Whether the list is collapsed to icon-only mode. false
collapsedWidth String Width of the list when collapsed. "4rem"
collapsedChange Event<Void> Emitted when the collapsed state changes.