Skip to content

Commit 390ec45

Browse files
authored
fix(commons): remove renamed mods marked for deprecation (#2580)
* fix(commons): remove renamed mods marked for deprecation Remove mods that were renamed and previously marked for deprecation, and regenerate mods lists. This will help in reviewing the accuracy of other components' mods lists as they are being migrated to s2. * docs: migration guide notes for mod property deprecations Add notes to components affected by mod property changes in the commons basebutton. * docs(closebutton): updated docs for migration guide and icon size - Removes the "Icon size" variant options, as noted in the closebutton PR. Per Figma changelog "removed icon size as a property". - Updates migration guide with a more organized history. * fix(commons): remove another mod referencing global token Deprecates an additional mod name that was referencing a global token, and updates migration notes for all affected components.
1 parent d404aec commit 390ec45

File tree

15 files changed

+148
-155
lines changed

15 files changed

+148
-155
lines changed

components/actionbutton/metadata/actionbutton.yml

+15-7
Original file line numberDiff line numberDiff line change
@@ -12,16 +12,24 @@ sections:
1212
This component can be modified via its `--mod-*` prefixed custom properties. A list of those prefixed custom properties can be found <a class="spectrum-Link" href="https://github.com/adobe/spectrum-css/tree/main/components/actionbutton/metadata/mods.md">here</a>.
1313
- name: Migration Guide
1414
description: |
15-
### Action Button now requires a class on its icon
15+
### x/x/2024 - Version 6.0.0
16+
#### Spectrum 2 release
17+
Action button now uses Spectrum 2 tokens and specifications. A few notable changes:
18+
- The mod custom property `--mod-line-height-100` has been renamed to `--mod-button-line-height`.
19+
- The mod custom property `--mod-sans-font-family-stack` has been renamed to `--mod-button-font-family`.
20+
- The mod custom property `--mod-animation-duration-100` has been renamed to `--mod-button-animation-duration`.
21+
22+
### Versions prior to 6.0.0
23+
#### Action Button now requires a class on its icon
1624
The `.spectrum-ActionButton-icon` class is now required on the icon.
1725
18-
### T-shirt sizing
26+
#### T-shirt sizing
1927
Action Button now supports t-shirt sizing and requires that you specify the size by adding a `.spectrum-ActionButton--size*` class.
2028
21-
### Action Button is now a separate component
29+
#### Action Button is now a separate component
2230
Action Button has been moved to the [Action Button](actionbutton.html) component.
2331
24-
### Change workflow icon size
32+
#### Change workflow icon size
2533
2634
Previously, all Action Buttons used `.spectrum-Icon--sizeS`. This has changed:
2735
@@ -33,7 +41,7 @@ sections:
3341
| `.spectrum-ActionButton--sizeL` | `.spectrum-Icon--sizeL` |
3442
| `.spectrum-ActionButton--sizeXL` | `.spectrum-Icon--sizeXL` |
3543
36-
### Change hold icon classnames
44+
#### Change hold icon classnames
3745
3846
Hold icon classnames must be set as follows:
3947
@@ -45,10 +53,10 @@ sections:
4553
| `.spectrum-ActionButton--sizeL` | `.spectrum-UIIcon-CornerTriangle200` |
4654
| `.spectrum-ActionButton--sizeXL` | `.spectrum-UIIcon-CornerTriangle300` |
4755
48-
### Include markup for hold icon before workflow icon
56+
#### Include markup for hold icon before workflow icon
4957
Because of the way padding is calculated, the hold icon must be placed before the workflow icon.
5058
51-
### Remove focus-ring class
59+
#### Remove focus-ring class
5260
We've migrated away from the focus-ring class in favor of the native `:focus-visible` pseudo-class due to changes in browser support.
5361
examples:
5462
- id: actionbutton-sizing

components/actionbutton/metadata/mods.md

-3
Original file line numberDiff line numberDiff line change
@@ -49,9 +49,6 @@
4949
| `--mod-actionbutton-min-width` |
5050
| `--mod-actionbutton-static-content-color` |
5151
| `--mod-actionbutton-text-to-visual` |
52-
| `--mod-animation-duration-100` |
5352
| `--mod-button-animation-duration` |
5453
| `--mod-button-font-family` |
5554
| `--mod-button-line-height` |
56-
| `--mod-line-height-100` |
57-
| `--mod-sans-font-family-stack` |

components/button/metadata/button-accent.yml

+14-6
Original file line numberDiff line numberDiff line change
@@ -8,20 +8,28 @@ sections:
88
This component can be modified via its `--mod-*` prefixed custom properties. A list of those prefixed custom properties can be found <a class="spectrum-Link" href="https://github.com/adobe/spectrum-css/tree/main/components/button/metadata/mods.md">here</a>.
99
- name: Migration Guide
1010
description: |
11-
### Fill or Outline class required
11+
### x/x/2024 - Version 13.0.0
12+
#### Spectrum 2 release
13+
Button now uses Spectrum 2 tokens and specifications. A few notable changes:
14+
- The mod custom property `--mod-line-height-100` has been renamed to `--mod-button-line-height`.
15+
- The mod custom property `--mod-sans-font-family-stack` has been renamed to `--mod-button-font-family`.
16+
- The mod custom property `--mod-animation-duration-100` has been renamed to `--mod-button-animation-duration`.
17+
18+
### Versions prior to 13.0.0
19+
#### Fill or Outline class required
1220
All buttons now require either the `.spectrum-Button--fill` or `.spectrum-Button--outline` class.
1321
14-
### CTA replaced by Accent with Fill
22+
#### CTA replaced by Accent with Fill
1523
Replace all `.spectrum-Button--cta` with `.spectrum-Button--accent .spectrum-Button--fill`.
1624
17-
### Icon Only
25+
#### Icon Only
1826
Add the `.spectrum-Button--iconOnly` class to apply the correct styling when an icon is used without a label.
1927
Provide an `aria-label` on the button itself when using this variant for accessibility.
2028
21-
### T-shirt sizing
29+
#### T-shirt sizing
2230
Button now supports t-shirt sizing and requires that you specify the size of button by adding a `.spectrum-Button--size*` class.
2331
24-
### Change workflow icon size
32+
#### Change workflow icon size
2533
2634
Previously, all Buttons used `.spectrum-Icon--sizeS`. This has changed:
2735
@@ -32,7 +40,7 @@ sections:
3240
| `.spectrum-Button--sizeL` | `.spectrum-Icon--sizeL` |
3341
| `.spectrum-Button--sizeXL` | `.spectrum-Icon--sizeXL` |
3442
35-
### Remove focus-ring class
43+
#### Remove focus-ring class
3644
We've migrated away from the focus-ring class in favor of the native `:focus-visible` pseudo-class due to changes in browser support.
3745
examples:
3846
- id: button-accent

components/button/metadata/button-negative.yml

+15-7
Original file line numberDiff line numberDiff line change
@@ -8,23 +8,31 @@ sections:
88
This component can be modified via its `--mod-*` prefixed custom properties. A list of those prefixed custom properties can be found <a class="spectrum-Link" href="https://github.com/adobe/spectrum-css/tree/main/components/button/metadata/mods.md">here</a>.
99
- name: Migration Guide
1010
description: |
11-
### Fill or Outline class required
11+
### x/x/2024 - Version 13.0.0
12+
#### Spectrum 2 release
13+
Button now uses Spectrum 2 tokens and specifications. A few notable changes:
14+
- The mod custom property `--mod-line-height-100` has been renamed to `--mod-button-line-height`.
15+
- The mod custom property `--mod-sans-font-family-stack` has been renamed to `--mod-button-font-family`.
16+
- The mod custom property `--mod-animation-duration-100` has been renamed to `--mod-button-animation-duration`.
17+
18+
### Versions prior to 13.0.0
19+
#### Fill or Outline class required
1220
All buttons now require either the `.spectrum-Button--fill` or `.spectrum-Button--outline` class.
1321
14-
### Negative replaced by Negative with Outline
22+
#### Negative replaced by Negative with Outline
1523
Replace all `.spectrum-Button--negative` with `.spectrum-Button--negative .spectrum-Button--outline`.
1624
17-
### Negative Quiet replaced by Negative with Outline
25+
#### Negative Quiet replaced by Negative with Outline
1826
Replace all `.spectrum-Button--negative .spectrum-Button--quiet` with `.spectrum-Button--negative .spectrum-Button--outline`.
1927
20-
### Icon Only
28+
#### Icon Only
2129
Add the `.spectrum-Button--iconOnly` class to apply the correct styling when an icon is used without a label.
2230
Provide an `aria-label` on the button itself when using this variant for accessibility.
2331
24-
### T-shirt sizing
32+
#### T-shirt sizing
2533
Button now supports t-shirt sizing and requires that you specify the size of button by adding a `.spectrum-Button--size*` class.
2634
27-
### Change workflow icon size
35+
#### Change workflow icon size
2836
2937
Previously, all Buttons used `.spectrum-Icon--sizeS`. This has changed:
3038
@@ -35,7 +43,7 @@ sections:
3543
| `.spectrum-Button--sizeL` | `.spectrum-Icon--sizeL` |
3644
| `.spectrum-Button--sizeXL` | `.spectrum-Icon--sizeXL` |
3745
38-
### Remove focus-ring class
46+
#### Remove focus-ring class
3947
We've migrated away from the focus-ring class in favor of the native `:focus-visible` pseudo-class due to changes in browser support.
4048
examples:
4149
- id: button-negative

components/button/metadata/button-primary.yml

+15-7
Original file line numberDiff line numberDiff line change
@@ -8,23 +8,31 @@ sections:
88
This component can be modified via its `--mod-*` prefixed custom properties. A list of those prefixed custom properties can be found <a class="spectrum-Link" href="https://github.com/adobe/spectrum-css/tree/main/components/button/metadata/mods.md">here</a>.
99
- name: Migration Guide
1010
description: |
11-
### Fill or Outline class required
11+
### x/x/2024 - Version 13.0.0
12+
#### Spectrum 2 release
13+
Button now uses Spectrum 2 tokens and specifications. A few notable changes:
14+
- The mod custom property `--mod-line-height-100` has been renamed to `--mod-button-line-height`.
15+
- The mod custom property `--mod-sans-font-family-stack` has been renamed to `--mod-button-font-family`.
16+
- The mod custom property `--mod-animation-duration-100` has been renamed to `--mod-button-animation-duration`.
17+
18+
### Versions prior to 13.0.0
19+
#### Fill or Outline class required
1220
All buttons now require either the `.spectrum-Button--fill` or `.spectrum-Button--outline` class.
1321
14-
### Primary replaced by Primary with Outline
22+
#### Primary replaced by Primary with Outline
1523
Replace all `.spectrum-Button--primary` with `.spectrum-Button--primary .spectrum-Button--outline`.
1624
17-
### Primary Quiet replaced by Secondary with Outline
25+
#### Primary Quiet replaced by Secondary with Outline
1826
Replace all `.spectrum-Button--primary .spectrum-Button--quiet` with `.spectrum-Button--secondary .spectrum-Button--outline`.
1927
20-
### Icon Only
28+
#### Icon Only
2129
Add the `.spectrum-Button--iconOnly` class to apply the correct styling when an icon is used without a label.
2230
Provide an `aria-label` on the button itself when using this variant for accessibility.
2331
24-
### T-shirt sizing
32+
#### T-shirt sizing
2533
Button now supports t-shirt sizing and requires that you specify the size of button by adding a `.spectrum-Button--size*` class.
2634
27-
### Change workflow icon size
35+
#### Change workflow icon size
2836
2937
Previously, all Buttons used `.spectrum-Icon--sizeS`. This has changed:
3038
@@ -35,7 +43,7 @@ sections:
3543
| `.spectrum-Button--sizeL` | `.spectrum-Icon--sizeL` |
3644
| `.spectrum-Button--sizeXL` | `.spectrum-Icon--sizeXL` |
3745
38-
### Remove focus-ring class
46+
#### Remove focus-ring class
3947
We've migrated away from the focus-ring class in favor of the native `:focus-visible` pseudo-class due to changes in browser support.
4048
examples:
4149
- id: button-primary

components/button/metadata/button-secondary.yml

+15-7
Original file line numberDiff line numberDiff line change
@@ -8,23 +8,31 @@ sections:
88
This component can be modified via its `--mod-*` prefixed custom properties. A list of those prefixed custom properties can be found <a class="spectrum-Link" href="https://github.com/adobe/spectrum-css/tree/main/components/button/metadata/mods.md">here</a>.
99
- name: Migration Guide
1010
description: |
11-
### Fill or Outline class required
11+
### x/x/2024 - Version 13.0.0
12+
#### Spectrum 2 release
13+
Button now uses Spectrum 2 tokens and specifications. A few notable changes:
14+
- The mod custom property `--mod-line-height-100` has been renamed to `--mod-button-line-height`.
15+
- The mod custom property `--mod-sans-font-family-stack` has been renamed to `--mod-button-font-family`.
16+
- The mod custom property `--mod-animation-duration-100` has been renamed to `--mod-button-animation-duration`.
17+
18+
### Versions prior to 13.0.0
19+
#### Fill or Outline class required
1220
All buttons now require either the `.spectrum-Button--fill` or `.spectrum-Button--outline` class.
1321
14-
### Secondary replaced by Secondary with Outline
22+
#### Secondary replaced by Secondary with Outline
1523
Replace all `.spectrum-Button--secondary` with `.spectrum-Button--secondary .spectrum-Button--outline`.
1624
17-
### Secondary Quiet replaced by Secondary with Outline
25+
#### Secondary Quiet replaced by Secondary with Outline
1826
Replace all `.spectrum-Button--secondary .spectrum-Button--quiet` with `.spectrum-Button--secondary .spectrum-Button--outline`.
1927
20-
### Icon Only
28+
#### Icon Only
2129
Add the `.spectrum-Button--iconOnly` class to apply the correct styling when an icon is used without a label.
2230
Provide an `aria-label` on the button itself when using this variant for accessibility.
2331
24-
### T-shirt sizing
32+
#### T-shirt sizing
2533
Button now supports t-shirt sizing and requires that you specify the size of button by adding a `.spectrum-Button--size*` class.
2634
27-
### Change workflow icon size
35+
#### Change workflow icon size
2836
2937
Previously, all Buttons used `.spectrum-Icon--sizeS`. This has changed:
3038
@@ -35,7 +43,7 @@ sections:
3543
| `.spectrum-Button--sizeL` | `.spectrum-Icon--sizeL` |
3644
| `.spectrum-Button--sizeXL` | `.spectrum-Icon--sizeXL` |
3745
38-
### Remove focus-ring class
46+
#### Remove focus-ring class
3947
We've migrated away from the focus-ring class in favor of the native `:focus-visible` pseudo-class due to changes in browser support.
4048
examples:
4149
- id: button-secondary

components/button/metadata/button-staticcolor.yml

+15-7
Original file line numberDiff line numberDiff line change
@@ -8,23 +8,31 @@ sections:
88
This component can be modified via its `--mod-*` prefixed custom properties. A list of those prefixed custom properties can be found <a class="spectrum-Link" href="https://github.com/adobe/spectrum-css/tree/main/components/button/metadata/mods.md">here</a>.
99
- name: Migration Guide
1010
description: |
11-
### Fill or Outline class required
11+
### x/x/2024 - Version 13.0.0
12+
#### Spectrum 2 release
13+
Button now uses Spectrum 2 tokens and specifications. A few notable changes:
14+
- The mod custom property `--mod-line-height-100` has been renamed to `--mod-button-line-height`.
15+
- The mod custom property `--mod-sans-font-family-stack` has been renamed to `--mod-button-font-family`.
16+
- The mod custom property `--mod-animation-duration-100` has been renamed to `--mod-button-animation-duration`.
17+
18+
### Versions prior to 13.0.0
19+
#### Fill or Outline class required
1220
All buttons now require either the `.spectrum-Button--fill` or `.spectrum-Button--outline` class.
1321
14-
### Over background replaced by StaticWhite with Outline
22+
#### Over background replaced by StaticWhite with Outline
1523
Replace all `.spectrum-Button--overBackground` with `.spectrum-Button--staticWhite .spectrum-Button--outline`.
1624
17-
### Over background Quiet replaced by StaticWhite with Outline
25+
#### Over background Quiet replaced by StaticWhite with Outline
1826
Replace all `.spectrum-Button--overBackground .spectrum-Button--quiet` with `.spectrum-Button--staticWhite .spectrum-Button--outline`.
1927
20-
### Icon Only
28+
#### Icon Only
2129
Add the `.spectrum-Button--iconOnly` class to apply the correct styling when an icon is used without a label.
2230
Provide an `aria-label` on the button itself when using this variant for accessibility.
2331
24-
### T-shirt sizing
32+
#### T-shirt sizing
2533
Button now supports t-shirt sizing and requires that you specify the size of button by adding a `.spectrum-Button--size*` class.
2634
27-
### Change workflow icon size
35+
#### Change workflow icon size
2836
2937
Previously, all Buttons used `.spectrum-Icon--sizeS`. This has changed:
3038
@@ -35,7 +43,7 @@ sections:
3543
| `.spectrum-Button--sizeL` | `.spectrum-Icon--sizeL` |
3644
| `.spectrum-Button--sizeXL` | `.spectrum-Icon--sizeXL` |
3745
38-
### Remove focus-ring class
46+
#### Remove focus-ring class
3947
We've migrated away from the focus-ring class in favor of the native `:focus-visible` pseudo-class due to changes in browser support.
4048
examples:
4149
- id: button-staticcolor

components/button/metadata/mods.md

-3
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
11
| Modifiable custom properties |
22
| ------------------------------------------ |
3-
| `--mod-animation-duration-100` |
43
| `--mod-bold-font-weight` |
54
| `--mod-button-animation-duration` |
65
| `--mod-button-background-color-default` |
@@ -45,6 +44,4 @@
4544
| `--mod-button-top-to-icon` |
4645
| `--mod-button-top-to-text` |
4746
| `--mod-focus-indicator-gap` |
48-
| `--mod-line-height-100` |
49-
| `--mod-sans-font-family-stack` |
5047
| `--mod-static-black-focus-indicator-color` |

0 commit comments

Comments
 (0)