58 lines
1.8 KiB
JavaScript
58 lines
1.8 KiB
JavaScript
|
'use client';
|
||
|
|
|
||
|
|
import * as React from 'react';
|
||
|
|
import { ListContext } from '../useList';
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Stabilizes the ListContext value for the Option component, so it doesn't change when sibling Options update.
|
||
|
|
*
|
||
|
|
* @param value The value of the Option.
|
||
|
|
* @returns The stable ListContext value.
|
||
|
|
*
|
||
|
|
* Demos:
|
||
|
|
*
|
||
|
|
* - [Select](https://mui.com/base-ui/react-select/#hooks)
|
||
|
|
*
|
||
|
|
* API:
|
||
|
|
*
|
||
|
|
* - [useOptionContextStabilizer API](https://mui.com/base-ui/react-select/hooks-api/#use-option-context-stabilizer)
|
||
|
|
*/
|
||
|
|
export function useOptionContextStabilizer(value) {
|
||
|
|
const listContext = React.useContext(ListContext);
|
||
|
|
if (!listContext) {
|
||
|
|
throw new Error('Option: ListContext was not found.');
|
||
|
|
}
|
||
|
|
const {
|
||
|
|
getItemState,
|
||
|
|
dispatch
|
||
|
|
} = listContext;
|
||
|
|
const {
|
||
|
|
highlighted,
|
||
|
|
selected,
|
||
|
|
focusable
|
||
|
|
} = getItemState(value);
|
||
|
|
|
||
|
|
// The local version of getItemState can be only called with the current Option's value.
|
||
|
|
// It doesn't make much sense to render an Option depending on other Options' state anyway.
|
||
|
|
const localGetItemState = React.useCallback(itemValue => {
|
||
|
|
if (itemValue !== value) {
|
||
|
|
throw new Error(['Base UI Option: Tried to access the state of another Option.', 'This is unsupported when the Option uses the OptionContextStabilizer as a performance optimization.'].join('/n'));
|
||
|
|
}
|
||
|
|
return {
|
||
|
|
highlighted,
|
||
|
|
selected,
|
||
|
|
focusable
|
||
|
|
};
|
||
|
|
}, [highlighted, selected, focusable, value]);
|
||
|
|
|
||
|
|
// Create a local (per Option) instance of the ListContext that changes only when
|
||
|
|
// the getItemState's return value changes.
|
||
|
|
// This makes Options re-render only when their state actually change, not when any Option's state changes.
|
||
|
|
const localContextValue = React.useMemo(() => ({
|
||
|
|
dispatch,
|
||
|
|
getItemState: localGetItemState
|
||
|
|
}), [dispatch, localGetItemState]);
|
||
|
|
return {
|
||
|
|
contextValue: localContextValue
|
||
|
|
};
|
||
|
|
}
|