{"componentChunkName":"component---src-templates-post-template-js","path":"/en-US/show/userGuide","result":{"data":{"current":{"frontmatter":{"title":"UserGuide","order":85,"brief":"Used to guide new users through pages","icon":"doc-userGuide"},"fields":{"type":"show"},"tableOfContents":{"items":[{"url":"#demos","title":"Demos","items":[{"url":"#how-to-import","title":"How to import"},{"url":"#basic-usage","title":"Basic Usage"},{"url":"#theme","title":"Theme"},{"url":"#popup-position","title":"Popup position"},{"url":"#set-the-size-of-the-highlight-area","title":"Set the size of the highlight area"},{"url":"#customize-the-button","title":"Customize the button"},{"url":"#controlled","title":"Controlled"},{"url":"#modal-guide","title":"Modal guide"},{"url":"#no-mask","title":"No mask"}]},{"url":"#api-reference","title":"API Reference","items":[{"url":"#stepsstep","title":"Steps.Step"}]},{"url":"#design-tokens","title":"Design Tokens"}]},"body":"var _excluded = [\"components\"];\nfunction _extends() { return _extends = Object.assign ? Object.assign.bind() : function (n) { for (var e = 1; e < arguments.length; e++) { var t = arguments[e]; for (var r in t) ({}).hasOwnProperty.call(t, r) && (n[r] = t[r]); } return n; }, _extends.apply(null, arguments); }\nfunction _objectWithoutProperties(e, t) { if (null == e) return {}; var o, r, i = _objectWithoutPropertiesLoose(e, t); if (Object.getOwnPropertySymbols) { var s = Object.getOwnPropertySymbols(e); for (r = 0; r < s.length; r++) o = s[r], t.includes(o) || {}.propertyIsEnumerable.call(e, o) && (i[o] = e[o]); } return i; }\nfunction _objectWithoutPropertiesLoose(r, e) { if (null == r) return {}; var t = {}; for (var n in r) if ({}.hasOwnProperty.call(r, n)) { if (e.includes(n)) continue; t[n] = r[n]; } return t; }\n/* @jsxRuntime classic */\n/* @jsx mdx */\n\nvar _frontmatter = {\n  \"localeCode\": \"en-US\",\n  \"order\": 85,\n  \"category\": \"Show\",\n  \"title\": \"UserGuide\",\n  \"icon\": \"doc-userGuide\",\n  \"brief\": \"Used to guide new users through pages\"\n};\nvar makeShortcode = function makeShortcode(name) {\n  return function MDXDefaultShortcode(props) {\n    console.warn(\"Component \" + name + \" was not imported, exported, or provided by MDXProvider as global scope\");\n    return mdx(\"div\", props);\n  };\n};\nvar DesignToken = makeShortcode(\"DesignToken\");\nvar layoutProps = {\n  _frontmatter: _frontmatter\n};\nvar MDXLayout = \"wrapper\";\nreturn function MDXContent(_ref) {\n  var components = _ref.components,\n    props = _objectWithoutProperties(_ref, _excluded);\n  return mdx(MDXLayout, _extends({}, layoutProps, props, {\n    components: components,\n    mdxType: \"MDXLayout\"\n  }), mdx(\"section\", null, mdx(\"h2\", {\n    parentName: \"section\"\n  }, \"Demos\"), mdx(\"h3\", {\n    parentName: \"section\"\n  }, \"How to import\"), mdx(\"pre\", {\n    parentName: \"section\"\n  }, mdx(\"code\", {\n    parentName: \"pre\",\n    \"className\": \"language-jsx\",\n    \"metastring\": \"import\",\n    \"import\": true\n  }, \"import { UserGuide } from '@douyinfe/semi-ui';\\n\")), mdx(\"h3\", {\n    parentName: \"section\"\n  }, \"Basic Usage\"), mdx(\"pre\", {\n    parentName: \"section\"\n  }, mdx(\"code\", {\n    parentName: \"pre\",\n    \"className\": \"language-jsx\",\n    \"metastring\": \"live=true\",\n    \"live\": \"true\"\n  }, \"import React from 'react';\\nimport { UserGuide, Button, Space, Tag, Switch } from '@douyinfe/semi-ui';\\n\\n() => {\\n    const [visible, setVisible] = useState(false);\\n    const showDialog = () => {\\n        setVisible(true);\\n    };\\n    return (\\n        <div>\\n            <Button onClick={showDialog}>Start Guide</Button>\\n            <br />\\n            <br />\\n            <Space>\\n                <Switch id={'basic-demo-1'} defaultChecked={true}></Switch>\\n                <Tag id={'basic-demo-2'}> Default Tag </Tag>\\n                <Button id={'basic-demo-3'}>Confirm</Button>\\n            </Space>\\n            <UserGuide\\n                mode=\\\"popup\\\"\\n                mask={true}\\n                visible={visible}\\n                steps={[\\n                    {\\n                        target: document.querySelector('#basic-demo-1'),\\n                        title: \\\"Beginner's Guide\\\",\\n                        description: 'Hello ByteDancer!',\\n                        position: 'bottom',\\n                    },\\n                    {\\n                        target: document.querySelector('#basic-demo-2'),\\n                        title: 'Switch',\\n                        description: 'This is a Semi Switch',\\n                        position: 'bottom',\\n                    },\\n                    {\\n                        target: document.querySelector('#basic-demo-3'),\\n                        title: 'Button',\\n                        description: 'This is a Semi Button',\\n                        position: 'bottom',\\n                    },\\n                ]}\\n                onChange={(current) => {\\n                    console.log('Current guide step', current);\\n                }}\\n                onNext={(current) => {\\n                    console.log('Next guide step');\\n                }}\\n                onPrev={(current) => {\\n                    console.log('Previous guide step');\\n                }}\\n                onFinish={() => {\\n                    setVisible(false);\\n                    console.log('Guide completed');\\n                }}\\n                onSkip={() => {\\n                    setVisible(false);\\n                    console.log('Skip guide');\\n                }}\\n            />  \\n        </div>\\n    );\\n};\\n\")), mdx(\"h3\", {\n    parentName: \"section\"\n  }, \"Theme\"), mdx(\"p\", {\n    parentName: \"section\"\n  }, mdx(\"inlineCode\", {\n    parentName: \"p\"\n  }, \"popup\"), \" bubble card mode provides two themes \", mdx(\"inlineCode\", {\n    parentName: \"p\"\n  }, \"default\"), \" and \", mdx(\"inlineCode\", {\n    parentName: \"p\"\n  }, \"primary\"), \", set by the \", mdx(\"inlineCode\", {\n    parentName: \"p\"\n  }, \"theme\"), \" property.\"), mdx(\"pre\", {\n    parentName: \"section\"\n  }, mdx(\"code\", {\n    parentName: \"pre\",\n    \"className\": \"language-jsx\",\n    \"metastring\": \"live=true\",\n    \"live\": \"true\"\n  }, \"import React from 'react';\\nimport { UserGuide, Button, Space, Tag, Switch } from '@douyinfe/semi-ui';\\n\\n() => {\\n    const [visible, setVisible] = useState(false);\\n    const showDialog = () => {\\n        setVisible(true);\\n    };\\n    return (\\n        <div>\\n            <Button onClick={showDialog}>Start Guide</Button>\\n            <br />\\n            <br />\\n            <Space>\\n                <Switch id={'theme-demo-1'} defaultChecked={true}></Switch>\\n                <Tag id={'theme-demo-2'}> Default Tag </Tag>\\n                <Button id={'theme-demo-3'}>Confirm</Button>\\n            </Space>\\n            <UserGuide\\n                mode=\\\"popup\\\"\\n                mask={true}\\n                visible={visible}\\n                theme=\\\"primary\\\"\\n                steps={[\\n                    {\\n                        target: document.querySelector('#theme-demo-1'),\\n                        title: \\\"Beginner's Guide\\\",\\n                        description: 'Hello ByteDancer!',\\n                        position: 'bottom',\\n                    },\\n                    {\\n                        target: document.querySelector('#theme-demo-2'),\\n                        title: 'Switch',\\n                        description: 'This is a Semi Switch',\\n                        position: 'bottom',\\n                    },\\n                    {\\n                        target: document.querySelector('#theme-demo-3'),\\n                        title: 'Button',\\n                        description: 'This is a Semi Button',\\n                        position: 'bottom',\\n                    },\\n                ]}\\n                onFinish={() => {\\n                    setVisible(false);\\n                    console.log('\\u5F15\\u5BFC\\u5B8C\\u6210');\\n                }}\\n                onSkip={() => {\\n                    setVisible(false);\\n                    console.log('\\u8DF3\\u8FC7\\u5F15\\u5BFC');\\n                }}\\n            />  \\n        </div>\\n    );\\n};\\n\")), mdx(\"h3\", {\n    parentName: \"section\"\n  }, \"Popup position\"), mdx(\"p\", {\n    parentName: \"section\"\n  }, mdx(\"inlineCode\", {\n    parentName: \"p\"\n  }, \"popup\"), \" bubble card mode provides 12 positions, optional values are \", mdx(\"inlineCode\", {\n    parentName: \"p\"\n  }, \"top\"), \", \", mdx(\"inlineCode\", {\n    parentName: \"p\"\n  }, \"topLeft\"), \", \", mdx(\"inlineCode\", {\n    parentName: \"p\"\n  }, \"topRight\"), \", \", mdx(\"inlineCode\", {\n    parentName: \"p\"\n  }, \"left\"), \", \", mdx(\"inlineCode\", {\n    parentName: \"p\"\n  }, \"leftTop\"), \", \", mdx(\"inlineCode\", {\n    parentName: \"p\"\n  }, \"leftBottom\"), \", \", mdx(\"inlineCode\", {\n    parentName: \"p\"\n  }, \"right\"), \", \", mdx(\"inlineCode\", {\n    parentName: \"p\"\n  }, \"rightTop\"), \", \", mdx(\"inlineCode\", {\n    parentName: \"p\"\n  }, \"rightBottom\"), \", \", mdx(\"inlineCode\", {\n    parentName: \"p\"\n  }, \"bottom\"), \", \", mdx(\"inlineCode\", {\n    parentName: \"p\"\n  }, \"bottomLeft\"), \", \", mdx(\"inlineCode\", {\n    parentName: \"p\"\n  }, \"bottomRight\"), \", and can be set by the \", mdx(\"inlineCode\", {\n    parentName: \"p\"\n  }, \"showArrow\"), \" property to display the arrow.\"), mdx(\"pre\", {\n    parentName: \"section\"\n  }, mdx(\"code\", {\n    parentName: \"pre\",\n    \"className\": \"language-jsx\",\n    \"metastring\": \"live=true\",\n    \"live\": \"true\"\n  }, \"import React from 'react';\\nimport { UserGuide, Button, Space, Tag, Switch } from '@douyinfe/semi-ui';\\n\\n() => {\\n    const [visible, setVisible] = useState(false);\\n    const showDialog = () => {\\n        setVisible(true);\\n    };\\n    return (\\n        <div>\\n            <Button id={'position-demo'} onClick={showDialog}>Start Guide</Button>\\n            <UserGuide\\n                mode=\\\"popup\\\"\\n                mask={true}\\n                visible={visible}\\n                steps={[\\n                    {\\n                        target: document.querySelector('#position-demo'),\\n                        title: \\\"Beginner's Guide\\\",\\n                        description: 'Hello ByteDancer!',\\n                        position: 'top',\\n                    },\\n                    {\\n                        target: document.querySelector('#position-demo'),\\n                        title: 'New Position',\\n                        description: 'This is Right Position',\\n                        position: 'right',\\n                    },\\n                    {\\n                        target: document.querySelector('#position-demo'),\\n                        title: 'Hide Arrow',\\n                        description: 'We hide the arrow',\\n                        position: 'bottom',\\n                        showArrow: false,\\n                    },\\n                ]}\\n                onFinish={() => {\\n                    setVisible(false);\\n                    console.log('Guide completed');\\n                }}\\n                onSkip={() => {\\n                    setVisible(false);\\n                    console.log('Skip guide');\\n                }}\\n            />  \\n        </div>\\n    );\\n};\\n\")), mdx(\"h3\", {\n    parentName: \"section\"\n  }, \"Set the size of the highlight area\"), mdx(\"p\", {\n    parentName: \"section\"\n  }, \"Set by the \", mdx(\"inlineCode\", {\n    parentName: \"p\"\n  }, \"spotlightPadding\"), \" property.\"), mdx(\"pre\", {\n    parentName: \"section\"\n  }, mdx(\"code\", {\n    parentName: \"pre\",\n    \"className\": \"language-jsx\",\n    \"metastring\": \"live=true\",\n    \"live\": \"true\"\n  }, \"import React from 'react';\\nimport { UserGuide, Button, Space, Tag, Switch } from '@douyinfe/semi-ui';\\n\\n() => {\\n    const [visible, setVisible] = useState(false);\\n    const showDialog = () => {\\n        setVisible(true);\\n    };\\n    return (\\n        <div>\\n            <Button onClick={showDialog}>Start Guide</Button>\\n            <br />\\n            <br />\\n            <Space>\\n                <Switch id={'padding-demo-1'} defaultChecked={true}></Switch>\\n                <Tag id={'padding-demo-2'}> Default Tag </Tag>\\n                <Button id={'padding-demo-3'}>Confirm</Button>\\n            </Space>\\n            <UserGuide\\n                mode=\\\"popup\\\"\\n                mask={true}\\n                visible={visible}\\n                spotlightPadding={10}\\n                steps={[\\n                    {\\n                        target: document.querySelector('#padding-demo-1'),\\n                        title: \\\"Beginner's Guide\\\",\\n                        description: 'Hello ByteDancer!',\\n                    },\\n                    {\\n                        target: document.querySelector('#padding-demo-2'),\\n                        title: 'New Padding',\\n                        description: 'This is 10px padding',\\n                    },\\n                    {\\n                        target: document.querySelector('#padding-demo-3'),\\n                        title: 'Change Padding',\\n                        spotlightPadding: 15,\\n                        description: 'We change the Padding to 15px',\\n                    },\\n                ]}\\n                onFinish={() => {\\n                    setVisible(false);\\n                    console.log('Guide completed');\\n                }}\\n                onSkip={() => {\\n                    setVisible(false);\\n                    console.log('Skip guide');\\n                }}\\n            />  \\n        </div>\\n    );\\n};\\n\")), mdx(\"h3\", {\n    parentName: \"section\"\n  }, \"Customize the button\"), mdx(\"p\", {\n    parentName: \"section\"\n  }, \"Set by the \", mdx(\"inlineCode\", {\n    parentName: \"p\"\n  }, \"nextButtonProps\"), \" and \", mdx(\"inlineCode\", {\n    parentName: \"p\"\n  }, \"prevButtonProps\"), \" properties.\"), mdx(\"pre\", {\n    parentName: \"section\"\n  }, mdx(\"code\", {\n    parentName: \"pre\",\n    \"className\": \"language-jsx\",\n    \"metastring\": \"live=true\",\n    \"live\": \"true\"\n  }, \"import React from 'react';\\nimport { UserGuide, Button, Space, Tag, Switch } from '@douyinfe/semi-ui';\\n\\n() => {\\n    const [visible, setVisible] = useState(false);\\n    const showDialog = () => {\\n        setVisible(true);\\n    };\\n    return (\\n        <div>\\n            <Button onClick={showDialog}>Start Guide</Button>\\n            <br />\\n            <br />\\n            <Space>\\n                <Switch id={'button-demo-1'} defaultChecked={true}></Switch>\\n                <Tag id={'button-demo-2'}> Default Tag </Tag>\\n                <Button id={'button-demo-3'}>Confirm</Button>\\n            </Space>\\n            <UserGuide\\n                mode=\\\"popup\\\"\\n                mask={true}\\n                visible={visible}\\n                nextButtonProps={{\\n                    children: 'Next',\\n                }}\\n                prevButtonProps={{\\n                    children: 'Prev',\\n                    theme: 'borderless',\\n                }}\\n                finishText=\\\"I know!\\\"\\n                steps={[\\n                    {\\n                        target: document.querySelector('#button-demo-1'),\\n                        title: \\\"Beginner's Guide\\\",\\n                        description: 'Hello ByteDancer!',\\n                    },\\n                    {\\n                        target: document.querySelector('#button-demo-2'),\\n                        title: 'New Button Style',\\n                        description: 'Button text is Next',\\n                    },\\n                    {\\n                        target: document.querySelector('#button-demo-3'),\\n                        title: 'New finish button text',\\n                        description: 'Button text is I know',\\n                    },\\n                ]}\\n                onFinish={() => {\\n                    setVisible(false);\\n                    console.log('Guide completed');\\n                }}\\n                onSkip={() => {\\n                    setVisible(false);\\n                    console.log('Skip guide');\\n                }}\\n            />  \\n        </div>\\n    );\\n};\\n\")), mdx(\"h3\", {\n    parentName: \"section\"\n  }, \"Controlled\"), mdx(\"p\", {\n    parentName: \"section\"\n  }, \"Set by the \", mdx(\"inlineCode\", {\n    parentName: \"p\"\n  }, \"current\"), \" property.\"), mdx(\"pre\", {\n    parentName: \"section\"\n  }, mdx(\"code\", {\n    parentName: \"pre\",\n    \"className\": \"language-jsx\",\n    \"metastring\": \"live=true\",\n    \"live\": \"true\"\n  }, \"import React from 'react';\\nimport { UserGuide, Button, Space, Tag, Switch } from '@douyinfe/semi-ui';\\n\\n() => {\\n    const [visible, setVisible] = useState(false);\\n    const [current, setCurrent] = useState(0);\\n\\n    const showDialog = () => {\\n        setVisible(true);\\n    };\\n    return (\\n        <div>\\n            <Button onClick={showDialog}>Start Guide</Button>\\n            <br />\\n            <br />\\n            <Space>\\n                <Switch id={'controlled-demo-1'} defaultChecked={true}></Switch>\\n                <Tag id={'controlled-demo-2'}> Default Tag </Tag>\\n                <Button id={'controlled-demo-3'}>Confirm</Button>\\n            </Space>\\n            <UserGuide\\n                mode=\\\"popup\\\"\\n                mask={true}\\n                visible={visible}\\n                current={current}\\n                steps={[\\n                    {\\n                        target: document.querySelector('#controlled-demo-1'),\\n                        title: \\\"Beginner's Guide\\\",\\n                        description: 'Hello ByteDancer!',\\n                        position: 'bottom',\\n                    },\\n                    {\\n                        target: document.querySelector('#controlled-demo-2'),\\n                        title: 'Switch',\\n                        description: 'This is a Semi Switch',\\n                        position: 'bottom',\\n                    },\\n                    {\\n                        target: document.querySelector('#controlled-demo-3'),\\n                        title: 'Button',\\n                        description: 'This is a Semi Button',\\n                        position: 'bottom',\\n                    },\\n                ]}\\n                onChange={(current) => {\\n                    setCurrent(current);\\n                }}\\n                onFinish={() => {\\n                    setVisible(false);\\n                    setCurrent(0);\\n                    console.log('Guide completed');\\n                }}\\n                onSkip={() => {\\n                    setVisible(false);\\n                    setCurrent(0);\\n                    console.log('Skip guide');\\n                }}\\n            />  \\n        </div>\\n    );\\n};\\n\")), mdx(\"h3\", {\n    parentName: \"section\"\n  }, \"Modal guide\"), mdx(\"p\", {\n    parentName: \"section\"\n  }, \"Set by the \", mdx(\"inlineCode\", {\n    parentName: \"p\"\n  }, \"mode\"), \" property.\"), mdx(\"pre\", {\n    parentName: \"section\"\n  }, mdx(\"code\", {\n    parentName: \"pre\",\n    \"className\": \"language-jsx\",\n    \"metastring\": \"live=true\",\n    \"live\": \"true\"\n  }, \"import React from 'react';\\nimport { UserGuide, Button, Space, Tag, Switch, Image, Typography } from '@douyinfe/semi-ui';\\n\\n() => {\\n    const [visible, setVisible] = useState(false);\\n    const showDialog = () => {\\n        setVisible(true);\\n    };\\n    return (\\n        <div>\\n            <Button onClick={showDialog}>Start Guide</Button>\\n            <UserGuide\\n                mode=\\\"modal\\\"\\n                mask={true}\\n                visible={visible}\\n                steps={[\\n                    {\\n                        title: 'Welcome to Semi DSM!',\\n                        description: <div>You can start from the published theme, or choose {<Typography.Text strong>Create Now</Typography.Text>} to create a new theme</div>,\\n                        cover: <Image \\n                            width={'600px'} \\n                            height={'100%'} \\n                            src=\\\"https://lf9-static.bytednsdoc.com/obj/eden-cn/nuhpxphk/dsm/dsm_welcome.png\\\"\\n                        />,\\n                        position: 'bottom',\\n                    },\\n                    {\\n                        title: 'High-available color palette',\\n                        description: 'After selecting the main color, our color algorithm will generate a high-available color palette for you',\\n                        cover: <Image \\n                            width={'600px'} \\n                            height={'100%'} \\n                            src=\\\"https://lf9-static.bytednsdoc.com/obj/eden-cn/nuhpxphk/dsm/dsm_console.png\\\"\\n                        />,\\n                        position: 'bottom',\\n                    },\\n                    {\\n                        title: 'Customize freely',\\n                        description: 'Start customizing your design system!',\\n                        cover: <Image \\n                            width={'600px'} \\n                            height={'100%'} \\n                            src=\\\"https://lf9-static.bytednsdoc.com/obj/eden-cn/nuhpxphk/dsm/dsm_palette.png\\\" \\n                        />,\\n                        position: 'bottom',\\n                    },\\n                ]}\\n                onChange={(current) => {\\n                    console.log('Current guide step', current);\\n                }}\\n                onNext={(current) => {\\n                    console.log('Next guide step');\\n                }}\\n                onPrev={(current) => {\\n                    console.log('Previous guide step');\\n                }}\\n                onFinish={() => {\\n                    setVisible(false);\\n                    console.log('Guide completed');\\n                }}\\n                onSkip={() => {\\n                    setVisible(false);\\n                    console.log('Skip guide');\\n                }}\\n            />  \\n        </div>\\n    );\\n};\\n\")), mdx(\"h3\", {\n    parentName: \"section\"\n  }, \"No mask\"), mdx(\"p\", {\n    parentName: \"section\"\n  }, \"Set by the \", mdx(\"inlineCode\", {\n    parentName: \"p\"\n  }, \"mask\"), \" property.\"), mdx(\"pre\", {\n    parentName: \"section\"\n  }, mdx(\"code\", {\n    parentName: \"pre\",\n    \"className\": \"language-jsx\",\n    \"metastring\": \"live=true\",\n    \"live\": \"true\"\n  }, \"import React from 'react';\\nimport { UserGuide, Button, Space, Tag, Switch, Image } from '@douyinfe/semi-ui';\\n\\n() => {\\n    const [visible, setVisible] = useState(false);\\n    const showDialog = () => {\\n        setVisible(true);\\n    };\\n    return (\\n        <div>\\n            <Button id={'mask-demo'} onClick={showDialog}>Start Guide</Button>\\n            <UserGuide\\n                mode=\\\"popup\\\"\\n                mask={false}\\n                visible={visible}\\n                steps={[\\n                    {\\n                        target: document.querySelector('#mask-demo'),\\n                        title: 'No Mask',\\n                        description: 'Hello ByteDancer!',\\n                    },\\n                ]}\\n                onFinish={() => {\\n                    setVisible(false);\\n                    console.log('Guide completed');\\n                }}\\n                onSkip={() => {\\n                    setVisible(false);\\n                    console.log('Skip guide');\\n                }}\\n            />  \\n        </div>\\n    );\\n};\\n\"))), mdx(\"section\", null, mdx(\"h2\", {\n    parentName: \"section\"\n  }, \"API Reference\"), mdx(\"hr\", {\n    parentName: \"section\"\n  }), mdx(\"table\", {\n    parentName: \"section\"\n  }, mdx(\"thead\", {\n    parentName: \"table\"\n  }, mdx(\"tr\", {\n    parentName: \"thead\"\n  }, mdx(\"th\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"Properties\"), mdx(\"th\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"Instructions\"), mdx(\"th\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"Type\"), mdx(\"th\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"Default\"), mdx(\"th\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"Version\"))), mdx(\"tbody\", {\n    parentName: \"table\"\n  }, mdx(\"tr\", {\n    parentName: \"tbody\"\n  }, mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"className\"), mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"Custom class name\"), mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"string\"), mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"-\"), mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": null\n  })), mdx(\"tr\", {\n    parentName: \"tbody\"\n  }, mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"current\"), mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"Current step index\"), mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"number\"), mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"0\"), mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": null\n  })), mdx(\"tr\", {\n    parentName: \"tbody\"\n  }, mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"finishText\"), mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"Text of the last step completion button\"), mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"string\"), mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"'\\u5B8C\\u6210'\"), mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": null\n  })), mdx(\"tr\", {\n    parentName: \"tbody\"\n  }, mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"mask\"), mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"Whether to display the mask\"), mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"boolean\"), mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"true\"), mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": null\n  })), mdx(\"tr\", {\n    parentName: \"tbody\"\n  }, mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"mode\"), mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"Guide mode, optional values: \", mdx(\"inlineCode\", {\n    parentName: \"td\"\n  }, \"popup\"), \" (bubble card) or \", mdx(\"inlineCode\", {\n    parentName: \"td\"\n  }, \"modal\"), \" (modal)\"), mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"string\"), mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"popup\"), mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": null\n  })), mdx(\"tr\", {\n    parentName: \"tbody\"\n  }, mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"nextButtonProps\"), mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"The properties of the next button\"), mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"ButtonProps\"), mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"{}\"), mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": null\n  })), mdx(\"tr\", {\n    parentName: \"tbody\"\n  }, mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"onChange\"), mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"Callback when the step changes\"), mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"function(current: number)\"), mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"() => void\"), mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": null\n  })), mdx(\"tr\", {\n    parentName: \"tbody\"\n  }, mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"onFinish\"), mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"Callback when all steps are completed\"), mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"function()\"), mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"() => void\"), mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": null\n  })), mdx(\"tr\", {\n    parentName: \"tbody\"\n  }, mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"onNext\"), mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"Callback when the next button is clicked\"), mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"function(current: number)\"), mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"() => void\"), mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": null\n  })), mdx(\"tr\", {\n    parentName: \"tbody\"\n  }, mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"onPrev\"), mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"Callback when the previous button is clicked\"), mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"function(current: number)\"), mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"() => void\"), mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": null\n  })), mdx(\"tr\", {\n    parentName: \"tbody\"\n  }, mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"onSkip\"), mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"Callback when the skip button is clicked\"), mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"function()\"), mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"() => void\"), mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": null\n  })), mdx(\"tr\", {\n    parentName: \"tbody\"\n  }, mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"position\"), mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"The position of the pop-up layer relative to the target element, optional values: \", mdx(\"inlineCode\", {\n    parentName: \"td\"\n  }, \"top\"), \", \", mdx(\"inlineCode\", {\n    parentName: \"td\"\n  }, \"topLeft\"), \", \", mdx(\"inlineCode\", {\n    parentName: \"td\"\n  }, \"topRight\"), \", \", mdx(\"inlineCode\", {\n    parentName: \"td\"\n  }, \"left\"), \", \", mdx(\"inlineCode\", {\n    parentName: \"td\"\n  }, \"leftTop\"), \", \", mdx(\"inlineCode\", {\n    parentName: \"td\"\n  }, \"leftBottom\"), \", \", mdx(\"inlineCode\", {\n    parentName: \"td\"\n  }, \"right\"), \", \", mdx(\"inlineCode\", {\n    parentName: \"td\"\n  }, \"rightTop\"), \", \", mdx(\"inlineCode\", {\n    parentName: \"td\"\n  }, \"rightBottom\"), \", \", mdx(\"inlineCode\", {\n    parentName: \"td\"\n  }, \"bottom\"), \", \", mdx(\"inlineCode\", {\n    parentName: \"td\"\n  }, \"bottomLeft\"), \", \", mdx(\"inlineCode\", {\n    parentName: \"td\"\n  }, \"bottomRight\")), mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"string\"), mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"bottom\"), mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": null\n  })), mdx(\"tr\", {\n    parentName: \"tbody\"\n  }, mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"prevButtonProps\"), mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"The properties of the previous button\"), mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"ButtonProps\"), mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"{}\"), mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": null\n  })), mdx(\"tr\", {\n    parentName: \"tbody\"\n  }, mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"showPrevButton\"), mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"Whether to display the previous button\"), mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"boolean\"), mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"true\"), mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": null\n  })), mdx(\"tr\", {\n    parentName: \"tbody\"\n  }, mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"showSkipButton\"), mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"Whether to display the skip button\"), mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"boolean\"), mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"true\"), mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": null\n  })), mdx(\"tr\", {\n    parentName: \"tbody\"\n  }, mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"spotlightPadding\"), mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"The inner padding of the highlight area, in pixels\"), mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"number\"), mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"-\"), mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": null\n  })), mdx(\"tr\", {\n    parentName: \"tbody\"\n  }, mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"steps\"), mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"Guide step configuration, required\"), mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"StepItem[]\"), mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"[]\"), mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": null\n  })), mdx(\"tr\", {\n    parentName: \"tbody\"\n  }, mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"style\"), mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"Custom style\"), mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"React.CSSProperties\"), mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"-\"), mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": null\n  })), mdx(\"tr\", {\n    parentName: \"tbody\"\n  }, mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"theme\"), mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"Theme style, optional values: \", mdx(\"inlineCode\", {\n    parentName: \"td\"\n  }, \"default\"), \" or \", mdx(\"inlineCode\", {\n    parentName: \"td\"\n  }, \"primary\")), mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"string\"), mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"default\"), mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": null\n  })), mdx(\"tr\", {\n    parentName: \"tbody\"\n  }, mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"visible\"), mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"Whether to display the guide\"), mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"boolean\"), mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"false\"), mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": null\n  })), mdx(\"tr\", {\n    parentName: \"tbody\"\n  }, mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"getPopupContainer\"), mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"Specify the parent DOM, the pop-up layer will be rendered to the DOM\"), mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"() => HTMLElement\"), mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"-\"), mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": null\n  })), mdx(\"tr\", {\n    parentName: \"tbody\"\n  }, mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"zIndex\"), mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"Pop-up layer level\"), mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"number\"), mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"1030\"), mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": null\n  })))), mdx(\"h3\", {\n    parentName: \"section\"\n  }, \"Steps.Step\"), mdx(\"table\", {\n    parentName: \"section\"\n  }, mdx(\"thead\", {\n    parentName: \"table\"\n  }, mdx(\"tr\", {\n    parentName: \"thead\"\n  }, mdx(\"th\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"Properties\"), mdx(\"th\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"Instructions\"), mdx(\"th\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"Type\"), mdx(\"th\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"Default\"), mdx(\"th\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"Version\"))), mdx(\"tbody\", {\n    parentName: \"table\"\n  }, mdx(\"tr\", {\n    parentName: \"tbody\"\n  }, mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"className\"), mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"Custom class name\"), mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"string\"), mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"-\"), mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": null\n  })), mdx(\"tr\", {\n    parentName: \"tbody\"\n  }, mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"cover\"), mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"The cover image of the step\"), mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"ReactNode\"), mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"-\"), mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": null\n  })), mdx(\"tr\", {\n    parentName: \"tbody\"\n  }, mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"target\"), mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"The target element, the highlight area will focus on this element\"), mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"(() => Element) \", \"|\", \" Element\"), mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"-\"), mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": null\n  })), mdx(\"tr\", {\n    parentName: \"tbody\"\n  }, mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"title\"), mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"Step title\"), mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"string \", \"|\", \" ReactNode\"), mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"-\"), mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": null\n  })), mdx(\"tr\", {\n    parentName: \"tbody\"\n  }, mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"description\"), mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"Step description\"), mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"ReactNode\"), mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"-\"), mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": null\n  })), mdx(\"tr\", {\n    parentName: \"tbody\"\n  }, mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"mask\"), mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"Whether to display the mask of this step, it will override the global configuration\"), mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"boolean\"), mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"-\"), mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": null\n  })), mdx(\"tr\", {\n    parentName: \"tbody\"\n  }, mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"showArrow\"), mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"Whether to display the arrow (only valid when mode=\", mdx(\"inlineCode\", {\n    parentName: \"td\"\n  }, \"popup\"), \")\"), mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"boolean\"), mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"true\"), mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": null\n  })), mdx(\"tr\", {\n    parentName: \"tbody\"\n  }, mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"spotlightPadding\"), mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"The inner padding of the highlight area of this step, it will override the global configuration\"), mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"number\"), mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"-\"), mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": null\n  })), mdx(\"tr\", {\n    parentName: \"tbody\"\n  }, mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"theme\"), mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"The theme of this step, it will override the global configuration\"), mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, mdx(\"inlineCode\", {\n    parentName: \"td\"\n  }, \"default\"), \" \", \"|\", \" \", mdx(\"inlineCode\", {\n    parentName: \"td\"\n  }, \"primary\")), mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"-\"), mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": null\n  })), mdx(\"tr\", {\n    parentName: \"tbody\"\n  }, mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"position\"), mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"The position of the pop-up layer of this step, it will override the global configuration\"), mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"Position\"), mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"-\"), mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": null\n  }))))), mdx(\"section\", null, mdx(\"h2\", {\n    parentName: \"section\"\n  }, \"Design Tokens\"), mdx(DesignToken, {\n    mdxType: \"DesignToken\"\n  })));\n}\n;\nMDXContent.isMDXComponent = true;"}},"pageContext":{"slug":"en-US/show/userGuide","next":{"fields":{"slug":"zh-CN/show/userGuide"},"id":"63249a74-2e4b-5ba0-9cfc-707ee5b43d77","frontmatter":{"title":"UserGuide 用户引导","localeCode":"zh-CN","icon":"doc-userGuide","showNew":null}},"previous":{"fields":{"slug":"zh-CN/show/tooltip"},"id":"67ed9aaa-9de3-5021-bf7e-cf8905869acf","frontmatter":{"title":"Tooltip 工具提示","localeCode":"zh-CN","icon":"doc-tooltip","showNew":null}}}},"staticQueryHashes":["1348983216229725","1477422646229725","3245198693229725","417590761229725","63159454229725"]}