Interface: VitePressNavOptions
Configures generated VitePress sidebar data and optional navigation artifacts.
Signature
ts
export interface VitePressNavOptionsProperties
| Name | Type | Description |
|---|---|---|
collapsed (optional) | boolean | ((item: ApiDocsNavItem, depth: number) => boolean | undefined) | Collapsed state for generated sidebar branches, or a resolver called per item. A boolean value also controls the top-level section when section.collapsed is omitted. Default: undefined |
enabled (optional) | boolean | Whether generated navigation integration is enabled. Default: true |
exportName (optional) | string | Named export used in the generated navigation code file. Default: 'apiDocsNav' |
insert (optional) | VitePressSidebarInsert | Positioning strategy used when merging generated items into an existing sidebar. Default: 'append' |
outputFile (optional) | string | false | File path for generated navigation code, or false to skip writing it. Default: undefined |
replaceText (optional) | string | Sidebar item text to replace when insert is set to replace. Default: undefined |
section (optional) | VitePressSidebarSectionOptions | Optional top-level sidebar section that wraps all generated API doc items. Default: undefined |
sidebarRoute (optional) | string | Route key to update when the existing VitePress sidebar is a route map. Default: undefined |
virtualModule (optional) | string | false | Virtual module id that exposes generated navigation data, or false to disable it. Default: false |