Repository navigation
refactor(useBooleanState, useStorageState, useCounter): return the value with an actions object - #532
Merged
Merged
Conversation
🦋 Changeset detectedLatest commit: a403c7e The changes in this PR will be included in the next version bump. This PR includes changesets to release 1 package
Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
Contributor
|
Size Change: +266 B (+0.23%) Total Size: 115 kB 📦 View Changed
ℹ️ View Unchanged
|
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## v1-base #532 +/- ##
=========================================
Coverage 100.00% 100.00%
=========================================
Files 69 69
Lines 2280 2281 +1
Branches 735 738 +3
=========================================
+ Hits 2280 2281 +1 🚀 New features to boost your workflow:
|
This was referenced Sep 28, 2026
Member
// before
const [value, setTrue, setFalse, toggle] = useBooleanState(false);
const [value, setValue, refresh] = useStorageState<string>('token');
const [list, { push, insertAt, updateAt, removeAt, setAll, reset }] = useList<string>(['a', 'b']);
const [map, { set, setAll, remove, reset }] = useMap<string, number>([['a', 1]]);
const [set, { add, remove, toggle, setAll, reset }] = useSet<string>(['a']);
// after (this pr now)
const { value, setTrue, setFalse, toggle } = useBooleanState(false);
const { value, setValue, refresh } = useStorageState<string>('token');
const { list, push, insertAt, updateAt, removeAt, setAll, reset } = useList<string>(['a', 'b']);
const { map, set, setAll, remove, reset } = useMap<string, number>([['a', 1]]);
const { set, add, remove, toggle, setAll, reset } = useSet<string>(['a']);
// or this ???
const [isOpen, { setTrue, setFalse, toggle }] = useBooleanState(false);
const [token, { setValue, refresh }] = useStorageState<string>('token');
const [list, { push, insertAt, updateAt, removeAt, setAll, reset }] = useList<string>(['a', 'b']); // same as before
const [map, { set, setAll, remove, reset }] = useMap<string, number>([['a', 1]]); // same as before
const [set, { add, remove, toggle, setAll, reset }] = useSet<string>(['a']); // same as before |
3 of 4 tasks
…lue with an actions object
mnxmnz
force-pushed
the
refactor/state-hook-returns
branch
from
October 6, 2026 14:40
17f6d47 to
1425afb
Compare
mnxmnz
changed the title
…ing "hook" and translate the zh-Hans example comment
… tree-shaking size gate
Member
Author
|
@hyesungoh Went with const [isOpen, { setTrue, setFalse, toggle }] = useBooleanState(false);
const [token, { setValue, refresh }] = useStorageState<string>('token');
const [count, { increment, decrement, reset, setCount }] = useCounter(0);
|
mnxmnz
marked this pull request as ready for review
October 6, 2026 15:02
hyesungoh
approved these changes
Oct 7, 2026
hyesungoh
left a comment
hyesungoh
left a comment
Member
There was a problem hiding this comment.
useCounter looks good to me! 👍
Not sure about deprecating useToggle though 🤔 Let's leave it as is for now and talk about it later.
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
Overview
useBooleanState,useStorageStateanduseCounternow return[value, actions], the same shapeuseList,useMapanduseSetalready use. Closes #528.This replaces the first draft, which returned a flat object. With a tuple, callers name the value per call site, and two
useBooleanStatecalls in one component no longer collide onsetTrue/toggle. Most libraries that ship a multi-action boolean hook use the same shape: ahooksuseBoolean, mantineuseDisclosure, chakra v2useBoolean.useTogglekeeps[value, toggle]and now declares its return type, so React 18 consumers no longer see the React 19ActionDispatchtype. Deprecating it in favor ofuseBooleanStatewill follow once the deprecated-export tooling lands.[value, action], two or more →[value, { actions }].yarn test,yarn test:coverage,yarn test:compiled,yarn test:docsandyarn test:skillpass.Checklist
yarn run fixto format and lint the code and docs?yarn run test:coverageto make sure there is no uncovered line?