eidotter 0.28.0 → 0.29.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.
@@ -31,6 +31,28 @@ export interface RetroEffectsProps {
31
31
  * pattern (DMNC-1047).
32
32
  */
33
33
  boot?: boolean;
34
+ /**
35
+ * Gate `boot` to once per browser tab/session (via sessionStorage). The boot
36
+ * sequence plays on the first load of a tab and is suppressed on every
37
+ * subsequent mount within the same tab — both SPA route changes and MPA
38
+ * full-reload navigation. A new tab/visit replays it; a hard refresh does not.
39
+ * No-op unless `boot` is also set. Falls back to playing if storage is
40
+ * unavailable (e.g. private mode).
41
+ *
42
+ * Like `boot`, this is evaluated once on mount; changing it afterwards has no
43
+ * effect (remount the component — e.g. via `key` — to re-evaluate).
44
+ */
45
+ bootOnce?: boolean;
46
+ /**
47
+ * sessionStorage key used by `bootOnce`. Defaults to `'eidotter:retro-boot'`.
48
+ * Override to scope the once-per-session flag independently, or to force a
49
+ * replay (e.g. a fresh key in a Storybook story). Read once on mount.
50
+ *
51
+ * Instances that mount simultaneously and share a key share one flag (the
52
+ * intended single-overlay case); give each a distinct key if they must gate
53
+ * independently.
54
+ */
55
+ bootStorageKey?: string;
34
56
  /**
35
57
  * Intensity of the effects (0-1)
36
58
  */
package/dist/index.d.ts CHANGED
@@ -83,4 +83,4 @@ export { isSafeUrl } from './utils';
83
83
  export { ZOOM_LEVELS } from './components/TimelineContainer';
84
84
  export { componentRegistry, projects, getComponentMeta, getComponentsByOrigin, getComponentsByConsumer, getVariantsUsedBy, getVariantConsumerMap, } from './components/registry';
85
85
  export type { ComponentMeta, ProjectId, ProjectInfo, VariantMeta, PlatformId, PlatformMeta, ChangelogEntry, } from './components/registry';
86
- export declare const version = "0.28.0";
86
+ export declare const version = "0.29.0";