HelixOverviewDocsComponentsSandboxTheme builderCortexDocsEngramBuildingTraceBuildingRecallDeclaredServicesInsightsGet in touchSource on GitHub
Loading the reference
OutlineView SourceEdit in SandboxView MarkdownCopy MarkdownOpen in ClaudeOpen in CursorLinks to the headings on this page, marking the one being read.ExperimentalSince 0.1.0NavigationUsageimport'@fusion.dev/helix/outline'import'@fusion.dev/helix-headless/outline'Preview
API ReferenceRoothelix-outlineLinks to the headings on this page, marking the one being read.
PropTypeDefaultDescriptionbehaviorScrollBehavior"auto"How a click on one of these links travels to its section.labelstring"On this page"Accessible name for the navigation.offsetnumber0How far below the top of the window a heading counts as reached, in pixels.
ReadTypeDescriptioncurrentstringThe id of the section being read, or empty before anything is measured.whenSettledPromise<void>Resolves a frame after the first update, when transitions are switched on.
SlotDescription(default)The links, as anchors with fragment hrefs.
EventTypeDescriptionhelix-before-activateHelixBeforeActivateEventThe section being read has changed, carrying its id as the value. Cancelable: refusing it takes the decision and nothing moves.
PartDescriptionindicatorThe mark that travels to the section being read.navThe navigation landmark.
CSS PropertyDescription--outline-indentHow far each level is inset from the one above.--outline-railWidth of the gutter the rule and the traveling mark share.
Roothelix-headless-outlineLinks to the headings on this page, marking the one being read.
PropTypeDefaultDescriptionbehaviorScrollBehavior"auto"How a click on one of these links travels to its section.labelstring"On this page"Accessible name for the navigation.offsetnumber0How far below the top of the window a heading counts as reached, in pixels.
ReadTypeDescriptioncurrentstringThe id of the section being read, or empty before anything is measured.whenSettledPromise<void>Resolves a frame after the first update, when transitions are switched on.
SlotDescription(default)The links, as anchors with fragment hrefs.
EventTypeDescriptionhelix-before-activateHelixBeforeActivateEventThe section being read has changed, carrying its id as the value. Cancelable: refusing it takes the decision and nothing moves.
PartDescriptionindicatorThe mark that travels to the section being read.navThe navigation landmark.
ExamplesNameDescriptionEventsThe section being read, announced as the page scrolls past it.PreviewHeadings on a page, with the one in view marked as the page scrolls.PreviewHeadings on a page, with the one in view marked as the page scrolls.SmoothThe same outline, scrolling smoothly and stopping clear of a sticky header.