Skip to content

chore(react-utilities): simplifies useControllableState hook internals #27702

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 1 commit into from
Apr 26, 2023
Merged

chore(react-utilities): simplifies useControllableState hook internals #27702

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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-fa9ce15a-c1d5-4b9a-93e7-e07b2d60b837.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
{
"type": "patch",
"comment": "chore: simplifies useControllableState hook internals",
"packageName": "@fluentui/react-utilities",
"email": "[email protected]",
"dependentChangeType": "patch"
}
35 changes: 6 additions & 29 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 @@ -19,10 +19,6 @@ export type UseControllableStateOptions<State> = {
initialState: State;
};

function isFactoryDispatch<State>(newState: React.SetStateAction<State>): newState is (prevState: State) => State {
return typeof newState === 'function';
}

/**
* @internal
*
Expand All @@ -42,40 +38,21 @@ function isFactoryDispatch<State>(newState: React.SetStateAction<State>): newSta
export const useControllableState = <State>(
options: UseControllableStateOptions<State>,
): [State, React.Dispatch<React.SetStateAction<State>>] => {
const isControlled = useIsControlled(options.state);
const initialState = typeof options.defaultState === 'undefined' ? options.initialState : options.defaultState;
const [internalState, setInternalState] = React.useState<State>(initialState);
Comment on lines 41 to 42
Copy link
Member

@layershifter layershifter Apr 27, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

One more improvement might to move the check to factory, so it will be executed once:

const [internalState, setInternalState] = React.useState<State>(
  () => typeof options.defaultState === 'undefined' ? options.initialState : options.defaultState
);


const state = isControlled ? (options.state as State) : internalState;

const stateRef = React.useRef(state);
React.useEffect(() => {
stateRef.current = state;
}, [state]);

// To match the behavior of the setter returned by React.useState, this callback's identity
// should never change. This means it MUST NOT directly reference variables that can change.
const setState = React.useCallback((newState: React.SetStateAction<State>) => {
// React dispatch can use a factory
// https://reactjs.org/docs/hooks-reference.html#functional-updates
if (isFactoryDispatch(newState)) {
stateRef.current = newState(stateRef.current);
} else {
stateRef.current = newState;
}

setInternalState(stateRef.current);
}, []);

return [state, setState];
return useIsControlled(options.state) ? [options.state, noop] : [internalState, setInternalState];
};

function noop() {
/* noop */
}

/**
* Helper hook to handle previous comparison of controlled/uncontrolled
* Prints an error when isControlled value switches between subsequent renders
* @returns - whether the value is controlled
*/
const useIsControlled = (controlledValue: unknown) => {
const useIsControlled = <V>(controlledValue?: V): controlledValue is V => {
Copy link
Member

@layershifter layershifter Apr 27, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nit: value should be always passed

const useIsControlled = <V>(controlledValue: V | undefined): controlledValue is V => {

const [isControlled] = React.useState<boolean>(() => controlledValue !== undefined);

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