Skip to content

NavbarItem

type NavbarItem =
    | NavbarLink of label: string * url: string
    | NavbarSection of label: string * section: string * url: string
    | NavbarDropdown of label: string * items: NavbarItem list
    | NavbarDivider
    | NavbarIcon of label: string * url: string * svg: string
    | NavbarDescribed of label: string * description: string * url: string
    | NavbarLocalePicker
    | NavbarWidget of html: string
    | NavbarDynamicWidget of render: SiteInfo -> string
AssemblyNacara.Theme.Default

An entry of the navigation bar.

Cases

NavbarLink of label: string * url: string
NavbarSection of label: string * section: string * url: string
NavbarDropdown of label: string * items: NavbarItem list
NavbarDivider
NavbarIcon of label: string * url: string * svg: string

An icon-only link. The icon is inline SVG markup.

NavbarDescribed of label: string * description: string * url: string

A link with a description, for use inside a dropdown.

NavbarLocalePicker

Lists the locales of the site, linking to the translation of the page being read.

NavbarWidget of html: string

Raw markup, which is how a plugin contributes a widget of its own.

NavbarDynamicWidget of render: SiteInfo -> string

Markup rendered from the site as it is being built, for a widget that needs to know something only settled by then - which version this build is, say.

Properties

member IsNavbarDescribed: bool
member IsNavbarDivider: bool
member IsNavbarDropdown: bool
member IsNavbarDynamicWidget: bool
member IsNavbarIcon: bool
member IsNavbarLink: bool
member IsNavbarLocalePicker: bool
member IsNavbarSection: bool
member IsNavbarWidget: bool