docs(useDark): note about default localStorage key #2236
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
This PR clarifies the default behavior of the isDark composable, which persists the current value to localStorage under the key `vueuse-color-scheme`, and fixes a few grammatical points in the remainder of the page for clarity.
sxzz
reviewed
Sep 21, 2022
packages/core/useDark/index.md
Outdated
| @@ -37,7 +37,7 @@ By default, it uses [Tailwind CSS favored dark mode](https://tailwindcss.com/doc | |||
| <html class="dark"> ... </html> | |||
| ``` | |||
|
|
|||
| While you can customize it and make it work for most of the CSS frameworks. | |||
| Stillm you can also customize it to make it work with most CSS frameworks. | |||
There was a problem hiding this comment.
Yes, sorry about that. It should read: "Still,"
sxzz
approved these changes
Sep 21, 2022
antfu
changed the title
antfu
changed the title
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.
Description
This PR clarifies the default behavior of the isDark composable, which persists the current value to localStorage under the key
vueuse-color-scheme, and fixes a few grammatical points in the remainder of the page for clarity.Additional context
While the docs say that this composable reads "the value from localStorage/sessionStorage (the key is configurable) to see if there is a user configured color scheme," it's not illustrated how this key can be configured. I'm not sure how that is done, so I just added information about the default behavior.
What is the purpose of this pull request?
Before submitting the PR, please make sure you do the following
fixes #123).