Skip to content

Commit ed72f6c

Browse files
authored
chore: Remove all legacy markdown from Style API interfaces (#3779)
1 parent 643c45d commit ed72f6c

File tree

9 files changed

+0
-146
lines changed

9 files changed

+0
-146
lines changed

src/__tests__/snapshot-tests/__snapshots__/documenter.test.ts.snap

Lines changed: 0 additions & 73 deletions
Original file line numberDiff line numberDiff line change
@@ -181,22 +181,6 @@ If the label is assigned via the \`i18nStrings\` property, this label will be ig
181181
"type": "string",
182182
},
183183
{
184-
"description": "Specifies an object of selectors and properties that are used to apply custom styles.
185-
186-
- \`root.background\` (string) - (Optional) Background for alert.
187-
- \`root.borderColor\` (string) - (Optional) Border color for alert.
188-
- \`root.borderRadius\` (string) - (Optional) Alert border radius.
189-
- \`root.borderWidth\` (string) - (Optional) Alert border width.
190-
- \`root.color\` (string) - (Optional) Text color for alert.
191-
- \`root.focusRing.borderColor\` (string) - (Optional) Alert focus ring border color.
192-
- \`root.focusRing.borderRadius\` (string) - (Optional) Alert button focus ring border radius.
193-
- \`root.focusRing.borderWidth\` (string) - (Optional) Alert button focus ring border width.
194-
- \`dismissButton.color.active\` (string) - (Optional) Color for dismiss button active state.
195-
- \`dismissButton.color.default\` (string) - (Optional) Color for dismiss button default state.
196-
- \`dismissButton.color.hover\` (string) - (Optional) Color for dismiss button hover state.
197-
- \`dismissButton.focusRing.borderColor\` (string) - (Optional) Dismiss button focus ring border color.
198-
- \`dismissButton.focusRing.borderRadius\` (string) - (Optional) Dismiss button focus ring border radius.
199-
- \`dismissButton.focusRing.borderWidth\` (string) - (Optional) Dismiss button focus ring border width.",
200184
"inlineType": {
201185
"name": "AlertProps.Style",
202186
"properties": [
@@ -3592,15 +3576,6 @@ use the \`id\` attribute, consider setting it on a parent element instead.",
35923576
"type": "string",
35933577
},
35943578
{
3595-
"description": "Specifies an object of selectors and properties that are used to apply custom styles.
3596-
3597-
- \`root.background\` (string) - (Optional) Background for badge.
3598-
- \`root.borderColor\` (string) - (Optional) Border color for badge.
3599-
- \`root.borderRadius\` (string) - (Optional) Border radius style.
3600-
- \`root.borderWidth\` (string) - (Optional) Border width style.
3601-
- \`root.color\` (string) - (Optional) Text color for badge.
3602-
- \`root.paddingBlock\` (string) - (Optional) Block dimension padding.
3603-
- \`root.paddingInline\` (string) - (Optional) Inline dimension padding.",
36043579
"inlineType": {
36053580
"name": "BadgeProps.Style",
36063581
"properties": [
@@ -7081,7 +7056,6 @@ If both \`readOnly\` and \`disabled\` are set, \`disabled\` takes precedence.",
70817056
"type": "boolean",
70827057
},
70837058
{
7084-
"description": "Specifies an object of selectors and properties that are used to apply custom styles.",
70857059
"inlineType": {
70867060
"name": "CheckboxProps.Style",
70877061
"properties": [
@@ -9034,21 +9008,6 @@ If no height is provided, the media slot will be displayed at its full height.",
90349008
"type": "ContainerProps.Media",
90359009
},
90369010
{
9037-
"description": "Specifies an object of selectors and properties that are used to apply custom styles.
9038-
9039-
- \`root.background\` (string) - (Optional) Background of the container.
9040-
- \`root.borderColor\` (string) - (Optional) Border color of the container.
9041-
- \`root.borderRadius\` (string) - (Optional) Border radius of the container.
9042-
- \`root.borderWidth\` (string) - (Optional) Border width of the container.
9043-
- \`root.boxShadow\` (string) - (Optional) Box shadow of the container.
9044-
- \`content.paddingBlock\` (string) - (Optional) Block dimension padding of the content slot.
9045-
- \`content.paddingInline\` (string) - (Optional) Inline dimension padding of the content slot.
9046-
- \`header.paddingBlock\` (string) - (Optional) Block dimension padding of the header slot.
9047-
- \`header.paddingInline\` (string) - (Optional) Inline dimension padding of the header slot.
9048-
- \`footer.root.paddingBlock\` (string) - (Optional) Block dimension padding of the footer slot.
9049-
- \`footer.root.paddingInline\` (string) - (Optional) Inline dimension padding of the footer slot.
9050-
- \`footer.divider.borderColor\` (string) - (Optional) Border color of the footer divider.
9051-
- \`footer.divider.borderWidth\` (string) - (Optional) Border width of the footer divider.",
90529011
"inlineType": {
90539012
"name": "ContainerProps.Style",
90549013
"properties": [
@@ -11897,30 +11856,6 @@ If the \`action\` property is set, this property is ignored. **Deprecated**, rep
1189711856
"type": "boolean",
1189811857
},
1189911858
{
11900-
"description": "Specifies an object of selectors and properties that are used to apply custom styles.
11901-
11902-
- \`item.root.background\` {error, info, inProgress, success, warning} - (Optional) Background for item types.
11903-
- \`item.root.borderColor\` {error, info, inProgress, success, warning} - (Optional) Border color for item types.
11904-
- \`item.root.borderRadius\` (string) - (Optional) Item border radius.
11905-
- \`item.root.borderWidth\` (string) - (Optional) Item border width.
11906-
- \`item.root.color\` {error, info, inProgress, success, warning} - (Optional) Color for item types.
11907-
- \`item.root.focusRing.borderColor\` {error, info, inProgress, success, warning} - (Optional) Item focus ring border color.
11908-
- \`item.root.focusRing.borderRadius\` (string) - (Optional) Item focus ring border radius.
11909-
- \`item.root.focusRing.borderWidth\` (string) - (Optional) Item focus ring border width.
11910-
- \`item.dismissButton.color.active\` {error, info, inProgress, success, warning} - (Optional) Color for dismiss button active state.
11911-
- \`item.dismissButton.color.default\` {error, info, inProgress, success, warning} - (Optional) Color for dismiss button default state.
11912-
- \`item.dismissButton.color.hover\` {error, info, inProgress, success, warning} - (Optional) Color for dismiss button hover state.
11913-
- \`item.dismissButton.focusRing.borderColor\` {error, info, inProgress, success, warning} - (Optional) Dismiss button focus ring border color.
11914-
- \`item.dismissButton.focusRing.borderRadius\` (string) - (Optional) Dismiss button focus ring border radius.
11915-
- \`item.dismissButton.focusRing.borderWidth\` (string) - (Optional) Dismiss button focus ring border width.
11916-
- \`notificationBar.root.background\` {active, default, hover} - (Optional) Background for notification bar states.
11917-
- \`notificationBar.root.borderColor\` {active, default, hover} - (Optional) Border color for notification bar states.
11918-
- \`notificationBar.root.borderRadius\` (string) - (Optional) Notification bar border radius.
11919-
- \`notificationBar.root.borderWidth\` (string) - (Optional) Notification bar border width.
11920-
- \`notificationBar.root.color\` {active, default, hover} - (Optional) Color for notification bar states.
11921-
- \`notificationBar.expandButton.focusRing.borderColor\` (string) - (Optional) Border color for the expand button.
11922-
- \`notificationBar.expandButton.focusRing.borderRadius\` (string) - (Optional) Border radius for the expand button.
11923-
- \`notificationBar.expandButton.focusRing.borderWidth\` (string) - (Optional) Border width for the expand button.",
1192411859
"inlineType": {
1192511860
"name": "FlashbarProps.Style",
1192611861
"properties": [
@@ -15274,12 +15209,6 @@ By default, the component sets the \`rel\` attribute to "noopener noreferrer" wh
1527415209
"type": "string",
1527515210
},
1527615211
{
15277-
"description": "Specifies an object of selectors and properties that are used to apply custom styles.
15278-
15279-
- \`root.color\` {active, default, hover} (string) - (Optional) Text color for link.
15280-
- \`root.focusRing.borderColor\` (string) - (Optional) Focus ring border color.
15281-
- \`root.focusRing.borderRadius\` (string) - (Optional) Focus ring border radius.
15282-
- \`root.focusRing.borderWidth\` (string) - (Optional) Focus ring border width.",
1528315212
"inlineType": {
1528415213
"name": "LinkProps.Style",
1528515214
"properties": [
@@ -19411,7 +19340,6 @@ being included in a form submission. A read-only control is still focusable.",
1941119340
"type": "boolean",
1941219341
},
1941319342
{
19414-
"description": "Specifies an object of selectors and properties that are used to apply custom styles.",
1941519343
"inlineType": {
1941619344
"name": "RadioGroupProps.Style",
1941719345
"properties": [
@@ -25156,7 +25084,6 @@ If both \`readOnly\` and \`disabled\` are set, \`disabled\` takes precedence.",
2515625084
"type": "boolean",
2515725085
},
2515825086
{
25159-
"description": "Specifies an object of selectors and properties that are used to apply custom styles.",
2516025087
"inlineType": {
2516125088
"name": "ToggleProps.Style",
2516225089
"properties": [

src/alert/interfaces.ts

Lines changed: 0 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -150,22 +150,6 @@ export interface AlertProps extends BaseComponentProps {
150150
*/
151151
analyticsMetadata?: AlertProps.AnalyticsMetadata;
152152
/**
153-
* Specifies an object of selectors and properties that are used to apply custom styles.
154-
*
155-
* - `root.background` (string) - (Optional) Background for alert.
156-
* - `root.borderColor` (string) - (Optional) Border color for alert.
157-
* - `root.borderRadius` (string) - (Optional) Alert border radius.
158-
* - `root.borderWidth` (string) - (Optional) Alert border width.
159-
* - `root.color` (string) - (Optional) Text color for alert.
160-
* - `root.focusRing.borderColor` (string) - (Optional) Alert focus ring border color.
161-
* - `root.focusRing.borderRadius` (string) - (Optional) Alert button focus ring border radius.
162-
* - `root.focusRing.borderWidth` (string) - (Optional) Alert button focus ring border width.
163-
* - `dismissButton.color.active` (string) - (Optional) Color for dismiss button active state.
164-
* - `dismissButton.color.default` (string) - (Optional) Color for dismiss button default state.
165-
* - `dismissButton.color.hover` (string) - (Optional) Color for dismiss button hover state.
166-
* - `dismissButton.focusRing.borderColor` (string) - (Optional) Dismiss button focus ring border color.
167-
* - `dismissButton.focusRing.borderRadius` (string) - (Optional) Dismiss button focus ring border radius.
168-
* - `dismissButton.focusRing.borderWidth` (string) - (Optional) Dismiss button focus ring border width.
169153
* @awsuiSystem core
170154
*/
171155
style?: AlertProps.Style;

src/badge/interfaces.ts

Lines changed: 0 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -25,15 +25,6 @@ export interface BadgeProps extends BaseComponentProps {
2525
children?: React.ReactNode;
2626

2727
/**
28-
* Specifies an object of selectors and properties that are used to apply custom styles.
29-
*
30-
* - `root.background` (string) - (Optional) Background for badge.
31-
* - `root.borderColor` (string) - (Optional) Border color for badge.
32-
* - `root.borderRadius` (string) - (Optional) Border radius style.
33-
* - `root.borderWidth` (string) - (Optional) Border width style.
34-
* - `root.color` (string) - (Optional) Text color for badge.
35-
* - `root.paddingBlock` (string) - (Optional) Block dimension padding.
36-
* - `root.paddingInline` (string) - (Optional) Inline dimension padding.
3728
* @awsuiSystem core
3829
*/
3930
style?: BadgeProps.Style;

src/checkbox/interfaces.ts

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,6 @@ export interface CheckboxProps extends BaseCheckboxProps {
3030
ariaRequired?: boolean;
3131

3232
/**
33-
* Specifies an object of selectors and properties that are used to apply custom styles.
3433
* @awsuiSystem core
3534
*/
3635
style?: CheckboxProps.Style;

src/container/interfaces.ts

Lines changed: 0 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -83,21 +83,6 @@ export interface ContainerProps extends BaseComponentProps {
8383
variant?: 'default' | 'stacked';
8484

8585
/**
86-
* Specifies an object of selectors and properties that are used to apply custom styles.
87-
*
88-
* - `root.background` (string) - (Optional) Background of the container.
89-
* - `root.borderColor` (string) - (Optional) Border color of the container.
90-
* - `root.borderRadius` (string) - (Optional) Border radius of the container.
91-
* - `root.borderWidth` (string) - (Optional) Border width of the container.
92-
* - `root.boxShadow` (string) - (Optional) Box shadow of the container.
93-
* - `content.paddingBlock` (string) - (Optional) Block dimension padding of the content slot.
94-
* - `content.paddingInline` (string) - (Optional) Inline dimension padding of the content slot.
95-
* - `header.paddingBlock` (string) - (Optional) Block dimension padding of the header slot.
96-
* - `header.paddingInline` (string) - (Optional) Inline dimension padding of the header slot.
97-
* - `footer.root.paddingBlock` (string) - (Optional) Block dimension padding of the footer slot.
98-
* - `footer.root.paddingInline` (string) - (Optional) Inline dimension padding of the footer slot.
99-
* - `footer.divider.borderColor` (string) - (Optional) Border color of the footer divider.
100-
* - `footer.divider.borderWidth` (string) - (Optional) Border width of the footer divider.
10186
* @awsuiSystem core
10287
*/
10388
style?: ContainerProps.Style;

src/flashbar/interfaces.ts

Lines changed: 0 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -208,30 +208,6 @@ export interface FlashbarProps extends BaseComponentProps {
208208
i18nStrings?: FlashbarProps.I18nStrings;
209209

210210
/**
211-
* Specifies an object of selectors and properties that are used to apply custom styles.
212-
*
213-
* - `item.root.background` {error, info, inProgress, success, warning} - (Optional) Background for item types.
214-
* - `item.root.borderColor` {error, info, inProgress, success, warning} - (Optional) Border color for item types.
215-
* - `item.root.borderRadius` (string) - (Optional) Item border radius.
216-
* - `item.root.borderWidth` (string) - (Optional) Item border width.
217-
* - `item.root.color` {error, info, inProgress, success, warning} - (Optional) Color for item types.
218-
* - `item.root.focusRing.borderColor` {error, info, inProgress, success, warning} - (Optional) Item focus ring border color.
219-
* - `item.root.focusRing.borderRadius` (string) - (Optional) Item focus ring border radius.
220-
* - `item.root.focusRing.borderWidth` (string) - (Optional) Item focus ring border width.
221-
* - `item.dismissButton.color.active` {error, info, inProgress, success, warning} - (Optional) Color for dismiss button active state.
222-
* - `item.dismissButton.color.default` {error, info, inProgress, success, warning} - (Optional) Color for dismiss button default state.
223-
* - `item.dismissButton.color.hover` {error, info, inProgress, success, warning} - (Optional) Color for dismiss button hover state.
224-
* - `item.dismissButton.focusRing.borderColor` {error, info, inProgress, success, warning} - (Optional) Dismiss button focus ring border color.
225-
* - `item.dismissButton.focusRing.borderRadius` (string) - (Optional) Dismiss button focus ring border radius.
226-
* - `item.dismissButton.focusRing.borderWidth` (string) - (Optional) Dismiss button focus ring border width.
227-
* - `notificationBar.root.background` {active, default, hover} - (Optional) Background for notification bar states.
228-
* - `notificationBar.root.borderColor` {active, default, hover} - (Optional) Border color for notification bar states.
229-
* - `notificationBar.root.borderRadius` (string) - (Optional) Notification bar border radius.
230-
* - `notificationBar.root.borderWidth` (string) - (Optional) Notification bar border width.
231-
* - `notificationBar.root.color` {active, default, hover} - (Optional) Color for notification bar states.
232-
* - `notificationBar.expandButton.focusRing.borderColor` (string) - (Optional) Border color for the expand button.
233-
* - `notificationBar.expandButton.focusRing.borderRadius` (string) - (Optional) Border radius for the expand button.
234-
* - `notificationBar.expandButton.focusRing.borderWidth` (string) - (Optional) Border width for the expand button.
235211
* @awsuiSystem core
236212
*/
237213
style?: FlashbarProps.Style;

src/link/interfaces.ts

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -108,12 +108,6 @@ export interface LinkProps extends BaseComponentProps {
108108
rel?: string;
109109

110110
/**
111-
* Specifies an object of selectors and properties that are used to apply custom styles.
112-
*
113-
* - `root.color` {active, default, hover} (string) - (Optional) Text color for link.
114-
* - `root.focusRing.borderColor` (string) - (Optional) Focus ring border color.
115-
* - `root.focusRing.borderRadius` (string) - (Optional) Focus ring border radius.
116-
* - `root.focusRing.borderWidth` (string) - (Optional) Focus ring border width.
117111
* @awsuiSystem core
118112
*/
119113
style?: LinkProps.Style;

src/radio-group/interfaces.ts

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,6 @@ export interface RadioGroupProps extends BaseComponentProps, FormFieldControlPro
6565
readOnly?: boolean;
6666

6767
/**
68-
* Specifies an object of selectors and properties that are used to apply custom styles.
6968
* @awsuiSystem core
7069
*/
7170
style?: RadioGroupProps.Style;

src/toggle/interfaces.ts

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,6 @@ export interface ToggleProps extends BaseCheckboxProps {
1919
onChange?: NonCancelableEventHandler<ToggleProps.ChangeDetail>;
2020

2121
/**
22-
* Specifies an object of selectors and properties that are used to apply custom styles.
2322
* @awsuiSystem core
2423
*/
2524
style?: ToggleProps.Style;

0 commit comments

Comments
 (0)