Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Clarify custom link color documentation for themes #24056

Merged
merged 2 commits into from Jul 29, 2020

Conversation

@kjellr
Copy link
Contributor

@kjellr kjellr commented Jul 20, 2020

Following up on #23590, this PR clarifies how themes can properly opt-in and support the experimental custom link color.

@nosolosw, does this look about right to you?

@github-actions
Copy link

@github-actions github-actions bot commented Jul 20, 2020

Size Change: -1.03 MB (89%) 🏆

Total Size: 1.16 MB

Filename Size Change
build/a11y/index.min.js 0 B -1.14 kB (0%)
build/annotations/index.min.js 0 B -3.67 kB (0%)
build/api-fetch/index.min.js 0 B -3.43 kB (0%)
build/autop/index.min.js 0 B -2.82 kB (0%)
build/blob/index.min.js 0 B -620 B (0%)
build/block-directory/index.min.js 0 B -7.63 kB (0%)
build/block-directory/style-rtl.css 953 B +9 B (0%)
build/block-directory/style.css 952 B +7 B (0%)
build/block-editor/index.min.js 0 B -125 kB (0%)
build/block-editor/style-rtl.css 10.8 kB +35 B (0%)
build/block-editor/style.css 10.8 kB +36 B (0%)
build/block-library/editor-rtl.css 7.58 kB +4 B (0%)
build/block-library/editor.css 7.58 kB +7 B (0%)
build/block-library/index.min.js 0 B -132 kB (0%)
build/block-library/style-rtl.css 7.76 kB -3 B (0%)
build/block-library/style.css 7.77 kB -4 B (0%)
build/block-serialization-default-parser/index.min.js 0 B -1.88 kB (0%)
build/block-serialization-spec-parser/index.min.js 0 B -3.1 kB (0%)
build/blocks/index.min.js 0 B -48.3 kB (0%)
build/components/index.min.js 0 B -200 kB (0%)
build/components/style-rtl.css 15.7 kB +62 B (0%)
build/components/style.css 15.7 kB +61 B (0%)
build/compose/index.min.js 0 B -9.67 kB (0%)
build/core-data/index.min.js 0 B -11.5 kB (0%)
build/data-controls/index.min.js 0 B -1.29 kB (0%)
build/data/index.min.js 0 B -8.45 kB (0%)
build/date/index.min.js 0 B -5.38 kB (0%)
build/deprecated/index.min.js 0 B -772 B (0%)
build/dom-ready/index.min.js 0 B -568 B (0%)
build/dom/index.min.js 0 B -3.23 kB (0%)
build/edit-navigation/index.min.js 0 B -10.8 kB (0%)
build/edit-post/index.min.js 0 B -304 kB (0%)
build/edit-site/index.min.js 0 B -16.8 kB (0%)
build/edit-widgets/index.min.js 0 B -9.35 kB (0%)
build/editor/index.min.js 0 B -45.3 kB (0%)
build/editor/style-rtl.css 3.8 kB +17 B (0%)
build/editor/style.css 3.79 kB +16 B (0%)
build/element/index.min.js 0 B -4.65 kB (0%)
build/escape-html/index.min.js 0 B -733 B (0%)
build/format-library/index.min.js 0 B -7.72 kB (0%)
build/hooks/index.min.js 0 B -2.13 kB (0%)
build/html-entities/index.min.js 0 B -621 B (0%)
build/i18n/index.min.js 0 B -3.56 kB (0%)
build/is-shallow-equal/index.min.js 0 B -711 B (0%)
build/keyboard-shortcuts/index.min.js 0 B -2.51 kB (0%)
build/keycodes/index.min.js 0 B -1.94 kB (0%)
build/list-reusable-blocks/index.min.js 0 B -3.12 kB (0%)
build/media-utils/index.min.js 0 B -5.32 kB (0%)
build/notices/index.min.js 0 B -1.79 kB (0%)
build/nux/index.min.js 0 B -3.4 kB (0%)
build/plugins/index.min.js 0 B -2.56 kB (0%)
build/primitives/index.min.js 0 B -1.4 kB (0%)
build/priority-queue/index.min.js 0 B -789 B (0%)
build/redux-routine/index.min.js 0 B -2.85 kB (0%)
build/rich-text/index.min.js 0 B -13.9 kB (0%)
build/server-side-render/index.min.js 0 B -2.71 kB (0%)
build/shortcode/index.min.js 0 B -1.7 kB (0%)
build/token-list/index.min.js 0 B -1.27 kB (0%)
build/url/index.min.js 0 B -4.06 kB (0%)
build/viewport/index.min.js 0 B -1.85 kB (0%)
build/warning/index.min.js 0 B -1.14 kB (0%)
build/wordcount/index.min.js 0 B -1.17 kB (0%)
ℹ️ View Unchanged
Filename Size Change
build/a11y/index.js 1.14 kB 0 B
build/annotations/index.js 3.67 kB 0 B
build/api-fetch/index.js 3.44 kB 0 B
build/autop/index.js 2.82 kB 0 B
build/blob/index.js 620 B 0 B
build/block-directory/index.js 7.93 kB 0 B
build/block-editor/index.js 125 kB 0 B
build/block-library/index.js 133 kB 0 B
build/block-library/theme-rtl.css 728 B 0 B
build/block-library/theme.css 729 B 0 B
build/block-serialization-default-parser/index.js 1.88 kB 0 B
build/block-serialization-spec-parser/index.js 3.1 kB 0 B
build/blocks/index.js 48.2 kB 0 B
build/components/index.js 200 kB 0 B
build/compose/index.js 9.68 kB 0 B
build/core-data/index.js 11.8 kB 0 B
build/data-controls/index.js 1.29 kB 0 B
build/data/index.js 8.45 kB 0 B
build/date/index.js 5.38 kB 0 B
build/deprecated/index.js 772 B 0 B
build/dom-ready/index.js 568 B 0 B
build/dom/index.js 3.23 kB 0 B
build/edit-navigation/index.js 10.9 kB 0 B
build/edit-navigation/style-rtl.css 1.08 kB 0 B
build/edit-navigation/style.css 1.08 kB 0 B
build/edit-post/index.js 304 kB 0 B
build/edit-post/style-rtl.css 5.61 kB 0 B
build/edit-post/style.css 5.61 kB 0 B
build/edit-site/index.js 17 kB 0 B
build/edit-site/style-rtl.css 3.06 kB 0 B
build/edit-site/style.css 3.06 kB 0 B
build/edit-widgets/index.js 9.38 kB 0 B
build/edit-widgets/style-rtl.css 2.45 kB 0 B
build/edit-widgets/style.css 2.45 kB 0 B
build/editor/editor-styles-rtl.css 537 B 0 B
build/editor/editor-styles.css 539 B 0 B
build/editor/index.js 45.3 kB 0 B
build/element/index.js 4.65 kB 0 B
build/escape-html/index.js 733 B 0 B
build/format-library/index.js 7.72 kB 0 B
build/format-library/style-rtl.css 547 B 0 B
build/format-library/style.css 548 B 0 B
build/hooks/index.js 2.13 kB 0 B
build/html-entities/index.js 621 B 0 B
build/i18n/index.js 3.56 kB 0 B
build/is-shallow-equal/index.js 711 B 0 B
build/keyboard-shortcuts/index.js 2.52 kB 0 B
build/keycodes/index.js 1.94 kB 0 B
build/list-reusable-blocks/index.js 3.11 kB 0 B
build/list-reusable-blocks/style-rtl.css 476 B 0 B
build/list-reusable-blocks/style.css 476 B 0 B
build/media-utils/index.js 5.33 kB 0 B
build/notices/index.js 1.79 kB 0 B
build/nux/index.js 3.4 kB 0 B
build/nux/style-rtl.css 671 B 0 B
build/nux/style.css 668 B 0 B
build/plugins/index.js 2.56 kB 0 B
build/primitives/index.js 1.41 kB 0 B
build/priority-queue/index.js 789 B 0 B
build/redux-routine/index.js 2.85 kB 0 B
build/rich-text/index.js 13.9 kB 0 B
build/server-side-render/index.js 2.71 kB 0 B
build/shortcode/index.js 1.7 kB 0 B
build/token-list/index.js 1.27 kB 0 B
build/url/index.js 4.06 kB 0 B
build/viewport/index.js 1.85 kB 0 B
build/warning/index.js 1.14 kB 0 B
build/wordcount/index.js 1.17 kB 0 B

