SidebarItem

type SidebarItem = object;

Defined in: types.ts:167

Sidebar item

Remarks

Extracted from VitePress source code

See

https://github.com/vuejs/vitepress/blob/923aa902523739bfb9d77aed376ebc73c32eeb33/types/default-theme.d.ts#L236

Since

1.0.0

Author

Simon Kovtyk

Properties

base?

optional base: string;

Defined in: types.ts:195

Base path for the children items.

---

collapsed?

optional collapsed: boolean;

Defined in: types.ts:190

If not specified, group is not collapsible.

If true, group is collapsible and collapsed by default

If false, group is collapsible but expanded by default

---

docFooterText?

optional docFooterText: string;

Defined in: types.ts:200

Customize text that appears on the footer of previous/next page.

---

items?

optional items: SidebarItem[];

Defined in: types.ts:181

The children of the item.

---

link?

optional link: string;

Defined in: types.ts:176

The link of the item.

---

rel?

optional rel: string;

Defined in: types.ts:202

---

target?

optional target: string;

Defined in: types.ts:203

---

text?

optional text: string;

Defined in: types.ts:171

The text label of the item.