@blueprint-chart/docs 2.17.1 → 2.18.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/package.json +3 -3
  2. package/src/guide/scenes.md +3 -3
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@blueprint-chart/docs",
3
- "version": "2.17.1",
3
+ "version": "2.18.0",
4
4
  "description": "Public documentation for Blueprint Chart — handbook, guide, BPC DSL spec, and lib API reference.",
5
5
  "type": "module",
6
6
  "license": "MIT",
@@ -33,8 +33,8 @@
33
33
  "provenance": true
34
34
  },
35
35
  "devDependencies": {
36
- "@blueprint-chart/lib": "2.17.1",
37
- "@blueprint-chart/ui": "2.17.1",
36
+ "@blueprint-chart/lib": "2.18.0",
37
+ "@blueprint-chart/ui": "2.18.0",
38
38
  "@fontsource-variable/geist": "^5.3.0",
39
39
  "@fontsource-variable/geist-mono": "^5.3.0",
40
40
  "@fontsource/dm-serif-display": "^5.3.0",
package/src/guide/scenes.md CHANGED
@@ -65,7 +65,7 @@ chart bar-horizontal {
65
65
  This is `packages/lib/src/samples/co2-emissions-story.bpc` verbatim. The first three scenes keep the same base data and only shift the title and highlight; the fourth swaps in per-capita data for a closing reframe.
66
66
  :::
67
67
 
68
- Open this in the editor to see the scene timeline appear automatically; embed it on a page and readers get a Previous / Next nav.
68
+ Open this in the editor to see the scene timeline appear automatically; embed it on a page and readers get the same scene player in the chart footer.
69
69
 
70
70
  ## How it works
71
71
 
@@ -74,9 +74,9 @@ A scene block accepts the same member set as the top-level chart. At parse time,
74
74
  At render time:
75
75
 
76
76
  1. The runtime collects the chart's scenes into a `SceneDefinition[]`.
77
- 2. `createSceneController(container, scenes, onSceneChange)` injects a small `<nav>` (Previous / Next / counter) into the container.
77
+ 2. The embed mounts the scene player chosen with `player` (`buttons` by default) in the chart footer, as the editor does.
78
78
  3. On every scene change, the callback re-renders the chart with `transition = true`, which triggers the motion helpers (`snapshotForFadeOut`, `commitFadeOut`, `fadeIn`) and animates the crossfade.
79
- 4. `goTo(index)` clamps and wraps so `goTo(-1)` cycles to the last scene.
79
+ 4. Previous is disabled on the first scene and Next on the last; Play steps through every scene once, then stops.
80
80
 
81
81
  The pipeline that runs per scene is the same eleven-step sequence documented in [Embedding](/guide/embed) and the DSL spec — scene overrides are merged at step 3 (transforms), so everything downstream sees the post-scene state.
82
82