Clyune Component GalleryReading Progress · How it works & code
Progress = scrolled distance ÷ total scrollable distance.
Runtime logic
Visiting `/scroll-fx/progress`, DemoHost lazy-loads `demos/kits/kit-scroll.js` (registry `mod: 'kit-scroll'`) and calls `mount(host, { variant: 'progress' })`. mount resolves the variant to family `progress`; `withControls` builds the control panel (6 presets + sliders). `createCanvasStage` creates the `<canvas>` (HiDPI ≤ 2×, ResizeObserver) and the info panel. The family’s `build(S)` initialises state and returns the per-frame callback. Every `requestAnimationFrame`: read controls, advance a speed-scaled clock (dt ≤ 50 ms), run the frame callback; returned readouts go to the info panel. Changing parameters: colour/speed/size apply live; structural ones remount; leaving the page cancels rAF, removes listeners and frees resources.
Environment
Canvas 2D: 2D canvas drawing; requestAnimationFrame: Display-synced animation loop; ResizeObserver: Canvas follows container size; Pointer Events: Unified mouse/touch/pen events; devicePixelRatio: Crisp HiDPI rendering (capped at 2×) · react 18.3.1, react-router-dom 6.30.6, vite 5.4.21
Dependencies
react 18.3.1
Imported APIs
withControls — Wraps the demo in the shared control panel (presets, sliders, reset); hot-updates or remounts on change; paramsFromSpec — Turns the spec (colour/speed/size/count/extras) into control-panel parameter definitions; createCanvasStage — Shared Canvas 2D stage: canvas + info panel, HiDPI, one rAF loop, pointer state, idle auto-pointer; hueOf — Hue of a colour (0–360°); clamp — Clamps a value to a range; TAU — Constant 2π; fmt — Number formatting (fixed decimals); F — Formula block HTML; S.clear — Clears with the background colour (translucent = trails); S.isAutoDemo — Whether auto demo is on; S.onFrame — Registers a per-frame callback; its return value feeds the info panel; ctx.fill() — Fills the current path; ctx.fillRect() — Fills a rectangle; ctx.save() — Saves the drawing state (transform, styles, clip); ctx.createLinearGradient() — Creates a linear gradient; ctx.restore() — Restores the saved drawing state; ctx.beginPath() — Starts a new path; ctx.arc() — Adds a circular arc (center, radius, start/end angle); ctx.stroke() — Strokes the current path; ctx.fillText() — Draws filled text; ctx.moveTo() — Moves the pen without drawing; ctx.arcTo() — Adds an arc using tangent lines; ctx.closePath() — Closes the current sub-path; ctx.rect() — Adds a rectangle to the path
Source code
frontend/src/demos/kits/kit-scroll.js: FAM.progress (L189-L208)
Code walkthrough
L189-208: Calls the factory `scFam()` to produce the full definition (spec + doc + build) from the options below. L189-189: Title shown in the info and control panels: “Reading Progress”. L189-189: Range/default of the count slider. L189-189: Extra demo-specific slider/toggle: Glow. L189-189: Range/default of the size slider. L189-189: Default main colour. L190-190: Help text of the count parameter. L190-190: Help text of the extra parameter. L190-190: Help text of the size parameter. L191-191: Preset buttons: name → parameter overrides (4). L192-192: Body of the “Notes” section. L193-193: Main formula of the “Formula” section. L193-193: Second formula line. L194-208: Per-frame draw function: draws with Canvas 2D `fill`, `fillRect`, `save`, `createLinearGradient`, `restore`, `beginPath` …; math via `Math.min`, `Math.round`, `Math.floor`; returns readouts `mode`, `cell`, `pageH` to the info panel.
Principles
Progress = scrollY congratulate / (page height - visual height) progress bar width = progress · Screen width Read the progress bar: Progress = scrolled distance ÷ rolling total distance. Multiply this ratio of 0~1 by the width of the screen, which is the length of the top progress bar; the scale indicates the beginning of each chapter and the circle at the lower left corner shows the same progress. Image simulates a scrollable web page: scrollY 表示页面已经向上滚过了多少像素，这里它自动来回滚动（右侧细条就是滚动条）。元素在屏幕上的位置 = Page Location − scrollY；The degree to which the elements enter the vision is usually used scroll Event or event IntersectionObserver Let's figure this out 0~1 The progress is driven by animations such as transparency, offset, scaling, etc.