@repobuddy/storybook 2.25.0 → 2.27.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' | 'class' | '!class' | '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. */
|
|
@@ -37,6 +37,8 @@ declare const todoBadge: TagBadgeParameter;
|
|
|
37
37
|
declare const codeOnlyBadge: TagBadgeParameter;
|
|
38
38
|
/** Badge (<T>) for stories that showcase or document TypeScript types. Hidden in MDX. */
|
|
39
39
|
declare const typeBadge: TagBadgeParameter;
|
|
40
|
+
/** Badge (🔷) for stories that showcase or document classes. Hidden in MDX. */
|
|
41
|
+
declare const classBadge: TagBadgeParameter;
|
|
40
42
|
/** Badge (ƒ(x)) for stories that showcase or document functions. Hidden in MDX. */
|
|
41
43
|
declare const functionBadge: TagBadgeParameter;
|
|
42
44
|
/** Badge (var) for stories that describe values and variables. */
|
|
@@ -49,6 +51,8 @@ declare const snapshotBadge: TagBadgeParameter;
|
|
|
49
51
|
declare const unitBadge: TagBadgeParameter;
|
|
50
52
|
/** Badge (🔗) for stories with integration tests. Hidden in sidebar. */
|
|
51
53
|
declare const integrationBadge: TagBadgeParameter;
|
|
54
|
+
/** Badge (♿) for stories that demonstrate or test accessibility. */
|
|
55
|
+
declare const a11yBadge: TagBadgeParameter;
|
|
52
56
|
/** Badge (⌨️) for stories that demonstrate or test keyboard interaction. */
|
|
53
57
|
declare const keyboardBadge: TagBadgeParameter;
|
|
54
58
|
/** Badge (🔒) for internal or private-use-only stories. */
|
|
@@ -66,7 +70,7 @@ declare const perfBadge: TagBadgeParameter;
|
|
|
66
70
|
* Each badge is associated with a specific tag and displays an emoji or symbol with a tooltip.
|
|
67
71
|
*
|
|
68
72
|
* 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 →
|
|
73
|
+
* Spec → Playground → Example → Perf → A11y → Keyboard → Source → Type → Class → Function → Var → Props → Todo → Unit →
|
|
70
74
|
* Integration → Editor → Code Only → Version → Internal → Snapshot.
|
|
71
75
|
*
|
|
72
76
|
* - 🆕 New - Recently added stories
|
|
@@ -82,12 +86,14 @@ declare const perfBadge: TagBadgeParameter;
|
|
|
82
86
|
* - ▶️ Playground - High-quality interactive stories for users to explore and interact with the component
|
|
83
87
|
* - ✨ Example - Example or demo stories
|
|
84
88
|
* - ⚡ Perf - Stories that demonstrate or test performance
|
|
89
|
+
* - ♿ A11y - Stories that demonstrate or test accessibility
|
|
85
90
|
* - ⌨️ Keyboard - Stories that demonstrate or test keyboard interaction
|
|
86
91
|
* - `</>` Source - Source-code-focused stories
|
|
92
|
+
* - 🔧 Props - Stories that demonstrate props or configuration
|
|
87
93
|
* - `<T>` Type - Stories that showcase or document TypeScript types
|
|
94
|
+
* - 🔷 Class - Stories that showcase or document classes
|
|
88
95
|
* - `ƒ(x)` Function - Stories that showcase or document functions
|
|
89
96
|
* - `var` Variables - Stories that describe values and variables
|
|
90
|
-
* - 🔧 Props - Stories that demonstrate props or configuration
|
|
91
97
|
* - 📋 Todo - Stories marked as todo/incomplete
|
|
92
98
|
* - 🧪 Unit - Stories with unit tests
|
|
93
99
|
* - 🔗 Integration - Stories with integration tests
|
|
@@ -171,4 +177,4 @@ type StoryObj<TMetaOrCmpOrArgs = Args> = ExtendStoryObj<TMetaOrCmpOrArgs, StoryO
|
|
|
171
177
|
tag: TagNames;
|
|
172
178
|
}>;
|
|
173
179
|
//#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 };
|
|
180
|
+
export { Meta, StoryObj, TagNames, a11yBadge, alphaBadge, betaBadge, classBadge, 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 };
|
|
@@ -198,6 +198,19 @@ const typeBadge = {
|
|
|
198
198
|
},
|
|
199
199
|
display: { mdx: true }
|
|
200
200
|
};
|
|
201
|
+
/** Badge (🔷) for stories that showcase or document classes. Hidden in MDX. */
|
|
202
|
+
const classBadge = {
|
|
203
|
+
tags: "class",
|
|
204
|
+
badge: {
|
|
205
|
+
text: "🔷",
|
|
206
|
+
style: {
|
|
207
|
+
backgroundColor: "transparent",
|
|
208
|
+
borderColor: "transparent"
|
|
209
|
+
},
|
|
210
|
+
tooltip: "Class"
|
|
211
|
+
},
|
|
212
|
+
display: { mdx: true }
|
|
213
|
+
};
|
|
201
214
|
/** Badge (ƒ(x)) for stories that showcase or document functions. Hidden in MDX. */
|
|
202
215
|
const functionBadge = {
|
|
203
216
|
tags: "func",
|
|
@@ -291,6 +304,22 @@ const integrationBadge = {
|
|
|
291
304
|
skipInherited: false
|
|
292
305
|
} }
|
|
293
306
|
};
|
|
307
|
+
/** Badge (♿) for stories that demonstrate or test accessibility. */
|
|
308
|
+
const a11yBadge = {
|
|
309
|
+
tags: "a11y",
|
|
310
|
+
badge: {
|
|
311
|
+
text: "♿",
|
|
312
|
+
style: {
|
|
313
|
+
backgroundColor: "transparent",
|
|
314
|
+
borderColor: "transparent"
|
|
315
|
+
},
|
|
316
|
+
tooltip: "Accessibility"
|
|
317
|
+
},
|
|
318
|
+
display: { sidebar: {
|
|
319
|
+
type: "story",
|
|
320
|
+
skipInherited: false
|
|
321
|
+
} }
|
|
322
|
+
};
|
|
294
323
|
/** Badge (⌨️) for stories that demonstrate or test keyboard interaction. */
|
|
295
324
|
const keyboardBadge = {
|
|
296
325
|
tags: "keyboard",
|
|
@@ -384,7 +413,7 @@ const perfBadge = {
|
|
|
384
413
|
* Each badge is associated with a specific tag and displays an emoji or symbol with a tooltip.
|
|
385
414
|
*
|
|
386
415
|
* 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 →
|
|
416
|
+
* Spec → Playground → Example → Perf → A11y → Keyboard → Source → Type → Class → Function → Var → Props → Todo → Unit →
|
|
388
417
|
* Integration → Editor → Code Only → Version → Internal → Snapshot.
|
|
389
418
|
*
|
|
390
419
|
* - 🆕 New - Recently added stories
|
|
@@ -400,12 +429,14 @@ const perfBadge = {
|
|
|
400
429
|
* - ▶️ Playground - High-quality interactive stories for users to explore and interact with the component
|
|
401
430
|
* - ✨ Example - Example or demo stories
|
|
402
431
|
* - ⚡ Perf - Stories that demonstrate or test performance
|
|
432
|
+
* - ♿ A11y - Stories that demonstrate or test accessibility
|
|
403
433
|
* - ⌨️ Keyboard - Stories that demonstrate or test keyboard interaction
|
|
404
434
|
* - `</>` Source - Source-code-focused stories
|
|
435
|
+
* - 🔧 Props - Stories that demonstrate props or configuration
|
|
405
436
|
* - `<T>` Type - Stories that showcase or document TypeScript types
|
|
437
|
+
* - 🔷 Class - Stories that showcase or document classes
|
|
406
438
|
* - `ƒ(x)` Function - Stories that showcase or document functions
|
|
407
439
|
* - `var` Variables - Stories that describe values and variables
|
|
408
|
-
* - 🔧 Props - Stories that demonstrate props or configuration
|
|
409
440
|
* - 📋 Todo - Stories marked as todo/incomplete
|
|
410
441
|
* - 🧪 Unit - Stories with unit tests
|
|
411
442
|
* - 🔗 Integration - Stories with integration tests
|
|
@@ -430,12 +461,14 @@ const tagBadges = [
|
|
|
430
461
|
playgroundBadge,
|
|
431
462
|
exampleBadge,
|
|
432
463
|
perfBadge,
|
|
433
|
-
keyboardBadge,
|
|
434
464
|
sourceBadge,
|
|
465
|
+
a11yBadge,
|
|
466
|
+
keyboardBadge,
|
|
467
|
+
propsBadge,
|
|
435
468
|
typeBadge,
|
|
469
|
+
classBadge,
|
|
436
470
|
functionBadge,
|
|
437
471
|
varBadge,
|
|
438
|
-
propsBadge,
|
|
439
472
|
todoBadge,
|
|
440
473
|
unitBadge,
|
|
441
474
|
integrationBadge,
|
|
@@ -447,4 +480,4 @@ const tagBadges = [
|
|
|
447
480
|
];
|
|
448
481
|
|
|
449
482
|
//#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 };
|
|
483
|
+
export { a11yBadge, alphaBadge, betaBadge, classBadge, 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,9 +93,11 @@ 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) |
|
|
100
|
+
| 🔷 | `class` | Classes (shown in MDX) |
|
|
99
101
|
| `ƒ(x)` | `func` | Functions (shown in MDX) |
|
|
100
102
|
| `var` | `var` | Variables (shown in MDX) |
|
|
101
103
|
| 🔧 | `props` | Props or configuration |
|
|
@@ -13,11 +13,14 @@ export type TagNames =
|
|
|
13
13
|
| 'source'
|
|
14
14
|
| 'type'
|
|
15
15
|
| '!type'
|
|
16
|
+
| 'class'
|
|
17
|
+
| '!class'
|
|
16
18
|
| 'func'
|
|
17
19
|
| '!func'
|
|
18
20
|
| 'var'
|
|
19
21
|
| '!var'
|
|
20
22
|
| 'new'
|
|
23
|
+
| 'a11y'
|
|
21
24
|
| 'alpha'
|
|
22
25
|
| 'beta'
|
|
23
26
|
| 'rc'
|
|
@@ -264,6 +267,22 @@ export const typeBadge: TagBadgeParameter = {
|
|
|
264
267
|
}
|
|
265
268
|
}
|
|
266
269
|
|
|
270
|
+
/** Badge (🔷) for stories that showcase or document classes. Hidden in MDX. */
|
|
271
|
+
export const classBadge: TagBadgeParameter = {
|
|
272
|
+
tags: 'class',
|
|
273
|
+
badge: {
|
|
274
|
+
text: '🔷',
|
|
275
|
+
style: {
|
|
276
|
+
backgroundColor: 'transparent',
|
|
277
|
+
borderColor: 'transparent'
|
|
278
|
+
},
|
|
279
|
+
tooltip: 'Class'
|
|
280
|
+
},
|
|
281
|
+
display: {
|
|
282
|
+
mdx: true
|
|
283
|
+
}
|
|
284
|
+
}
|
|
285
|
+
|
|
267
286
|
/** Badge (ƒ(x)) for stories that showcase or document functions. Hidden in MDX. */
|
|
268
287
|
export const functionBadge: TagBadgeParameter = {
|
|
269
288
|
tags: 'func',
|
|
@@ -371,6 +390,25 @@ export const integrationBadge: TagBadgeParameter = {
|
|
|
371
390
|
}
|
|
372
391
|
}
|
|
373
392
|
|
|
393
|
+
/** Badge (♿) for stories that demonstrate or test accessibility. */
|
|
394
|
+
export const a11yBadge: TagBadgeParameter = {
|
|
395
|
+
tags: 'a11y',
|
|
396
|
+
badge: {
|
|
397
|
+
text: '♿',
|
|
398
|
+
style: {
|
|
399
|
+
backgroundColor: 'transparent',
|
|
400
|
+
borderColor: 'transparent'
|
|
401
|
+
},
|
|
402
|
+
tooltip: 'Accessibility'
|
|
403
|
+
},
|
|
404
|
+
display: {
|
|
405
|
+
sidebar: {
|
|
406
|
+
type: 'story',
|
|
407
|
+
skipInherited: false
|
|
408
|
+
}
|
|
409
|
+
}
|
|
410
|
+
}
|
|
411
|
+
|
|
374
412
|
/** Badge (⌨️) for stories that demonstrate or test keyboard interaction. */
|
|
375
413
|
export const keyboardBadge: TagBadgeParameter = {
|
|
376
414
|
tags: 'keyboard',
|
|
@@ -478,7 +516,7 @@ export const perfBadge: TagBadgeParameter = {
|
|
|
478
516
|
* Each badge is associated with a specific tag and displays an emoji or symbol with a tooltip.
|
|
479
517
|
*
|
|
480
518
|
* 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 →
|
|
519
|
+
* Spec → Playground → Example → Perf → A11y → Keyboard → Source → Type → Class → Function → Var → Props → Todo → Unit →
|
|
482
520
|
* Integration → Editor → Code Only → Version → Internal → Snapshot.
|
|
483
521
|
*
|
|
484
522
|
* - 🆕 New - Recently added stories
|
|
@@ -494,12 +532,14 @@ export const perfBadge: TagBadgeParameter = {
|
|
|
494
532
|
* - ▶️ Playground - High-quality interactive stories for users to explore and interact with the component
|
|
495
533
|
* - ✨ Example - Example or demo stories
|
|
496
534
|
* - ⚡ Perf - Stories that demonstrate or test performance
|
|
535
|
+
* - ♿ A11y - Stories that demonstrate or test accessibility
|
|
497
536
|
* - ⌨️ Keyboard - Stories that demonstrate or test keyboard interaction
|
|
498
537
|
* - `</>` Source - Source-code-focused stories
|
|
538
|
+
* - 🔧 Props - Stories that demonstrate props or configuration
|
|
499
539
|
* - `<T>` Type - Stories that showcase or document TypeScript types
|
|
540
|
+
* - 🔷 Class - Stories that showcase or document classes
|
|
500
541
|
* - `ƒ(x)` Function - Stories that showcase or document functions
|
|
501
542
|
* - `var` Variables - Stories that describe values and variables
|
|
502
|
-
* - 🔧 Props - Stories that demonstrate props or configuration
|
|
503
543
|
* - 📋 Todo - Stories marked as todo/incomplete
|
|
504
544
|
* - 🧪 Unit - Stories with unit tests
|
|
505
545
|
* - 🔗 Integration - Stories with integration tests
|
|
@@ -524,12 +564,14 @@ export const tagBadges: TagBadgeParameters = [
|
|
|
524
564
|
playgroundBadge,
|
|
525
565
|
exampleBadge,
|
|
526
566
|
perfBadge,
|
|
527
|
-
keyboardBadge,
|
|
528
567
|
sourceBadge,
|
|
568
|
+
a11yBadge,
|
|
569
|
+
keyboardBadge,
|
|
570
|
+
propsBadge,
|
|
529
571
|
typeBadge,
|
|
572
|
+
classBadge,
|
|
530
573
|
functionBadge,
|
|
531
574
|
varBadge,
|
|
532
|
-
propsBadge,
|
|
533
575
|
todoBadge,
|
|
534
576
|
unitBadge,
|
|
535
577
|
integrationBadge,
|