Skip to content

Commit

Permalink
Clearer changelog entry on migrating gap classnames
Browse files Browse the repository at this point in the history
  • Loading branch information
planktonic committed Jul 1, 2024
1 parent 6e4042a commit f3879b5
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -126,7 +126,7 @@
- Changes to color names in the default configuration’s global palette mean the classnames in the default configuration of the `fg` and `bg` utility classes has also changed, since they match naming scheme e.g. `.u-fg-gray-30` has become `u-fg-text-light`. If you are overriding the global color palette, you’ll also need to override the `fg` and `bg` configurations to use your own colors. If you’re using the default configuration, you’ll need to update your classnames to use the new naming scheme.
- Sizes scale naming has been updated to use to following convention `s`, `xs`, `2xs`, `3xs`, and `l`, `xl`, `2xl`, `3xl`. Any utility classnames in your codebase containing the sizes (e.g. `u-margin-xxs-bottom`, `u-padding-xxxl`) will need to be updated to use the new naming scheme (e.g. `u-margin-2xs-bottom`, `u-padding-3xl`). Any uses of `size.get()` in your codebase will need to be updated to use the new naming scheme.
- Badge component color variant `gray` has been renamed to `text`, changing the classname from `.a-badge--gray` to `.a-badge--text`
- The default configuration for the gap utilities changed. The result is that classnames were renamed to match the size from the sizing scale they output as a gap. Previously the gap sizes were named on a scale internal to the gap module, not necessarily matching the global sizing scale e.g. a “large” gap (`.u-gap-l`) was using size `xl` on the global scale. This change renames the class from `.u-gap-l` to `.u-gap-xl`, since its value is `size-xl`. You can either rename your classnames in HTML templates to match the new classnames, or override the new configuration to set the old names. If you were already overriding the module’s configuration, you don’t need to change anything.
- The default configuration for the gap utilities changed. The result is that classnames were renamed to match the size from the sizing scale they output as a gap. Previously the gap sizes were named on a scale internal to the gap module, not necessarily matching the global sizing scale e.g. a “large” gap (`.u-gap-l`) was using size `xl` on the global scale. This change renames the class from `.u-gap-l` to `.u-gap-xl`, since its value is `size-xl`. You can either rename your classnames in HTML templates to match the new classnames (rename `u-gap-l` to `u-gap-xl`, and `u-gap-m` to `u-gap-l`), or override the new configuration to set the old names. If you were already overriding the module’s configuration, you don’t need to change anything.

### Fixed

Expand Down

0 comments on commit f3879b5

Please sign in to comment.