@wordpress/components
Version:
UI components for WordPress.
155 lines (154 loc) • 5.71 kB
JavaScript
;
Object.defineProperties(exports, {
__esModule: { value: true },
[Symbol.toStringTag]: { value: "Module" }
});
// \0rolldown/runtime.js
var __create = Object.create;
var __defProp = Object.defineProperty;
var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
var __getOwnPropNames = Object.getOwnPropertyNames;
var __getProtoOf = Object.getPrototypeOf;
var __hasOwnProp = Object.prototype.hasOwnProperty;
var __copyProps = (to, from, except, desc) => {
if (from && typeof from === "object" || typeof from === "function") for (var keys = __getOwnPropNames(from), i = 0, n = keys.length, key; i < n; i++) {
key = keys[i];
if (!__hasOwnProp.call(to, key) && key !== except) __defProp(to, key, {
get: ((k) => from[k]).bind(null, key),
enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable
});
}
return to;
};
var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", {
value: mod,
enumerable: true
}) : target, mod));
let clsx = require("clsx");
clsx = __toESM(clsx);
let _wordpress_element = require("@wordpress/element");
let _wordpress_deprecated = require("@wordpress/deprecated");
_wordpress_deprecated = __toESM(_wordpress_deprecated);
let _wordpress_i18n = require("@wordpress/i18n");
let ___modal_index_tsx = require("../modal/index.cjs");
___modal_index_tsx = __toESM(___modal_index_tsx);
let ___button_index_tsx = require("../button/index.cjs");
___button_index_tsx = __toESM(___button_index_tsx);
let __page_control_tsx = require("./page-control.cjs");
__page_control_tsx = __toESM(__page_control_tsx);
let react_jsx_runtime = require("react/jsx-runtime");
// packages/components/src/guide/index.tsx
/**
* `Guide` is a React component that renders a _user guide_ in a modal. The guide consists of several pages which the user can step through one by one. The guide is finished when the modal is closed or when the user clicks _Finish_ on the last page of the guide.
*
* ```jsx
* function MyTutorial() {
* const [ isOpen, setIsOpen ] = useState( true );
*
* if ( ! isOpen ) {
* return null;
* }
*
* return (
* <Guide
* onFinish={ () => setIsOpen( false ) }
* pages={ [
* {
* content: <p>Welcome to the ACME Store!</p>,
* },
* {
* image: <img src="https://acmestore.com/add-to-cart.png" />,
* content: (
* <p>
* Click <i>Add to Cart</i> to buy a product.
* </p>
* ),
* },
* ] }
* />
* );
* }
* ```
*/
function Guide({ children, className, contentLabel, finishButtonText = (0, _wordpress_i18n.__)("Finish"), nextButtonText = (0, _wordpress_i18n.__)("Next"), previousButtonText = (0, _wordpress_i18n.__)("Previous"), onFinish, pages = [] }) {
const ref = (0, _wordpress_element.useRef)(null);
const [currentPage, setCurrentPage] = (0, _wordpress_element.useState)(0);
(0, _wordpress_element.useEffect)(() => {
const frame = ref.current?.querySelector(".components-guide");
if (frame instanceof HTMLElement) frame.focus();
}, [currentPage]);
(0, _wordpress_element.useEffect)(() => {
if (_wordpress_element.Children.count(children)) (0, _wordpress_deprecated.default)("Passing children to <Guide>", {
since: "5.5",
alternative: "the `pages` prop"
});
}, [children]);
if (_wordpress_element.Children.count(children)) pages = _wordpress_element.Children.map(children, (child) => ({ content: child })) ?? [];
const canGoBack = currentPage > 0;
const canGoForward = currentPage < pages.length - 1;
const goBack = () => {
if (canGoBack) setCurrentPage(currentPage - 1);
};
const goForward = () => {
if (canGoForward) setCurrentPage(currentPage + 1);
};
if (pages.length === 0) return null;
return /* @__PURE__ */ (0, react_jsx_runtime.jsx)(___modal_index_tsx.default, {
className: (0, clsx.default)("components-guide", className),
contentLabel,
isDismissible: pages.length > 1,
onRequestClose: onFinish,
onKeyDown: (event) => {
if (event.code === "ArrowLeft") {
goBack();
event.preventDefault();
} else if (event.code === "ArrowRight") {
goForward();
event.preventDefault();
}
},
ref,
children: /* @__PURE__ */ (0, react_jsx_runtime.jsxs)("div", {
className: "components-guide__container",
children: [/* @__PURE__ */ (0, react_jsx_runtime.jsxs)("div", {
className: "components-guide__page",
children: [
pages[currentPage].image,
pages.length > 1 && /* @__PURE__ */ (0, react_jsx_runtime.jsx)(__page_control_tsx.default, {
currentPage,
numberOfPages: pages.length,
setCurrentPage
}),
pages[currentPage].content
]
}), /* @__PURE__ */ (0, react_jsx_runtime.jsxs)("div", {
className: "components-guide__footer",
children: [
canGoBack && /* @__PURE__ */ (0, react_jsx_runtime.jsx)(___button_index_tsx.default, {
className: "components-guide__back-button",
variant: "tertiary",
onClick: goBack,
__next40pxDefaultSize: true,
children: previousButtonText
}),
canGoForward && /* @__PURE__ */ (0, react_jsx_runtime.jsx)(___button_index_tsx.default, {
className: "components-guide__forward-button",
variant: "primary",
onClick: goForward,
__next40pxDefaultSize: true,
children: nextButtonText
}),
!canGoForward && /* @__PURE__ */ (0, react_jsx_runtime.jsx)(___button_index_tsx.default, {
className: "components-guide__finish-button",
variant: "primary",
onClick: onFinish,
__next40pxDefaultSize: true,
children: finishButtonText
})
]
})]
})
});
}
exports.default = Guide;
//# sourceMappingURL=index.cjs.map