@repobuddy/storybook 2.23.0 → 2.24.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.
|
@@ -8,7 +8,7 @@ type TagBadgeParameter = TagBadgeParameters[0];
|
|
|
8
8
|
/**
|
|
9
9
|
* Type representing the names of predefined tags used in Storybook stories.
|
|
10
10
|
*/
|
|
11
|
-
type TagNames = '!test' | 'editor' | 'source' | 'type' | '!type' | 'func' | '!func' | 'var' | '!var' | 'new' | 'alpha' | 'beta' | 'rc' | 'props' | 'deprecated' | 'outdated' | 'danger' | 'todo' | 'code-only' | 'snapshot' | '!snapshot' | 'unit' | 'integration' | 'keyboard' | 'internal' | 'usecase' | 'use-case' | 'example' | 'perf' | 'version:next' | 'remove' | 'remove:next' | 'autodocs';
|
|
11
|
+
type TagNames = '!test' | 'editor' | 'source' | 'type' | '!type' | 'func' | '!func' | 'var' | '!var' | 'new' | 'alpha' | 'beta' | 'rc' | 'props' | 'deprecated' | 'outdated' | 'danger' | 'todo' | 'code-only' | 'snapshot' | '!snapshot' | 'unit' | 'integration' | 'keyboard' | 'internal' | 'usecase' | 'use-case' | 'playground' | 'example' | 'perf' | 'version:next' | 'remove' | 'remove:next' | 'autodocs';
|
|
12
12
|
/** Badge (✏️) for stories with a live editor. Shown in sidebar on story and inherited. */
|
|
13
13
|
declare const editorBadge: TagBadgeParameter;
|
|
14
14
|
/** Badge (🆕) for recently added stories. */
|
|
@@ -53,6 +53,8 @@ declare const keyboardBadge: TagBadgeParameter;
|
|
|
53
53
|
declare const internalBadge: TagBadgeParameter;
|
|
54
54
|
/** Badge (🎯) for stories that demonstrate a specific use case or scenario. */
|
|
55
55
|
declare const useCaseBadge: TagBadgeParameter;
|
|
56
|
+
/** Badge (▶️) for high-quality interactive playground stories where users can explore and interact with the component. */
|
|
57
|
+
declare const playgroundBadge: TagBadgeParameter;
|
|
56
58
|
/** Badge (✨) for example or demo stories. */
|
|
57
59
|
declare const exampleBadge: TagBadgeParameter;
|
|
58
60
|
/** Badge (⚡) for stories that demonstrate or test performance. */
|
|
@@ -62,7 +64,7 @@ declare const perfBadge: TagBadgeParameter;
|
|
|
62
64
|
* Each badge is associated with a specific tag and displays an emoji or symbol with a tooltip.
|
|
63
65
|
*
|
|
64
66
|
* Badge order (first match wins): New → Alpha → Beta → RC → Deprecated → Remove → Outdated → Danger → Use Case →
|
|
65
|
-
* Example → Perf → Keyboard → Source → Type → Function → Var → Props → Todo → Unit → Integration →
|
|
67
|
+
* Playground → Example → Perf → Keyboard → Source → Type → Function → Var → Props → Todo → Unit → Integration →
|
|
66
68
|
* Editor → Code Only → Version → Internal → Snapshot.
|
|
67
69
|
*
|
|
68
70
|
* - 🆕 New - Recently added stories
|
|
@@ -74,6 +76,7 @@ declare const perfBadge: TagBadgeParameter;
|
|
|
74
76
|
* - ⚠️ Outdated - Stories that need updating
|
|
75
77
|
* - 🚨 Danger - Stories demonstrating dangerous patterns
|
|
76
78
|
* - 🎯 Use Case - Stories that demonstrate a specific use case or scenario
|
|
79
|
+
* - ▶️ Playground - High-quality interactive stories for users to explore and interact with the component
|
|
77
80
|
* - ✨ Example - Example or demo stories
|
|
78
81
|
* - ⚡ Perf - Stories that demonstrate or test performance
|
|
79
82
|
* - ⌨️ Keyboard - Stories that demonstrate or test keyboard interaction
|
|
@@ -165,4 +168,4 @@ type StoryObj<TMetaOrCmpOrArgs = Args> = ExtendStoryObj<TMetaOrCmpOrArgs, StoryO
|
|
|
165
168
|
tag: TagNames;
|
|
166
169
|
}>;
|
|
167
170
|
//#endregion
|
|
168
|
-
export { Meta, StoryObj, TagNames, alphaBadge, betaBadge, codeOnlyBadge, dangerBadge, deprecatedBadge, editorBadge, exampleBadge, functionBadge, integrationBadge, internalBadge, keyboardBadge, newBadge, outdatedBadge, perfBadge, propsBadge, rcBadge, removeBadge, snapshotBadge, sourceBadge, tagBadges, todoBadge, typeBadge, unitBadge, useCaseBadge, varBadge };
|
|
171
|
+
export { Meta, StoryObj, TagNames, alphaBadge, betaBadge, codeOnlyBadge, dangerBadge, deprecatedBadge, editorBadge, exampleBadge, functionBadge, integrationBadge, internalBadge, keyboardBadge, newBadge, outdatedBadge, perfBadge, playgroundBadge, propsBadge, rcBadge, removeBadge, snapshotBadge, sourceBadge, tagBadges, todoBadge, typeBadge, unitBadge, useCaseBadge, varBadge };
|
|
@@ -315,6 +315,22 @@ const useCaseBadge = {
|
|
|
315
315
|
skipInherited: false
|
|
316
316
|
} }
|
|
317
317
|
};
|
|
318
|
+
/** Badge (▶️) for high-quality interactive playground stories where users can explore and interact with the component. */
|
|
319
|
+
const playgroundBadge = {
|
|
320
|
+
tags: "playground",
|
|
321
|
+
badge: {
|
|
322
|
+
text: "▶️",
|
|
323
|
+
style: {
|
|
324
|
+
backgroundColor: "transparent",
|
|
325
|
+
borderColor: "transparent"
|
|
326
|
+
},
|
|
327
|
+
tooltip: "Playground"
|
|
328
|
+
},
|
|
329
|
+
display: { sidebar: {
|
|
330
|
+
type: "story",
|
|
331
|
+
skipInherited: false
|
|
332
|
+
} }
|
|
333
|
+
};
|
|
318
334
|
/** Badge (✨) for example or demo stories. */
|
|
319
335
|
const exampleBadge = {
|
|
320
336
|
tags: "example",
|
|
@@ -352,7 +368,7 @@ const perfBadge = {
|
|
|
352
368
|
* Each badge is associated with a specific tag and displays an emoji or symbol with a tooltip.
|
|
353
369
|
*
|
|
354
370
|
* Badge order (first match wins): New → Alpha → Beta → RC → Deprecated → Remove → Outdated → Danger → Use Case →
|
|
355
|
-
* Example → Perf → Keyboard → Source → Type → Function → Var → Props → Todo → Unit → Integration →
|
|
371
|
+
* Playground → Example → Perf → Keyboard → Source → Type → Function → Var → Props → Todo → Unit → Integration →
|
|
356
372
|
* Editor → Code Only → Version → Internal → Snapshot.
|
|
357
373
|
*
|
|
358
374
|
* - 🆕 New - Recently added stories
|
|
@@ -364,6 +380,7 @@ const perfBadge = {
|
|
|
364
380
|
* - ⚠️ Outdated - Stories that need updating
|
|
365
381
|
* - 🚨 Danger - Stories demonstrating dangerous patterns
|
|
366
382
|
* - 🎯 Use Case - Stories that demonstrate a specific use case or scenario
|
|
383
|
+
* - ▶️ Playground - High-quality interactive stories for users to explore and interact with the component
|
|
367
384
|
* - ✨ Example - Example or demo stories
|
|
368
385
|
* - ⚡ Perf - Stories that demonstrate or test performance
|
|
369
386
|
* - ⌨️ Keyboard - Stories that demonstrate or test keyboard interaction
|
|
@@ -392,6 +409,7 @@ const tagBadges = [
|
|
|
392
409
|
outdatedBadge,
|
|
393
410
|
dangerBadge,
|
|
394
411
|
useCaseBadge,
|
|
412
|
+
playgroundBadge,
|
|
395
413
|
exampleBadge,
|
|
396
414
|
perfBadge,
|
|
397
415
|
keyboardBadge,
|
|
@@ -411,4 +429,4 @@ const tagBadges = [
|
|
|
411
429
|
];
|
|
412
430
|
|
|
413
431
|
//#endregion
|
|
414
|
-
export { alphaBadge, betaBadge, codeOnlyBadge, dangerBadge, deprecatedBadge, editorBadge, exampleBadge, functionBadge, integrationBadge, internalBadge, keyboardBadge, newBadge, outdatedBadge, perfBadge, propsBadge, rcBadge, removeBadge, snapshotBadge, sourceBadge, tagBadges, todoBadge, typeBadge, unitBadge, useCaseBadge, varBadge };
|
|
432
|
+
export { alphaBadge, betaBadge, codeOnlyBadge, dangerBadge, deprecatedBadge, editorBadge, exampleBadge, functionBadge, integrationBadge, internalBadge, keyboardBadge, newBadge, outdatedBadge, perfBadge, playgroundBadge, propsBadge, rcBadge, removeBadge, snapshotBadge, sourceBadge, tagBadges, todoBadge, typeBadge, unitBadge, useCaseBadge, varBadge };
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@repobuddy/storybook",
|
|
3
|
-
"version": "2.
|
|
3
|
+
"version": "2.24.0",
|
|
4
4
|
"description": "Storybook repo buddy",
|
|
5
5
|
"keywords": [
|
|
6
6
|
"storybook",
|
|
@@ -80,6 +80,7 @@
|
|
|
80
80
|
"class-variance-authority": "^0.7.1",
|
|
81
81
|
"htmlfy": "^1.0.0",
|
|
82
82
|
"tailwind-merge": "^3.4.0",
|
|
83
|
+
"tailwindcss": "^4.2.1",
|
|
83
84
|
"type-plus": "8.0.0-beta.8"
|
|
84
85
|
},
|
|
85
86
|
"devDependencies": {
|
|
@@ -102,7 +103,6 @@
|
|
|
102
103
|
"storybook-addon-code-editor": "^6.1.3",
|
|
103
104
|
"storybook-addon-tag-badges": "^3.0.6",
|
|
104
105
|
"storybook-addon-vis": "^3.1.2",
|
|
105
|
-
"tailwindcss": "^4.1.17",
|
|
106
106
|
"tsdown": "^0.20.0",
|
|
107
107
|
"vite": "^7.3.0",
|
|
108
108
|
"vitest": "^4.0.16"
|
package/readme.md
CHANGED
|
@@ -89,6 +89,7 @@ we provide a different set of badges that uses emojis (order: first match wins):
|
|
|
89
89
|
| ⚠️ | `outdated` | Stories that need updating |
|
|
90
90
|
| 🚨 | `danger` | Dangerous or cautionary patterns |
|
|
91
91
|
| 🎯 | `use-case` | Specific use case or scenario |
|
|
92
|
+
| ▶️ | `playground` | High-quality interactive stories for users to explore and interact with the component |
|
|
92
93
|
| ✨ | `example` | Example or demo stories |
|
|
93
94
|
| ⚡ | `perf` | Performance (stories that demonstrate or test performance) |
|
|
94
95
|
| ⌨️ | `keyboard` | Keyboard interaction |
|
|
@@ -35,6 +35,7 @@ export type TagNames =
|
|
|
35
35
|
| 'internal'
|
|
36
36
|
| 'usecase'
|
|
37
37
|
| 'use-case'
|
|
38
|
+
| 'playground'
|
|
38
39
|
| 'example'
|
|
39
40
|
| 'perf'
|
|
40
41
|
| 'version:next'
|
|
@@ -395,6 +396,25 @@ export const useCaseBadge: TagBadgeParameter = {
|
|
|
395
396
|
}
|
|
396
397
|
}
|
|
397
398
|
|
|
399
|
+
/** Badge (▶️) for high-quality interactive playground stories where users can explore and interact with the component. */
|
|
400
|
+
export const playgroundBadge: TagBadgeParameter = {
|
|
401
|
+
tags: 'playground',
|
|
402
|
+
badge: {
|
|
403
|
+
text: '▶️',
|
|
404
|
+
style: {
|
|
405
|
+
backgroundColor: 'transparent',
|
|
406
|
+
borderColor: 'transparent'
|
|
407
|
+
},
|
|
408
|
+
tooltip: 'Playground'
|
|
409
|
+
},
|
|
410
|
+
display: {
|
|
411
|
+
sidebar: {
|
|
412
|
+
type: 'story',
|
|
413
|
+
skipInherited: false
|
|
414
|
+
}
|
|
415
|
+
}
|
|
416
|
+
}
|
|
417
|
+
|
|
398
418
|
/** Badge (✨) for example or demo stories. */
|
|
399
419
|
export const exampleBadge: TagBadgeParameter = {
|
|
400
420
|
tags: 'example',
|
|
@@ -438,7 +458,7 @@ export const perfBadge: TagBadgeParameter = {
|
|
|
438
458
|
* Each badge is associated with a specific tag and displays an emoji or symbol with a tooltip.
|
|
439
459
|
*
|
|
440
460
|
* Badge order (first match wins): New → Alpha → Beta → RC → Deprecated → Remove → Outdated → Danger → Use Case →
|
|
441
|
-
* Example → Perf → Keyboard → Source → Type → Function → Var → Props → Todo → Unit → Integration →
|
|
461
|
+
* Playground → Example → Perf → Keyboard → Source → Type → Function → Var → Props → Todo → Unit → Integration →
|
|
442
462
|
* Editor → Code Only → Version → Internal → Snapshot.
|
|
443
463
|
*
|
|
444
464
|
* - 🆕 New - Recently added stories
|
|
@@ -450,6 +470,7 @@ export const perfBadge: TagBadgeParameter = {
|
|
|
450
470
|
* - ⚠️ Outdated - Stories that need updating
|
|
451
471
|
* - 🚨 Danger - Stories demonstrating dangerous patterns
|
|
452
472
|
* - 🎯 Use Case - Stories that demonstrate a specific use case or scenario
|
|
473
|
+
* - ▶️ Playground - High-quality interactive stories for users to explore and interact with the component
|
|
453
474
|
* - ✨ Example - Example or demo stories
|
|
454
475
|
* - ⚡ Perf - Stories that demonstrate or test performance
|
|
455
476
|
* - ⌨️ Keyboard - Stories that demonstrate or test keyboard interaction
|
|
@@ -478,6 +499,7 @@ export const tagBadges: TagBadgeParameters = [
|
|
|
478
499
|
outdatedBadge,
|
|
479
500
|
dangerBadge,
|
|
480
501
|
useCaseBadge,
|
|
502
|
+
playgroundBadge,
|
|
481
503
|
exampleBadge,
|
|
482
504
|
perfBadge,
|
|
483
505
|
keyboardBadge,
|
package/styles.css
CHANGED