@markdy/astro 1.0.17 → 1.0.19

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.
package/README.md CHANGED
@@ -79,18 +79,18 @@ export const code = `
79
79
  | `height` | `number` | `400` | Placeholder height in pixels |
80
80
  | `bg` | `string` | `"white"` | Placeholder background colour |
81
81
  | `assets` | `Record<string, string>` | `{}` | Asset URL overrides |
82
- | `autoplay` | `boolean` | `plan.meta.autoplay ?? true` | Start playing on hydration |
83
- | `loop` | `boolean` | `plan.meta.loop ?? true` | Loop the animation when it ends |
84
- | `copyright` | `boolean` | `plan.meta.copyright ?? true` | Show a "Powered by Markdy" badge below the animation |
82
+ | `autoplay` | `boolean` | script or `true` | Override whether playback starts on hydration |
83
+ | `loop` | `boolean` | script or `true` | Override whether playback loops |
84
+ | `copyright` | `boolean` | script or `true` | Show the linked badge at the footer's right edge |
85
85
  | `progressBar` | `boolean \| string` | `true` | Deprecated compatibility flag for the scene-boundary progress bar |
86
- | `sceneBoundaryProgress` | `boolean \| string` | `true` | Show boundary progress bar, or pass a custom color/gradient string |
87
- | `progressColor` | `string` | `plan.meta.progressColor ?? "rainbow"` | Custom progress bar color (e.g. `"#3b82f6"`) or gradient (e.g. `"#ec4899, #8b5cf6"`) |
88
- | `playbackRate` | `number` | `plan.meta.playbackRate ?? 1` | Normalized timeline speed multiplier; `1` is Markdy's normal pace |
89
- | `interactiveViewport` | `boolean` | `controls \|\| player.interaction` | Enable wheel zoom and drag pan after hydration |
90
- | `controls` | `boolean` | `player.controls` | Show the footer toolbar (play, prev/next beat, restart, seek, speed, fit, reset view, SVG, share); also enables viewport interaction |
86
+ | `sceneBoundaryProgress` | `boolean \| string` | script | Override boundary progress or its color |
87
+ | `progressColor` | `string` | script or rainbow | Override the progress color or gradient |
88
+ | `playbackRate` | `number` | script or `1` | Override the initial timeline multiplier |
89
+ | `interactiveViewport` | `boolean` | script | `true` supplies default gestures; `false` suppresses script gestures |
90
+ | `controls` | `boolean` | script | `true` supplies legacy toolbar defaults; `false` suppresses script controls |
91
91
  | `class` | `string` | — | CSS class for the outer wrapper |
92
92
 
93
- > **Self-Contained MarkdyScript:** You can declare `controls true`, `interactive true`, `progressColor "#3b82f6"`, `loop false`, etc. directly inside the `.markdy` code so you only need `<Markdy code={code} />`. Explicit props passed to `<Markdy />` will override in-script directives.
93
+ > **Self-Contained MarkdyScript:** Prefer grouped `player:` settings inside the `.markdy` code so `<Markdy code={code} />` preserves scene behavior. Pass props only when the host intentionally gates or supplies defaults.
94
94
  >
95
95
  > **Tip:** Match `width`, `height`, and `bg` props to your `scene` declaration values to avoid a visual flash on hydration.
96
96
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@markdy/astro",
3
- "version": "1.0.17",
3
+ "version": "1.0.19",
4
4
  "description": "Astro island component for diagram-native animated MarkdyScript architecture diagrams.",
5
5
  "license": "MIT",
6
6
  "type": "module",
@@ -38,7 +38,7 @@
38
38
  "access": "public"
39
39
  },
40
40
  "dependencies": {
41
- "@markdy/renderer-dom": "1.0.17"
41
+ "@markdy/renderer-dom": "1.0.19"
42
42
  },
43
43
  "peerDependencies": {
44
44
  "astro": ">=4.0.0"
package/src/Markdy.astro CHANGED
@@ -34,11 +34,11 @@ export interface Props {
34
34
  * Useful for CDN assets or data URIs in demos.
35
35
  */
36
36
  assets?: Record<string, string>;
37
- /** Start playing as soon as the scene is hydrated. Defaults to true. */
37
+ /** Override whether playback starts when the scene is hydrated. */
38
38
  autoplay?: boolean;
39
- /** Loop the animation when it ends. Defaults to true. */
39
+ /** Override whether playback loops when it ends. */
40
40
  loop?: boolean;
41
- /** Show a small "Powered by Markdy" badge below the animation. Defaults to true. */
41
+ /** Show the linked "Powered by Markdy" badge at the footer's right edge. */
42
42
  copyright?: boolean;
43
43
  /** Show a rainbow progress bar around the viewport border, or specify a custom color/gradient. Defaults to true. */
44
44
  progressBar?: boolean | string;
@@ -50,9 +50,9 @@ export interface Props {
50
50
  progressBarColor?: string;
51
51
  /** Playback speed multiplier. Defaults to 1, where 1 is Markdy's normal pace. */
52
52
  playbackRate?: number;
53
- /** Enable wheel zoom and drag pan after hydration. Defaults to false. */
53
+ /** Host interaction override: true supplies default gestures; false suppresses script gestures. */
54
54
  interactiveViewport?: boolean;
55
- /** Show built-in playback and viewport controls. Also enables viewport interaction. Defaults to false. */
55
+ /** Host controls override: true supplies legacy defaults; false suppresses script controls. */
56
56
  controls?: boolean;
57
57
  class?: string;
58
58
  /**