ThemeProvider: add instructions to replace Fabric, Customizer, loadTheme in README #15194
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
|
This pull request is automatically built and testable in CodeSandbox. To see build info of the built libraries, click here or the icon next to each commit SHA. Latest deployment of this branch, based on commit ee36178:
|
Perf AnalysisNo significant results to display. All results
Perf Analysis (Fluent)Perf comparison
Perf tests with no regressions
|
Asset size changesSize Auditor did not detect a change in bundle size for any component! Baseline commit: 9c8c7aebfb1f94da29e886b5886d647407ea3aef (build) |
dzearing
reviewed
Sep 24, 2020
dzearing
reviewed
Sep 24, 2020
xugao
force-pushed
the
xgao/update-theme-provider-readme
branch
from
1e2e9bf
to
c0a8753
Compare
dzearing
approved these changes
Sep 24, 2020
Comment on lines
202
to
214
| ### loadTheme | ||
|
|
||
| `loadTheme` remains to work as is. However, you are recommended to replace `loadTheme` with `ThemeProvider`. That way, your application consistently has one way of providing theme. | ||
|
|
||
| To do that, instead of calling `loadTheme(your_theme)`, you will simply wrap the root component of your React application once with `ThemeProvider`: | ||
|
|
||
| ``` | ||
| <ThemeProvider theme={your_theme}> | ||
| <App /> | ||
| </ThemeProvider> | ||
| ``` | ||
|
|
||
| One caveat here is that if you app has styles which relies on `@microsoft/load-themed-styles`, `ThemeProvider` won't be able to replace `loadTheme` in this case. |
There was a problem hiding this comment.
loadTheme does not exist in this package; this guidance probably should just live in release-notes, possibly the styling readme where it currently lives.
There was a problem hiding this comment.
agree this doesn't seem to be the most ideal place. These are mainly purposed as our release notes.
I am going to do more wiki/doc cleanup next week (tracked in #14740). I am going to start here and re-evaluate as I go.
xugao
force-pushed
the
xgao/update-theme-provider-readme
branch
from
c0a8753
to
ee36178
Compare
|
🎉 Handy links: |
|
🎉 Handy links: |
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.
Pull request checklist
$ yarn changeDescription of changes
Add instructions for how to replace
Fabric,Customizer, andloadThemewithThemeProvider.Related issue: #14740
Focus areas to test
(optional)