On this page
Overview
Binds document navigation, filtering, history, current-item reveal, and load initialization.
- Artifact
DocumentNavigation.js· esm - Classification
public first party - Availability
Browser / native WebView - Normalization
Normalized filter/navigation state; DOM effects preserved.
Import and lifecycle
import * as module from '/arcane/modules/DocumentNavigation.js';
Import auto-initializes on DOMContentLoaded or immediately; binding installs filter, escape, clear, and submit listeners and mutates hidden, open, status, and scroll state.
Application-facing behavior: Five binding/filter/reveal helpers.
Protocol and host implementation
DOM and history This detail does not widen the application-facing API or grant authority.
Exports, signatures, parameters, and results
| Binding | Form | Declaration or signature | Parameter syntax |
|---|---|---|---|
bindDocumentNavigation | function | function bindDocumentNavigation(navigation) | navigation |
initializeDocumentNavigation | function | function initializeDocumentNavigation(root=globalThis.document) | root=globalThis.document |
applyDocumentNavigationFilter | function | function applyDocumentNavigationFilter(binding) | binding |
clearDocumentNavigationFilter | function | function clearDocumentNavigationFilter(binding,{focus=true}={}) | binding,{focus=true}={} |
revealCurrentDocumentNavigationItem | function | function revealCurrentDocumentNavigationItem(binding) | binding |
Parameter meanings and results
bindDocumentNavigation(element) returns a reusable frozen binding or null. initializeDocumentNavigation(root) returns bindings; filter and clear return the visible count; revealCurrentDocumentNavigationItem returns whether it scrolled.
Events, side effects, and errors
Source-literal CustomEvent dispatches
No source-literal CustomEvent dispatch is part of this artifact.
Lifecycle and event flow
- consumes DOMContentLoaded
- consumes input
- consumes keydown
- consumes click
- consumes submit
Direct coded failures
This artifact directly assigns no stable coded failure.
Exported Error subclasses
This artifact exports no Error subclass.
Documented failure behavior
No additional module-specific rejection behavior is documented.
Availability and capabilities
Browser / native WebView. Normalized filter/navigation state; DOM effects preserved.
Browser and native-WebView documentation navigation behavior with no Core dependency.
Contract example
import {initializeDocumentNavigation, applyDocumentNavigationFilter} from '/arcane/modules/DocumentNavigation.js';
const navigation=document.body.appendChild(document.createElement('nav'));
navigation.dataset.documentNavigation='';
navigation.innerHTML='<input data-document-navigation-filter><div data-document-navigation-group><a data-document-navigation-item data-navigation-search="API">API</a></div><output data-document-navigation-status></output>';
const [binding]=initializeDocumentNavigation(navigation);
binding.filter.value='api';
console.log(applyDocumentNavigationFilter(binding));
Related reference
No direct Core call is claimed for this artifact. Any injected provider or consuming module retains its own documented authority.