Skip to content

Commit a910144

Browse files
committed
CounterLabel, StateLabel: sync docs.json with deprecated props
Mark CounterLabel scheme and StateLabel variant as deprecated and document their replacements (variant, size)
1 parent 31005f8 commit a910144

2 files changed

Lines changed: 16 additions & 2 deletions

File tree

packages/react/src/CounterLabel/CounterLabel.docs.json

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,11 +16,18 @@
1616
],
1717
"importPath": "@primer/react",
1818
"props": [
19+
{
20+
"name": "variant",
21+
"type": "'primary' | 'secondary'",
22+
"defaultValue": "",
23+
"description": "Pass in 'primary' for a darker background and inverse text, or 'secondary' for a lighter background and primary text. Omitting the variant prop renders the default counter scheme"
24+
},
1925
{
2026
"name": "scheme",
2127
"type": "'primary' | 'secondary'",
2228
"defaultValue": "",
23-
"description": "Pass in 'primary' for a darker background and inverse text, or 'secondary' for a lighter background and primary text. Omitting the scheme prop renders the default counter scheme"
29+
"description": "Use `variant` instead.",
30+
"deprecated": true
2431
},
2532
{
2633
"name": "className",

packages/react/src/StateLabel/StateLabel.docs.json

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -64,10 +64,17 @@
6464
],
6565
"importPath": "@primer/react",
6666
"props": [
67+
{
68+
"name": "size",
69+
"type": "'small' | 'medium'",
70+
"defaultValue": "'medium'"
71+
},
6772
{
6873
"name": "variant",
6974
"type": "'small' | 'normal'",
70-
"defaultValue": "'normal'"
75+
"defaultValue": "'normal'",
76+
"description": "Use `size` instead.",
77+
"deprecated": true
7178
},
7279
{
7380
"name": "status",

0 commit comments

Comments
 (0)