feat(useColorMode): expose state
to the ref, deprecated emitAuto
#2980
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.
Before submitting the PR, please make sure you do the following
fixes #123
).Description
Applied some improvements was done in #2023
initialValue
to be passed asref
emitAuto
, in favor ofstore.value
whenauto
mode needs to be knownstate
, so dev won't need to writecomputed(() => store.value === 'auto' ? system.value : store.value)
when extracting thestore
valuestore
,system
,state
useDark
to usesystem.value
instead of importingusePreferredDark
Additional context
🤖 Generated by Copilot at f8e66e3
This pull request enhances the
useColorMode
function and its test case to provide better type safety, customization, and readability. It also removes some redundant code and improves the naming consistency.🤖 Generated by Copilot at f8e66e3
BasicColorMode
type and constrain generic type parameterT
to extend it (link, link, link, link)initialValue
option to acceptMaybeRef
type and use it directly forstore
variable (link, link, link)state
property to return value and use computed ref to return eitherstore.value
orstate.value
depending onemitAuto
option (link, link)defaultOnChanged
function and removewatch
function forsystem
value (link, link)value
property and link to documentation (link)packages/core/useColorMode/index.test.ts
, link)