Global Styles: Expose the provider and the reset hook #42824
Closed
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
scruffian
added
the
Global Styles
|
Size Change: +34 B (0%) Total Size: 1.25 MB
ℹ️ View Unchanged
|
scruffian
commented
Aug 9, 2022
scruffian
force-pushed
the
expose/global-styles
branch
2 times, most recently
from
7783dac
to
ff24d88
Compare
jffng
reviewed
Aug 11, 2022
There was a problem hiding this comment.
Should it be documented here if it's being exposed as a public API?
I find this quite useful for the purposes of letting plugin developers interact with global styles, as demonstrated by WordPress/create-block-theme#96 !
Good idea, done! |
jffng
reviewed
Aug 12, 2022
|
|
||
| The `MyUIControls` component will now have access to the Global Styles store. | ||
|
|
||
| ## useGlobalStylesReset |
There was a problem hiding this comment.
I think this hook is already documented above? :)
|
Oops you're right, it's gone! |
|
Would really love to see this land in 6.1 to enable tools like Create Block Theme to progress. Are there any reasons why this can't be brought in? |
Just need an approval from someone! |
ajlende
approved these changes
Aug 22, 2022
There was a problem hiding this comment.
I don't see any problem with exposing this publicly—it seems pretty stable to me.
I would still like to hear from @oandregal or @jorgefilipecosta—they've both seen the major refactoring this component has gone through and may have some thoughts on the stability.
|
👋 My first instinct is that exporting only the two functions that are used by I know Jorge & Riad discussed options for extracting GS to its own package. Jorge has a wider view of the extensibility systems in place than I have. I'd like to here what his thoughts are before merging this. |
There was a problem hiding this comment.
I think we are not ready to have a public global styles API yet. Right now, global styles are part of the edit site. As @oandregal referred, we may have a global styles package in the future, if we also include parts of global styles on edit-post.
I also imagine that if we are going to expose an API for global styles, we would not expose the provider and reset directly but instead expose a single hook that provides global styles value and a setter.
|
I imagine not having an API may be a blocker. I guess a possible intermediate step would be to expose a clearly experimental, internal, and unstable API so we can have some progress on WordPress/create-block-theme#96. |
scruffian
force-pushed
the
expose/global-styles
branch
from
04cf449
to
7a2cd10
Compare
|
Thanks for the feedback @jorgefilipecosta, I marked them as unstable... |
|
The exports should be named |
|
Closing this old PR. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What?
This exports the GlobalStylesProvider component and the useGlobalStylesReset hook, so that plugins can interact with Global Styles.
Why?
This will be used in the create block theme plugin: WordPress/create-block-theme#96
How?
Simple - export these functions from the edit-site package.
Testing Instructions
See WordPress/create-block-theme#96
Screenshots or screencast