@wordpress/components
Version:
UI components for WordPress.
1 lines • 6.81 kB
Source Map (JSON)
{"version":3,"file":"index.cjs","names":["__","useRef","useState","Children","Modal","PageControl","Button"],"sources":["../../src/guide/index.tsx"],"sourcesContent":["import clsx from 'clsx';\nimport { useState, useEffect, Children, useRef } from '@wordpress/element';\nimport deprecated from '@wordpress/deprecated';\nimport { __ } from '@wordpress/i18n';\nimport Modal from '../modal';\nimport Button from '../button';\nimport PageControl from './page-control';\nimport type { GuideProps } from './types';\n\n/**\n * `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.\n *\n * ```jsx\n * function MyTutorial() {\n * \tconst [ isOpen, setIsOpen ] = useState( true );\n *\n * \tif ( ! isOpen ) {\n * \t\treturn null;\n * \t}\n *\n * \treturn (\n * \t\t<Guide\n * \t\t\tonFinish={ () => setIsOpen( false ) }\n * \t\t\tpages={ [\n * \t\t\t\t{\n * \t\t\t\t\tcontent: <p>Welcome to the ACME Store!</p>,\n * \t\t\t\t},\n * \t\t\t\t{\n * \t\t\t\t\timage: <img src=\"https://acmestore.com/add-to-cart.png\" />,\n * \t\t\t\t\tcontent: (\n * \t\t\t\t\t\t<p>\n * \t\t\t\t\t\t\tClick <i>Add to Cart</i> to buy a product.\n * \t\t\t\t\t\t</p>\n * \t\t\t\t\t),\n * \t\t\t\t},\n * \t\t\t] }\n * \t\t/>\n * \t);\n * }\n * ```\n */\nfunction Guide( {\n\tchildren,\n\tclassName,\n\tcontentLabel,\n\tfinishButtonText = __( 'Finish' ),\n\tnextButtonText = __( 'Next' ),\n\tpreviousButtonText = __( 'Previous' ),\n\tonFinish,\n\tpages = [],\n}: GuideProps ) {\n\tconst ref = useRef< HTMLDivElement >( null );\n\tconst [ currentPage, setCurrentPage ] = useState( 0 );\n\n\tuseEffect( () => {\n\t\t// Place focus at the top of the guide on mount and when the page changes.\n\t\tconst frame = ref.current?.querySelector( '.components-guide' );\n\t\tif ( frame instanceof HTMLElement ) {\n\t\t\tframe.focus();\n\t\t}\n\t}, [ currentPage ] );\n\n\tuseEffect( () => {\n\t\tif ( Children.count( children ) ) {\n\t\t\tdeprecated( 'Passing children to <Guide>', {\n\t\t\t\tsince: '5.5',\n\t\t\t\talternative: 'the `pages` prop',\n\t\t\t} );\n\t\t}\n\t}, [ children ] );\n\n\tif ( Children.count( children ) ) {\n\t\tpages =\n\t\t\tChildren.map( children, ( child ) => ( {\n\t\t\t\tcontent: child,\n\t\t\t} ) ) ?? [];\n\t}\n\n\tconst canGoBack = currentPage > 0;\n\tconst canGoForward = currentPage < pages.length - 1;\n\n\tconst goBack = () => {\n\t\tif ( canGoBack ) {\n\t\t\tsetCurrentPage( currentPage - 1 );\n\t\t}\n\t};\n\n\tconst goForward = () => {\n\t\tif ( canGoForward ) {\n\t\t\tsetCurrentPage( currentPage + 1 );\n\t\t}\n\t};\n\n\tif ( pages.length === 0 ) {\n\t\treturn null;\n\t}\n\n\treturn (\n\t\t<Modal\n\t\t\tclassName={ clsx( 'components-guide', className ) }\n\t\t\tcontentLabel={ contentLabel }\n\t\t\tisDismissible={ pages.length > 1 }\n\t\t\tonRequestClose={ onFinish }\n\t\t\tonKeyDown={ ( event ) => {\n\t\t\t\tif ( event.code === 'ArrowLeft' ) {\n\t\t\t\t\tgoBack();\n\t\t\t\t\t// Do not scroll the modal's contents.\n\t\t\t\t\tevent.preventDefault();\n\t\t\t\t} else if ( event.code === 'ArrowRight' ) {\n\t\t\t\t\tgoForward();\n\t\t\t\t\t// Do not scroll the modal's contents.\n\t\t\t\t\tevent.preventDefault();\n\t\t\t\t}\n\t\t\t} }\n\t\t\tref={ ref }\n\t\t>\n\t\t\t<div className=\"components-guide__container\">\n\t\t\t\t<div className=\"components-guide__page\">\n\t\t\t\t\t{ pages[ currentPage ].image }\n\n\t\t\t\t\t{ pages.length > 1 && (\n\t\t\t\t\t\t<PageControl\n\t\t\t\t\t\t\tcurrentPage={ currentPage }\n\t\t\t\t\t\t\tnumberOfPages={ pages.length }\n\t\t\t\t\t\t\tsetCurrentPage={ setCurrentPage }\n\t\t\t\t\t\t/>\n\t\t\t\t\t) }\n\n\t\t\t\t\t{ pages[ currentPage ].content }\n\t\t\t\t</div>\n\n\t\t\t\t<div className=\"components-guide__footer\">\n\t\t\t\t\t{ canGoBack && (\n\t\t\t\t\t\t<Button\n\t\t\t\t\t\t\tclassName=\"components-guide__back-button\"\n\t\t\t\t\t\t\tvariant=\"tertiary\"\n\t\t\t\t\t\t\tonClick={ goBack }\n\t\t\t\t\t\t\t__next40pxDefaultSize\n\t\t\t\t\t\t>\n\t\t\t\t\t\t\t{ previousButtonText }\n\t\t\t\t\t\t</Button>\n\t\t\t\t\t) }\n\t\t\t\t\t{ canGoForward && (\n\t\t\t\t\t\t<Button\n\t\t\t\t\t\t\tclassName=\"components-guide__forward-button\"\n\t\t\t\t\t\t\tvariant=\"primary\"\n\t\t\t\t\t\t\tonClick={ goForward }\n\t\t\t\t\t\t\t__next40pxDefaultSize\n\t\t\t\t\t\t>\n\t\t\t\t\t\t\t{ nextButtonText }\n\t\t\t\t\t\t</Button>\n\t\t\t\t\t) }\n\t\t\t\t\t{ ! canGoForward && (\n\t\t\t\t\t\t<Button\n\t\t\t\t\t\t\tclassName=\"components-guide__finish-button\"\n\t\t\t\t\t\t\tvariant=\"primary\"\n\t\t\t\t\t\t\tonClick={ onFinish }\n\t\t\t\t\t\t\t__next40pxDefaultSize\n\t\t\t\t\t\t>\n\t\t\t\t\t\t\t{ finishButtonText }\n\t\t\t\t\t\t</Button>\n\t\t\t\t\t) }\n\t\t\t\t</div>\n\t\t\t</div>\n\t\t</Modal>\n\t);\n}\n\nexport default Guide;\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAyCA,SAAS,MAAO,EACf,UACA,WACA,cACA,oBAAA,GAAmBA,gBAAAA,GAAAA,CAAI,QAAS,GAChC,kBAAA,GAAiBA,gBAAAA,GAAAA,CAAI,MAAO,GAC5B,sBAAA,GAAqBA,gBAAAA,GAAAA,CAAI,UAAW,GACpC,UACA,QAAQ,CAAC,KACM;CACf,MAAM,OAAA,GAAMC,mBAAAA,OAAAA,CAA0B,IAAK;CAC3C,MAAM,CAAE,aAAa,mBAAA,GAAmBC,mBAAAA,SAAAA,CAAU,CAAE;CAEpD,CAAA,GAAA,mBAAA,UAAA,OAAiB;EAEhB,MAAM,QAAQ,IAAI,SAAS,cAAe,mBAAoB;EAC9D,IAAK,iBAAiB,aACrB,MAAM,MAAM;CAEd,GAAG,CAAE,WAAY,CAAE;CAEnB,CAAA,GAAA,mBAAA,UAAA,OAAiB;EAChB,IAAKC,mBAAAA,SAAS,MAAO,QAAS,GAC7B,CAAA,GAAA,sBAAA,QAAA,CAAY,+BAA+B;GAC1C,OAAO;GACP,aAAa;EACd,CAAE;CAEJ,GAAG,CAAE,QAAS,CAAE;CAEhB,IAAKA,mBAAAA,SAAS,MAAO,QAAS,GAC7B,QACCA,mBAAAA,SAAS,IAAK,WAAY,WAAa,EACtC,SAAS,MACV,EAAI,KAAK,CAAC;CAGZ,MAAM,YAAY,cAAc;CAChC,MAAM,eAAe,cAAc,MAAM,SAAS;CAElD,MAAM,eAAe;EACpB,IAAK,WACJ,eAAgB,cAAc,CAAE;CAElC;CAEA,MAAM,kBAAkB;EACvB,IAAK,cACJ,eAAgB,cAAc,CAAE;CAElC;CAEA,IAAK,MAAM,WAAW,GACrB,OAAO;CAGR,OACC,iBAAA,GAAA,kBAAA,IAAA,CAACC,mBAAAA,SAAD;EACC,YAAA,GAAY,KAAA,QAAA,CAAM,oBAAoB,SAAU;EACjC;EACf,eAAgB,MAAM,SAAS;EAC/B,gBAAiB;EACjB,YAAc,UAAW;GACxB,IAAK,MAAM,SAAS,aAAc;IACjC,OAAO;IAEP,MAAM,eAAe;GACtB,OAAO,IAAK,MAAM,SAAS,cAAe;IACzC,UAAU;IAEV,MAAM,eAAe;GACtB;EACD;EACM;EAEN,UAAA,iBAAA,GAAA,kBAAA,KAAA,CAAC,OAAD;GAAK,WAAU;GAAf,UAAA,CACC,iBAAA,GAAA,kBAAA,KAAA,CAAC,OAAD;IAAK,WAAU;IAAf,UAAA;KACG,MAAO,YAAa,CAAC;KAErB,MAAM,SAAS,KAChB,iBAAA,GAAA,kBAAA,IAAA,CAACC,mBAAAA,SAAD;MACe;MACd,eAAgB,MAAM;MACL;KACjB,CAAA;KAGA,MAAO,YAAa,CAAC;IACnB;GAEL,CAAA,GAAA,iBAAA,GAAA,kBAAA,KAAA,CAAC,OAAD;IAAK,WAAU;IAAf,UAAA;KACG,aACD,iBAAA,GAAA,kBAAA,IAAA,CAACC,oBAAAA,SAAD;MACC,WAAU;MACV,SAAQ;MACR,SAAU;MACV,uBAAA;MAEE,UAAA;KACK,CAAA;KAEP,gBACD,iBAAA,GAAA,kBAAA,IAAA,CAACA,oBAAAA,SAAD;MACC,WAAU;MACV,SAAQ;MACR,SAAU;MACV,uBAAA;MAEE,UAAA;KACK,CAAA;KAEP,CAAE,gBACH,iBAAA,GAAA,kBAAA,IAAA,CAACA,oBAAAA,SAAD;MACC,WAAU;MACV,SAAQ;MACR,SAAU;MACV,uBAAA;MAEE,UAAA;KACK,CAAA;IAEL;GACD,CAAA,CAAA;;CACC,CAAA;AAET"}