UNPKG

@wordpress/components

Version:
58 lines (57 loc) • 2.29 kB
import deepmerge from "deepmerge"; import fastDeepEqual from "fast-deep-equal/es6/index.js"; import { isPlainObject } from "is-plain-object"; import { createContext, memo, useContext, useMemo, useRef } from "@wordpress/element"; import warn from "@wordpress/warning"; import { useUpdateEffect } from "../utils/index.mjs"; import { jsx } from "react/jsx-runtime"; // packages/components/src/context/context-system-provider.tsx const ComponentsContext = createContext({}); ComponentsContext.displayName = "ComponentsContext"; const useComponentsContext = () => useContext(ComponentsContext); /** * Consolidates incoming ContextSystem values with a (potential) parent ContextSystem value. * * Note: This function will warn if it detects an un-memoized `value` * * @param {Object} props * @param {Record<string, any>} props.value * @return {Record<string, any>} The consolidated value. */ function useContextSystemBridge({ value }) { const parentContext = useComponentsContext(); const valueRef = useRef(value); useUpdateEffect(() => { if (fastDeepEqual(valueRef.current, value) && valueRef.current !== value) warn(`Please memoize your context: ${JSON.stringify(value)}`); }, [value]); return useMemo(() => { return deepmerge(parentContext ?? {}, value ?? {}, { isMergeableObject: isPlainObject }); }, [parentContext, value]); } /** * A Provider component that can modify props for connected components within * the Context system. * * @example * ```jsx * <ContextSystemProvider value={{ Button: { size: 'small' }}}> * <Button>...</Button> * </ContextSystemProvider> * ``` * * @template {Record<string, any>} T * @param {Object} options * @param {React.ReactNode} options.children Children to render. * @param {T} options.value Props to render into connected components. * @return {React.JSX.Element} A Provider wrapped component. */ const BaseContextSystemProvider = ({ children, value }) => { const contextValue = useContextSystemBridge({ value }); return /* @__PURE__ */ jsx(ComponentsContext.Provider, { value: contextValue, children }); }; const ContextSystemProvider = memo(BaseContextSystemProvider); export { ComponentsContext, ContextSystemProvider, useComponentsContext }; //# sourceMappingURL=context-system-provider.mjs.map