@wordpress/components
Version:
UI components for WordPress.
53 lines (52 loc) • 1.86 kB
JavaScript
import { useCallback, useEffect, useState } from "@wordpress/element";
import { getDefinedValue, isValueDefined } from "../values.mjs";
// packages/components/src/utils/hooks/use-controlled-state.ts
const defaultOptions = {
initial: void 0,
/**
* Defaults to empty string, as that is preferred for usage with
* <input />, <textarea />, and <select /> form elements.
*/
fallback: ""
};
/**
* Custom hooks for "controlled" components to track and consolidate internal
* state and incoming values. This is useful for components that render
* `input`, `textarea`, or `select` HTML elements.
*
* https://reactjs.org/docs/forms.html#controlled-components
*
* At first, a component using useControlledState receives an initial prop
* value, which is used as initial internal state.
*
* This internal state can be maintained and updated without
* relying on new incoming prop values.
*
* Unlike the basic useState hook, useControlledState's state can
* be updated if a new incoming prop value is changed.
*
* @param currentState The current value.
* @param [options=defaultOptions] Additional options for the hook.
*
* @return The controlled value and the value setter.
*/
function useControlledState(currentState, options = defaultOptions) {
const { initial, fallback } = {
...defaultOptions,
...options
};
const [internalState, setInternalState] = useState(currentState);
const hasCurrentState = isValueDefined(currentState);
useEffect(() => {
if (hasCurrentState && internalState) setInternalState(void 0);
}, [hasCurrentState, internalState]);
return [getDefinedValue([
currentState,
internalState,
initial
], fallback), useCallback((nextState) => {
if (!hasCurrentState) setInternalState(nextState);
}, [hasCurrentState])];
}
export { useControlledState as default };
//# sourceMappingURL=use-controlled-state.mjs.map