userGuide.stories.jsx 27 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607
  1. /* argus-disable unPkgSensitiveInfo */
  2. import React, { useState } from 'react';
  3. import { Button, UserGuide, Toast, Tag, Switch, Space } from '@douyinfe/semi-ui/index';
  4. export default {
  5. title: 'UserGuide',
  6. };
  7. export const BasicUsage = () => {
  8. const [visible, setVisible] = useState(false);
  9. return (
  10. <div>
  11. <Space spacing='medium'>
  12. <Switch id={'step-1'} defaultChecked={true}/>
  13. <Button id={'step-2'} type="secondary">次要</Button>
  14. <Button id={'step-3'} type="tertiary">第三</Button>
  15. <Button id={'step-4'} type="warning">警告</Button>
  16. </Space>
  17. <div style={{ marginTop: '20px' }}>
  18. <Button onClick={() => setVisible(true)}>显示引导</Button>
  19. </div>
  20. <UserGuide
  21. mode="popup"
  22. mask={true}
  23. steps={[
  24. {
  25. target: document.querySelector('#step-1'),
  26. cover: (
  27. <img
  28. alt="example"
  29. height={200}
  30. src="https://lf3-static.bytednsdoc.com/obj/eden-cn/ptlz_zlp/ljhwZthlaukjlkulzlp/root-web-sites/card-cover-docs-demo.jpeg"
  31. />
  32. ),
  33. title: "这里是标题1",
  34. description: "一些描述文案一些描述文案一些描述文案一些描述文案一些描述文案一些描述文案一些描述文案一些描述文案",
  35. position: "bottom"
  36. },
  37. {
  38. target: document.querySelector('#step-2'),
  39. cover: (
  40. <img
  41. alt="example"
  42. height={200}
  43. width={'100%'}
  44. src="https://lf3-static.bytednsdoc.com/obj/eden-cn/ptlz_zlp/ljhwZthlaukjlkulzlp/root-web-sites/card-cover-docs-demo.jpeg"
  45. />
  46. ),
  47. title: "这里是标题2",
  48. description: "这是第二步的说明一些描述文案一些描述文案一些描述文案一些描述文案一些描述文案一些描述文案一些描述文案一些描述文案",
  49. position: "right"
  50. },
  51. {
  52. target: document.querySelector('#step-3'),
  53. title: "这里是标题3",
  54. description: "这是第二步的说明一些描述文案一些描述文案一些描述文案一些描述文案一些描述文案一些描述文案一些描述文案一些描述文案",
  55. position: "bottom"
  56. },
  57. {
  58. target: document.querySelector('#step-4'),
  59. title: "这里是标题4",
  60. description: "这是第二步的说明一些描述文案一些描述文案一些描述文案一些描述文案一些描述文案一些描述文案一些描述文案一些描述文案",
  61. position: "right"
  62. }
  63. ]}
  64. visible={visible}
  65. onFinish={() => {
  66. setVisible(false);
  67. console.log('引导完成')
  68. }}
  69. onSkip={() => {
  70. setVisible(false);
  71. console.log('引导跳过')
  72. }}
  73. />
  74. </div>
  75. );
  76. };
  77. export const PrimaryTheme = () => {
  78. const [visible, setVisible] = useState(false);
  79. return (
  80. <div>
  81. <Space spacing='medium'>
  82. <Switch id={'step-1'} defaultChecked={true}/>
  83. <Button id={'step-2'} type="secondary">次要</Button>
  84. <Button id={'step-3'} type="tertiary">第三</Button>
  85. <Button id={'step-4'} type="warning">警告</Button>
  86. </Space>
  87. <div style={{ marginTop: '20px' }}>
  88. <Button onClick={() => setVisible(true)}>显示引导</Button>
  89. </div>
  90. <UserGuide
  91. mode="popup"
  92. theme="primary"
  93. mask={true}
  94. steps={[
  95. {
  96. target: document.querySelector('#step-1'),
  97. cover: (
  98. <img
  99. alt="example"
  100. height={200}
  101. width={'100%'}
  102. src="https://lf3-static.bytednsdoc.com/obj/eden-cn/ptlz_zlp/ljhwZthlaukjlkulzlp/root-web-sites/card-cover-docs-demo.jpeg"
  103. />
  104. ),
  105. title: "这里是标题1",
  106. description: "一些描述文案一些描述文案一些描述文案一些描述文案一些描述文案一些描述文案一些描述文案一些描述文案",
  107. position: "bottom"
  108. },
  109. {
  110. target: document.querySelector('#step-2'),
  111. cover: (
  112. <img
  113. alt="example"
  114. height={200}
  115. width={'100%'}
  116. src="https://lf3-static.bytednsdoc.com/obj/eden-cn/ptlz_zlp/ljhwZthlaukjlkulzlp/root-web-sites/card-cover-docs-demo.jpeg"
  117. />
  118. ),
  119. title: "这里是标题2",
  120. description: "这是第二步的说明一些描述文案一些描述文案一些描述文案一些描述文案一些描述文案一些描述文案一些描述文案一些描述文案",
  121. position: "right"
  122. },
  123. {
  124. target: document.querySelector('#step-3'),
  125. title: "这里是标题3",
  126. description: "这是第二步的说明一些描述文案一些描述文案一些描述文案一些描述文案一些描述文案一些描述文案一些描述文案一些描述文案",
  127. position: "bottom"
  128. },
  129. {
  130. target: document.querySelector('#step-4'),
  131. title: "这里是标题4",
  132. description: "这是第二步的说明一些描述文案一些描述文案一些描述文案一些描述文案一些描述文案一些描述文案一些描述文案一些描述文案",
  133. position: "right"
  134. }
  135. ]}
  136. visible={visible}
  137. onFinish={() => {
  138. setVisible(false);
  139. console.log('引导完成')
  140. }}
  141. onSkip={() => {
  142. setVisible(false);
  143. console.log('引导跳过')
  144. }}
  145. />
  146. </div>
  147. );
  148. };
  149. export const HideButtons = () => {
  150. const [visible, setVisible] = useState(false);
  151. return (
  152. <div>
  153. <Space spacing='medium'>
  154. <Switch id={'step-1'} defaultChecked={true}/>
  155. <Button id={'step-2'} type="secondary">次要</Button>
  156. <Button id={'step-3'} type="tertiary">第三</Button>
  157. <Button id={'step-4'} type="warning">警告</Button>
  158. </Space>
  159. <div style={{ marginTop: '20px' }}>
  160. <Button onClick={() => setVisible(true)}>显示引导</Button>
  161. </div>
  162. <UserGuide
  163. mode="popup"
  164. mask={true}
  165. showPrevButton={false}
  166. showSkipButton={false}
  167. steps={[
  168. {
  169. target: document.querySelector('#step-1'),
  170. cover: (
  171. <img
  172. alt="example"
  173. height={200}
  174. width={'100%'}
  175. src="https://lf3-static.bytednsdoc.com/obj/eden-cn/ptlz_zlp/ljhwZthlaukjlkulzlp/root-web-sites/card-cover-docs-demo.jpeg"
  176. />
  177. ),
  178. title: "这里是标题1",
  179. description: "一些描述文案一些描述文案一些描述文案一些描述文案一些描述文案一些描述文案一些描述文案一些描述文案",
  180. position: "bottom"
  181. },
  182. {
  183. target: document.querySelector('#step-2'),
  184. cover: (
  185. <img
  186. alt="example"
  187. height={200}
  188. width={'100%'}
  189. src="https://lf3-static.bytednsdoc.com/obj/eden-cn/ptlz_zlp/ljhwZthlaukjlkulzlp/root-web-sites/card-cover-docs-demo.jpeg"
  190. />
  191. ),
  192. title: "这里是标题2",
  193. description: "这是第二步的说明一些描述文案一些描述文案一些描述文案一些描述文案一些描述文案一些描述文案一些描述文案一些描述文案",
  194. position: "right"
  195. },
  196. {
  197. target: document.querySelector('#step-3'),
  198. title: "这里是标题3",
  199. description: "这是第二步的说明一些描述文案一些描述文案一些描述文案一些描述文案一些描述文案一些描述文案一些描述文案一些描述文案",
  200. position: "bottom"
  201. },
  202. {
  203. target: document.querySelector('#step-4'),
  204. title: "这里是标题4",
  205. description: "这是第二步的说明一些描述文案一些描述文案一些描述文案一些描述文案一些描述文案一些描述文案一些描述文案一些描述文案",
  206. position: "right"
  207. }
  208. ]}
  209. visible={visible}
  210. onFinish={() => {
  211. setVisible(false);
  212. console.log('引导完成')
  213. }}
  214. onSkip={() => {
  215. setVisible(false);
  216. console.log('引导跳过')
  217. }}
  218. />
  219. </div>
  220. );
  221. };
  222. export const NoMask = () => {
  223. const [visible, setVisible] = useState(false);
  224. return (
  225. <div>
  226. <Space spacing='medium'>
  227. <Switch id={'step-1'} defaultChecked={true}/>
  228. <Button id={'step-2'} type="secondary">次要</Button>
  229. <Button id={'step-3'} type="tertiary">第三</Button>
  230. <Button id={'step-4'} type="warning">警告</Button>
  231. </Space>
  232. <div style={{ marginTop: '20px' }}>
  233. <Button onClick={() => setVisible(true)}>显示引导</Button>
  234. </div>
  235. <UserGuide
  236. mode="popup"
  237. theme="primary"
  238. mask={false}
  239. steps={[
  240. {
  241. target: document.querySelector('#step-1'),
  242. cover: (
  243. <img
  244. alt="example"
  245. height={200}
  246. width={'100%'}
  247. src="https://lf3-static.bytednsdoc.com/obj/eden-cn/ptlz_zlp/ljhwZthlaukjlkulzlp/root-web-sites/card-cover-docs-demo.jpeg"
  248. />
  249. ),
  250. title: "这里是标题1",
  251. description: "一些描述文案一些描述文案一些描述文案一些描述文案一些描述文案一些描述文案一些描述文案一些描述文案",
  252. position: "bottom"
  253. },
  254. {
  255. target: document.querySelector('#step-2'),
  256. cover: (
  257. <img
  258. alt="example"
  259. height={200}
  260. width={'100%'}
  261. src="https://lf3-static.bytednsdoc.com/obj/eden-cn/ptlz_zlp/ljhwZthlaukjlkulzlp/root-web-sites/card-cover-docs-demo.jpeg"
  262. />
  263. ),
  264. title: "这里是标题2",
  265. description: "这是第二步的说明一些描述文案一些描述文案一些描述文案一些描述文案一些描述文案一些描述文案一些描述文案一些描述文案",
  266. position: "right"
  267. },
  268. {
  269. target: document.querySelector('#step-3'),
  270. title: "这里是标题3",
  271. description: "这是第二步的说明一些描述文案一些描述文案一些描述文案一些描述文案一些描述文案一些描述文案一些描述文案一些描述文案",
  272. position: "bottom"
  273. },
  274. {
  275. target: document.querySelector('#step-4'),
  276. title: "这里是标题4",
  277. description: "这是第二步的说明一些描述文案一些描述文案一些描述文案一些描述文案一些描述文案一些描述文案一些描述文案一些描述文案",
  278. position: "right"
  279. }
  280. ]}
  281. visible={visible}
  282. onFinish={() => {
  283. setVisible(false);
  284. console.log('引导完成')
  285. }}
  286. onSkip={() => {
  287. setVisible(false);
  288. console.log('引导跳过')
  289. }}
  290. />
  291. </div>
  292. );
  293. };
  294. export const ControlledDemo = () => {
  295. const [visible, setVisible] = useState(false);
  296. const [current, setCurrent] = useState(1);
  297. return (
  298. <div>
  299. <Space spacing='medium'>
  300. <Switch id={'step-1'} defaultChecked={true}/>
  301. <Button id={'step-2'} type="secondary">次要</Button>
  302. <Button id={'step-3'} type="tertiary">第三</Button>
  303. <Button id={'step-4'} type="warning">警告</Button>
  304. </Space>
  305. <div style={{ marginTop: '20px' }}>
  306. <Button onClick={() => setVisible(true)}>显示引导</Button>
  307. </div>
  308. <UserGuide
  309. mode="popup"
  310. theme="primary"
  311. current={current}
  312. steps={[
  313. {
  314. target: document.querySelector('#step-1'),
  315. cover: (
  316. <img
  317. alt="example"
  318. height={200}
  319. width={'100%'}
  320. src="https://lf3-static.bytednsdoc.com/obj/eden-cn/ptlz_zlp/ljhwZthlaukjlkulzlp/root-web-sites/card-cover-docs-demo.jpeg"
  321. />
  322. ),
  323. title: "这里是标题1",
  324. description: "一些描述文案一些描述文案一些描述文案一些描述文案一些描述文案一些描述文案一些描述文案一些描述文案",
  325. position: "bottom"
  326. },
  327. {
  328. target: document.querySelector('#step-2'),
  329. cover: (
  330. <img
  331. alt="example"
  332. height={200}
  333. width={'100%'}
  334. src="https://lf3-static.bytednsdoc.com/obj/eden-cn/ptlz_zlp/ljhwZthlaukjlkulzlp/root-web-sites/card-cover-docs-demo.jpeg"
  335. />
  336. ),
  337. title: "这里是标题2",
  338. description: "这是第二步的说明一些描述文案一些描述文案一些描述文案一些描述文案一些描述文案一些描述文案一些描述文案一些描述文案",
  339. position: "right"
  340. },
  341. {
  342. target: document.querySelector('#step-3'),
  343. title: "这里是标题3",
  344. description: "这是第二步的说明一些描述文案一些描述文案一些描述文案一些描述文案一些描述文案一些描述文案一些描述文案一些描述文案",
  345. position: "bottom"
  346. },
  347. {
  348. target: document.querySelector('#step-4'),
  349. title: "这里是标题4",
  350. description: "这是第二步的说明一些描述文案一些描述文案一些描述文案一些描述文案一些描述文案一些描述文案一些描述文案一些描述文案",
  351. position: "right"
  352. }
  353. ]}
  354. visible={visible}
  355. onPrev={(current) => {
  356. console.log('onPrev', current)
  357. setCurrent(current - 1);
  358. }}
  359. onNext={(current) => {
  360. console.log('onNext', current)
  361. setCurrent(current + 1);
  362. }}
  363. onFinish={(current) => {
  364. console.log('onFinish', current)
  365. setVisible(false);
  366. setCurrent(0);
  367. console.log('引导完成')
  368. }}
  369. onSkip={(current) => {
  370. console.log('onSkip', current)
  371. setVisible(false);
  372. setCurrent(0);
  373. console.log('引导跳过')
  374. }}
  375. onChange={(current) => {
  376. console.log('onChange', current)
  377. console.log('changel', current)
  378. }}
  379. />
  380. </div>
  381. );
  382. };
  383. export const ModalMode = () => {
  384. const [visible, setVisible] = useState(false);
  385. return (
  386. <div>
  387. <Space spacing='medium'>
  388. <Switch id={'step-1'} defaultChecked={true}/>
  389. <Button id={'step-2'} type="secondary">次要</Button>
  390. <Button id={'step-3'} type="tertiary">第三</Button>
  391. <Button id={'step-4'} type="warning">警告</Button>
  392. </Space>
  393. <div style={{ marginTop: '20px' }}>
  394. <Button onClick={() => setVisible(true)}>显示引导</Button>
  395. </div>
  396. <UserGuide
  397. mode="modal"
  398. mask={true}
  399. steps={[
  400. {
  401. cover: (
  402. <img
  403. alt="example"
  404. height={'100%'}
  405. width={'100%'}
  406. src="https://lf3-static.bytednsdoc.com/obj/eden-cn/ptlz_zlp/ljhwZthlaukjlkulzlp/root-web-sites/card-cover-docs-demo.jpeg"
  407. />
  408. ),
  409. title: "这里是标题1",
  410. description: "一些描述文案一些描述文案一些描述文案一些描述文案一些描述文案一些描述文案一些描述文案一些描述文案",
  411. },
  412. {
  413. cover: (
  414. <img
  415. alt="example"
  416. height={'100%'}
  417. width={'100%'}
  418. src="https://lf3-static.bytednsdoc.com/obj/eden-cn/ptlz_zlp/ljhwZthlaukjlkulzlp/root-web-sites/card-cover-docs-demo2.jpeg"
  419. />
  420. ),
  421. title: "这里是标题2",
  422. description: "这是第二步的说明一些描述文案一些描述文案一些描述文案一些描述文案一些描述文案一些描述文案一些描述文案一些描述文案",
  423. },
  424. {
  425. cover: (
  426. <img
  427. alt="example"
  428. height={'100%'}
  429. width={'100%'}
  430. src="https://lf3-static.bytednsdoc.com/obj/eden-cn/ptlz_zlp/ljhwZthlaukjlkulzlp/root-web-sites/card-cover-docs-demo2.jpeg"
  431. />
  432. ),
  433. title: "这里是标题3",
  434. description: "这是第二步的说明一些描述文案一些描述文案一些描述文案一些描述文案一些描述文案一些描述文案一些描述文案一些描述文案",
  435. },
  436. {
  437. cover: (
  438. <img
  439. alt="example"
  440. height={'100%'}
  441. width={'100%'}
  442. src="https://lf3-static.bytednsdoc.com/obj/eden-cn/ptlz_zlp/ljhwZthlaukjlkulzlp/root-web-sites/card-cover-docs-demo2.jpeg"
  443. />
  444. ),
  445. title: "这里是标题4",
  446. description: "这是第二步的说明一些描述文案一些描述文案一些描述文案一些描述文案一些描述文案一些描述文案一些描述文案一些描述文案",
  447. }
  448. ]}
  449. visible={visible}
  450. onFinish={() => {
  451. setVisible(false);
  452. console.log('引导完成')
  453. }}
  454. onSkip={() => {
  455. setVisible(false);
  456. console.log('引导跳过')
  457. }}
  458. />
  459. </div>
  460. );
  461. };
  462. export const CustomButton = () => {
  463. const [visible, setVisible] = useState(false);
  464. return (
  465. <div>
  466. <Space spacing='medium'>
  467. <Switch id={'step-1'} defaultChecked={true}/>
  468. <Button id={'step-2'} type="secondary">次要</Button>
  469. <Button id={'step-3'} type="tertiary">第三</Button>
  470. <Button id={'step-4'} type="warning">警告</Button>
  471. </Space>
  472. <div style={{ marginTop: '20px' }}>
  473. <Button onClick={() => setVisible(true)}>显示引导</Button>
  474. </div>
  475. <UserGuide
  476. mode="popup"
  477. mask={true}
  478. finishText='开始使用'
  479. prevButtonProps={{ theme: 'outline', type: 'primary' }}
  480. steps={[
  481. {
  482. target: document.querySelector('#step-1'),
  483. title: "这里是标题1",
  484. description: "一些描述文案一些描述文案一些描述文案一些描述文案一些描述文案一些描述文案一些描述文案一些描述文案",
  485. position: "bottom"
  486. },
  487. {
  488. target: document.querySelector('#step-2'),
  489. title: "这里是标题2",
  490. description: "这是第二步的说明一些描述文案一些描述文案一些描述文案一些描述文案一些描述文案一些描述文案一些描述文案一些描述文案",
  491. position: "right"
  492. },
  493. ]}
  494. visible={visible}
  495. onFinish={() => {
  496. setVisible(false);
  497. console.log('引导完成')
  498. }}
  499. onSkip={() => {
  500. setVisible(false);
  501. console.log('引导跳过')
  502. }}
  503. />
  504. </div>
  505. );
  506. }
  507. export const MixedTheme = () => {
  508. const [visible, setVisible] = useState(false);
  509. return (
  510. <div>
  511. <Space spacing='medium'>
  512. <Switch id={'step-1'} defaultChecked={true}/>
  513. <Button id={'step-2'} type="secondary">次要</Button>
  514. <Button id={'step-3'} type="tertiary">第三</Button>
  515. <Button id={'step-4'} type="warning">警告</Button>
  516. </Space>
  517. <div style={{ marginTop: '20px' }}>
  518. <Button onClick={() => setVisible(true)}>显示引导</Button>
  519. </div>
  520. <UserGuide
  521. mode="popup"
  522. mask={true}
  523. steps={[
  524. {
  525. target: document.querySelector('#step-1'),
  526. theme: 'primary',
  527. title: "这里是标题1",
  528. description: "一些描述文案",
  529. position: "bottom"
  530. },
  531. {
  532. target: document.querySelector('#step-2'),
  533. title: "这里是标题2",
  534. description: "这是第二步的说明一些描述文案一些描述文案一些描述文案一些描述文案一些描述文案一些描述文案一些描述文案一些描述文案",
  535. position: "right"
  536. },
  537. ]}
  538. visible={visible}
  539. onFinish={() => {
  540. setVisible(false);
  541. console.log('引导完成')
  542. }}
  543. onSkip={() => {
  544. setVisible(false);
  545. console.log('引导跳过')
  546. }}
  547. />
  548. </div>
  549. );
  550. }
  551. export const OneStep = () => {
  552. const [visible, setVisible] = useState(false);
  553. return (
  554. <div>
  555. <Space spacing='medium'>
  556. <Switch id={'step-1'} defaultChecked={true}/>
  557. <Button id={'step-2'} type="secondary">次要</Button>
  558. <Button id={'step-3'} type="tertiary">第三</Button>
  559. <Button id={'step-4'} type="warning">警告</Button>
  560. </Space>
  561. <div style={{ marginTop: '20px' }}>
  562. <Button onClick={() => setVisible(true)}>显示引导</Button>
  563. </div>
  564. <UserGuide
  565. mode="popup"
  566. mask={true}
  567. steps={[
  568. {
  569. target: document.querySelector('#step-1'),
  570. theme: 'primary',
  571. title: "这里是标题",
  572. description: "一些描述文案",
  573. position: "bottom"
  574. }
  575. ]}
  576. visible={visible}
  577. onFinish={() => {
  578. setVisible(false);
  579. console.log('引导完成')
  580. }}
  581. onSkip={() => {
  582. setVisible(false);
  583. console.log('引导跳过')
  584. }}
  585. />
  586. </div>
  587. )
  588. }