Skip to content

feat: defers useControllableState state to initializer method #27717

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
bsunderhus merged 2 commits into from
May 11, 2023
Merged

feat: defers useControllableState state to initializer method #27717

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
3022be8
chore: defers useControllableState state to initializer method
bsunderhus May 10, 2023
ef642a9
Update packages/react-components/react-utilities/src/hooks/useControl…
bsunderhus May 10, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions change/@fluentui-react-utilities-3e7e29b4-ccde-4269-ac7f-8adf2333171e.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
{
"type": "patch",
"comment": "feat: defers useControllableState state to initializer method",
"packageName": "@fluentui/react-utilities",
"email": "[email protected]",
"dependentChangeType": "patch"
}
14 changes: 11 additions & 3 deletions packages/react-components/react-utilities/src/hooks/useControllableState.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,11 +39,19 @@ export type UseControllableStateOptions<State> = {
export const useControllableState = <State>(
options: UseControllableStateOptions<State>,
): [State, React.Dispatch<React.SetStateAction<State>>] => {
const initialState = typeof options.defaultState === 'undefined' ? options.initialState : options.defaultState;
const [internalState, setInternalState] = React.useState<State>(initialState);
const [internalState, setInternalState] = React.useState<State>(() => {
if (options.defaultState === undefined) {
return options.initialState;
}
return isInitializer(options.defaultState) ? options.defaultState() : options.defaultState;
});
return useIsControlled(options.state) ? [options.state, noop] : [internalState, setInternalState];
};

function isInitializer<State>(value: State | (() => State)): value is () => State {
return typeof value === 'function';
}

function noop() {
/* noop */
}
Expand All @@ -53,7 +61,7 @@ function noop() {
* Prints an error when isControlled value switches between subsequent renders
* @returns - whether the value is controlled
*/
const useIsControlled = <V>(controlledValue?: V): controlledValue is V => {
const useIsControlled = <V>(controlledValue: V | undefined): controlledValue is V => {
const [isControlled] = React.useState<boolean>(() => controlledValue !== undefined);

if (process.env.NODE_ENV !== 'production') {
Expand Down