[docs] Add a guide for setting dark mode by default #34839
Merged
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
siriwatknp
added
docs
|
danilo-leal
reviewed
Oct 21, 2022
Co-authored-by: danilo leal <67129314+danilo-leal@users.noreply.github.com> Signed-off-by: Siriwat K <siriwatkunaporn@gmail.com>
There was a problem hiding this comment.
👍
Thoughts:
- A demo could help a lot to be able to build reproductions that are dark mode only. It could also serve as a visual regression test case.
- I wonder if setting the default is more important than the rest of the page, so maybe it should be closer to the top.
- The dark mode docs page is under "How to guide" but all the pages that aren't API references are also how to guides in our docs, only that they are groups in "logical" sections. So per this rational, I think that it could be better to have the docs about the dark mode under the Customization section. Meaning, we could use "How to guide" for pages we don't know where else to put.
Agree on all points, let me update them altogether. |
Comment on lines
13
to
15
| useEnhancedEffect(() => { | ||
| setNode(document.getElementById('dark-mode-by-default')); | ||
| }, []); |
There was a problem hiding this comment.
Off topic
This could suggest that nesting dark with a light theme in Joy UI might be a bit of a struggle (it's not a single rendering step).
github-actions
bot
added
the
PR: out-of-date
…/joy-default-dark
…/joy-default-dark
github-actions
bot
removed
the
PR: out-of-date
|
@oliviertassinari it is ready for a second review.
|
danilo-leal
approved these changes
Nov 2, 2022
There was a problem hiding this comment.
This is looking great, thanks for putting it up, Jun! Sam will definitely do a thorough copy review but I already took the opportunity to do some content rearranging + writing tweaks. I wonder how to make it better when similar and close sections have exact same content, though.
mnajdova
reviewed
Nov 3, 2022
…l-ui into docs/joy-default-dark
|
@samuelsycamore @danilo-leal Wow 😲, it looks much much better. The content flow is so smooth. |
daniel-rabe
pushed a commit
to daniel-rabe/material-ui
that referenced
this pull request
Nov 29, 2022
feliperli
pushed a commit
to jesrodri/material-ui
that referenced
this pull request
Dec 6, 2022
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.
Preview: https://deploy-preview-34839--material-ui.netlify.app/joy-ui/customization/dark-mode/
From the docs feedback.