@wordpress/components
Version:
UI components for WordPress.
56 lines (55 loc) • 2.03 kB
JavaScript
import { Component } from "@wordpress/element";
import { createHigherOrderComponent, useFocusReturn } from "@wordpress/compose";
import deprecated from "@wordpress/deprecated";
import { jsx } from "react/jsx-runtime";
// packages/components/src/higher-order/with-focus-return/index.tsx
/**
* Returns true if the given object is component-like. An object is component-
* like if it is an instance of wp.element.Component, or is a function.
*
* @param object Object to test.
*
* @return Whether object is component-like.
*/
function isComponentLike(object) {
return object instanceof Component || typeof object === "function";
}
/**
* Higher Order Component used to be used to wrap disposable elements like
* sidebars, modals, dropdowns. When mounting the wrapped component, we track a
* reference to the current active element so we know where to restore focus
* when the component is unmounted.
*
* @param options The component to be enhanced with
* focus return behavior, or an object
* describing the component and the
* focus return characteristics.
*
* @return Higher Order Component with the focus restoration behaviour.
*/
var with_focus_return_default = createHigherOrderComponent((options) => {
const HoC = ({ onFocusReturn } = {}) => (WrappedComponent) => {
const WithFocusReturn = (props) => {
const ref = useFocusReturn(onFocusReturn);
return /* @__PURE__ */ jsx("div", {
ref,
children: /* @__PURE__ */ jsx(WrappedComponent, { ...props })
});
};
return WithFocusReturn;
};
if (isComponentLike(options)) {
const WrappedComponent = options;
return HoC()(WrappedComponent);
}
return HoC(options);
}, "withFocusReturn");
const Provider = ({ children }) => {
deprecated("wp.components.FocusReturnProvider component", {
since: "5.7",
hint: "This provider is not used anymore. You can just remove it from your codebase"
});
return children;
};
export { Provider, with_focus_return_default as default };
//# sourceMappingURL=index.mjs.map