@openpawlabs/diy-guides-ui 1.6.0 → 1.7.0

package/dist/utils/guideStepUrl.d.ts

@@ -0,0 +1,11 @@
+export declare const DEFAULT_GUIDE_STEP_URL_PREFIX = "step-";
+export declare const DEFAULT_GUIDE_STEP_URL_KEY = "step";
+export type GuideStepUrlMode = "hash" | "search";
+/** DOM id / hash fragment for a guide step (`step-2`). */
+export declare function guideStepUrlId(step: number, prefix?: string): string;
+export declare function parseGuideStepFromHash(hash: string, prefix?: string): number | null;
+export declare function parseGuideStepFromSearch(search: string, key?: string): number | null;
+export declare function readGuideStepFromLocation(location: Pick<Location, "hash" | "search">, mode: GuideStepUrlMode, key?: string, prefix?: string): number | null;
+/** Returns a full URL string with the step encoded per `mode`. Pass `null` to clear the step. */
+export declare function buildGuideStepUrl(currentUrl: string, step: number | null, mode: GuideStepUrlMode, key?: string, prefix?: string): string;
+//# sourceMappingURL=guideStepUrl.d.ts.map

package/dist/utils/guideStepUrl.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"guideStepUrl.d.ts","sourceRoot":"","sources":["../../src/utils/guideStepUrl.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,6BAA6B,UAAU,CAAC;AACrD,eAAO,MAAM,0BAA0B,SAAS,CAAC;AAEjD,MAAM,MAAM,gBAAgB,GAAG,MAAM,GAAG,QAAQ,CAAC;AAEjD,0DAA0D;AAC1D,wBAAgB,cAAc,CAC5B,IAAI,EAAE,MAAM,EACZ,MAAM,SAAgC,GACrC,MAAM,CAER;AAED,wBAAgB,sBAAsB,CACpC,IAAI,EAAE,MAAM,EACZ,MAAM,SAAgC,GACrC,MAAM,GAAG,IAAI,CAQf;AAED,wBAAgB,wBAAwB,CACtC,MAAM,EAAE,MAAM,EACd,GAAG,SAA6B,GAC/B,MAAM,GAAG,IAAI,CASf;AAED,wBAAgB,yBAAyB,CACvC,QAAQ,EAAE,IAAI,CAAC,QAAQ,EAAE,MAAM,GAAG,QAAQ,CAAC,EAC3C,IAAI,EAAE,gBAAgB,EACtB,GAAG,SAA6B,EAChC,MAAM,SAAgC,GACrC,MAAM,GAAG,IAAI,CAIf;AAED,iGAAiG;AACjG,wBAAgB,iBAAiB,CAC/B,UAAU,EAAE,MAAM,EAClB,IAAI,EAAE,MAAM,GAAG,IAAI,EACnB,IAAI,EAAE,gBAAgB,EACtB,GAAG,SAA6B,EAChC,MAAM,SAAgC,GACrC,MAAM,CAeR"}

package/dist/utils/guideStepUrl.test.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=guideStepUrl.test.d.ts.map

package/dist/utils/guideStepUrl.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"guideStepUrl.test.d.ts","sourceRoot":"","sources":["../../src/utils/guideStepUrl.test.ts"],"names":[],"mappings":""}

package/dist/utils/pickActiveGuideStep.d.ts

@@ -0,0 +1,9 @@
+/** Fraction of a step's height that is visible in the viewport. */
+export declare function getStepVisibleRatio(rect: DOMRect, innerHeight?: number): number;
+/**
+ * Picks the active step while scrolling: the earliest step that still has at
+ * least `activeStepMinVisibleRatio` of its height on screen. Later steps do
+ * not take over until every earlier step has fallen below that threshold.
+ */
+export declare function pickActiveGuideStep(stepNumbers: number[], activeStepMinVisibleRatio: number, getRect: (step: number) => DOMRect | null, innerHeight?: number): number | null;
+//# sourceMappingURL=pickActiveGuideStep.d.ts.map

package/dist/utils/pickActiveGuideStep.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"pickActiveGuideStep.d.ts","sourceRoot":"","sources":["../../src/utils/pickActiveGuideStep.ts"],"names":[],"mappings":"AAAA,mEAAmE;AACnE,wBAAgB,mBAAmB,CACjC,IAAI,EAAE,OAAO,EACb,WAAW,GAAE,MAA2B,GACvC,MAAM,CAUR;AAED;;;;GAIG;AACH,wBAAgB,mBAAmB,CACjC,WAAW,EAAE,MAAM,EAAE,EACrB,yBAAyB,EAAE,MAAM,EACjC,OAAO,EAAE,CAAC,IAAI,EAAE,MAAM,KAAK,OAAO,GAAG,IAAI,EACzC,WAAW,GAAE,MAA2B,GACvC,MAAM,GAAG,IAAI,CAiCf"}

package/dist/utils/pickActiveGuideStep.test.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=pickActiveGuideStep.test.d.ts.map

package/dist/utils/pickActiveGuideStep.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"pickActiveGuideStep.test.d.ts","sourceRoot":"","sources":["../../src/utils/pickActiveGuideStep.test.ts"],"names":[],"mappings":""}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@openpawlabs/diy-guides-ui",
-  "version": "1.6.0",
+  "version": "1.7.0",
   "description": "React UI library for building open-source, iFixit-style step-by-step diy guides",
   "license": "MIT",
   "type": "module",