Skip to content

theme.json: add appearanceTools flag to opt-in into appearance UI controls#36646

Merged
oandregal merged 10 commits intotrunkfrom
add/appearance-tools-flag
Nov 23, 2021
Merged

theme.json: add appearanceTools flag to opt-in into appearance UI controls#36646
oandregal merged 10 commits intotrunkfrom
add/appearance-tools-flag

Conversation

@oandregal
Copy link
Copy Markdown
Member

@oandregal oandregal commented Nov 19, 2021 •
edited
Loading

Fixes #36187
Follow-up to #36246 and #36477

This PR adds a new setting property in theme.json called appearanceTools whose function is to opt-in into all appearance UI controls.

The result is that a theme.json like this one:

{
  'version': 2,
  'settings': {
    'appearanceTools': true
  }
}

is the same as this other:

{
  'version': 2,
  'settings': {
    'border': {
      'color': true,
      'radius': true,
      'style': true,
      'width': true
    },
   'color': {
     'link': true
   },
    'spacing': {
      'blockGap': true,
      'margin': true,
      'padding': true
    },
    'typography': {
      'lineHeight': true
    } 
  }
}

Themes that don't use this flag need to individually enable the opt-in features, which is the same behavior as of now in trunk.

Notes

Name

After some discussion in the first PR #36246 and consulting other people, we're going with appearanceTools for the name, which leaves appearance free for the future and clarifies the purpose of the flag.

Cascade behavior

Themes can still set anything to false and will be respected. So, this theme.json:

{
  'version': 2,
  'settings': {
    'appearanceTools': true,
    'typography': {
      'lineHeight': false
    }
  }
}

is the same as:

{
  'version': 2,
  'settings': {
    'border': {
      'color': true,
      'radius': true,
      'style': true,
      'width': true
    },
    'color': {
      'link': true
    },
    'spacing': {
      'blockGap': true,
      'margin': true,
      'padding': true
    },
    'typography': {
      'lineHeight': false
    } 
  }
}

@oandregal oandregal changed the title theme.json: add appearanceTools flag to opt-in into appareance settings theme.json: add appearanceTools flag to opt-in into appareance UI controls Nov 19, 2021
This was referenced Nov 19, 2021
Merged
Merged
Closed
@oandregal oandregal self-assigned this Nov 19, 2021
@oandregal oandregal added [Feature] Themes Questions or issues with incorporating or styling blocks in a theme. Global Styles Anything related to the broader Global Styles efforts, including Styles Engine and theme.json Backport to WP Beta/RC labels Nov 19, 2021
@oandregal oandregal requested a review from ajlende as a code owner November 19, 2021 12:10
@oandregal oandregal changed the title theme.json: add appearanceTools flag to opt-in into appareance UI controls theme.json: add appearanceTools flag to opt-in into appearance UI controls Nov 19, 2021
@overclokk
Copy link
Copy Markdown

overclokk commented Nov 19, 2021

What happen with a child theme?

@mikachan mikachan mentioned this pull request Nov 22, 2021
Merged
@oandregal
Copy link
Copy Markdown
Member Author

oandregal commented Nov 23, 2021

What happen with a child theme?

Same as before: the child overrides the parent. Did you run into any issue?

youknowriad
youknowriad approved these changes Nov 23, 2021
View reviewed changes
Copy link
Copy Markdown
Contributor

@youknowriad youknowriad left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This looks good to me personally.

Let's not forget to backport the theme.json unit tests updates that happened since WP 5.8 into WordPress trunk

@oandregal oandregal merged commit 1e78e92 into trunk Nov 23, 2021
@oandregal oandregal deleted the add/appearance-tools-flag branch November 23, 2021 10:01
@github-actions github-actions bot added this to the Gutenberg 12.1 milestone Nov 23, 2021
@oandregal
Copy link
Copy Markdown
Member Author

oandregal commented Nov 23, 2021

Let's not forget to backport the theme.json unit tests updates that happened since WP 5.8 into WordPress trunk

@youknowriad what do you mean by this?

@youknowriad
Copy link
Copy Markdown
Contributor

youknowriad commented Nov 23, 2021

I mean that during the 5.9 lifecycle we did some changes to theme.json php unit tests like in this PR and we might not have back ported everything to Core.

Since at some point we will remove this code from Gutenberg (theme.json classes and tests), we should make sure to backport all the tests to avoid losing coverage.

@kjellr kjellr mentioned this pull request Nov 23, 2021
Closed
@oandregal
Copy link
Copy Markdown
Member Author

oandregal commented Nov 23, 2021

FWIW, all of them should be already in core, that was part of the initial backporting (except for the PRs that still need to backported, such as this one).

@overclokk
Copy link
Copy Markdown

overclokk commented Nov 24, 2021

@oandregal not tryed yet on child theme.
I want to test in case a parent and child have different version of the schema.

@oandregal
Copy link
Copy Markdown
Member Author

oandregal commented Nov 24, 2021

Everything should work as expected, but wider and extensive testing is always appreciated :)

noisysocks pushed a commit that referenced this pull request Nov 29, 2021
@oandregal @noisysocks
theme.json: add appearanceTools flag to opt-in into appearance UI c…
ba30000 
…ontrols (#36646)
@noisysocks noisysocks mentioned this pull request Nov 29, 2021
Closed
@oandregal oandregal mentioned this pull request Nov 29, 2021
Closed
This was referenced Dec 9, 2021
Merged
Closed
@aaronrobertshaw aaronrobertshaw mentioned this pull request Dec 15, 2021
Merged
7 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@youknowriad youknowriad youknowriad approved these changes

@ajitbohra ajitbohra Awaiting requested review from ajitbohra ajitbohra is a code owner

@mkaz mkaz Awaiting requested review from mkaz

@spacedmonkey spacedmonkey Awaiting requested review from spacedmonkey spacedmonkey is a code owner

@scruffian scruffian Awaiting requested review from scruffian

@richtabor richtabor Awaiting requested review from richtabor

@kjellr kjellr Awaiting requested review from kjellr

@jffng jffng Awaiting requested review from jffng

@MaggieCabrera MaggieCabrera Awaiting requested review from MaggieCabrera

@aaronrobertshaw aaronrobertshaw Awaiting requested review from aaronrobertshaw

@carolinan carolinan Awaiting requested review from carolinan

@colorful-tones colorful-tones Awaiting requested review from colorful-tones

@fabiankaegy fabiankaegy Awaiting requested review from fabiankaegy fabiankaegy is a code owner

@ajlende ajlende Awaiting requested review from ajlende

Assignees

@oandregal oandregal

Labels

[Feature] Themes Questions or issues with incorporating or styling blocks in a theme. Global Styles Anything related to the broader Global Styles efforts, including Styles Engine and theme.json

Projects

None yet

Milestone

Gutenberg 12.1

Development

Successfully merging this pull request may close these issues.

Consider changing some theme.json settings to opt-out

4 participants

@oandregal @overclokk @youknowriad @noisysocks