Skip to content

Commit

Permalink
updates docs output after merging from main
Browse files Browse the repository at this point in the history
  • Loading branch information
@mperrotti
mperrotti committed Aug 8, 2024
1 parent 4efe0dc commit f2f27bd
Show file tree
Hide file tree
Showing 2 changed files with 133 additions and 11 deletions.
60 changes: 49 additions & 11 deletions packages/react/script/prop-docs/components.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -199,7 +199,7 @@
},
{
"name": "variant",
"type": "\"default\" | \"danger\" | \"primary\" | \"invisible\"",
"type": "\"link\" | \"default\" | \"danger\" | \"primary\" | \"invisible\"",
"required": false,
"description": "Determine's the styles on a button one of 'default' | 'primary' | 'invisible' | 'danger'",
"defaultValue": ""
Expand Down Expand Up @@ -841,7 +841,7 @@
},
{
"name": "variant",
"type": "\"default\" | \"danger\" | \"primary\" | \"invisible\"",
"type": "\"link\" | \"default\" | \"danger\" | \"primary\" | \"invisible\"",
"required": false,
"description": "Determine's the styles on a button one of 'default' | 'primary' | 'invisible' | 'danger'",
"defaultValue": ""
Expand Down Expand Up @@ -2365,6 +2365,10 @@
"id": "components-button-features--invisible",
"code": "() => <Button variant=\"invisible\">Invisible</Button>"
},
{
"id": "components-button-features--link",
"code": "() => <Button variant=\"link\">Button that looks like a link</Button>"
},
{
"id": "components-button-features--leading-visual",
"code": "() => <Button leadingVisual={HeartIcon}>Leading visual</Button>"
Expand Down Expand Up @@ -2440,6 +2444,10 @@
{
"id": "components-button-features--label-wrap",
"code": "() => {\n return (\n <Stack\n style={{\n width: '200px',\n }}\n >\n <Button labelWrap>\n This button label will wrap if the label is too long\n </Button>\n <Button size=\"small\" labelWrap>\n This small button label will wrap if the label is too long\n </Button>\n <Button size=\"large\" labelWrap>\n This large button label will wrap if the label is too long\n </Button>\n <Button labelWrap leadingVisual={HeartIcon} trailingVisual={EyeIcon}>\n This button label will wrap if the label is too long\n </Button>\n <Button labelWrap trailingAction={TriangleDownIcon}>\n This button label will wrap if the label is too long\n </Button>\n </Stack>\n )\n}"
},
{
"id": "components-button-features--inactive-button-with-tooltip",
"code": "() => (\n <Tooltip\n text=\"Action unavailable: an error occured while loading respository permissions\"\n direction=\"n\"\n >\n <Button inactive>Review changes</Button>\n </Tooltip>\n)"
}
],
"importPath": "@primer/react",
Expand Down Expand Up @@ -2502,7 +2510,7 @@
},
{
"name": "variant",
"type": "\"default\" | \"danger\" | \"primary\" | \"invisible\"",
"type": "\"link\" | \"default\" | \"danger\" | \"primary\" | \"invisible\"",
"required": false,
"description": "Determine's the styles on a button one of 'default' | 'primary' | 'invisible' | 'danger'",
"defaultValue": ""
Expand Down Expand Up @@ -2732,7 +2740,7 @@
},
{
"name": "variant",
"type": "\"default\" | \"danger\" | \"primary\" | \"invisible\"",
"type": "\"link\" | \"default\" | \"danger\" | \"primary\" | \"invisible\"",
"required": false,
"description": "Determine's the styles on a button one of 'default' | 'primary' | 'invisible' | 'danger'",
"defaultValue": ""
Expand Down Expand Up @@ -2962,7 +2970,7 @@
},
{
"name": "variant",
"type": "\"default\" | \"danger\" | \"primary\" | \"invisible\"",
"type": "\"link\" | \"default\" | \"danger\" | \"primary\" | \"invisible\"",
"required": false,
"description": "Determine's the styles on a button one of 'default' | 'primary' | 'invisible' | 'danger'",
"defaultValue": ""
Expand Down Expand Up @@ -4210,6 +4218,13 @@
"description": "The direction the content flows.\nVertical layout is used by default, and horizontal layout is used for checkbox and radio inputs.",
"defaultValue": "vertical"
},
{
"name": "className",
"type": "string",
"required": false,
"description": "",
"defaultValue": ""
},
{
"name": "sx",
"type": "BetterSystemStyleObject",
Expand Down Expand Up @@ -4355,6 +4370,22 @@
{
"id": "components-heading--default",
"code": "() => <Heading>Default H2 Heading</Heading>"
},
{
"id": "components-heading-features--test-sx",
"code": "() => (\n <Heading\n sx={{\n fontSize: 2,\n fontWeight: 'normal',\n }}\n >\n Heading with sx override\n </Heading>\n)"
},
{
"id": "components-heading-features--small",
"code": "() => <Heading variant=\"small\">Small heading</Heading>"
},
{
"id": "components-heading-features--medium",
"code": "() => <Heading variant=\"medium\">Medium heading</Heading>"
},
{
"id": "components-heading-features--large",
"code": "() => <Heading variant=\"large\">Large heading</Heading>"
}
],
"importPath": "@primer/react",
Expand All @@ -4366,6 +4397,13 @@
"description": "",
"defaultValue": ""
},
{
"name": "variant",
"type": "\"small\" | \"large\" | \"medium\"",
"required": false,
"description": "",
"defaultValue": ""
},
{
"name": "sx",
"type": "BetterSystemStyleObject",
Expand Down Expand Up @@ -8268,7 +8306,7 @@
},
{
"name": "variant",
"type": "\"default\" | \"danger\" | \"primary\" | \"invisible\"",
"type": "\"link\" | \"default\" | \"danger\" | \"primary\" | \"invisible\"",
"required": false,
"description": "@deprecated Text input action buttons should only use the 'invisible' button variant\nDetermine's the styles on a button one of 'default' | 'primary' | 'invisible' | 'danger'",
"defaultValue": "invisible"
Expand Down Expand Up @@ -10292,7 +10330,7 @@
},
{
"name": "variant",
"type": "\"default\" | \"danger\" | \"primary\" | \"invisible\"",
"type": "\"link\" | \"default\" | \"danger\" | \"primary\" | \"invisible\"",
"required": false,
"description": "Determine's the styles on a button one of 'default' | 'primary' | 'invisible' | 'danger'",
"defaultValue": ""
Expand Down Expand Up @@ -10421,7 +10459,7 @@
},
{
"name": "variant",
"type": "\"default\" | \"danger\" | \"primary\" | \"invisible\"",
"type": "\"link\" | \"default\" | \"danger\" | \"primary\" | \"invisible\"",
"required": false,
"description": "Determine's the styles on a button one of 'default' | 'primary' | 'invisible' | 'danger'",
"defaultValue": ""
Expand Down Expand Up @@ -10615,7 +10653,7 @@
},
{
"name": "variant",
"type": "\"default\" | \"danger\" | \"primary\" | \"invisible\"",
"type": "\"link\" | \"default\" | \"danger\" | \"primary\" | \"invisible\"",
"required": false,
"description": "Determine's the styles on a button one of 'default' | 'primary' | 'invisible' | 'danger'",
"defaultValue": ""
Expand Down Expand Up @@ -10732,7 +10770,7 @@
},
{
"name": "variant",
"type": "\"default\" | \"danger\" | \"primary\" | \"invisible\"",
"type": "\"link\" | \"default\" | \"danger\" | \"primary\" | \"invisible\"",
"required": false,
"description": "Determine's the styles on a button one of 'default' | 'primary' | 'invisible' | 'danger'",
"defaultValue": ""
Expand Down Expand Up @@ -11038,7 +11076,7 @@
},
{
"name": "variant",
"type": "\"default\" | \"danger\" | \"primary\" | \"invisible\"",
"type": "\"link\" | \"default\" | \"danger\" | \"primary\" | \"invisible\"",
"required": false,
"description": "Determine's the styles on a button one of 'default' | 'primary' | 'invisible' | 'danger'",
"defaultValue": "warning"
Expand Down
84 changes: 84 additions & 0 deletions packages/react/script/prop-docs/docgen-output.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2456,6 +2456,9 @@
"name": "enum",
"raw": "VariantType",
"value": [
{
"value": "\"link\""
},
{
"value": "\"default\""
},
Expand Down Expand Up @@ -9480,6 +9483,9 @@
"name": "enum",
"raw": "VariantType",
"value": [
{
"value": "\"link\""
},
{
"value": "\"default\""
},
Expand Down Expand Up @@ -26646,6 +26652,9 @@
"name": "enum",
"raw": "VariantType",
"value": [
{
"value": "\"link\""
},
{
"value": "\"default\""
},
Expand Down Expand Up @@ -28456,6 +28465,9 @@
"name": "enum",
"raw": "VariantType",
"value": [
{
"value": "\"link\""
},
{
"value": "\"default\""
},
Expand Down Expand Up @@ -31342,6 +31354,9 @@
"name": "enum",
"raw": "VariantType",
"value": [
{
"value": "\"link\""
},
{
"value": "\"default\""
},
Expand Down Expand Up @@ -39362,6 +39377,27 @@
]
}
},
"className": {
"defaultValue": null,
"description": "",
"name": "className",
"declarations": [
{
"fileName": "react/packages/react/src/FormControl/FormControl.tsx",
"name": "TypeLiteral"
}
],
"required": false,
"type": {
"name": "enum",
"raw": "string",
"value": [
{
"value": "string"
}
]
}
},
"sx": {
"defaultValue": null,
"description": "A style object used to override styles using styled-components",
Expand Down Expand Up @@ -40348,6 +40384,33 @@
]
}
},
"variant": {
"defaultValue": null,
"description": "",
"name": "variant",
"declarations": [
{
"fileName": "react/packages/react/src/Heading/Heading.tsx",
"name": "TypeLiteral"
}
],
"required": false,
"type": {
"name": "enum",
"raw": "\"small\" | \"large\" | \"medium\"",
"value": [
{
"value": "\"small\""
},
{
"value": "\"large\""
},
{
"value": "\"medium\""
}
]
}
},
"sx": {
"defaultValue": null,
"description": "A style object used to override styles using styled-components",
Expand Down Expand Up @@ -67875,6 +67938,9 @@
"name": "enum",
"raw": "VariantType",
"value": [
{
"value": "\"link\""
},
{
"value": "\"default\""
},
Expand Down Expand Up @@ -92107,6 +92173,9 @@
"name": "enum",
"raw": "VariantType",
"value": [
{
"value": "\"link\""
},
{
"value": "\"default\""
},
Expand Down Expand Up @@ -94951,6 +95020,9 @@
"name": "enum",
"raw": "VariantType",
"value": [
{
"value": "\"link\""
},
{
"value": "\"default\""
},
Expand Down Expand Up @@ -97102,6 +97174,9 @@
"name": "enum",
"raw": "VariantType",
"value": [
{
"value": "\"link\""
},
{
"value": "\"default\""
},
Expand Down Expand Up @@ -98819,6 +98894,9 @@
"name": "enum",
"raw": "VariantType",
"value": [
{
"value": "\"link\""
},
{
"value": "\"default\""
},
Expand Down Expand Up @@ -102070,6 +102148,9 @@
"name": "enum",
"raw": "VariantType",
"value": [
{
"value": "\"link\""
},
{
"value": "\"default\""
},
Expand Down Expand Up @@ -109960,6 +110041,9 @@
"name": "enum",
"raw": "VariantType",
"value": [
{
"value": "\"link\""
},
{
"value": "\"default\""
},
Expand Down

0 comments on commit f2f27bd

Please sign in to comment.