Improve consistency of variable map keys #4116
Conversation
|
Demo starting at https://vanilla-framework-4116.demos.haus |
templates/docs/upgrade-guide-v3.md
Outdated
|
|
||
| The variable `$max-width--default` has been renamed to `$text-max-width`. All other heading max-width variables have been replaced by $text-max-width. | ||
|
|
||
| The keys in map `$nudges` no longer include the `$nudge--` prefix. |
There was a problem hiding this comment.
The keys don't have $ prefix:
| The keys in map `$nudges` no longer include the `$nudge--` prefix. | |
| The keys in map `$nudges` no longer include the `nudge--` prefix. |
I know this would look quite repetitive, but could be useful to be more clear and explicit. Would be nice to have a table of all the renames:
| before | after |
|---|---|
map-get($nudges, nudge--p) |
map-get($nudges, p) |
map-get($nudges, nudge--h1) |
map-get($nudges, h1) |
| etc... |
with list of all renamed keys, to make it clear what gets replaced with what, and to make searching easier.
There was a problem hiding this comment.
I've pushed the fixes.
|
good points, thanks @bartaz. |
Co-authored-by: Bartek Szopka <83575+bartaz@users.noreply.github.com>
bartaz
changed the title
templates/docs/upgrade-guide-v3.md
Outdated
| @@ -38,7 +38,12 @@ Use of `.col` classes outside of `.row` is no longer supported. If you use `.col | |||
|
|
|||
| ### Column layout change | |||
|
|
|||
| <<<<<<< HEAD | |||
There was a problem hiding this comment.
These conflict marks should be removed (not sure why I can't suggest it on GH).
templates/docs/upgrade-guide-v3.md
Outdated
| Previously, the grid layout would switch from 6 to 12 columns wide at the medium breakpoint. With the removal of the medium breakpoint, this has been changed so that the switch happens at the large breakpoint instead. We recommend visually checking your layouts at each breakpoint for any adverse effects this change may cause. | ||
| ======= | ||
| Max-widths should not be based on font-size. Any legacy classes, placeholders, or mixins that used a font-size based max-width setting will be removed. Use `$text-max-width` instead. |
There was a problem hiding this comment.
This whole block from conflict should be removed. Max-widths are separately explained below, so this text and surrounding conflict marks can be removed.
Co-authored-by: Bartek Szopka <83575+bartaz@users.noreply.github.com>
Done
Minimal renaming of variables and maps to make using them a little more intuitive.
QA
Check if PR is ready for release
If this PR contains Vanilla SCSS code changes, it should contain the following changes to make sure it's ready for the release:
Feature 馃巵,Breaking Change 馃挘,Bug 馃悰,Documentation 馃摑,Maintenance 馃敤.package.jsonshould be updated relative to the most recent release, following semver convention:Screenshots
[if relevant, include a screenshot or screen capture]