@repobuddy/storybook 2.18.0 → 2.18.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.
|
@@ -51,24 +51,27 @@ declare const useCaseBadge: TagBadgeParameter;
|
|
|
51
51
|
* Configuration for story tag badges that appear in the Storybook sidebar.
|
|
52
52
|
* Each badge is associated with a specific tag and displays an emoji or symbol with a tooltip.
|
|
53
53
|
*
|
|
54
|
-
*
|
|
54
|
+
* Badge order (first match wins): New → Beta → Deprecated → Outdated → Danger → Use Case →
|
|
55
|
+
* Keyboard → Source → Type → Function → Var → Props → Todo → Unit → Integration → Editor →
|
|
56
|
+
* Code Only → Version → Internal → Snapshot.
|
|
57
|
+
*
|
|
55
58
|
* - 🆕 New - Recently added stories
|
|
56
59
|
* - 🌱 Beta - Stories for features in beta
|
|
57
60
|
* - 🪦 Deprecated - Stories for deprecated features
|
|
58
61
|
* - ⚠️ Outdated - Stories that need updating
|
|
59
|
-
* - ✏️ Editor - Stories with live editor
|
|
60
|
-
* - 🧪 Unit - Stories with unit tests
|
|
61
|
-
* - 🔗 Integration - Stories with integration tests
|
|
62
|
-
* - ⌨️ Keyboard - Stories that demonstrate or test keyboard interaction
|
|
63
62
|
* - 🚨 Danger - Stories demonstrating dangerous patterns
|
|
63
|
+
* - 🎯 Use Case - Stories that demonstrate a specific use case or scenario
|
|
64
|
+
* - ⌨️ Keyboard - Stories that demonstrate or test keyboard interaction
|
|
64
65
|
* - `</>` Source - Source-code-focused stories
|
|
65
66
|
* - `<T>` Type - Stories that showcase or document TypeScript types
|
|
66
67
|
* - `ƒ(x)` Function - Stories that showcase or document functions
|
|
67
68
|
* - `var` Variables - Stories that describe values and variables
|
|
68
69
|
* - 🔧 Props - Stories that demonstrate props or configuration
|
|
69
|
-
* - 📝 Code Only - Stories without visual examples
|
|
70
70
|
* - 📋 Todo - Stories marked as todo/incomplete
|
|
71
|
-
* -
|
|
71
|
+
* - 🧪 Unit - Stories with unit tests
|
|
72
|
+
* - 🔗 Integration - Stories with integration tests
|
|
73
|
+
* - ✏️ Editor - Stories with live editor
|
|
74
|
+
* - 📝 Code Only - Stories without visual examples
|
|
72
75
|
* - `next` - (`version:next`) The component or function is available in the next version
|
|
73
76
|
* - `x.y` - (`version:x.y`) The component or function was created or updated in the x.y version
|
|
74
77
|
* - 🔒 Internal - Internal or private-use-only stories
|
|
@@ -250,24 +250,27 @@ const useCaseBadge = {
|
|
|
250
250
|
* Configuration for story tag badges that appear in the Storybook sidebar.
|
|
251
251
|
* Each badge is associated with a specific tag and displays an emoji or symbol with a tooltip.
|
|
252
252
|
*
|
|
253
|
-
*
|
|
253
|
+
* Badge order (first match wins): New → Beta → Deprecated → Outdated → Danger → Use Case →
|
|
254
|
+
* Keyboard → Source → Type → Function → Var → Props → Todo → Unit → Integration → Editor →
|
|
255
|
+
* Code Only → Version → Internal → Snapshot.
|
|
256
|
+
*
|
|
254
257
|
* - 🆕 New - Recently added stories
|
|
255
258
|
* - 🌱 Beta - Stories for features in beta
|
|
256
259
|
* - 🪦 Deprecated - Stories for deprecated features
|
|
257
260
|
* - ⚠️ Outdated - Stories that need updating
|
|
258
|
-
* - ✏️ Editor - Stories with live editor
|
|
259
|
-
* - 🧪 Unit - Stories with unit tests
|
|
260
|
-
* - 🔗 Integration - Stories with integration tests
|
|
261
|
-
* - ⌨️ Keyboard - Stories that demonstrate or test keyboard interaction
|
|
262
261
|
* - 🚨 Danger - Stories demonstrating dangerous patterns
|
|
262
|
+
* - 🎯 Use Case - Stories that demonstrate a specific use case or scenario
|
|
263
|
+
* - ⌨️ Keyboard - Stories that demonstrate or test keyboard interaction
|
|
263
264
|
* - `</>` Source - Source-code-focused stories
|
|
264
265
|
* - `<T>` Type - Stories that showcase or document TypeScript types
|
|
265
266
|
* - `ƒ(x)` Function - Stories that showcase or document functions
|
|
266
267
|
* - `var` Variables - Stories that describe values and variables
|
|
267
268
|
* - 🔧 Props - Stories that demonstrate props or configuration
|
|
268
|
-
* - 📝 Code Only - Stories without visual examples
|
|
269
269
|
* - 📋 Todo - Stories marked as todo/incomplete
|
|
270
|
-
* -
|
|
270
|
+
* - 🧪 Unit - Stories with unit tests
|
|
271
|
+
* - 🔗 Integration - Stories with integration tests
|
|
272
|
+
* - ✏️ Editor - Stories with live editor
|
|
273
|
+
* - 📝 Code Only - Stories without visual examples
|
|
271
274
|
* - `next` - (`version:next`) The component or function is available in the next version
|
|
272
275
|
* - `x.y` - (`version:x.y`) The component or function was created or updated in the x.y version
|
|
273
276
|
* - 🔒 Internal - Internal or private-use-only stories
|
|
@@ -278,19 +281,19 @@ const tagBadges = [
|
|
|
278
281
|
betaBadge,
|
|
279
282
|
deprecatedBadge,
|
|
280
283
|
outdatedBadge,
|
|
281
|
-
editorBadge,
|
|
282
|
-
unitBadge,
|
|
283
|
-
integrationBadge,
|
|
284
|
-
keyboardBadge,
|
|
285
284
|
dangerBadge,
|
|
285
|
+
useCaseBadge,
|
|
286
|
+
keyboardBadge,
|
|
286
287
|
sourceBadge,
|
|
287
288
|
typeBadge,
|
|
288
289
|
functionBadge,
|
|
289
290
|
varBadge,
|
|
290
291
|
propsBadge,
|
|
291
|
-
codeOnlyBadge,
|
|
292
292
|
todoBadge,
|
|
293
|
-
|
|
293
|
+
unitBadge,
|
|
294
|
+
integrationBadge,
|
|
295
|
+
editorBadge,
|
|
296
|
+
codeOnlyBadge,
|
|
294
297
|
versionBadge,
|
|
295
298
|
internalBadge,
|
|
296
299
|
snapshotBadge
|
package/package.json
CHANGED
package/readme.md
CHANGED
|
@@ -76,28 +76,28 @@ addons.setConfig({
|
|
|
76
76
|
### `storybook-addon-tag-badges`
|
|
77
77
|
|
|
78
78
|
If you use [`storybook-addon-tag-badges`][`storybook-addon-tag-badges`],
|
|
79
|
-
we provide a different set of badges that uses emojis:
|
|
79
|
+
we provide a different set of badges that uses emojis (order: first match wins):
|
|
80
80
|
|
|
81
|
-
- ✏️ `editor` - Live editor stories (with [`storybook-addon-code-editor`][`storybook-addon-code-editor`])
|
|
82
81
|
- 🆕 `new` - Recently added stories
|
|
83
82
|
- 🌱 `beta` - Features in beta
|
|
84
83
|
- 🪦 `deprecated` - Deprecated features
|
|
85
84
|
- ⚠️ `outdated` - Stories that need updating
|
|
86
|
-
- 🔧 `props` - Props or configuration
|
|
87
85
|
- 🚨 `danger` - Dangerous or cautionary patterns
|
|
86
|
+
- 🎯 `use-case` - Specific use case or scenario
|
|
87
|
+
- ⌨️ `keyboard` - Keyboard interaction
|
|
88
88
|
- `</>` `source` - Source-code-focused stories
|
|
89
89
|
- `<T>` `type` - TypeScript types (shown in MDX)
|
|
90
90
|
- `ƒ(x)` `func` - Functions (shown in MDX)
|
|
91
91
|
- `var` `var` - Variables (shown in MDX)
|
|
92
|
-
-
|
|
92
|
+
- 🔧 `props` - Props or configuration
|
|
93
93
|
- 📋 `todo` - Todo or incomplete stories
|
|
94
|
-
- 🎯 `use-case` - Specific use case or scenario
|
|
95
|
-
- ⌨️ `keyboard` - Keyboard interaction
|
|
96
|
-
- 📸 `snapshot` - Snapshot tests (toolbar only, not sidebar)
|
|
97
94
|
- 🧪 `unit` - Unit tests
|
|
98
95
|
- 🔗 `integration` - Integration tests (hidden in sidebar)
|
|
99
|
-
-
|
|
96
|
+
- ✏️ `editor` - Live editor stories (with [`storybook-addon-code-editor`][`storybook-addon-code-editor`])
|
|
97
|
+
- 📝 `code-only` - Stories without visual examples (hidden in MDX)
|
|
100
98
|
- Version indicators (unchanged)
|
|
99
|
+
- 🔒 `internal` - Internal or private-use-only stories
|
|
100
|
+
- 📸 `snapshot` - Snapshot tests (toolbar only, not sidebar)
|
|
101
101
|
|
|
102
102
|
To use them, add them to your `.storybook/manager.ts`:
|
|
103
103
|
|
|
@@ -317,24 +317,27 @@ export const useCaseBadge: TagBadgeParameter = {
|
|
|
317
317
|
* Configuration for story tag badges that appear in the Storybook sidebar.
|
|
318
318
|
* Each badge is associated with a specific tag and displays an emoji or symbol with a tooltip.
|
|
319
319
|
*
|
|
320
|
-
*
|
|
320
|
+
* Badge order (first match wins): New → Beta → Deprecated → Outdated → Danger → Use Case →
|
|
321
|
+
* Keyboard → Source → Type → Function → Var → Props → Todo → Unit → Integration → Editor →
|
|
322
|
+
* Code Only → Version → Internal → Snapshot.
|
|
323
|
+
*
|
|
321
324
|
* - 🆕 New - Recently added stories
|
|
322
325
|
* - 🌱 Beta - Stories for features in beta
|
|
323
326
|
* - 🪦 Deprecated - Stories for deprecated features
|
|
324
327
|
* - ⚠️ Outdated - Stories that need updating
|
|
325
|
-
* - ✏️ Editor - Stories with live editor
|
|
326
|
-
* - 🧪 Unit - Stories with unit tests
|
|
327
|
-
* - 🔗 Integration - Stories with integration tests
|
|
328
|
-
* - ⌨️ Keyboard - Stories that demonstrate or test keyboard interaction
|
|
329
328
|
* - 🚨 Danger - Stories demonstrating dangerous patterns
|
|
329
|
+
* - 🎯 Use Case - Stories that demonstrate a specific use case or scenario
|
|
330
|
+
* - ⌨️ Keyboard - Stories that demonstrate or test keyboard interaction
|
|
330
331
|
* - `</>` Source - Source-code-focused stories
|
|
331
332
|
* - `<T>` Type - Stories that showcase or document TypeScript types
|
|
332
333
|
* - `ƒ(x)` Function - Stories that showcase or document functions
|
|
333
334
|
* - `var` Variables - Stories that describe values and variables
|
|
334
335
|
* - 🔧 Props - Stories that demonstrate props or configuration
|
|
335
|
-
* - 📝 Code Only - Stories without visual examples
|
|
336
336
|
* - 📋 Todo - Stories marked as todo/incomplete
|
|
337
|
-
* -
|
|
337
|
+
* - 🧪 Unit - Stories with unit tests
|
|
338
|
+
* - 🔗 Integration - Stories with integration tests
|
|
339
|
+
* - ✏️ Editor - Stories with live editor
|
|
340
|
+
* - 📝 Code Only - Stories without visual examples
|
|
338
341
|
* - `next` - (`version:next`) The component or function is available in the next version
|
|
339
342
|
* - `x.y` - (`version:x.y`) The component or function was created or updated in the x.y version
|
|
340
343
|
* - 🔒 Internal - Internal or private-use-only stories
|
|
@@ -345,19 +348,19 @@ export const tagBadges: TagBadgeParameters = [
|
|
|
345
348
|
betaBadge,
|
|
346
349
|
deprecatedBadge,
|
|
347
350
|
outdatedBadge,
|
|
348
|
-
editorBadge,
|
|
349
|
-
unitBadge,
|
|
350
|
-
integrationBadge,
|
|
351
|
-
keyboardBadge,
|
|
352
351
|
dangerBadge,
|
|
352
|
+
useCaseBadge,
|
|
353
|
+
keyboardBadge,
|
|
353
354
|
sourceBadge,
|
|
354
355
|
typeBadge,
|
|
355
356
|
functionBadge,
|
|
356
357
|
varBadge,
|
|
357
358
|
propsBadge,
|
|
358
|
-
codeOnlyBadge,
|
|
359
359
|
todoBadge,
|
|
360
|
-
|
|
360
|
+
unitBadge,
|
|
361
|
+
integrationBadge,
|
|
362
|
+
editorBadge,
|
|
363
|
+
codeOnlyBadge,
|
|
361
364
|
versionBadge,
|
|
362
365
|
internalBadge,
|
|
363
366
|
snapshotBadge
|