@impulse-ui-native/storybook 2.0.0 → 2.0.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/README.md +37 -0
- package/package.json +2 -2
package/README.md
ADDED
|
@@ -0,0 +1,37 @@
|
|
|
1
|
+
# @impulse-ui-native/storybook
|
|
2
|
+
|
|
3
|
+
Shared constants and metadata helpers used by the Impulse UI Native Storybook application.
|
|
4
|
+
|
|
5
|
+
## Installation
|
|
6
|
+
|
|
7
|
+
```sh
|
|
8
|
+
pnpm add -D @impulse-ui-native/storybook
|
|
9
|
+
```
|
|
10
|
+
|
|
11
|
+
This is an authoring-support package rather than a UI component package.
|
|
12
|
+
|
|
13
|
+
## Main exports
|
|
14
|
+
|
|
15
|
+
- `createStoryDescription(notes)` produces the notes metadata for an individual story.
|
|
16
|
+
- `createComponentDescription(notes)` produces component-level notes metadata.
|
|
17
|
+
- `ComponentSizeOptions` contains `small`, `medium`, and `large`.
|
|
18
|
+
- `ComponentVariantOptions` contains `filled`, `outlined`, `soft`, `ghost`, and `plain`.
|
|
19
|
+
|
|
20
|
+
## Usage
|
|
21
|
+
|
|
22
|
+
```ts
|
|
23
|
+
import {
|
|
24
|
+
ComponentSizeOptions,
|
|
25
|
+
createComponentDescription,
|
|
26
|
+
} from "@impulse-ui-native/storybook";
|
|
27
|
+
|
|
28
|
+
export default {
|
|
29
|
+
title: "Primitives/Button",
|
|
30
|
+
parameters: createComponentDescription("A token-driven action control."),
|
|
31
|
+
argTypes: {
|
|
32
|
+
size: { options: ComponentSizeOptions, control: "select" },
|
|
33
|
+
},
|
|
34
|
+
};
|
|
35
|
+
```
|
|
36
|
+
|
|
37
|
+
The package source also contains the toolkit's own stories and documentation screens, but those files are not part of the public root export.
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@impulse-ui-native/storybook",
|
|
3
|
-
"version": "2.0.
|
|
3
|
+
"version": "2.0.1",
|
|
4
4
|
"source": "src/index.ts",
|
|
5
5
|
"module": "dist/index.js",
|
|
6
6
|
"types": "dist/index.d.mts",
|
|
@@ -18,7 +18,7 @@
|
|
|
18
18
|
"LICENSE"
|
|
19
19
|
],
|
|
20
20
|
"dependencies": {
|
|
21
|
-
"@impulse-ui-native/toolkit": "2.0.
|
|
21
|
+
"@impulse-ui-native/toolkit": "2.0.1"
|
|
22
22
|
},
|
|
23
23
|
"devDependencies": {
|
|
24
24
|
"@types/react": "~19.2.14",
|