Skip to content

Commit e2a974f

Browse files
authored
add classname prop support to PageHeader component and its children (#4667)
* add classname prop to root and all child components * document className prop * add changeset
1 parent eb2ab13 commit e2a974f

File tree

3 files changed

+162
-11
lines changed

3 files changed

+162
-11
lines changed

.changeset/two-snakes-brush.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
---
2+
'@primer/react': minor
3+
---
4+
5+
Adds support for `className` prop to PageHeader component and its children.

packages/react/src/PageHeader/PageHeader.docs.json

Lines changed: 84 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,12 @@
1212
"defaultValue": "",
1313
"description": "A unique label for the rendered main landmark"
1414
},
15+
{
16+
"name": "className",
17+
"type": "string | undefined",
18+
"defaultValue": "",
19+
"description": "CSS string"
20+
},
1521
{
1622
"name": "hidden",
1723
"type": "| boolean | { narrow?: boolean regular?: boolean wide?: boolean }",
@@ -32,6 +38,12 @@
3238
{
3339
"name": "PageHeader.ContextArea",
3440
"props": [
41+
{
42+
"name": "className",
43+
"type": "string | undefined",
44+
"defaultValue": "",
45+
"description": "CSS string"
46+
},
3547
{
3648
"name": "hidden",
3749
"type": "| boolean | { narrow?: boolean regular?: boolean wide?: boolean }",
@@ -47,6 +59,12 @@
4759
{
4860
"name": "PageHeader.ParentLink",
4961
"props": [
62+
{
63+
"name": "className",
64+
"type": "string | undefined",
65+
"defaultValue": "",
66+
"description": "CSS string"
67+
},
5068
{
5169
"name": "href",
5270
"type": "string",
@@ -68,6 +86,12 @@
6886
{
6987
"name": "PageHeader.ContextBar",
7088
"props": [
89+
{
90+
"name": "className",
91+
"type": "string | undefined",
92+
"defaultValue": "",
93+
"description": "CSS string"
94+
},
7195
{
7296
"name": "hidden",
7397
"type": "| boolean | { narrow?: boolean regular?: boolean wide?: boolean }",
@@ -83,6 +107,12 @@
83107
{
84108
"name": "PageHeader.ContextAreaActions",
85109
"props": [
110+
{
111+
"name": "className",
112+
"type": "string | undefined",
113+
"defaultValue": "",
114+
"description": "CSS string"
115+
},
86116
{
87117
"name": "hidden",
88118
"type": "| boolean | { narrow?: boolean regular?: boolean wide?: boolean }",
@@ -98,6 +128,12 @@
98128
{
99129
"name": "PageHeader.TitleArea",
100130
"props": [
131+
{
132+
"name": "className",
133+
"type": "string | undefined",
134+
"defaultValue": "",
135+
"description": "CSS string"
136+
},
101137
{
102138
"name": "hidden",
103139
"type": "| boolean | { narrow?: boolean regular?: boolean wide?: boolean }",
@@ -119,6 +155,12 @@
119155
{
120156
"name": "PageHeader.LeadingAction",
121157
"props": [
158+
{
159+
"name": "className",
160+
"type": "string | undefined",
161+
"defaultValue": "",
162+
"description": "CSS string"
163+
},
122164
{
123165
"name": "hidden",
124166
"type": "| boolean | { narrow?: boolean regular?: boolean wide?: boolean }",
@@ -134,6 +176,12 @@
134176
{
135177
"name": "PageHeader.LeadingVisual",
136178
"props": [
179+
{
180+
"name": "className",
181+
"type": "string | undefined",
182+
"defaultValue": "",
183+
"description": "CSS string"
184+
},
137185
{
138186
"name": "hidden",
139187
"type": "| boolean | { narrow?: boolean regular?: boolean wide?: boolean }",
@@ -149,6 +197,12 @@
149197
{
150198
"name": "PageHeader.Title",
151199
"props": [
200+
{
201+
"name": "className",
202+
"type": "string | undefined",
203+
"defaultValue": "",
204+
"description": "CSS string"
205+
},
152206
{
153207
"name": "hidden",
154208
"type": "| boolean | { narrow?: boolean regular?: boolean wide?: boolean }",
@@ -169,6 +223,12 @@
169223
{
170224
"name": "PageHeader.TrailingVisual",
171225
"props": [
226+
{
227+
"name": "className",
228+
"type": "string | undefined",
229+
"defaultValue": "",
230+
"description": "CSS string"
231+
},
172232
{
173233
"name": "hidden",
174234
"type": "| boolean | { narrow?: boolean regular?: boolean wide?: boolean }",
@@ -184,6 +244,12 @@
184244
{
185245
"name": "PageHeader.TrailingAction",
186246
"props": [
247+
{
248+
"name": "className",
249+
"type": "string | undefined",
250+
"defaultValue": "",
251+
"description": "CSS string"
252+
},
187253
{
188254
"name": "hidden",
189255
"type": "| boolean | { narrow?: boolean regular?: boolean wide?: boolean }",
@@ -199,6 +265,12 @@
199265
{
200266
"name": "PageHeader.Actions",
201267
"props": [
268+
{
269+
"name": "className",
270+
"type": "string | undefined",
271+
"defaultValue": "",
272+
"description": "CSS string"
273+
},
202274
{
203275
"name": "hidden",
204276
"type": "| boolean | { narrow?: boolean regular?: boolean wide?: boolean }",
@@ -214,6 +286,12 @@
214286
{
215287
"name": "PageHeader.Description",
216288
"props": [
289+
{
290+
"name": "className",
291+
"type": "string | undefined",
292+
"defaultValue": "",
293+
"description": "CSS string"
294+
},
217295
{
218296
"name": "hidden",
219297
"type": "| boolean | { narrow?: boolean regular?: boolean wide?: boolean }",
@@ -245,6 +323,12 @@
245323
"defaultValue": "\"div\"",
246324
"description": "The HTML element used to render the navigation."
247325
},
326+
{
327+
"name": "className",
328+
"type": "string | undefined",
329+
"defaultValue": "",
330+
"description": "CSS string"
331+
},
248332
{
249333
"name": "hidden",
250334
"type": "| boolean | { narrow?: boolean regular?: boolean wide?: boolean }",

0 commit comments

Comments
 (0)