docs: add note for colorMode.dataValue option
#198
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
✅ Live Preview ready!
|
✅ Deploy Preview for nuxt-color-mode canceled.
|
antfu
reviewed
Jul 4, 2023
docs/content/1.index.md
Outdated
| @@ -149,6 +149,7 @@ export default defineNuxtConfig({ | |||
|
|
|||
| Notes: | |||
| - `'system'` is a special value; it will automatically detect the color mode based on the system preferences (see [prefers-color-mode spec](https://drafts.csswg.org/mediaqueries-5/#descdef-media-prefers-color-mode)). The value injected will be either `'light'` or `'dark'`. If `no-preference` is detected or the browser does not handle color-mode, it will set the `fallback` value. | |||
| - Optional `colorMode.dataValue` lets you add dataset to the `html`, for example if you currently have `class="dark"` on `html`, `dataValue: 'theme'` will also set `data-theme="dark"` on `html`. This is useful when using library like daisyUI that uses `data-theme="light"` on `html` to apply theme. | |||
There was a problem hiding this comment.
I don't think it is worth to be as a "note" as I see it's a regular option. We could list it in the example above with a short description.
There was a problem hiding this comment.
That would be great. I didn't know where to put it so I added it close to the other options.
atinux
reviewed
Aug 8, 2023
atinux
approved these changes
Aug 8, 2023
# for free
to join this conversation on GitHub.
Already have an account?
# 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.
I found this option is quite useful but it is currently missing in the document.