@repobuddy/storybook 2.25.0 → 2.26.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' | 'spec' | 'snapshot' | '!snapshot' | 'unit' | 'integration' | 'keyboard' | 'internal' | 'usecase' | 'use-case' | 'playground' | 'example' | 'perf' | 'version:next' | 'remove' | 'remove:next' | 'autodocs';
|
|
11
|
+
type TagNames = '!test' | 'editor' | 'source' | 'type' | '!type' | 'func' | '!func' | 'var' | '!var' | 'new' | 'a11y' | 'alpha' | 'beta' | 'rc' | 'props' | 'deprecated' | 'outdated' | 'danger' | 'todo' | 'code-only' | 'spec' | '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. */
|
|
@@ -49,6 +49,8 @@ declare const snapshotBadge: TagBadgeParameter;
|
|
|
49
49
|
declare const unitBadge: TagBadgeParameter;
|
|
50
50
|
/** Badge (🔗) for stories with integration tests. Hidden in sidebar. */
|
|
51
51
|
declare const integrationBadge: TagBadgeParameter;
|
|
52
|
+
/** Badge (♿) for stories that demonstrate or test accessibility. */
|
|
53
|
+
declare const a11yBadge: TagBadgeParameter;
|
|
52
54
|
/** Badge (⌨️) for stories that demonstrate or test keyboard interaction. */
|
|
53
55
|
declare const keyboardBadge: TagBadgeParameter;
|
|
54
56
|
/** Badge (🔒) for internal or private-use-only stories. */
|
|
@@ -66,7 +68,7 @@ declare const perfBadge: TagBadgeParameter;
|
|
|
66
68
|
* Each badge is associated with a specific tag and displays an emoji or symbol with a tooltip.
|
|
67
69
|
*
|
|
68
70
|
* Badge order (first match wins): New → Alpha → Beta → RC → Deprecated → Remove → Outdated → Danger → Use Case →
|
|
69
|
-
* Spec → Playground → Example → Perf → Keyboard → Source → Type → Function → Var → Props → Todo → Unit →
|
|
71
|
+
* Spec → Playground → Example → Perf → A11y → Keyboard → Source → Type → Function → Var → Props → Todo → Unit →
|
|
70
72
|
* Integration → Editor → Code Only → Version → Internal → Snapshot.
|
|
71
73
|
*
|
|
72
74
|
* - 🆕 New - Recently added stories
|
|
@@ -82,6 +84,7 @@ declare const perfBadge: TagBadgeParameter;
|
|
|
82
84
|
* - ▶️ Playground - High-quality interactive stories for users to explore and interact with the component
|
|
83
85
|
* - ✨ Example - Example or demo stories
|
|
84
86
|
* - ⚡ Perf - Stories that demonstrate or test performance
|
|
87
|
+
* - ♿ A11y - Stories that demonstrate or test accessibility
|
|
85
88
|
* - ⌨️ Keyboard - Stories that demonstrate or test keyboard interaction
|
|
86
89
|
* - `</>` Source - Source-code-focused stories
|
|
87
90
|
* - `<T>` Type - Stories that showcase or document TypeScript types
|
|
@@ -171,4 +174,4 @@ type StoryObj<TMetaOrCmpOrArgs = Args> = ExtendStoryObj<TMetaOrCmpOrArgs, StoryO
|
|
|
171
174
|
tag: TagNames;
|
|
172
175
|
}>;
|
|
173
176
|
//#endregion
|
|
174
|
-
export { Meta, StoryObj, TagNames, alphaBadge, betaBadge, codeOnlyBadge, dangerBadge, deprecatedBadge, editorBadge, exampleBadge, functionBadge, integrationBadge, internalBadge, keyboardBadge, newBadge, outdatedBadge, perfBadge, playgroundBadge, propsBadge, rcBadge, removeBadge, snapshotBadge, sourceBadge, specBadge, tagBadges, todoBadge, typeBadge, unitBadge, useCaseBadge, varBadge };
|
|
177
|
+
export { Meta, StoryObj, TagNames, a11yBadge, alphaBadge, betaBadge, codeOnlyBadge, dangerBadge, deprecatedBadge, editorBadge, exampleBadge, functionBadge, integrationBadge, internalBadge, keyboardBadge, newBadge, outdatedBadge, perfBadge, playgroundBadge, propsBadge, rcBadge, removeBadge, snapshotBadge, sourceBadge, specBadge, tagBadges, todoBadge, typeBadge, unitBadge, useCaseBadge, varBadge };
|
|
@@ -291,6 +291,22 @@ const integrationBadge = {
|
|
|
291
291
|
skipInherited: false
|
|
292
292
|
} }
|
|
293
293
|
};
|
|
294
|
+
/** Badge (♿) for stories that demonstrate or test accessibility. */
|
|
295
|
+
const a11yBadge = {
|
|
296
|
+
tags: "a11y",
|
|
297
|
+
badge: {
|
|
298
|
+
text: "♿",
|
|
299
|
+
style: {
|
|
300
|
+
backgroundColor: "transparent",
|
|
301
|
+
borderColor: "transparent"
|
|
302
|
+
},
|
|
303
|
+
tooltip: "Accessibility"
|
|
304
|
+
},
|
|
305
|
+
display: { sidebar: {
|
|
306
|
+
type: "story",
|
|
307
|
+
skipInherited: false
|
|
308
|
+
} }
|
|
309
|
+
};
|
|
294
310
|
/** Badge (⌨️) for stories that demonstrate or test keyboard interaction. */
|
|
295
311
|
const keyboardBadge = {
|
|
296
312
|
tags: "keyboard",
|
|
@@ -384,7 +400,7 @@ const perfBadge = {
|
|
|
384
400
|
* Each badge is associated with a specific tag and displays an emoji or symbol with a tooltip.
|
|
385
401
|
*
|
|
386
402
|
* Badge order (first match wins): New → Alpha → Beta → RC → Deprecated → Remove → Outdated → Danger → Use Case →
|
|
387
|
-
* Spec → Playground → Example → Perf → Keyboard → Source → Type → Function → Var → Props → Todo → Unit →
|
|
403
|
+
* Spec → Playground → Example → Perf → A11y → Keyboard → Source → Type → Function → Var → Props → Todo → Unit →
|
|
388
404
|
* Integration → Editor → Code Only → Version → Internal → Snapshot.
|
|
389
405
|
*
|
|
390
406
|
* - 🆕 New - Recently added stories
|
|
@@ -400,6 +416,7 @@ const perfBadge = {
|
|
|
400
416
|
* - ▶️ Playground - High-quality interactive stories for users to explore and interact with the component
|
|
401
417
|
* - ✨ Example - Example or demo stories
|
|
402
418
|
* - ⚡ Perf - Stories that demonstrate or test performance
|
|
419
|
+
* - ♿ A11y - Stories that demonstrate or test accessibility
|
|
403
420
|
* - ⌨️ Keyboard - Stories that demonstrate or test keyboard interaction
|
|
404
421
|
* - `</>` Source - Source-code-focused stories
|
|
405
422
|
* - `<T>` Type - Stories that showcase or document TypeScript types
|
|
@@ -430,6 +447,7 @@ const tagBadges = [
|
|
|
430
447
|
playgroundBadge,
|
|
431
448
|
exampleBadge,
|
|
432
449
|
perfBadge,
|
|
450
|
+
a11yBadge,
|
|
433
451
|
keyboardBadge,
|
|
434
452
|
sourceBadge,
|
|
435
453
|
typeBadge,
|
|
@@ -447,4 +465,4 @@ const tagBadges = [
|
|
|
447
465
|
];
|
|
448
466
|
|
|
449
467
|
//#endregion
|
|
450
|
-
export { alphaBadge, betaBadge, codeOnlyBadge, dangerBadge, deprecatedBadge, editorBadge, exampleBadge, functionBadge, integrationBadge, internalBadge, keyboardBadge, newBadge, outdatedBadge, perfBadge, playgroundBadge, propsBadge, rcBadge, removeBadge, snapshotBadge, sourceBadge, specBadge, tagBadges, todoBadge, typeBadge, unitBadge, useCaseBadge, varBadge };
|
|
468
|
+
export { a11yBadge, alphaBadge, betaBadge, codeOnlyBadge, dangerBadge, deprecatedBadge, editorBadge, exampleBadge, functionBadge, integrationBadge, internalBadge, keyboardBadge, newBadge, outdatedBadge, perfBadge, playgroundBadge, propsBadge, rcBadge, removeBadge, snapshotBadge, sourceBadge, specBadge, tagBadges, todoBadge, typeBadge, unitBadge, useCaseBadge, varBadge };
|
package/package.json
CHANGED
package/readme.md
CHANGED
|
@@ -93,6 +93,7 @@ we provide a different set of badges that uses emojis (order: first match wins):
|
|
|
93
93
|
| ▶️ | `playground` | High-quality interactive stories for users to explore and interact with the component |
|
|
94
94
|
| ✨ | `example` | Example or demo stories |
|
|
95
95
|
| ⚡ | `perf` | Performance (stories that demonstrate or test performance) |
|
|
96
|
+
| ♿ | `a11y` | Accessibility (stories that demonstrate or test accessibility) |
|
|
96
97
|
| ⌨️ | `keyboard` | Keyboard interaction |
|
|
97
98
|
| `</>` | `source` | Source-code-focused stories |
|
|
98
99
|
| `<T>` | `type` | TypeScript types (shown in MDX) |
|
|
@@ -18,6 +18,7 @@ export type TagNames =
|
|
|
18
18
|
| 'var'
|
|
19
19
|
| '!var'
|
|
20
20
|
| 'new'
|
|
21
|
+
| 'a11y'
|
|
21
22
|
| 'alpha'
|
|
22
23
|
| 'beta'
|
|
23
24
|
| 'rc'
|
|
@@ -371,6 +372,25 @@ export const integrationBadge: TagBadgeParameter = {
|
|
|
371
372
|
}
|
|
372
373
|
}
|
|
373
374
|
|
|
375
|
+
/** Badge (♿) for stories that demonstrate or test accessibility. */
|
|
376
|
+
export const a11yBadge: TagBadgeParameter = {
|
|
377
|
+
tags: 'a11y',
|
|
378
|
+
badge: {
|
|
379
|
+
text: '♿',
|
|
380
|
+
style: {
|
|
381
|
+
backgroundColor: 'transparent',
|
|
382
|
+
borderColor: 'transparent'
|
|
383
|
+
},
|
|
384
|
+
tooltip: 'Accessibility'
|
|
385
|
+
},
|
|
386
|
+
display: {
|
|
387
|
+
sidebar: {
|
|
388
|
+
type: 'story',
|
|
389
|
+
skipInherited: false
|
|
390
|
+
}
|
|
391
|
+
}
|
|
392
|
+
}
|
|
393
|
+
|
|
374
394
|
/** Badge (⌨️) for stories that demonstrate or test keyboard interaction. */
|
|
375
395
|
export const keyboardBadge: TagBadgeParameter = {
|
|
376
396
|
tags: 'keyboard',
|
|
@@ -478,7 +498,7 @@ export const perfBadge: TagBadgeParameter = {
|
|
|
478
498
|
* Each badge is associated with a specific tag and displays an emoji or symbol with a tooltip.
|
|
479
499
|
*
|
|
480
500
|
* Badge order (first match wins): New → Alpha → Beta → RC → Deprecated → Remove → Outdated → Danger → Use Case →
|
|
481
|
-
* Spec → Playground → Example → Perf → Keyboard → Source → Type → Function → Var → Props → Todo → Unit →
|
|
501
|
+
* Spec → Playground → Example → Perf → A11y → Keyboard → Source → Type → Function → Var → Props → Todo → Unit →
|
|
482
502
|
* Integration → Editor → Code Only → Version → Internal → Snapshot.
|
|
483
503
|
*
|
|
484
504
|
* - 🆕 New - Recently added stories
|
|
@@ -494,6 +514,7 @@ export const perfBadge: TagBadgeParameter = {
|
|
|
494
514
|
* - ▶️ Playground - High-quality interactive stories for users to explore and interact with the component
|
|
495
515
|
* - ✨ Example - Example or demo stories
|
|
496
516
|
* - ⚡ Perf - Stories that demonstrate or test performance
|
|
517
|
+
* - ♿ A11y - Stories that demonstrate or test accessibility
|
|
497
518
|
* - ⌨️ Keyboard - Stories that demonstrate or test keyboard interaction
|
|
498
519
|
* - `</>` Source - Source-code-focused stories
|
|
499
520
|
* - `<T>` Type - Stories that showcase or document TypeScript types
|
|
@@ -524,6 +545,7 @@ export const tagBadges: TagBadgeParameters = [
|
|
|
524
545
|
playgroundBadge,
|
|
525
546
|
exampleBadge,
|
|
526
547
|
perfBadge,
|
|
548
|
+
a11yBadge,
|
|
527
549
|
keyboardBadge,
|
|
528
550
|
sourceBadge,
|
|
529
551
|
typeBadge,
|