@openpawlabs/diy-guides-ui 1.2.1 → 1.3.1
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/dist/components/GuideStep/GuideStep.d.ts +18 -2
- package/dist/components/GuideStep/GuideStep.d.ts.map +1 -1
- package/dist/components/GuideStep/GuideStep.stories.d.ts +4 -2
- package/dist/components/GuideStep/GuideStep.stories.d.ts.map +1 -1
- package/dist/components/GuideStep/index.d.ts +1 -1
- package/dist/components/GuideStep/index.d.ts.map +1 -1
- package/dist/components/MediaFigure/MediaFigureThumbnail.d.ts +15 -0
- package/dist/components/MediaFigure/MediaFigureThumbnail.d.ts.map +1 -0
- package/dist/components/MediaFigure/MediaFigureThumbnail.test.d.ts +2 -0
- package/dist/components/MediaFigure/MediaFigureThumbnail.test.d.ts.map +1 -0
- package/dist/components/MediaFigure/index.d.ts +2 -0
- package/dist/components/MediaFigure/index.d.ts.map +1 -1
- package/dist/diy-guides-ui.cjs +6 -6
- package/dist/diy-guides-ui.cjs.map +1 -1
- package/dist/diy-guides-ui.js +2544 -2413
- package/dist/diy-guides-ui.js.map +1 -1
- package/dist/index.d.ts +3 -3
- package/dist/index.d.ts.map +1 -1
- package/dist/style.css +1 -1
- package/package.json +1 -1
|
@@ -54,6 +54,20 @@ export interface GuideStepProps {
|
|
|
54
54
|
* as a standalone action with no marker.
|
|
55
55
|
*/
|
|
56
56
|
export type GuideStepBulletVariant = "dot" | "caution" | "reminder" | "note" | "button";
|
|
57
|
+
/**
|
|
58
|
+
* Optional, editor-only affordances for the bullet list. Passing `editing` to
|
|
59
|
+
* `GuideStep.Bullets` adds a drag handle to reorder bullets, a remove control per
|
|
60
|
+
* bullet, and a "+ New bullet" button. Every member is an intent callback — the
|
|
61
|
+
* library performs no data mutation. Omit entirely for the read-only reader experience.
|
|
62
|
+
*/
|
|
63
|
+
export interface GuideStepBulletsEditing {
|
|
64
|
+
/** Append a new bullet. Drives the "+ New bullet" button. */
|
|
65
|
+
onAddBullet?: () => void;
|
|
66
|
+
/** Remove the bullet at `index`. Hidden while only one bullet remains. */
|
|
67
|
+
onRemoveBullet?: (index: number) => void;
|
|
68
|
+
/** Move the bullet from `from` to `to`. When set (and >1 bullet), bullets gain a drag handle. */
|
|
69
|
+
onReorderBullet?: (from: number, to: number) => void;
|
|
70
|
+
}
|
|
57
71
|
export interface GuideStepBulletProps {
|
|
58
72
|
/**
|
|
59
73
|
* Bullet style. `dot` renders a colored dot (link to `MediaFigure`
|
|
@@ -83,12 +97,14 @@ declare function GuideStepMedia(_props: {
|
|
|
83
97
|
children?: ReactNode;
|
|
84
98
|
}): null;
|
|
85
99
|
/** Ordered container for `GuideStep.Bullet`s. */
|
|
86
|
-
declare function GuideStepBullets({ children, className, }: {
|
|
100
|
+
declare function GuideStepBullets({ children, className, editing, }: {
|
|
87
101
|
children: ReactNode;
|
|
88
102
|
className?: string;
|
|
103
|
+
/** Editor-only affordances; presence enables reorder / remove / add. Omit for readers. */
|
|
104
|
+
editing?: GuideStepBulletsEditing;
|
|
89
105
|
}): import("react").JSX.Element;
|
|
90
106
|
/** A single instruction line — dot bullets or semantic caution / reminder / note bullets. */
|
|
91
|
-
declare function GuideStepBullet(
|
|
107
|
+
declare function GuideStepBullet(props: GuideStepBulletProps): import("react").JSX.Element;
|
|
92
108
|
declare function GuideStepRoot({ number, title, isCompleted, defaultCompleted, onCompletedChange, completable, mediaEditing, children, className, }: GuideStepProps): import("react").JSX.Element;
|
|
93
109
|
/**
|
|
94
110
|
* A single numbered guide step: header with number badge and optional completion
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"GuideStep.d.ts","sourceRoot":"","sources":["../../../src/components/GuideStep/GuideStep.tsx"],"names":[],"mappings":"AAEA,OAAO,EAQL,KAAK,SAAS,EACf,MAAM,OAAO,CAAC;AAIf,OAAO,EAAU,KAAK,UAAU,EAAE,MAAM,oBAAoB,CAAC;
|
|
1
|
+
{"version":3,"file":"GuideStep.d.ts","sourceRoot":"","sources":["../../../src/components/GuideStep/GuideStep.tsx"],"names":[],"mappings":"AAEA,OAAO,EAQL,KAAK,SAAS,EACf,MAAM,OAAO,CAAC;AAIf,OAAO,EAAU,KAAK,UAAU,EAAE,MAAM,oBAAoB,CAAC;AAe7D;;;;;;GAMG;AACH,MAAM,WAAW,qBAAqB;IACpC,0FAA0F;IAC1F,UAAU,CAAC,EAAE,MAAM,IAAI,CAAC;IACxB,uEAAuE;IACvE,cAAc,CAAC,EAAE,CAAC,KAAK,EAAE,MAAM,KAAK,IAAI,CAAC;IACzC,2EAA2E;IAC3E,aAAa,CAAC,EAAE,CAAC,KAAK,EAAE,MAAM,KAAK,IAAI,CAAC;IACxC;;;OAGG;IACH,cAAc,CAAC,EAAE,CAAC,IAAI,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,KAAK,IAAI,CAAC;IACpD,8EAA8E;IAC9E,aAAa,CAAC,EAAE,CAAC,KAAK,EAAE,MAAM,KAAK,IAAI,CAAC;IACxC,qCAAqC;IACrC,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,6EAA6E;IAC7E,WAAW,CAAC,EAAE,OAAO,CAAC;CACvB;AAED,MAAM,WAAW,cAAc;IAC7B,iFAAiF;IACjF,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,oBAAoB;IACpB,KAAK,CAAC,EAAE,SAAS,CAAC;IAClB,mCAAmC;IACnC,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB,iEAAiE;IACjE,gBAAgB,CAAC,EAAE,OAAO,CAAC;IAC3B,6DAA6D;IAC7D,iBAAiB,CAAC,EAAE,CAAC,SAAS,EAAE,OAAO,KAAK,IAAI,CAAC;IACjD,yDAAyD;IACzD,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB;;;OAGG;IACH,YAAY,CAAC,EAAE,qBAAqB,CAAC;IACrC,6FAA6F;IAC7F,QAAQ,CAAC,EAAE,SAAS,CAAC;IACrB,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED;;;;GAIG;AACH,MAAM,MAAM,sBAAsB,GAC9B,KAAK,GACL,SAAS,GACT,UAAU,GACV,MAAM,GACN,QAAQ,CAAC;AAEb;;;;;GAKG;AACH,MAAM,WAAW,uBAAuB;IACtC,6DAA6D;IAC7D,WAAW,CAAC,EAAE,MAAM,IAAI,CAAC;IACzB,0EAA0E;IAC1E,cAAc,CAAC,EAAE,CAAC,KAAK,EAAE,MAAM,KAAK,IAAI,CAAC;IACzC,iGAAiG;IACjG,eAAe,CAAC,EAAE,CAAC,IAAI,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,KAAK,IAAI,CAAC;CACtD;AAcD,MAAM,WAAW,oBAAoB;IACnC;;;;;OAKG;IACH,OAAO,CAAC,EAAE,sBAAsB,CAAC;IACjC,iGAAiG;IACjG,KAAK,CAAC,EAAE,UAAU,CAAC;IACnB,mEAAmE;IACnE,KAAK,CAAC,EAAE,SAAS,CAAC;IAClB,mFAAmF;IACnF,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB;;;OAGG;IACH,aAAa,CAAC,EAAE,MAAM,IAAI,CAAC;IAC3B,0EAA0E;IAC1E,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,QAAQ,EAAE,SAAS,CAAC;IACpB,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AA8KD,0FAA0F;AAC1F,iBAAS,cAAc,CAAC,MAAM,EAAE;IAAE,QAAQ,CAAC,EAAE,SAAS,CAAA;CAAE,QAEvD;AAED,iDAAiD;AACjD,iBAAS,gBAAgB,CAAC,EACxB,QAAQ,EACR,SAAS,EACT,OAAO,GACR,EAAE;IACD,QAAQ,EAAE,SAAS,CAAC;IACpB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,0FAA0F;IAC1F,OAAO,CAAC,EAAE,uBAAuB,CAAC;CACnC,+BAuDA;AAED,6FAA6F;AAC7F,iBAAS,eAAe,CAAC,KAAK,EAAE,oBAAoB,+BAmKnD;AAgOD,iBAAS,aAAa,CAAC,EACrB,MAAM,EACN,KAAK,EACL,WAAW,EACX,gBAAwB,EACxB,iBAAiB,EACjB,WAAkB,EAClB,YAAY,EACZ,QAAQ,EACR,SAAS,GACV,EAAE,cAAc,+BAsFhB;AAED;;;;;GAKG;AACH,eAAO,MAAM,SAAS;;;;CAIpB,CAAC"}
|
|
@@ -5,11 +5,12 @@ declare const meta: {
|
|
|
5
5
|
Media: (_props: {
|
|
6
6
|
children?: import("react").ReactNode;
|
|
7
7
|
}) => null;
|
|
8
|
-
Bullets: ({ children, className, }: {
|
|
8
|
+
Bullets: ({ children, className, editing, }: {
|
|
9
9
|
children: import("react").ReactNode;
|
|
10
10
|
className?: string;
|
|
11
|
+
editing?: import("./GuideStep").GuideStepBulletsEditing;
|
|
11
12
|
}) => import("react").JSX.Element;
|
|
12
|
-
Bullet: (
|
|
13
|
+
Bullet: (props: import("./GuideStep").GuideStepBulletProps) => import("react").JSX.Element;
|
|
13
14
|
};
|
|
14
15
|
tags: string[];
|
|
15
16
|
parameters: {
|
|
@@ -29,6 +30,7 @@ export default meta;
|
|
|
29
30
|
type Story = StoryObj<typeof meta>;
|
|
30
31
|
export declare const Anatomy: Story;
|
|
31
32
|
export declare const MultipleImages: Story;
|
|
33
|
+
export declare const MixedMedia: Story;
|
|
32
34
|
export declare const DotBullets: Story;
|
|
33
35
|
export declare const SemanticBullets: Story;
|
|
34
36
|
export declare const ButtonBullet: Story;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"GuideStep.stories.d.ts","sourceRoot":"","sources":["../../../src/components/GuideStep/GuideStep.stories.tsx"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAQ,QAAQ,EAAE,MAAM,uBAAuB,CAAC;
|
|
1
|
+
{"version":3,"file":"GuideStep.stories.d.ts","sourceRoot":"","sources":["../../../src/components/GuideStep/GuideStep.stories.tsx"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAQ,QAAQ,EAAE,MAAM,uBAAuB,CAAC;AAyE5D,QAAA,MAAM,IAAI;;;;oBA4MQ,CAAC;;;;qBAIT,CAAN;mBAEgB,CAAC;;;;;;;;;;;;;;;;;CAtMa,CAAC;AAEnC,eAAe,IAAI,CAAC;AAEpB,KAAK,KAAK,GAAG,QAAQ,CAAC,OAAO,IAAI,CAAC,CAAC;AAEnC,eAAO,MAAM,OAAO,EAAE,KAgCrB,CAAC;AAEF,eAAO,MAAM,cAAc,EAAE,KAmC5B,CAAC;AAEF,eAAO,MAAM,UAAU,EAAE,KAiDxB,CAAC;AAEF,eAAO,MAAM,UAAU,EAAE,KAsCxB,CAAC;AAEF,eAAO,MAAM,eAAe,EAAE,KAoC7B,CAAC;AAEF,eAAO,MAAM,YAAY,EAAE,KAsC1B,CAAC;AAEF,eAAO,MAAM,SAAS,EAAE,KAwBvB,CAAC;AAEF,eAAO,MAAM,kBAAkB,EAAE,KA2GhC,CAAC;AAEF,eAAO,MAAM,iBAAiB,EAAE,KA0B/B,CAAC"}
|
|
@@ -1,3 +1,3 @@
|
|
|
1
1
|
export { GuideStep } from "./GuideStep";
|
|
2
|
-
export type { GuideStepProps, GuideStepBulletProps, GuideStepBulletVariant, GuideStepMediaEditing, } from "./GuideStep";
|
|
2
|
+
export type { GuideStepProps, GuideStepBulletProps, GuideStepBulletVariant, GuideStepMediaEditing, GuideStepBulletsEditing, } from "./GuideStep";
|
|
3
3
|
//# sourceMappingURL=index.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/components/GuideStep/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AACxC,YAAY,EACV,cAAc,EACd,oBAAoB,EACpB,sBAAsB,EACtB,qBAAqB,
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/components/GuideStep/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AACxC,YAAY,EACV,cAAc,EACd,oBAAoB,EACpB,sBAAsB,EACtB,qBAAqB,EACrB,uBAAuB,GACxB,MAAM,aAAa,CAAC"}
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
import type { MediaFigureProps } from "./MediaFigure";
|
|
2
|
+
export interface MediaFigureThumbnailProps {
|
|
3
|
+
/** Source URL of the underlying media. */
|
|
4
|
+
src: string;
|
|
5
|
+
/** Media kind. Non-image types render a colored placeholder. @default "image" */
|
|
6
|
+
type?: MediaFigureProps["type"];
|
|
7
|
+
className?: string;
|
|
8
|
+
}
|
|
9
|
+
/**
|
|
10
|
+
* A square thumbnail for a {@link MediaFigure} source. Images render directly;
|
|
11
|
+
* videos and 3D models — which have no still image — render a colored placeholder
|
|
12
|
+
* (a play icon or "3D") so they never appear as a broken image in a gallery.
|
|
13
|
+
*/
|
|
14
|
+
export declare function MediaFigureThumbnail({ src, type, className, }: MediaFigureThumbnailProps): import("react").JSX.Element;
|
|
15
|
+
//# sourceMappingURL=MediaFigureThumbnail.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"MediaFigureThumbnail.d.ts","sourceRoot":"","sources":["../../../src/components/MediaFigure/MediaFigureThumbnail.tsx"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,eAAe,CAAC;AAmBtD,MAAM,WAAW,yBAAyB;IACxC,0CAA0C;IAC1C,GAAG,EAAE,MAAM,CAAC;IACZ,iFAAiF;IACjF,IAAI,CAAC,EAAE,gBAAgB,CAAC,MAAM,CAAC,CAAC;IAChC,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED;;;;GAIG;AACH,wBAAgB,oBAAoB,CAAC,EACnC,GAAG,EACH,IAAc,EACd,SAAS,GACV,EAAE,yBAAyB,+BAsB3B"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"MediaFigureThumbnail.test.d.ts","sourceRoot":"","sources":["../../../src/components/MediaFigure/MediaFigureThumbnail.test.tsx"],"names":[],"mappings":""}
|
|
@@ -1,3 +1,5 @@
|
|
|
1
1
|
export { MediaFigure } from "./MediaFigure";
|
|
2
2
|
export type { MediaFigureProps, MediaAnnotation, MediaDisplayRegion, PointAnnotation, CircleAnnotation, RectangleAnnotation, } from "./MediaFigure";
|
|
3
|
+
export { MediaFigureThumbnail } from "./MediaFigureThumbnail";
|
|
4
|
+
export type { MediaFigureThumbnailProps } from "./MediaFigureThumbnail";
|
|
3
5
|
//# sourceMappingURL=index.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/components/MediaFigure/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AAC5C,YAAY,EACV,gBAAgB,EAChB,eAAe,EACf,kBAAkB,EAClB,eAAe,EACf,gBAAgB,EAChB,mBAAmB,GACpB,MAAM,eAAe,CAAC"}
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/components/MediaFigure/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AAC5C,YAAY,EACV,gBAAgB,EAChB,eAAe,EACf,kBAAkB,EAClB,eAAe,EACf,gBAAgB,EAChB,mBAAmB,GACpB,MAAM,eAAe,CAAC;AACvB,OAAO,EAAE,oBAAoB,EAAE,MAAM,wBAAwB,CAAC;AAC9D,YAAY,EAAE,yBAAyB,EAAE,MAAM,wBAAwB,CAAC"}
|