@openpawlabs/diy-guides-ui 1.0.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.
- package/LICENSE +661 -0
- package/README.md +126 -0
- package/dist/components/Callout/Callout.d.ts +21 -0
- package/dist/components/Callout/Callout.d.ts.map +1 -0
- package/dist/components/Callout/Callout.stories.d.ts +31 -0
- package/dist/components/Callout/Callout.stories.d.ts.map +1 -0
- package/dist/components/Callout/Callout.test.d.ts +2 -0
- package/dist/components/Callout/Callout.test.d.ts.map +1 -0
- package/dist/components/Callout/index.d.ts +3 -0
- package/dist/components/Callout/index.d.ts.map +1 -0
- package/dist/components/DifficultyBadge/DifficultyBadge.d.ts +20 -0
- package/dist/components/DifficultyBadge/DifficultyBadge.d.ts.map +1 -0
- package/dist/components/DifficultyBadge/DifficultyBadge.stories.d.ts +37 -0
- package/dist/components/DifficultyBadge/DifficultyBadge.stories.d.ts.map +1 -0
- package/dist/components/DifficultyBadge/DifficultyBadge.test.d.ts +2 -0
- package/dist/components/DifficultyBadge/DifficultyBadge.test.d.ts.map +1 -0
- package/dist/components/DifficultyBadge/index.d.ts +3 -0
- package/dist/components/DifficultyBadge/index.d.ts.map +1 -0
- package/dist/components/GuideLayout/GuideLayout.d.ts +49 -0
- package/dist/components/GuideLayout/GuideLayout.d.ts.map +1 -0
- package/dist/components/GuideLayout/GuideLayout.stories.d.ts +33 -0
- package/dist/components/GuideLayout/GuideLayout.stories.d.ts.map +1 -0
- package/dist/components/GuideLayout/GuideLayout.test.d.ts +2 -0
- package/dist/components/GuideLayout/GuideLayout.test.d.ts.map +1 -0
- package/dist/components/GuideLayout/index.d.ts +3 -0
- package/dist/components/GuideLayout/index.d.ts.map +1 -0
- package/dist/components/GuideStep/GuideStep.d.ts +62 -0
- package/dist/components/GuideStep/GuideStep.d.ts.map +1 -0
- package/dist/components/GuideStep/GuideStep.stories.d.ts +36 -0
- package/dist/components/GuideStep/GuideStep.stories.d.ts.map +1 -0
- package/dist/components/GuideStep/GuideStep.test.d.ts +2 -0
- package/dist/components/GuideStep/GuideStep.test.d.ts.map +1 -0
- package/dist/components/GuideStep/index.d.ts +3 -0
- package/dist/components/GuideStep/index.d.ts.map +1 -0
- package/dist/components/GuideStepList/GuideStepList.d.ts +21 -0
- package/dist/components/GuideStepList/GuideStepList.d.ts.map +1 -0
- package/dist/components/GuideStepList/GuideStepList.stories.d.ts +23 -0
- package/dist/components/GuideStepList/GuideStepList.stories.d.ts.map +1 -0
- package/dist/components/GuideStepList/GuideStepList.test.d.ts +2 -0
- package/dist/components/GuideStepList/GuideStepList.test.d.ts.map +1 -0
- package/dist/components/GuideStepList/index.d.ts +3 -0
- package/dist/components/GuideStepList/index.d.ts.map +1 -0
- package/dist/components/MediaFigure/MediaFigure.d.ts +70 -0
- package/dist/components/MediaFigure/MediaFigure.d.ts.map +1 -0
- package/dist/components/MediaFigure/MediaFigure.stories.d.ts +33 -0
- package/dist/components/MediaFigure/MediaFigure.stories.d.ts.map +1 -0
- package/dist/components/MediaFigure/MediaFigure.test.d.ts +2 -0
- package/dist/components/MediaFigure/MediaFigure.test.d.ts.map +1 -0
- package/dist/components/MediaFigure/MediaFigureMedia.d.ts +8 -0
- package/dist/components/MediaFigure/MediaFigureMedia.d.ts.map +1 -0
- package/dist/components/MediaFigure/MediaFigureModel.d.ts +5 -0
- package/dist/components/MediaFigure/MediaFigureModel.d.ts.map +1 -0
- package/dist/components/MediaFigure/index.d.ts +3 -0
- package/dist/components/MediaFigure/index.d.ts.map +1 -0
- package/dist/components/ToolList/ToolList.d.ts +34 -0
- package/dist/components/ToolList/ToolList.d.ts.map +1 -0
- package/dist/components/ToolList/ToolList.stories.d.ts +24 -0
- package/dist/components/ToolList/ToolList.stories.d.ts.map +1 -0
- package/dist/components/ToolList/ToolList.test.d.ts +2 -0
- package/dist/components/ToolList/ToolList.test.d.ts.map +1 -0
- package/dist/components/ToolList/index.d.ts +3 -0
- package/dist/components/ToolList/index.d.ts.map +1 -0
- package/dist/diy-guides-ui.cjs +24 -0
- package/dist/diy-guides-ui.cjs.map +1 -0
- package/dist/diy-guides-ui.js +7749 -0
- package/dist/diy-guides-ui.js.map +1 -0
- package/dist/hooks/useControlledState.d.ts +7 -0
- package/dist/hooks/useControlledState.d.ts.map +1 -0
- package/dist/index.d.ts +19 -0
- package/dist/index.d.ts.map +1 -0
- package/dist/stories/Welcome.stories.d.ts +21 -0
- package/dist/stories/Welcome.stories.d.ts.map +1 -0
- package/dist/style.css +1 -0
- package/dist/test/setup.d.ts +2 -0
- package/dist/test/setup.d.ts.map +1 -0
- package/dist/test/smoke.test.d.ts +2 -0
- package/dist/test/smoke.test.d.ts.map +1 -0
- package/dist/types/callout.d.ts +13 -0
- package/dist/types/callout.d.ts.map +1 -0
- package/dist/types/callout.test.d.ts +2 -0
- package/dist/types/callout.test.d.ts.map +1 -0
- package/dist/types/colors.d.ts +20 -0
- package/dist/types/colors.d.ts.map +1 -0
- package/dist/types/colors.test.d.ts +2 -0
- package/dist/types/colors.test.d.ts.map +1 -0
- package/dist/utils/mediaCrop.d.ts +19 -0
- package/dist/utils/mediaCrop.d.ts.map +1 -0
- package/dist/utils/mediaCrop.test.d.ts +2 -0
- package/dist/utils/mediaCrop.test.d.ts.map +1 -0
- package/package.json +81 -0
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Bridges controlled and uncontrolled usage with one hook. When `value` is
|
|
3
|
+
* provided the component is controlled; otherwise state is held internally and
|
|
4
|
+
* seeded from `defaultValue`. `onChange` always fires on updates.
|
|
5
|
+
*/
|
|
6
|
+
export declare function useControlledState<T>(value: T | undefined, defaultValue: T, onChange?: (value: T) => void): [T, (next: T) => void];
|
|
7
|
+
//# sourceMappingURL=useControlledState.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"useControlledState.d.ts","sourceRoot":"","sources":["../../src/hooks/useControlledState.ts"],"names":[],"mappings":"AAEA;;;;GAIG;AACH,wBAAgB,kBAAkB,CAAC,CAAC,EAClC,KAAK,EAAE,CAAC,GAAG,SAAS,EACpB,YAAY,EAAE,CAAC,EACf,QAAQ,CAAC,EAAE,CAAC,KAAK,EAAE,CAAC,KAAK,IAAI,GAC5B,CAAC,CAAC,EAAE,CAAC,IAAI,EAAE,CAAC,KAAK,IAAI,CAAC,CAcxB"}
|
package/dist/index.d.ts
ADDED
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
import "./styles/index.css";
|
|
2
|
+
export { COLORS, hexToRgba, markerTextColor, type GuideColor } from "./types/colors";
|
|
3
|
+
export { type CalloutType, calloutTypeColor, calloutTypeHex, calloutTypeLabel, } from "./types/callout";
|
|
4
|
+
export { DifficultyBadge } from "./components/DifficultyBadge";
|
|
5
|
+
export type { DifficultyBadgeProps, Difficulty, } from "./components/DifficultyBadge";
|
|
6
|
+
export { Callout } from "./components/Callout";
|
|
7
|
+
export type { CalloutProps } from "./components/Callout";
|
|
8
|
+
export { MediaFigure } from "./components/MediaFigure";
|
|
9
|
+
export type { MediaFigureProps, MediaAnnotation, MediaDisplayRegion, PointAnnotation, CircleAnnotation, RectangleAnnotation, } from "./components/MediaFigure";
|
|
10
|
+
export { DISPLAY_REGION_ASPECT, displayRegionHeight, } from "./utils/mediaCrop";
|
|
11
|
+
export { ToolList } from "./components/ToolList";
|
|
12
|
+
export type { ToolListProps, ToolListItemProps } from "./components/ToolList";
|
|
13
|
+
export { GuideStep } from "./components/GuideStep";
|
|
14
|
+
export type { GuideStepProps, GuideStepBulletProps, GuideStepBulletVariant, } from "./components/GuideStep";
|
|
15
|
+
export { GuideStepList } from "./components/GuideStepList";
|
|
16
|
+
export type { GuideStepListProps, GuideProgress, } from "./components/GuideStepList";
|
|
17
|
+
export { GuideLayout } from "./components/GuideLayout";
|
|
18
|
+
export type { GuideLayoutProps, GuideLayoutHeaderProps, GuideLayoutIntroProps, } from "./components/GuideLayout";
|
|
19
|
+
//# sourceMappingURL=index.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,oBAAoB,CAAC;AAG5B,OAAO,EAAE,MAAM,EAAE,SAAS,EAAE,eAAe,EAAE,KAAK,UAAU,EAAE,MAAM,gBAAgB,CAAC;AACrF,OAAO,EACL,KAAK,WAAW,EAChB,gBAAgB,EAChB,cAAc,EACd,gBAAgB,GACjB,MAAM,iBAAiB,CAAC;AAGzB,OAAO,EAAE,eAAe,EAAE,MAAM,8BAA8B,CAAC;AAC/D,YAAY,EACV,oBAAoB,EACpB,UAAU,GACX,MAAM,8BAA8B,CAAC;AAEtC,OAAO,EAAE,OAAO,EAAE,MAAM,sBAAsB,CAAC;AAC/C,YAAY,EAAE,YAAY,EAAE,MAAM,sBAAsB,CAAC;AAEzD,OAAO,EAAE,WAAW,EAAE,MAAM,0BAA0B,CAAC;AACvD,YAAY,EACV,gBAAgB,EAChB,eAAe,EACf,kBAAkB,EAClB,eAAe,EACf,gBAAgB,EAChB,mBAAmB,GACpB,MAAM,0BAA0B,CAAC;AAElC,OAAO,EACL,qBAAqB,EACrB,mBAAmB,GACpB,MAAM,mBAAmB,CAAC;AAE3B,OAAO,EAAE,QAAQ,EAAE,MAAM,uBAAuB,CAAC;AACjD,YAAY,EAAE,aAAa,EAAE,iBAAiB,EAAE,MAAM,uBAAuB,CAAC;AAE9E,OAAO,EAAE,SAAS,EAAE,MAAM,wBAAwB,CAAC;AACnD,YAAY,EACV,cAAc,EACd,oBAAoB,EACpB,sBAAsB,GACvB,MAAM,wBAAwB,CAAC;AAEhC,OAAO,EAAE,aAAa,EAAE,MAAM,4BAA4B,CAAC;AAC3D,YAAY,EACV,kBAAkB,EAClB,aAAa,GACd,MAAM,4BAA4B,CAAC;AAEpC,OAAO,EAAE,WAAW,EAAE,MAAM,0BAA0B,CAAC;AACvD,YAAY,EACV,gBAAgB,EAChB,sBAAsB,EACtB,qBAAqB,GACtB,MAAM,0BAA0B,CAAC"}
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
import type { StoryObj } from "@storybook/react-vite";
|
|
2
|
+
/**
|
|
3
|
+
* Narrative documentation for the library. These pages explain what DIY Guides
|
|
4
|
+
* UI is, how to install it, how a guide is composed, the guide color palette
|
|
5
|
+
* and callout types, and how to write guides people can actually follow.
|
|
6
|
+
* Component-level API reference lives under the "Guide" section.
|
|
7
|
+
*/
|
|
8
|
+
declare const meta: {
|
|
9
|
+
title: string;
|
|
10
|
+
parameters: {
|
|
11
|
+
layout: string;
|
|
12
|
+
};
|
|
13
|
+
};
|
|
14
|
+
export default meta;
|
|
15
|
+
type Story = StoryObj<typeof meta>;
|
|
16
|
+
export declare const Overview: Story;
|
|
17
|
+
export declare const Installation: Story;
|
|
18
|
+
export declare const AnatomyOfAGuide: Story;
|
|
19
|
+
export declare const ColorsAndCallouts: Story;
|
|
20
|
+
export declare const WritingGreatGuides: Story;
|
|
21
|
+
//# sourceMappingURL=Welcome.stories.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"Welcome.stories.d.ts","sourceRoot":"","sources":["../../src/stories/Welcome.stories.tsx"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAQ,QAAQ,EAAE,MAAM,uBAAuB,CAAC;AA8D5D;;;;;GAKG;AACH,QAAA,MAAM,IAAI;;;;;CAKM,CAAC;AAEjB,eAAe,IAAI,CAAC;AAEpB,KAAK,KAAK,GAAG,QAAQ,CAAC,OAAO,IAAI,CAAC,CAAC;AAiVnC,eAAO,MAAM,QAAQ,EAAE,KAqGtB,CAAC;AAEF,eAAO,MAAM,YAAY,EAAE,KAkD1B,CAAC;AAEF,eAAO,MAAM,eAAe,EAAE,KA0D7B,CAAC;AAEF,eAAO,MAAM,iBAAiB,EAAE,KAuG/B,CAAC;AAEF,eAAO,MAAM,kBAAkB,EAAE,KAoFhC,CAAC"}
|