id: doc_progress
label: Doc Progress
family: family-e-feedback
category: Display
intent: Indicate reading progress in a document
description: Document progress indicator
composable: false
capabilities:
required_parts: []
optional_parts: []
tags: ["doc-progress", "document", "progress", "reading"]
keywords:
pain: Scroll progress indicators require manual scroll tracking logic
promise: Progress tracking injected automatically via behavior layer
why: |
DocProgressPrimitive exposes progress via data attributes and ARIA. Portal variant allows injection anywhere in layout. This guarantees consistent scroll tracking without custom JS.
rules: ["CR-001", "CR-004"]
use_cases: ["docs reading", "long articles"]
related: ["progress", "spinner", "skeleton", "pulse", "loading_overlay"]
file: doc_progress_ui.css
tokens: doc-progress-*, size-*
foundation: size
states: ["active", "inactive"]
island: doc_progress_boundary.rs
pillar: progress
badges: ["SSR Safe", "Hydration Safe", "Token Driven", "Deterministic API", "Zero Drift"]
before: |
// ❌ Typical
window.onscroll = () => updateProgress();
after: |
// ✅ CanonRS
view! {
<DocProgress />
}
boundary_type: init
block: []
blocks_primitives: [container, stack]