Interface NavigationEntryDescription

Describes the structure of the navigation menu.

Since

0.1.0

interface NavigationEntryDescription {
    display_name: string;
    icon?: string;
    link: string;
    name: string;
    pages?: NavigationEntryDescription[];
}

Index

Properties

display_name icon? link name pages?

Properties

display_name

display_name: string

Human readable name to use as the navigation entry.

`Optional`icon

icon?: string

Icon name to display.

link

link: string

Relative url to the page this navigation entry gos to.

name

name: string

Unique identifier for this navigation entry.

`Optional`pages

pages?: NavigationEntryDescription[]

Children navigation entries. These will be added underneath this entry.