Skip to content
Binary Dreams UI Kit reference DocumentNavigation

Document navigation

Document contents with the current section, reading progress, and compact navigation.

Loading interactive example

Use DocumentNavigation beside a long document with stable heading IDs. Pass container for a nested scroll area. Native fragment links remain available before hydration; current-section and progress tracking start in the browser. Keep heading scroll margins clear of sticky headers.

API

MemberTypeKindRequiredDefault
containerHTMLElement | nullpropNonull
headingsreadonly DocumentHeading[]propYes
titlestringpropYes

Source

Loading source