[useEuiTheme] Update colorMode
return types
#5639
Merged
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.
Summary
The accepted input and expected output values are (intentionally) different for
colorMode
values.inverse
is an acceptable input value, but the output value accessible viauseEuiTheme
is the processed version oflight
ordark
for consumer understanding.The two types were incorrectly conflated and overly permissive. Now the consumer values will always be either
light
ordark
, which will simplify creating component styles that take advantage of color mode switching.Also note the change in
EuiThemeColorMode
that removesstring
as an option, instead adding the convenience lowercase versions ofLIGHT
,DARK
, andINVERSE
. We had left the door open for custom color modes, which flat out will not work with the light/dark concept foundational to EUI components. This is kind of a breaking change, but is more of bugfix in that attempting to use something like<EuiThemeProvider colorMode="custom" />
would break global styles.All of this becomes more clear if reviewed alongside upcoming changes in #4575.
Checklist