9.1 – Every option

Whatever is not in the configuration, the plugin takes as its default. An unknown value is replaced by the default and reported (9.2).

Form

Option	Values	Default	Chapter
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	empty	7.3
ariaLabel	text	translated “Main navigation”	7.3
className	classes	empty	7.2
id	letters, digits, -, _	checksum of the options	7.3
breakpoints	{ mobile, desktop } in px, rem, em	from variables.scss	6.2

Scope

Option	Values	Default	Chapter
language	auto, all, language code	auto	8.3
rootPath	folder path	root	3.1
scope	root, section, parent, current	root	3.1
depth	integer from 0; 0 = unlimited	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

Tree

These options shape the tree itself. Navigations that agree on them share one (1.3).

Option	Values	Default	Chapter
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	{ folder path: [entries] }	{}	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	list of patterns	empty = everything	2.3
exclude	list of patterns	empty	2.3
icons	both, type, custom, none (also true, false)	both	7.1
nodeIcons	{ path: icon }	{}	7.1

Interaction

Option	Values	Default	Chapter
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 names, see 7.1	7.1

For single variants only

Option	Values	Default	Chapter
flyout.side	auto, right, left	auto	4.1
tabs.secondary	true, false	true	4.2
select.button	true, false	false	4.3
columns.max	integer from 1	4 — currently no effect	4.3
pager.labels	true, false	true	4.3
pager.order	tree, siblings	tree	4.3

Frontmatter

Field	Values	Chapter
navTitle	text	2.1
navOrder	number	2.2
navHide	true, false, yes, no	2.3
navIcon	lucide:<name>, emoji, short text, none	7.1

Old spellings

From version 0.1, still understood, with a message at build time:

Old	New
variant: vertical	variant: tree
variant: horizontal	variant: bar
dropdownTrigger	trigger
style	gone; styling through CSS variables (7.2)