Was nicht in der Konfiguration steht, nimmt das Plugin als Vorgabe an. Ein unbekannter Wert wird durch die Vorgabe ersetzt und gemeldet (9.2).
Form
| Option | Werte | Vorgabe | Kapitel |
|---|---|---|---|
variant | tree, accordion, flyout, bar, dropdown, mega, tabs, columns, select, pager | tree | 4 |
mobile | same, accordion, offcanvas, select, hidden | same | 6.1 |
align | left, center, right, full | left | 4.2 |
title | Text | leer | 7.3 |
ariaLabel | Text | übersetzt „Hauptnavigation“ | 7.3 |
className | Klassen | leer | 7.2 |
id | Buchstaben, Ziffern, -, _ | Prüfwert der Optionen | 7.3 |
breakpoints | { mobile, desktop } in px, rem, em | aus variables.scss | 6.2 |
Ausschnitt
| Option | Werte | Vorgabe | Kapitel |
|---|---|---|---|
language | auto, all, Sprachcode | auto | 8.3 |
rootPath | Ordnerpfad | Wurzel | 3.1 |
scope | root, section, parent, current | root | 3.1 |
depth | ganze Zahl ab 0; 0 = unbegrenzt | 0 | 3.2 |
hideOutsideRoot | true, false | true | 3.2 |
showScopeRoot | true, false | false | 3.2 |
showHome | true, false | false | 3.2 |
indexEntry | none, first | none | 3.2 |
folderLink | index, first-child, none | index | 3.3 |
Baum
Diese Optionen bestimmen den Baum selbst. Navigationen, die in ihnen übereinstimmen, teilen sich einen (1.3).
| Option | Werte | Vorgabe | Kapitel |
|---|---|---|---|
sort | manual, alphabetical, date | manual | 2.2 |
sortDirection | asc, desc | asc | 2.2 |
foldersFirst | first, last, mixed | first | 2.2 |
dateField | created, modified, published | created | 2.2 |
order | { Ordnerpfad: [Einträge] } | {} | 2.2 |
stripNumericPrefix | true, false | false | 2.1 |
frontmatterKeys | { order, title, hide, icon } | navOrder, navTitle, navHide, navIcon | 2 |
hideTags | true, false | true | 2.3 |
hideUnlisted | true, false | true | 2.3 |
hideDrafts | true, false | true | 2.3 |
hideEmptyFolders | true, false | true | 2.3 |
keepIndexOnlyFolders | true, false | true | 2.3 |
include | Liste von Mustern | leer = alles | 2.3 |
exclude | Liste von Mustern | leer | 2.3 |
icons | both, type, custom, none (auch true, false) | both | 7.1 |
nodeIcons | { Pfad: Icon } | {} | 7.1 |
Bedienung
| Option | Werte | Vorgabe | Kapitel |
|---|---|---|---|
folderClick | toggle, link | toggle | 5.1 |
folderDefaultState | collapsed, open | collapsed | 5.1 |
expandActive | true, false | true | 5.1 |
exclusive | true, false | false | 5.1 |
persistState | true, false | false | 5.1 |
chevrons | true, false | true | 5.1 |
trigger | click, hover | click | 5.2 |
iconNames | { folder, folderOpen, file, home, chevron, menu, close, previous, next } | Lucide-Namen, siehe 7.1 | 7.1 |
Nur für einzelne Varianten
| Option | Werte | Vorgabe | Kapitel |
|---|---|---|---|
flyout.side | auto, right, left | auto | 4.1 |
tabs.secondary | true, false | true | 4.2 |
select.button | true, false | false | 4.3 |
columns.max | ganze Zahl ab 1 | 4 — wirkt derzeit nicht | 4.3 |
pager.labels | true, false | true | 4.3 |
pager.order | tree, siblings | tree | 4.3 |
Frontmatter
| Feld | Werte | Kapitel |
|---|---|---|
navTitle | Text | 2.1 |
navOrder | Zahl | 2.2 |
navHide | true, false, yes, no | 2.3 |
navIcon | lucide:<name>, Emoji, kurzer Text, none | 7.1 |
Alte Schreibweisen
Aus Version 0.1 werden noch verstanden, mit einer Meldung beim Bau:
| Alt | Neu |
|---|---|
variant: vertical | variant: tree |
variant: horizontal | variant: bar |
dropdownTrigger | trigger |
style | entfällt; Gestaltung über CSS-Variablen (7.2) |