compressed-size-action

Copy link
Member

@nosolosw nosolosw left a comment

This sounds right, thanks!

@metalandcoffee
Copy link

@metalandcoffee metalandcoffee commented Jul 28, 2020

@kjellr Hi there! I'm actually testing this feature right now and I'm finding the linked documentation a bit hard to follow. It might be a good idea to provide a experimental-theme.json example (with defined link colors) for good measure especially since there isn't really an example in the linked documentation.

The theme should also ensure that its link styles map to the --wp--style--color--link variable in both the editor and front-end stylesheets.

A more detailed explanation here would be helpful as well since I find this confusing. Is this a step you have to do if you do not have an experimental-theme.json file?

@nosolosw
Copy link
Member

@nosolosw nosolosw commented Jul 28, 2020

Would this update make this clearer?


If a theme opts in, it should define default link colors in experimental-theme.json (or in its theme styles if no experimental-theme.json is present). For example:

{ 
    "global": {
        "styles": {
            "color": {
                "link": "hotpink"
            }
        }
    }
}

If the theme styles the link color in its stylesheets (editor and front-end), it should ensure it maps to the --wp--style--color--link CSS variable:

a {
    color: var(--wp--style--color--link);
}
@metalandcoffee
Copy link

@metalandcoffee metalandcoffee commented Jul 28, 2020

@nosolosw That's perfect! Thank you for that!

@kjellr
Copy link
Contributor Author

@kjellr kjellr commented Jul 29, 2020

Excellent suggestion, thanks @metalandcoffee and @nosolosw! I've added that in f988afc and will merge in as soon as the tests pass.

@kjellr kjellr merged commit fe5b553 into master Jul 29, 2020
4 checks passed
4 checks passed
Cancel Previous Runs
Details
Check Check
Details
pull-request-automation
Details
All
Details
@kjellr kjellr deleted the update/link-color-documentation-details branch Jul 29, 2020
@github-actions github-actions bot added this to the Gutenberg 8.7 milestone Jul 29, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Linked issues

Successfully merging this pull request may close these issues.

None yet

3 participants
You can’t perform that action at this time.