Skip to content

Commit 5912f86

Browse files
interactivellamainteractivellama
committed
Clean up for release
Build Server commit: Update release notes, commit inline icons (if needed), site component documentation (if needed). Remove patch.md or minor.md
1 parent 672a38d commit 5912f86

File tree

3 files changed

+55
-71
lines changed

3 files changed

+55
-71
lines changed

‎components/component-docs.json

Lines changed: 54 additions & 43 deletions
Original file line numberDiff line numberDiff line change
@@ -839,16 +839,16 @@
839839
"type": {
840840
"name": "shape",
841841
"value": {
842-
"breadcrumb": {
842+
"label": {
843843
"name": "string",
844844
"required": false
845845
}
846846
}
847847
},
848848
"required": false,
849-
"description": "Assistive text for accessibility that labels the icon.\n**Assistive text for accessibility.**\nThis object is merged with the default props object on every render.\n* `breadcrumb`: The assistive text for the breadcrumb trail.",
849+
"description": "**Assistive text for accessibility.**\nThis object is merged with the default props object on every render.\n* `label`: The assistive text for the breadcrumb trail.",
850850
"defaultValue": {
851-
"value": "{\n breadcrumb: 'Breadcrumbs',\n}",
851+
"value": "{\n label: 'Breadcrumbs',\n}",
852852
"computed": false
853853
}
854854
},
@@ -866,7 +866,7 @@
866866
"dependencies": []
867867
},
868868
"button": {
869-
"description": "The Button component is the Lightning Design System Button component. The Button should be used for label buttons, icon buttons, or buttons that have both labels and icons.\nEither a <code>label</code> or <code>assistiveText</code> is required; see the Prop Details table below.\nFor buttons that maintain selected/unselected states, use the <a href=\"#/button-stateful\">ButtonStateful</a> component.",
869+
"description": "The Button component is the Lightning Design System Button component. The Button should be used for label buttons, icon buttons, or buttons that have both labels and icons.\nEither a <code>label</code> or <code>assistiveText.icon</code> is required; see the Prop Details table below.\nFor buttons that maintain selected/unselected states, use the <a href=\"#/button-stateful\">ButtonStateful</a> component.",
870870
"methods": [
871871
{
872872
"name": "getClassName",
@@ -968,10 +968,20 @@
968968
},
969969
"assistiveText": {
970970
"type": {
971-
"name": "string"
971+
"name": "shape",
972+
"value": {
973+
"icon": {
974+
"name": "string",
975+
"required": false
976+
}
977+
}
972978
},
973979
"required": false,
974-
"description": "Text that is visually hidden but read aloud by screenreaders to tell the user what the icon means.\nIf the button has an icon and a visible label, you can omit the <code>assistiveText</code> prop and use the <code>label</code> prop."
980+
"description": "**Assistive text for accessibility.**\nThis object is merged with the default props object on every render.\n* `icon`: Text that is visually hidden but read aloud by screenreaders to tell the user what the icon means. If the button has an icon and a visible label, you can omit the <code>assistiveText.icon</code> prop and use the <code>label</code> prop.",
981+
"defaultValue": {
982+
"value": "{ icon: '' }",
983+
"computed": false
984+
}
975985
},
976986
"buttonRef": {
977987
"type": {
@@ -1166,7 +1176,7 @@
11661176
]
11671177
},
11681178
"required": false,
1169-
"description": "Visible label on the button. If the button is an icon button with no label, you must use the <code>assistiveText</code> prop."
1179+
"description": "Visible label on the button. If the button is an icon button with no label, you must use the <code>assistiveText.icon</code> prop."
11701180
},
11711181
"onBlur": {
11721182
"type": {
@@ -1394,7 +1404,7 @@
13941404
}
13951405
},
13961406
"required": false,
1397-
"description": "Assistive text for accessibility that labels the icon.\n**Assistive text for accessibility.**\nThis object is merged with the default props object on every render.\n* `icon`: Text that is visually hidden but read aloud by screenreaders to tell the user what the icon means. This should also include the state of the button. If the button has an icon and a visible label, you can omit the <code>icon</code> prop and use the <code>label</code> prop.",
1407+
"description": "**Assistive text for accessibility.**\nThis object is merged with the default props object on every render.\n* `icon`: Text that is visually hidden but read aloud by screenreaders to tell the user what the icon means. This should also include the state of the button. If the button has an icon and a visible label, you can omit the <code>icon</code> prop and use the <code>label</code> prop.",
13981408
"defaultValue": {
13991409
"value": "{ icon: '' }",
14001410
"computed": false
@@ -3532,12 +3542,12 @@
35323542
"props": {
35333543
"assistiveText": {
35343544
"type": {
3535-
"name": "string"
3545+
"name": "object"
35363546
},
35373547
"required": false,
35383548
"description": "Description of the menu for screenreaders.",
35393549
"defaultValue": {
3540-
"value": "'Actions'",
3550+
"value": "{ icon: 'Actions' }",
35413551
"computed": false
35423552
}
35433553
},
@@ -4765,6 +4775,27 @@
47654775
}
47664776
],
47674777
"props": {
4778+
"assistiveText": {
4779+
"type": {
4780+
"name": "shape",
4781+
"value": {
4782+
"skipToNav": {
4783+
"name": "string",
4784+
"required": false
4785+
},
4786+
"skipToContent": {
4787+
"name": "string",
4788+
"required": false
4789+
}
4790+
}
4791+
},
4792+
"required": false,
4793+
"description": "**Assistive text for accessibility.**\nThis object is merged with the default props object on every render.\n* `skipToNav`: The localized text that will be read back for the \"Skip to Navigation\" accessibility link.\n* `skipToContent`: The localized text that will be read back for the \"Skip to Main Content\" accessibility link.",
4794+
"defaultValue": {
4795+
"value": "{\n skipToNav: 'Skip to Navigation',\n skipToContent: 'Skip to Main Content',\n}",
4796+
"computed": false
4797+
}
4798+
},
47684799
"children": {
47694800
"type": {
47704801
"name": "node"
@@ -4803,28 +4834,6 @@
48034834
},
48044835
"required": false,
48054836
"description": "Required for accessibility. Should jump the user to the primary navigation."
4806-
},
4807-
"skipToContentAssistiveText": {
4808-
"type": {
4809-
"name": "string"
4810-
},
4811-
"required": false,
4812-
"description": "The localized text that will be read back for the \"Skip to Main Content\" accessibility link.",
4813-
"defaultValue": {
4814-
"value": "'Skip to Main Content'",
4815-
"computed": false
4816-
}
4817-
},
4818-
"skipToNavAssistiveText": {
4819-
"type": {
4820-
"name": "string"
4821-
},
4822-
"required": false,
4823-
"description": "The localized text that will be read back for the \"Skip to Navigation\" accessibility link.",
4824-
"defaultValue": {
4825-
"value": "'Skip to Navigation'",
4826-
"computed": false
4827-
}
48284837
}
48294838
},
48304839
"route": "global-header",
@@ -5321,10 +5330,16 @@
53215330
},
53225331
"assistiveText": {
53235332
"type": {
5324-
"name": "string"
5333+
"name": "shape",
5334+
"value": {
5335+
"icon": {
5336+
"name": "string",
5337+
"required": false
5338+
}
5339+
}
53255340
},
5326-
"required": true,
5327-
"description": "Text that is visually hidden but read aloud by screenreaders to tell the user what the icon means."
5341+
"required": false,
5342+
"description": "**Assistive text for accessibility.**\nThis object is merged with the default props object on every render.\n* `icon`: Text that is visually hidden but read aloud by screenreaders to tell the user what the icon means. If the button has an icon and a visible label, you can omit the <code>assistiveText.icon</code> prop and use the <code>label</code> prop."
53285343
},
53295344
"align": {
53305345
"type": {
@@ -6496,7 +6511,7 @@
64966511
},
64976512
"assistiveText": {
64986513
"type": {
6499-
"name": "string"
6514+
"name": "object"
65006515
},
65016516
"required": false,
65026517
"description": "This prop is passed onto the triggering `Button`. Text that is visually hidden but read aloud by screenreaders to tell the user what the icon means. You can omit this prop if you are using the `label` prop."
@@ -7476,7 +7491,7 @@
74767491
"name": "func"
74777492
},
74787493
"required": false,
7479-
"description": "Function that returns parent node to contain Modal. Should return document.querySelector('#myModalContainer')."
7494+
"description": "Function whose return value is the mount node to insert the Modal element into. The default is `() => document.body`."
74807495
},
74817496
"portalClassName": {
74827497
"type": {
@@ -10248,11 +10263,7 @@
1024810263
"name": "number"
1024910264
},
1025010265
"required": false,
10251-
"description": "This is the initial value of an uncontrolled form element and is present\nonly to provide compatibility with hybrid framework applications that\nare not entirely React. It should only be used in an application without\ncentralized state (Redux, Flux). \"Controlled components\" with centralized\nstate is highly recommended. See [Code Overview](https://github.com/salesforce/design-system-react/blob/master/docs/codebase-overview.md#controlled-and-uncontrolled-components) for more information.",
10252-
"defaultValue": {
10253-
"value": "0",
10254-
"computed": false
10255-
}
10266+
"description": "This is the initial value of an uncontrolled form element and is present\nonly to provide compatibility with hybrid framework applications that\nare not entirely React. It should only be used in an application without\ncentralized state (Redux, Flux). \"Controlled components\" with centralized\nstate is highly recommended. See [Code Overview](https://github.com/salesforce/design-system-react/blob/master/docs/codebase-overview.md#controlled-and-uncontrolled-components) for more information."
1025610267
},
1025710268
"disabled": {
1025810269
"type": {
@@ -10366,7 +10377,7 @@
1036610377
"name": "number"
1036710378
},
1036810379
"required": false,
10369-
"description": "The Slider is a controlled component, and will always display this value."
10380+
"description": "The Slider should be a controlled component, and will always display this value. This should always be used if you are using a Flux/Redux framework."
1037010381
},
1037110382
"vertical": {
1037210383
"type": {

‎package-lock.json

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎patch.md

Lines changed: 0 additions & 27 deletions
This file was deleted.

0 commit comments

Comments
 (0)