Skip to content

SidebarItem

Represents a sidebar navigation item for the documentation site. Can be a link or a folder containing other items.

Signature

typescript
interface SidebarItem { text: string; link?: string; items?: SidebarItem[]; collapsed?: boolean }

Parameters

  • textRequired · string

    Display text for the sidebar item

  • link · string

    Optional link URL for the item

  • items · SidebarItem[]

    Optional array of sub-items for folder-type items

  • collapsed · boolean

    Whether the folder should be collapsed by default

Released under the MIT License.