@lowdefy/blocks-antd 5.6.0 → 6.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (285) hide show
  1. package/dist/TagPillRow.js +88 -0
  2. package/dist/blocks/Affix/gallery.yaml +399 -0
  3. package/dist/blocks/Affix/tests/Affix.e2e.yaml +72 -0
  4. package/dist/blocks/Affix/tests.yaml +29 -0
  5. package/dist/blocks/Alert/gallery.yaml +701 -0
  6. package/dist/blocks/Alert/tests/Alert.e2e.yaml +161 -0
  7. package/dist/blocks/Alert/tests.yaml +261 -0
  8. package/dist/blocks/AutoComplete/gallery.yaml +713 -0
  9. package/dist/blocks/AutoComplete/tests/AutoComplete.e2e.yaml +330 -0
  10. package/dist/blocks/AutoComplete/tests.yaml +178 -0
  11. package/dist/blocks/Avatar/gallery.yaml +1037 -0
  12. package/dist/blocks/Avatar/tests/Avatar.e2e.yaml +125 -0
  13. package/dist/blocks/Avatar/tests.yaml +76 -0
  14. package/dist/blocks/Badge/gallery.yaml +1090 -0
  15. package/dist/blocks/Badge/tests/Badge.e2e.yaml +195 -0
  16. package/dist/blocks/Badge/tests.yaml +91 -0
  17. package/dist/blocks/Breadcrumb/gallery.yaml +484 -0
  18. package/dist/blocks/Breadcrumb/tests/Breadcrumb.e2e.yaml +165 -0
  19. package/dist/blocks/Breadcrumb/tests.yaml +106 -0
  20. package/dist/blocks/Button/Button.js +11 -2
  21. package/dist/blocks/Button/gallery.yaml +718 -0
  22. package/dist/blocks/Button/meta.js +4 -0
  23. package/dist/blocks/Button/tests/Button.e2e.yaml +246 -0
  24. package/dist/blocks/Button/tests.yaml +109 -0
  25. package/dist/blocks/ButtonSelector/gallery.yaml +891 -0
  26. package/dist/blocks/ButtonSelector/tests/ButtonSelector.e2e.yaml +188 -0
  27. package/dist/blocks/ButtonSelector/tests.yaml +167 -0
  28. package/dist/blocks/Calendar/gallery.yaml +128 -0
  29. package/dist/blocks/Calendar/tests/Calendar.e2e.yaml +136 -0
  30. package/dist/blocks/Calendar/tests.yaml +50 -0
  31. package/dist/blocks/Card/gallery.yaml +1035 -0
  32. package/dist/blocks/Card/tests/Card.e2e.yaml +209 -0
  33. package/dist/blocks/Card/tests.yaml +75 -0
  34. package/dist/blocks/Carousel/gallery.yaml +1971 -0
  35. package/dist/blocks/Carousel/tests/Carousel.e2e.yaml +211 -0
  36. package/dist/blocks/Carousel/tests.yaml +117 -0
  37. package/dist/blocks/CheckboxSelector/gallery.yaml +781 -0
  38. package/dist/blocks/CheckboxSelector/tests/CheckboxSelector.e2e.yaml +272 -0
  39. package/dist/blocks/CheckboxSelector/tests.yaml +325 -0
  40. package/dist/blocks/CheckboxSwitch/gallery.yaml +457 -0
  41. package/dist/blocks/CheckboxSwitch/tests/CheckboxSwitch.e2e.yaml +126 -0
  42. package/dist/blocks/CheckboxSwitch/tests.yaml +96 -0
  43. package/dist/blocks/Collapse/gallery.yaml +1079 -0
  44. package/dist/blocks/Collapse/tests/Collapse.e2e.yaml +206 -0
  45. package/dist/blocks/Collapse/tests.yaml +265 -0
  46. package/dist/blocks/ColorSelector/gallery.yaml +807 -0
  47. package/dist/blocks/ColorSelector/tests/ColorSelector.e2e.yaml +77 -0
  48. package/dist/blocks/ColorSelector/tests.yaml +84 -0
  49. package/dist/blocks/ConfigProvider/gallery.yaml +1003 -0
  50. package/dist/blocks/ConfigProvider/tests.yaml +62 -0
  51. package/dist/blocks/ConfirmModal/gallery.yaml +1043 -0
  52. package/dist/blocks/ConfirmModal/tests/ConfirmModal.e2e.yaml +410 -0
  53. package/dist/blocks/ConfirmModal/tests.yaml +95 -0
  54. package/dist/blocks/Content/gallery.yaml +528 -0
  55. package/dist/blocks/Content/tests/Content.e2e.yaml +71 -0
  56. package/dist/blocks/Content/tests.yaml +42 -0
  57. package/dist/blocks/ControlledList/ControlledList.js +1 -1
  58. package/dist/blocks/ControlledList/gallery.yaml +481 -0
  59. package/dist/blocks/ControlledList/{style.module.css → style.css} +3 -3
  60. package/dist/blocks/ControlledList/tests/ControlledList.e2e.yaml +161 -0
  61. package/dist/blocks/ControlledList/tests.yaml +57 -0
  62. package/dist/blocks/DateRangeSelector/DateRangeSelector.js +7 -0
  63. package/dist/blocks/DateRangeSelector/e2e.js +28 -2
  64. package/dist/blocks/DateRangeSelector/gallery.yaml +858 -0
  65. package/dist/blocks/DateRangeSelector/meta.js +2 -0
  66. package/dist/blocks/DateRangeSelector/tests/DateRangeSelector.e2e.yaml +204 -0
  67. package/dist/blocks/DateRangeSelector/tests.yaml +129 -0
  68. package/dist/blocks/DateSelector/DateSelector.js +6 -0
  69. package/dist/blocks/DateSelector/e2e.js +28 -2
  70. package/dist/blocks/DateSelector/gallery.yaml +691 -0
  71. package/dist/blocks/DateSelector/meta.js +6 -0
  72. package/dist/blocks/DateSelector/tests/DateSelector.e2e.yaml +229 -0
  73. package/dist/blocks/DateSelector/tests.yaml +117 -0
  74. package/dist/blocks/DateTimeSelector/DateTimeSelector.js +7 -0
  75. package/dist/blocks/DateTimeSelector/e2e.js +26 -2
  76. package/dist/blocks/DateTimeSelector/gallery.yaml +770 -0
  77. package/dist/blocks/DateTimeSelector/meta.js +2 -0
  78. package/dist/blocks/DateTimeSelector/tests/DateTimeSelector.e2e.yaml +163 -0
  79. package/dist/blocks/DateTimeSelector/tests.yaml +140 -0
  80. package/dist/blocks/Descriptions/gallery.yaml +839 -0
  81. package/dist/blocks/Descriptions/tests/Descriptions.e2e.yaml +143 -0
  82. package/dist/blocks/Descriptions/tests.yaml +256 -0
  83. package/dist/blocks/Divider/gallery.yaml +375 -0
  84. package/dist/blocks/Divider/tests/Divider.e2e.yaml +107 -0
  85. package/dist/blocks/Divider/tests.yaml +58 -0
  86. package/dist/blocks/Drawer/gallery.yaml +1257 -0
  87. package/dist/blocks/Drawer/tests/Drawer.e2e.yaml +562 -0
  88. package/dist/blocks/Drawer/tests.yaml +80 -0
  89. package/dist/blocks/DropdownButton/gallery.yaml +606 -0
  90. package/dist/blocks/DropdownButton/tests/DropdownButton.e2e.yaml +243 -0
  91. package/dist/blocks/DropdownMenu/gallery.yaml +578 -0
  92. package/dist/blocks/DropdownMenu/tests/DropdownMenu.e2e.yaml +267 -0
  93. package/dist/blocks/Flex/gallery.yaml +1416 -0
  94. package/dist/blocks/Flex/tests/Flex.e2e.yaml +95 -0
  95. package/dist/blocks/Flex/tests.yaml +92 -0
  96. package/dist/blocks/FloatButton/gallery.yaml +518 -0
  97. package/dist/blocks/FloatButton/tests/FloatButton.e2e.yaml +73 -0
  98. package/dist/blocks/FloatButton/tests.yaml +59 -0
  99. package/dist/blocks/Footer/gallery.yaml +355 -0
  100. package/dist/blocks/Footer/tests/Footer.e2e.yaml +70 -0
  101. package/dist/blocks/Footer/tests.yaml +28 -0
  102. package/dist/blocks/Header/gallery.yaml +249 -0
  103. package/dist/blocks/Header/tests/Header.e2e.yaml +77 -0
  104. package/dist/blocks/Header/tests.yaml +36 -0
  105. package/dist/blocks/Label/Label.js +1 -1
  106. package/dist/blocks/Label/gallery.yaml +762 -0
  107. package/dist/blocks/Label/{style.module.css → style.css} +28 -28
  108. package/dist/blocks/Label/tests/Label.e2e.yaml +247 -0
  109. package/dist/blocks/Label/tests.yaml +212 -0
  110. package/dist/blocks/Layout/gallery.yaml +548 -0
  111. package/dist/blocks/Layout/tests/Layout.e2e.yaml +86 -0
  112. package/dist/blocks/Layout/tests.yaml +28 -0
  113. package/dist/blocks/ListSelector/gallery.yaml +223 -0
  114. package/dist/blocks/Masonry/gallery.yaml +989 -0
  115. package/dist/blocks/Masonry/tests/Masonry.e2e.yaml +128 -0
  116. package/dist/blocks/Masonry/tests.yaml +42 -0
  117. package/dist/blocks/MasonryList/gallery.yaml +224 -0
  118. package/dist/blocks/MasonryList/tests/MasonryList.e2e.yaml +55 -0
  119. package/dist/blocks/MasonryList/tests.yaml +42 -0
  120. package/dist/blocks/Menu/gallery.yaml +974 -0
  121. package/dist/blocks/Menu/tests/Menu.e2e.yaml +484 -0
  122. package/dist/blocks/Menu/tests.yaml +1053 -0
  123. package/dist/blocks/Message/gallery.yaml +860 -0
  124. package/dist/blocks/Message/tests/Message.e2e.yaml +246 -0
  125. package/dist/blocks/Message/tests.yaml +54 -0
  126. package/dist/blocks/MobileMenu/gallery.yaml +1172 -0
  127. package/dist/blocks/MobileMenu/tests/MobileMenu.e2e.yaml +314 -0
  128. package/dist/blocks/MobileMenu/tests.yaml +359 -0
  129. package/dist/blocks/Modal/gallery.yaml +1039 -0
  130. package/dist/blocks/Modal/tests/Modal.e2e.yaml +493 -0
  131. package/dist/blocks/Modal/tests.yaml +75 -0
  132. package/dist/blocks/MonthSelector/MonthSelector.js +6 -0
  133. package/dist/blocks/MonthSelector/e2e.js +26 -2
  134. package/dist/blocks/MonthSelector/gallery.yaml +687 -0
  135. package/dist/blocks/MonthSelector/meta.js +6 -0
  136. package/dist/blocks/MonthSelector/tests/MonthSelector.e2e.yaml +167 -0
  137. package/dist/blocks/MonthSelector/tests.yaml +124 -0
  138. package/dist/blocks/MultipleSelector/gallery.yaml +1245 -0
  139. package/dist/blocks/MultipleSelector/tests/MultipleSelector.e2e.yaml +445 -0
  140. package/dist/blocks/MultipleSelector/tests.yaml +201 -0
  141. package/dist/blocks/Notification/gallery.yaml +1376 -0
  142. package/dist/blocks/Notification/tests/Notification.e2e.yaml +362 -0
  143. package/dist/blocks/Notification/tests.yaml +97 -0
  144. package/dist/blocks/NumberInput/gallery.yaml +753 -0
  145. package/dist/blocks/NumberInput/tests/NumberInput.e2e.yaml +228 -0
  146. package/dist/blocks/NumberInput/tests.yaml +116 -0
  147. package/dist/blocks/PageHeaderMenu/PageHeaderMenu.js +1 -1
  148. package/dist/blocks/PageHeaderMenu/gallery.yaml +480 -0
  149. package/dist/blocks/PageHeaderMenu/tests/PageHeaderMenu.e2e.yaml +110 -0
  150. package/dist/blocks/PageHeaderMenu/tests.yaml +173 -0
  151. package/dist/blocks/PageSidebarLayout/PageSidebarLayout.js +10 -1
  152. package/dist/blocks/PageSidebarLayout/gallery.yaml +302 -0
  153. package/dist/blocks/PageSidebarLayout/meta.js +1 -0
  154. package/dist/blocks/PageSidebarLayout/tests/PageSidebarLayout.e2e.yaml +216 -0
  155. package/dist/blocks/PageSidebarLayout/tests.yaml +174 -0
  156. package/dist/blocks/PageSiderMenu/PageSiderMenu.js +1 -1
  157. package/dist/blocks/PageSiderMenu/gallery.yaml +516 -0
  158. package/dist/blocks/PageSiderMenu/tests/PageSiderMenu.e2e.yaml +175 -0
  159. package/dist/blocks/PageSiderMenu/tests.yaml +211 -0
  160. package/dist/blocks/Pagination/gallery.yaml +503 -0
  161. package/dist/blocks/Pagination/tests/Pagination.e2e.yaml +159 -0
  162. package/dist/blocks/Pagination/tests.yaml +80 -0
  163. package/dist/blocks/Paragraph/gallery.yaml +458 -0
  164. package/dist/blocks/Paragraph/tests/Paragraph.e2e.yaml +153 -0
  165. package/dist/blocks/Paragraph/tests.yaml +176 -0
  166. package/dist/blocks/ParagraphInput/gallery.yaml +1483 -0
  167. package/dist/blocks/ParagraphInput/tests/ParagraphInput.e2e.yaml +189 -0
  168. package/dist/blocks/ParagraphInput/tests.yaml +163 -0
  169. package/dist/blocks/PasswordInput/gallery.yaml +420 -0
  170. package/dist/blocks/PasswordInput/tests/PasswordInput.e2e.yaml +188 -0
  171. package/dist/blocks/PasswordInput/tests.yaml +78 -0
  172. package/dist/blocks/PhoneNumberInput/gallery.yaml +677 -0
  173. package/dist/blocks/PhoneNumberInput/tests/PhoneNumberInput.e2e.yaml +279 -0
  174. package/dist/blocks/PhoneNumberInput/tests.yaml +25 -0
  175. package/dist/blocks/Popover/gallery.yaml +1301 -0
  176. package/dist/blocks/Popover/tests/Popover.e2e.yaml +249 -0
  177. package/dist/blocks/Popover/tests.yaml +105 -0
  178. package/dist/blocks/Progress/gallery.yaml +772 -0
  179. package/dist/blocks/Progress/tests/Progress.e2e.yaml +167 -0
  180. package/dist/blocks/Progress/tests.yaml +114 -0
  181. package/dist/blocks/QRCode/gallery.yaml +492 -0
  182. package/dist/blocks/QRCode/tests/QRCode.e2e.yaml +66 -0
  183. package/dist/blocks/QRCode/tests.yaml +113 -0
  184. package/dist/blocks/RadioSelector/gallery.yaml +816 -0
  185. package/dist/blocks/RadioSelector/tests/RadioSelector.e2e.yaml +269 -0
  186. package/dist/blocks/RadioSelector/tests.yaml +339 -0
  187. package/dist/blocks/RatingSlider/gallery.yaml +627 -0
  188. package/dist/blocks/RatingSlider/tests/RatingSlider.e2e.yaml +188 -0
  189. package/dist/blocks/RatingSlider/tests.yaml +116 -0
  190. package/dist/blocks/Result/gallery.yaml +925 -0
  191. package/dist/blocks/Result/tests/Result.e2e.yaml +126 -0
  192. package/dist/blocks/Result/tests.yaml +75 -0
  193. package/dist/blocks/Search/Search.js +1 -1
  194. package/dist/blocks/Search/SearchModal.js +18 -9
  195. package/dist/blocks/Search/gallery.yaml +170 -0
  196. package/dist/blocks/Search/meta.js +2 -1
  197. package/dist/blocks/Search/{style.module.css → style.css} +19 -12
  198. package/dist/blocks/Search/tests/Search.e2e.yaml +125 -0
  199. package/dist/blocks/Search/useSearchIndex.js +24 -2
  200. package/dist/blocks/SegmentedSelector/gallery.yaml +725 -0
  201. package/dist/blocks/SegmentedSelector/tests/SegmentedSelector.e2e.yaml +115 -0
  202. package/dist/blocks/SegmentedSelector/tests.yaml +141 -0
  203. package/dist/blocks/Selector/gallery.yaml +1055 -0
  204. package/dist/blocks/Selector/tests/Selector.e2e.yaml +427 -0
  205. package/dist/blocks/Selector/tests.yaml +196 -0
  206. package/dist/blocks/Sider/gallery.yaml +994 -0
  207. package/dist/blocks/Sider/tests/Sider.e2e.yaml +162 -0
  208. package/dist/blocks/Sider/tests.yaml +20 -0
  209. package/dist/blocks/Slider/gallery.yaml +600 -0
  210. package/dist/blocks/Slider/tests/Slider.e2e.yaml +190 -0
  211. package/dist/blocks/Slider/tests.yaml +68 -0
  212. package/dist/blocks/Splitter/gallery.yaml +1511 -0
  213. package/dist/blocks/Splitter/tests/Splitter.e2e.yaml +114 -0
  214. package/dist/blocks/Splitter/tests.yaml +79 -0
  215. package/dist/blocks/Statistic/gallery.yaml +460 -0
  216. package/dist/blocks/Statistic/tests/Statistic.e2e.yaml +137 -0
  217. package/dist/blocks/Statistic/tests.yaml +77 -0
  218. package/dist/blocks/Steps/gallery.yaml +550 -0
  219. package/dist/blocks/Switch/gallery.yaml +502 -0
  220. package/dist/blocks/Switch/tests/Switch.e2e.yaml +132 -0
  221. package/dist/blocks/Switch/tests.yaml +87 -0
  222. package/dist/blocks/Tabs/gallery.yaml +1353 -0
  223. package/dist/blocks/Tabs/tests/Tabs.e2e.yaml +370 -0
  224. package/dist/blocks/Tabs/tests.yaml +349 -0
  225. package/dist/blocks/Tag/gallery.yaml +598 -0
  226. package/dist/blocks/Tag/tests/Tag.e2e.yaml +173 -0
  227. package/dist/blocks/Tag/tests.yaml +51 -0
  228. package/dist/blocks/TagMultipleSelector/TagMultipleSelector.js +53 -0
  229. package/dist/blocks/TagMultipleSelector/e2e.js +36 -0
  230. package/dist/blocks/TagMultipleSelector/gallery.yaml +70 -0
  231. package/dist/blocks/TagMultipleSelector/meta.js +91 -0
  232. package/dist/blocks/TagMultipleSelector/tests/TagMultipleSelector.e2e.yaml +93 -0
  233. package/dist/blocks/TagSelector/TagSelector.js +49 -0
  234. package/dist/blocks/TagSelector/e2e.js +36 -0
  235. package/dist/blocks/TagSelector/gallery.yaml +70 -0
  236. package/dist/blocks/TagSelector/meta.js +91 -0
  237. package/dist/blocks/TagSelector/tests/TagSelector.e2e.yaml +93 -0
  238. package/dist/blocks/TextArea/gallery.yaml +618 -0
  239. package/dist/blocks/TextArea/tests/TextArea.e2e.yaml +218 -0
  240. package/dist/blocks/TextArea/tests.yaml +100 -0
  241. package/dist/blocks/TextInput/gallery.yaml +560 -0
  242. package/dist/blocks/TextInput/tests/TextInput.e2e.yaml +287 -0
  243. package/dist/blocks/TextInput/tests.yaml +114 -0
  244. package/dist/blocks/TimelineList/gallery.yaml +431 -0
  245. package/dist/blocks/TimelineList/tests/TimelineList.e2e.yaml +244 -0
  246. package/dist/blocks/TimelineList/tests.yaml +251 -0
  247. package/dist/blocks/Title/gallery.yaml +483 -0
  248. package/dist/blocks/Title/tests/Title.e2e.yaml +180 -0
  249. package/dist/blocks/Title/tests.yaml +175 -0
  250. package/dist/blocks/TitleInput/gallery.yaml +1006 -0
  251. package/dist/blocks/TitleInput/tests/TitleInput.e2e.yaml +195 -0
  252. package/dist/blocks/TitleInput/tests.yaml +181 -0
  253. package/dist/blocks/Tooltip/gallery.yaml +1214 -0
  254. package/dist/blocks/Tooltip/tests/Tooltip.e2e.yaml +195 -0
  255. package/dist/blocks/Tooltip/tests.yaml +92 -0
  256. package/dist/blocks/Tour/gallery.yaml +2305 -0
  257. package/dist/blocks/Tour/tests/Tour.e2e.yaml +90 -0
  258. package/dist/blocks/Tour/tests.yaml +151 -0
  259. package/dist/blocks/TreeInput/gallery.yaml +78 -0
  260. package/dist/blocks/TreeInput/tests/TreeInput.e2e.yaml +139 -0
  261. package/dist/blocks/TreeInput/tests.yaml +140 -0
  262. package/dist/blocks/TreeMultipleSelector/gallery.yaml +67 -0
  263. package/dist/blocks/TreeSelector/gallery.yaml +81 -0
  264. package/dist/blocks/Watermark/gallery.yaml +479 -0
  265. package/dist/blocks/Watermark/tests/Watermark.e2e.yaml +62 -0
  266. package/dist/blocks/Watermark/tests.yaml +86 -0
  267. package/dist/blocks/WeekSelector/WeekSelector.js +6 -0
  268. package/dist/blocks/WeekSelector/e2e.js +26 -2
  269. package/dist/blocks/WeekSelector/gallery.yaml +589 -0
  270. package/dist/blocks/WeekSelector/meta.js +6 -0
  271. package/dist/blocks/WeekSelector/tests/WeekSelector.e2e.yaml +154 -0
  272. package/dist/blocks/WeekSelector/tests.yaml +122 -0
  273. package/dist/blocks.js +2 -0
  274. package/dist/disabledDate.js +91 -19
  275. package/dist/e2e.js +2 -0
  276. package/dist/getPresets.js +151 -0
  277. package/dist/getTagColor.js +44 -0
  278. package/dist/getTagSelectorOptions.js +30 -0
  279. package/dist/metas.js +2 -0
  280. package/dist/pickerPresetsStyle.css +26 -0
  281. package/dist/schemas/disabledDates.js +6 -2
  282. package/dist/schemas/index.js +1 -0
  283. package/dist/schemas/presets.js +111 -0
  284. package/dist/tagSelectorStyle.css +68 -0
  285. package/package.json +13 -13
@@ -0,0 +1,2305 @@
1
+ # Copyright 2020-2026 Lowdefy, Inc
2
+
3
+ # Licensed under the Apache License, Version 2.0 (the "License");
4
+ # you may not use this file except in compliance with the License.
5
+ # You may obtain a copy of the License at
6
+
7
+ # http://www.apache.org/licenses/LICENSE-2.0
8
+
9
+ # Unless required by applicable law or agreed to in writing, software
10
+ # distributed under the License is distributed on an "AS IS" BASIS,
11
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12
+ # See the License for the specific language governing permissions and
13
+ # limitations under the License.
14
+
15
+ - title: Basic Tour with Steps
16
+ blocks:
17
+ - id: basic_btns_row
18
+ type: Box
19
+ layout:
20
+ gap: 8
21
+ blocks:
22
+ - id: basic_steps_start_btn
23
+ type: Button
24
+ layout:
25
+ flex: 0 0 auto
26
+ properties:
27
+ title: 3 Steps
28
+ color: primary
29
+ variant: outlined
30
+ size: small
31
+ events:
32
+ onClick:
33
+ - id: basic_steps_start
34
+ type: SetState
35
+ params:
36
+ basic_steps_tour_open: true
37
+ - id: basic_single_step_start_btn
38
+ type: Button
39
+ layout:
40
+ flex: 0 0 auto
41
+ properties:
42
+ title: Single Step
43
+ color: primary
44
+ variant: outlined
45
+ size: small
46
+ events:
47
+ onClick:
48
+ - id: basic_single_step_start
49
+ type: SetState
50
+ params:
51
+ basic_single_step_tour_open: true
52
+ - id: basic_detailed_start_btn
53
+ type: Button
54
+ layout:
55
+ flex: 0 0 auto
56
+ properties:
57
+ title: 5 Steps
58
+ color: primary
59
+ variant: outlined
60
+ size: small
61
+ events:
62
+ onClick:
63
+ - id: basic_detailed_start
64
+ type: SetState
65
+ params:
66
+ basic_detailed_tour_open: true
67
+ - id: basic_steps_tour
68
+ type: Tour
69
+ properties:
70
+ open:
71
+ _state: basic_steps_tour_open
72
+ steps:
73
+ - title: Welcome
74
+ description: This is the first step of the tour.
75
+ - title: Explore Features
76
+ description: Discover the key features available in the dashboard.
77
+ - title: Get Started
78
+ description: You are all set to begin using the application.
79
+ events:
80
+ onClose:
81
+ - id: basic_steps_tour_close
82
+ type: SetState
83
+ params:
84
+ basic_steps_tour_open: false
85
+ onFinish:
86
+ - id: basic_steps_tour_finish
87
+ type: SetState
88
+ params:
89
+ basic_steps_tour_open: false
90
+ - id: basic_single_step_tour
91
+ type: Tour
92
+ properties:
93
+ open:
94
+ _state: basic_single_step_tour_open
95
+ steps:
96
+ - title: Quick Tip
97
+ description: A single-step tour works well for brief announcements.
98
+ events:
99
+ onClose:
100
+ - id: basic_single_step_tour_close
101
+ type: SetState
102
+ params:
103
+ basic_single_step_tour_open: false
104
+ onFinish:
105
+ - id: basic_single_step_tour_finish
106
+ type: SetState
107
+ params:
108
+ basic_single_step_tour_open: false
109
+ - id: basic_detailed_tour
110
+ type: Tour
111
+ properties:
112
+ open:
113
+ _state: basic_detailed_tour_open
114
+ steps:
115
+ - title: Step 1 of 5
116
+ description: Tours support many steps for longer walkthroughs.
117
+ - title: Step 2 of 5
118
+ description: Each step can have its own title and description.
119
+ - title: Step 3 of 5
120
+ description: Users navigate with Next and Previous buttons.
121
+ - title: Step 4 of 5
122
+ description: Steps are zero-indexed internally.
123
+ - title: Step 5 of 5
124
+ description: The last step shows a Finish button instead of Next.
125
+ events:
126
+ onClose:
127
+ - id: basic_detailed_tour_close
128
+ type: SetState
129
+ params:
130
+ basic_detailed_tour_open: false
131
+ onFinish:
132
+ - id: basic_detailed_tour_finish
133
+ type: SetState
134
+ params:
135
+ basic_detailed_tour_open: false
136
+
137
+ - title: Tour Types
138
+ blocks:
139
+ - id: type_btns_row
140
+ type: Box
141
+ layout:
142
+ gap: 8
143
+ blocks:
144
+ - id: type_default_start_btn
145
+ type: Button
146
+ layout:
147
+ flex: 0 0 auto
148
+ properties:
149
+ title: Default
150
+ color: primary
151
+ variant: outlined
152
+ size: small
153
+ events:
154
+ onClick:
155
+ - id: type_default_start
156
+ type: SetState
157
+ params:
158
+ type_default_tour_open: true
159
+ - id: type_primary_start_btn
160
+ type: Button
161
+ layout:
162
+ flex: 0 0 auto
163
+ properties:
164
+ title: Primary
165
+ color: primary
166
+ variant: outlined
167
+ size: small
168
+ events:
169
+ onClick:
170
+ - id: type_primary_start
171
+ type: SetState
172
+ params:
173
+ type_primary_tour_open: true
174
+ - id: type_per_step_start_btn
175
+ type: Button
176
+ layout:
177
+ flex: 0 0 auto
178
+ properties:
179
+ title: Per Step
180
+ color: primary
181
+ variant: outlined
182
+ size: small
183
+ events:
184
+ onClick:
185
+ - id: type_per_step_start
186
+ type: SetState
187
+ params:
188
+ type_per_step_tour_open: true
189
+ - id: type_default_tour
190
+ type: Tour
191
+ properties:
192
+ open:
193
+ _state: type_default_tour_open
194
+ type: default
195
+ steps:
196
+ - title: Default Type
197
+ description: Light background with dark text. Blends naturally with light-themed interfaces.
198
+ - title: Subtle Guidance
199
+ description: The default type is understated, ideal for non-intrusive tours.
200
+ events:
201
+ onClose:
202
+ - id: type_default_tour_close
203
+ type: SetState
204
+ params:
205
+ type_default_tour_open: false
206
+ onFinish:
207
+ - id: type_default_tour_finish
208
+ type: SetState
209
+ params:
210
+ type_default_tour_open: false
211
+ - id: type_primary_tour
212
+ type: Tour
213
+ properties:
214
+ open:
215
+ _state: type_primary_tour_open
216
+ type: primary
217
+ steps:
218
+ - title: Primary Type
219
+ description: Bold colored background using the theme primary color.
220
+ - title: High Visibility
221
+ description: Primary tours draw attention and suit critical onboarding flows.
222
+ events:
223
+ onClose:
224
+ - id: type_primary_tour_close
225
+ type: SetState
226
+ params:
227
+ type_primary_tour_open: false
228
+ onFinish:
229
+ - id: type_primary_tour_finish
230
+ type: SetState
231
+ params:
232
+ type_primary_tour_open: false
233
+ - id: type_per_step_row
234
+ type: Box
235
+ layout:
236
+ gap: 16
237
+ blocks:
238
+ - id: type_per_step_btn_1
239
+ type: Button
240
+ layout:
241
+ flex: 0 0 auto
242
+ properties:
243
+ title: Introduction
244
+ color: default
245
+ variant: outlined
246
+ - id: type_per_step_btn_2
247
+ type: Button
248
+ layout:
249
+ flex: 0 0 auto
250
+ properties:
251
+ title: Key Feature
252
+ color: primary
253
+ variant: solid
254
+ - id: type_per_step_tour
255
+ type: Tour
256
+ properties:
257
+ open:
258
+ _state: type_per_step_tour_open
259
+ type: default
260
+ steps:
261
+ - title: Introduction
262
+ description: This step inherits the default type from the tour.
263
+ target: type_per_step_btn_1
264
+ type: default
265
+ - title: Key Feature
266
+ description: This step overrides to primary to draw extra attention.
267
+ target: type_per_step_btn_2
268
+ type: primary
269
+ events:
270
+ onClose:
271
+ - id: type_per_step_tour_close
272
+ type: SetState
273
+ params:
274
+ type_per_step_tour_open: false
275
+ onFinish:
276
+ - id: type_per_step_tour_finish
277
+ type: SetState
278
+ params:
279
+ type_per_step_tour_open: false
280
+
281
+ - title: Targeted Steps
282
+ blocks:
283
+ - id: target_btns_row
284
+ type: Box
285
+ layout:
286
+ gap: 8
287
+ blocks:
288
+ - id: target_tour_start_btn
289
+ type: Button
290
+ layout:
291
+ flex: 0 0 auto
292
+ properties:
293
+ title: Button Targets
294
+ color: primary
295
+ variant: outlined
296
+ size: small
297
+ events:
298
+ onClick:
299
+ - id: target_tour_start
300
+ type: SetState
301
+ params:
302
+ target_tour_open: true
303
+ - id: target_mixed_tour_start_btn
304
+ type: Button
305
+ layout:
306
+ flex: 0 0 auto
307
+ properties:
308
+ title: Mixed Targets
309
+ color: primary
310
+ variant: outlined
311
+ size: small
312
+ events:
313
+ onClick:
314
+ - id: target_mixed_tour_start
315
+ type: SetState
316
+ params:
317
+ target_mixed_tour_open: true
318
+ - id: target_row
319
+ type: Box
320
+ layout:
321
+ gap: 16
322
+ blocks:
323
+ - id: target_upload_btn
324
+ type: Button
325
+ layout:
326
+ flex: 0 0 auto
327
+ properties:
328
+ title: Upload
329
+ color: primary
330
+ variant: solid
331
+ icon: AiOutlineUpload
332
+ - id: target_save_btn
333
+ type: Button
334
+ layout:
335
+ flex: 0 0 auto
336
+ properties:
337
+ title: Save Draft
338
+ color: green
339
+ variant: outlined
340
+ icon: AiOutlineSave
341
+ - id: target_share_btn
342
+ type: Button
343
+ layout:
344
+ flex: 0 0 auto
345
+ properties:
346
+ title: Share
347
+ color: purple
348
+ variant: solid
349
+ icon: AiOutlineShareAlt
350
+ - id: target_tour
351
+ type: Tour
352
+ properties:
353
+ open:
354
+ _state: target_tour_open
355
+ steps:
356
+ - title: Upload Files
357
+ description: Click here to upload documents or images to the workspace.
358
+ target: target_upload_btn
359
+ - title: Save Progress
360
+ description: Save your current work as a draft to continue later.
361
+ target: target_save_btn
362
+ - title: Share with Team
363
+ description: Share your work with team members via link or invitation.
364
+ target: target_share_btn
365
+ events:
366
+ onClose:
367
+ - id: target_tour_close
368
+ type: SetState
369
+ params:
370
+ target_tour_open: false
371
+ onFinish:
372
+ - id: target_tour_finish
373
+ type: SetState
374
+ params:
375
+ target_tour_open: false
376
+ - id: target_mixed_row
377
+ type: Box
378
+ layout:
379
+ gap: 16
380
+ align: center
381
+ blocks:
382
+ - id: target_mixed_input
383
+ type: TextInput
384
+ layout:
385
+ flex: 0 0 240px
386
+ properties:
387
+ label:
388
+ disabled: true
389
+ placeholder: Search...
390
+ - id: target_mixed_switch
391
+ type: Switch
392
+ layout:
393
+ flex: 0 0 auto
394
+ properties:
395
+ label:
396
+ disabled: true
397
+ - id: target_mixed_tour
398
+ type: Tour
399
+ properties:
400
+ open:
401
+ _state: target_mixed_tour_open
402
+ steps:
403
+ - title: Search Bar
404
+ description: Use the search bar to quickly find items.
405
+ target: target_mixed_input
406
+ - title: Toggle Setting
407
+ description: Toggle this switch to enable or disable notifications.
408
+ target: target_mixed_switch
409
+ events:
410
+ onClose:
411
+ - id: target_mixed_tour_close
412
+ type: SetState
413
+ params:
414
+ target_mixed_tour_open: false
415
+ onFinish:
416
+ - id: target_mixed_tour_finish
417
+ type: SetState
418
+ params:
419
+ target_mixed_tour_open: false
420
+
421
+ - title: Placement
422
+ blocks:
423
+ - id: placement_btns_row
424
+ type: Box
425
+ layout:
426
+ gap: 8
427
+ blocks:
428
+ - id: placement_tour_start_btn
429
+ type: Button
430
+ layout:
431
+ flex: 0 0 auto
432
+ properties:
433
+ title: Cardinal
434
+ color: primary
435
+ variant: outlined
436
+ size: small
437
+ events:
438
+ onClick:
439
+ - id: placement_tour_start
440
+ type: SetState
441
+ params:
442
+ placement_tour_open: true
443
+ - id: placement_fine_start_btn
444
+ type: Button
445
+ layout:
446
+ flex: 0 0 auto
447
+ properties:
448
+ title: Fine Placement
449
+ color: primary
450
+ variant: outlined
451
+ size: small
452
+ events:
453
+ onClick:
454
+ - id: placement_fine_start
455
+ type: SetState
456
+ params:
457
+ placement_fine_tour_open: true
458
+ - id: placement_level_start_btn
459
+ type: Button
460
+ layout:
461
+ flex: 0 0 auto
462
+ properties:
463
+ title: Tour-Level
464
+ color: primary
465
+ variant: outlined
466
+ size: small
467
+ events:
468
+ onClick:
469
+ - id: placement_level_start
470
+ type: SetState
471
+ params:
472
+ placement_tour_level_open: true
473
+ - id: placement_row
474
+ type: Box
475
+ layout:
476
+ gap: 16
477
+ justify: center
478
+ blocks:
479
+ - id: placement_top_btn
480
+ type: Button
481
+ layout:
482
+ flex: 0 0 auto
483
+ properties:
484
+ title: Top
485
+ color: primary
486
+ variant: outlined
487
+ - id: placement_right_btn
488
+ type: Button
489
+ layout:
490
+ flex: 0 0 auto
491
+ properties:
492
+ title: Right
493
+ color: green
494
+ variant: outlined
495
+ - id: placement_bottom_btn
496
+ type: Button
497
+ layout:
498
+ flex: 0 0 auto
499
+ properties:
500
+ title: Bottom
501
+ color: purple
502
+ variant: outlined
503
+ - id: placement_left_btn
504
+ type: Button
505
+ layout:
506
+ flex: 0 0 auto
507
+ properties:
508
+ title: Left
509
+ color: orange
510
+ variant: outlined
511
+ - id: placement_tour
512
+ type: Tour
513
+ properties:
514
+ open:
515
+ _state: placement_tour_open
516
+ steps:
517
+ - title: Top Placement
518
+ description: Guide card appears above the target element.
519
+ target: placement_top_btn
520
+ placement: top
521
+ - title: Right Placement
522
+ description: Guide card appears to the right of the target.
523
+ target: placement_right_btn
524
+ placement: right
525
+ - title: Bottom Placement
526
+ description: Guide card appears below the target element.
527
+ target: placement_bottom_btn
528
+ placement: bottom
529
+ - title: Left Placement
530
+ description: Guide card appears to the left of the target.
531
+ target: placement_left_btn
532
+ placement: left
533
+ events:
534
+ onClose:
535
+ - id: placement_tour_close
536
+ type: SetState
537
+ params:
538
+ placement_tour_open: false
539
+ onFinish:
540
+ - id: placement_tour_finish
541
+ type: SetState
542
+ params:
543
+ placement_tour_open: false
544
+ - id: placement_fine_tour
545
+ type: Tour
546
+ properties:
547
+ open:
548
+ _state: placement_fine_tour_open
549
+ steps:
550
+ - title: Top Left
551
+ description: Aligned to the top-left corner of the target.
552
+ placement: topLeft
553
+ - title: Bottom Right
554
+ description: Aligned to the bottom-right corner of the target.
555
+ placement: bottomRight
556
+ - title: Right Top
557
+ description: On the right side, aligned to the top.
558
+ placement: rightTop
559
+ events:
560
+ onClose:
561
+ - id: placement_fine_tour_close
562
+ type: SetState
563
+ params:
564
+ placement_fine_tour_open: false
565
+ onFinish:
566
+ - id: placement_fine_tour_finish
567
+ type: SetState
568
+ params:
569
+ placement_fine_tour_open: false
570
+ - id: placement_tour_level
571
+ type: Tour
572
+ properties:
573
+ open:
574
+ _state: placement_tour_level_open
575
+ placement: bottom
576
+ steps:
577
+ - title: Tour-Level Placement
578
+ description: Setting placement on the tour applies to all steps by default.
579
+ - title: Consistent Position
580
+ description: All steps appear below the target unless overridden at the step level.
581
+ events:
582
+ onClose:
583
+ - id: placement_tour_level_close
584
+ type: SetState
585
+ params:
586
+ placement_tour_level_open: false
587
+ onFinish:
588
+ - id: placement_tour_level_finish
589
+ type: SetState
590
+ params:
591
+ placement_tour_level_open: false
592
+
593
+ - title: Mask Configuration
594
+ blocks:
595
+ - id: mask_btns_row
596
+ type: Box
597
+ layout:
598
+ gap: 8
599
+ blocks:
600
+ - id: mask_enabled_start_btn
601
+ type: Button
602
+ layout:
603
+ flex: 0 0 auto
604
+ properties:
605
+ title: Mask On
606
+ color: primary
607
+ variant: outlined
608
+ size: small
609
+ events:
610
+ onClick:
611
+ - id: mask_enabled_start
612
+ type: SetState
613
+ params:
614
+ mask_enabled_tour_open: true
615
+ - id: mask_disabled_start_btn
616
+ type: Button
617
+ layout:
618
+ flex: 0 0 auto
619
+ properties:
620
+ title: Mask Off
621
+ color: primary
622
+ variant: outlined
623
+ size: small
624
+ events:
625
+ onClick:
626
+ - id: mask_disabled_start
627
+ type: SetState
628
+ params:
629
+ mask_disabled_tour_open: true
630
+ - id: mask_custom_start_btn
631
+ type: Button
632
+ layout:
633
+ flex: 0 0 auto
634
+ properties:
635
+ title: Custom Mask
636
+ color: primary
637
+ variant: outlined
638
+ size: small
639
+ events:
640
+ onClick:
641
+ - id: mask_custom_start
642
+ type: SetState
643
+ params:
644
+ mask_custom_tour_open: true
645
+ - id: mask_per_step_start_btn
646
+ type: Button
647
+ layout:
648
+ flex: 0 0 auto
649
+ properties:
650
+ title: Per Step
651
+ color: primary
652
+ variant: outlined
653
+ size: small
654
+ events:
655
+ onClick:
656
+ - id: mask_per_step_start
657
+ type: SetState
658
+ params:
659
+ mask_per_step_tour_open: true
660
+ - id: mask_row
661
+ type: Box
662
+ layout:
663
+ gap: 16
664
+ blocks:
665
+ - id: mask_target_btn
666
+ type: Button
667
+ layout:
668
+ flex: 0 0 auto
669
+ properties:
670
+ title: Masked Target
671
+ color: primary
672
+ variant: solid
673
+ - id: mask_enabled_tour
674
+ type: Tour
675
+ properties:
676
+ open:
677
+ _state: mask_enabled_tour_open
678
+ mask: true
679
+ steps:
680
+ - title: Mask Enabled
681
+ description: The background is dimmed, drawing focus to the tour card.
682
+ target: mask_target_btn
683
+ events:
684
+ onClose:
685
+ - id: mask_enabled_tour_close
686
+ type: SetState
687
+ params:
688
+ mask_enabled_tour_open: false
689
+ onFinish:
690
+ - id: mask_enabled_tour_finish
691
+ type: SetState
692
+ params:
693
+ mask_enabled_tour_open: false
694
+ - id: mask_disabled_tour
695
+ type: Tour
696
+ properties:
697
+ open:
698
+ _state: mask_disabled_tour_open
699
+ mask: false
700
+ steps:
701
+ - title: Mask Disabled
702
+ description: No overlay is shown. The page remains fully visible and interactive.
703
+ events:
704
+ onClose:
705
+ - id: mask_disabled_tour_close
706
+ type: SetState
707
+ params:
708
+ mask_disabled_tour_open: false
709
+ onFinish:
710
+ - id: mask_disabled_tour_finish
711
+ type: SetState
712
+ params:
713
+ mask_disabled_tour_open: false
714
+ - id: mask_custom_tour
715
+ type: Tour
716
+ style:
717
+ .mask:
718
+ boxShadow: inset 0 0 15px #333
719
+ properties:
720
+ open:
721
+ _state: mask_custom_tour_open
722
+ mask:
723
+ color: rgba(80, 0, 130, 0.5)
724
+ steps:
725
+ - title: Custom Mask
726
+ description: A purple-tinted overlay with an inner shadow effect.
727
+ target: mask_target_btn
728
+ events:
729
+ onClose:
730
+ - id: mask_custom_tour_close
731
+ type: SetState
732
+ params:
733
+ mask_custom_tour_open: false
734
+ onFinish:
735
+ - id: mask_custom_tour_finish
736
+ type: SetState
737
+ params:
738
+ mask_custom_tour_open: false
739
+ - id: mask_per_step_row
740
+ type: Box
741
+ layout:
742
+ gap: 16
743
+ blocks:
744
+ - id: mask_per_step_btn_1
745
+ type: Button
746
+ layout:
747
+ flex: 0 0 auto
748
+ properties:
749
+ title: Masked Step
750
+ color: primary
751
+ variant: solid
752
+ - id: mask_per_step_btn_2
753
+ type: Button
754
+ layout:
755
+ flex: 0 0 auto
756
+ properties:
757
+ title: Unmasked Step
758
+ color: default
759
+ variant: outlined
760
+ - id: mask_per_step_tour
761
+ type: Tour
762
+ properties:
763
+ open:
764
+ _state: mask_per_step_tour_open
765
+ mask: true
766
+ steps:
767
+ - title: Masked
768
+ description: This step shows the mask overlay.
769
+ target: mask_per_step_btn_1
770
+ mask: true
771
+ - title: Unmasked
772
+ description: This step hides the mask for a clear view.
773
+ target: mask_per_step_btn_2
774
+ mask: false
775
+ events:
776
+ onClose:
777
+ - id: mask_per_step_tour_close
778
+ type: SetState
779
+ params:
780
+ mask_per_step_tour_open: false
781
+ onFinish:
782
+ - id: mask_per_step_tour_finish
783
+ type: SetState
784
+ params:
785
+ mask_per_step_tour_open: false
786
+
787
+ - title: Arrow Configuration
788
+ blocks:
789
+ - id: arrow_btns_row
790
+ type: Box
791
+ layout:
792
+ gap: 8
793
+ blocks:
794
+ - id: arrow_enabled_start_btn
795
+ type: Button
796
+ layout:
797
+ flex: 0 0 auto
798
+ properties:
799
+ title: Arrow On
800
+ color: primary
801
+ variant: outlined
802
+ size: small
803
+ events:
804
+ onClick:
805
+ - id: arrow_enabled_start
806
+ type: SetState
807
+ params:
808
+ arrow_enabled_tour_open: true
809
+ - id: arrow_disabled_start_btn
810
+ type: Button
811
+ layout:
812
+ flex: 0 0 auto
813
+ properties:
814
+ title: Arrow Off
815
+ color: primary
816
+ variant: outlined
817
+ size: small
818
+ events:
819
+ onClick:
820
+ - id: arrow_disabled_start
821
+ type: SetState
822
+ params:
823
+ arrow_disabled_tour_open: true
824
+ - id: arrow_centered_start_btn
825
+ type: Button
826
+ layout:
827
+ flex: 0 0 auto
828
+ properties:
829
+ title: Centered
830
+ color: primary
831
+ variant: outlined
832
+ size: small
833
+ events:
834
+ onClick:
835
+ - id: arrow_centered_start
836
+ type: SetState
837
+ params:
838
+ arrow_centered_tour_open: true
839
+ - id: arrow_per_step_start_btn
840
+ type: Button
841
+ layout:
842
+ flex: 0 0 auto
843
+ properties:
844
+ title: Per Step
845
+ color: primary
846
+ variant: outlined
847
+ size: small
848
+ events:
849
+ onClick:
850
+ - id: arrow_per_step_start
851
+ type: SetState
852
+ params:
853
+ arrow_per_step_tour_open: true
854
+ - id: arrow_enabled_tour
855
+ type: Tour
856
+ properties:
857
+ open:
858
+ _state: arrow_enabled_tour_open
859
+ arrow: true
860
+ steps:
861
+ - title: Arrow Visible
862
+ description: An arrow points from the guide card toward the target element.
863
+ - title: Visual Connection
864
+ description: Arrows help users understand which element the step references.
865
+ events:
866
+ onClose:
867
+ - id: arrow_enabled_tour_close
868
+ type: SetState
869
+ params:
870
+ arrow_enabled_tour_open: false
871
+ onFinish:
872
+ - id: arrow_enabled_tour_finish
873
+ type: SetState
874
+ params:
875
+ arrow_enabled_tour_open: false
876
+ - id: arrow_disabled_tour
877
+ type: Tour
878
+ properties:
879
+ open:
880
+ _state: arrow_disabled_tour_open
881
+ arrow: false
882
+ steps:
883
+ - title: No Arrow
884
+ description: Without arrows, the guide card appears as a clean floating panel.
885
+ events:
886
+ onClose:
887
+ - id: arrow_disabled_tour_close
888
+ type: SetState
889
+ params:
890
+ arrow_disabled_tour_open: false
891
+ onFinish:
892
+ - id: arrow_disabled_tour_finish
893
+ type: SetState
894
+ params:
895
+ arrow_disabled_tour_open: false
896
+ - id: arrow_centered_tour
897
+ type: Tour
898
+ properties:
899
+ open:
900
+ _state: arrow_centered_tour_open
901
+ arrow:
902
+ pointAtCenter: true
903
+ steps:
904
+ - title: Centered Arrow
905
+ description: The arrow points precisely at the center of the target element.
906
+ events:
907
+ onClose:
908
+ - id: arrow_centered_tour_close
909
+ type: SetState
910
+ params:
911
+ arrow_centered_tour_open: false
912
+ onFinish:
913
+ - id: arrow_centered_tour_finish
914
+ type: SetState
915
+ params:
916
+ arrow_centered_tour_open: false
917
+ - id: arrow_per_step_row
918
+ type: Box
919
+ layout:
920
+ gap: 16
921
+ blocks:
922
+ - id: arrow_per_step_btn_1
923
+ type: Button
924
+ layout:
925
+ flex: 0 0 auto
926
+ properties:
927
+ title: With Arrow
928
+ color: primary
929
+ variant: solid
930
+ - id: arrow_per_step_btn_2
931
+ type: Button
932
+ layout:
933
+ flex: 0 0 auto
934
+ properties:
935
+ title: Centered Arrow
936
+ color: green
937
+ variant: solid
938
+ - id: arrow_per_step_tour
939
+ type: Tour
940
+ properties:
941
+ open:
942
+ _state: arrow_per_step_tour_open
943
+ steps:
944
+ - title: Default Arrow
945
+ description: This step shows the default arrow.
946
+ target: arrow_per_step_btn_1
947
+ arrow: true
948
+ - title: Centered Arrow
949
+ description: This step points the arrow at the center of the target.
950
+ target: arrow_per_step_btn_2
951
+ arrow:
952
+ pointAtCenter: true
953
+ events:
954
+ onClose:
955
+ - id: arrow_per_step_tour_close
956
+ type: SetState
957
+ params:
958
+ arrow_per_step_tour_open: false
959
+ onFinish:
960
+ - id: arrow_per_step_tour_finish
961
+ type: SetState
962
+ params:
963
+ arrow_per_step_tour_open: false
964
+
965
+ - title: Cover Images
966
+ blocks:
967
+ - id: cover_btns_row
968
+ type: Box
969
+ layout:
970
+ gap: 8
971
+ blocks:
972
+ - id: cover_tour_start_btn
973
+ type: Button
974
+ layout:
975
+ flex: 0 0 auto
976
+ properties:
977
+ title: Cover Tour
978
+ color: primary
979
+ variant: outlined
980
+ size: small
981
+ events:
982
+ onClick:
983
+ - id: cover_tour_start
984
+ type: SetState
985
+ params:
986
+ cover_tour_open: true
987
+ - id: cover_target_tour_start_btn
988
+ type: Button
989
+ layout:
990
+ flex: 0 0 auto
991
+ properties:
992
+ title: With Targets
993
+ color: primary
994
+ variant: outlined
995
+ size: small
996
+ events:
997
+ onClick:
998
+ - id: cover_target_tour_start
999
+ type: SetState
1000
+ params:
1001
+ cover_target_tour_open: true
1002
+ - id: cover_tour
1003
+ type: Tour
1004
+ properties:
1005
+ open:
1006
+ _state: cover_tour_open
1007
+ steps:
1008
+ - title: Welcome to the Dashboard
1009
+ description: Get familiar with the main interface and its key areas.
1010
+ cover: https://gw.alipayobjects.com/zos/bmw-prod/e9a9b1e8-5e62-4e12-a3b7-e3695b0a5f3c.png
1011
+ - title: Navigation Menu
1012
+ description: Use the sidebar to navigate between different sections.
1013
+ cover: https://gw.alipayobjects.com/zos/bmw-prod/ed5cf3c4-5e34-43e5-9c39-fe131c7cf88e.png
1014
+ - title: All Done
1015
+ description: You are ready to start using the application.
1016
+ events:
1017
+ onClose:
1018
+ - id: cover_tour_close
1019
+ type: SetState
1020
+ params:
1021
+ cover_tour_open: false
1022
+ onFinish:
1023
+ - id: cover_tour_finish
1024
+ type: SetState
1025
+ params:
1026
+ cover_tour_open: false
1027
+ - id: cover_target_row
1028
+ type: Box
1029
+ layout:
1030
+ gap: 16
1031
+ blocks:
1032
+ - id: cover_target_btn_1
1033
+ type: Button
1034
+ layout:
1035
+ flex: 0 0 auto
1036
+ properties:
1037
+ title: Dashboard
1038
+ color: primary
1039
+ variant: solid
1040
+ icon: AiOutlineDashboard
1041
+ - id: cover_target_btn_2
1042
+ type: Button
1043
+ layout:
1044
+ flex: 0 0 auto
1045
+ properties:
1046
+ title: Settings
1047
+ color: default
1048
+ variant: outlined
1049
+ icon: AiOutlineSetting
1050
+ - id: cover_target_tour
1051
+ type: Tour
1052
+ properties:
1053
+ open:
1054
+ _state: cover_target_tour_open
1055
+ steps:
1056
+ - title: Dashboard Overview
1057
+ description: The dashboard shows a summary of your workspace activity.
1058
+ target: cover_target_btn_1
1059
+ cover: https://gw.alipayobjects.com/zos/bmw-prod/e9a9b1e8-5e62-4e12-a3b7-e3695b0a5f3c.png
1060
+ - title: Configure Settings
1061
+ description: Adjust preferences and integrations from the settings page.
1062
+ target: cover_target_btn_2
1063
+ cover: https://gw.alipayobjects.com/zos/bmw-prod/ed5cf3c4-5e34-43e5-9c39-fe131c7cf88e.png
1064
+ events:
1065
+ onClose:
1066
+ - id: cover_target_tour_close
1067
+ type: SetState
1068
+ params:
1069
+ cover_target_tour_open: false
1070
+ onFinish:
1071
+ - id: cover_target_tour_finish
1072
+ type: SetState
1073
+ params:
1074
+ cover_target_tour_open: false
1075
+
1076
+ - title: Closable and Keyboard Navigation
1077
+ blocks:
1078
+ - id: closable_btns_row
1079
+ type: Box
1080
+ layout:
1081
+ gap: 8
1082
+ blocks:
1083
+ - id: closable_tour_start_btn
1084
+ type: Button
1085
+ layout:
1086
+ flex: 0 0 auto
1087
+ properties:
1088
+ title: Closable
1089
+ color: primary
1090
+ variant: outlined
1091
+ size: small
1092
+ events:
1093
+ onClick:
1094
+ - id: closable_tour_start
1095
+ type: SetState
1096
+ params:
1097
+ closable_tour_open: true
1098
+ - id: not_closable_tour_start_btn
1099
+ type: Button
1100
+ layout:
1101
+ flex: 0 0 auto
1102
+ properties:
1103
+ title: Not Closable
1104
+ color: primary
1105
+ variant: outlined
1106
+ size: small
1107
+ events:
1108
+ onClick:
1109
+ - id: not_closable_tour_start
1110
+ type: SetState
1111
+ params:
1112
+ not_closable_tour_open: true
1113
+ - id: closable_per_step_start_btn
1114
+ type: Button
1115
+ layout:
1116
+ flex: 0 0 auto
1117
+ properties:
1118
+ title: Per Step
1119
+ color: primary
1120
+ variant: outlined
1121
+ size: small
1122
+ events:
1123
+ onClick:
1124
+ - id: closable_per_step_start
1125
+ type: SetState
1126
+ params:
1127
+ closable_per_step_tour_open: true
1128
+ - id: closable_tour
1129
+ type: Tour
1130
+ properties:
1131
+ open:
1132
+ _state: closable_tour_open
1133
+ closable: true
1134
+ keyboard: true
1135
+ steps:
1136
+ - title: Closable Tour
1137
+ description: The close button (X) is visible. Press Escape to close.
1138
+ - title: Keyboard Navigation
1139
+ description: Use arrow keys to navigate between steps.
1140
+ - title: Final Step
1141
+ description: Both close button and keyboard shortcuts are available throughout.
1142
+ events:
1143
+ onClose:
1144
+ - id: closable_tour_close
1145
+ type: SetState
1146
+ params:
1147
+ closable_tour_open: false
1148
+ onFinish:
1149
+ - id: closable_tour_finish
1150
+ type: SetState
1151
+ params:
1152
+ closable_tour_open: false
1153
+ - id: not_closable_tour
1154
+ type: Tour
1155
+ properties:
1156
+ open:
1157
+ _state: not_closable_tour_open
1158
+ closable: false
1159
+ keyboard: false
1160
+ steps:
1161
+ - title: Guided Tour
1162
+ description: Close button and Escape key are disabled. Use Next and Previous buttons.
1163
+ - title: Must Complete
1164
+ description: Users must step through all steps to finish the tour.
1165
+ events:
1166
+ onClose:
1167
+ - id: not_closable_tour_close
1168
+ type: SetState
1169
+ params:
1170
+ not_closable_tour_open: false
1171
+ onFinish:
1172
+ - id: not_closable_tour_finish
1173
+ type: SetState
1174
+ params:
1175
+ not_closable_tour_open: false
1176
+ - id: closable_per_step_row
1177
+ type: Box
1178
+ layout:
1179
+ gap: 16
1180
+ blocks:
1181
+ - id: closable_per_step_btn_1
1182
+ type: Button
1183
+ layout:
1184
+ flex: 0 0 auto
1185
+ properties:
1186
+ title: Closable
1187
+ color: green
1188
+ variant: outlined
1189
+ - id: closable_per_step_btn_2
1190
+ type: Button
1191
+ layout:
1192
+ flex: 0 0 auto
1193
+ properties:
1194
+ title: Not Closable
1195
+ color: orange
1196
+ variant: outlined
1197
+ - id: closable_per_step_tour
1198
+ type: Tour
1199
+ properties:
1200
+ open:
1201
+ _state: closable_per_step_tour_open
1202
+ closable: true
1203
+ steps:
1204
+ - title: Closable Step
1205
+ description: This step has the close button visible.
1206
+ target: closable_per_step_btn_1
1207
+ closable: true
1208
+ - title: Not Closable Step
1209
+ description: This step hides the close button. Navigate forward to continue.
1210
+ target: closable_per_step_btn_2
1211
+ closable: false
1212
+ events:
1213
+ onClose:
1214
+ - id: closable_per_step_tour_close
1215
+ type: SetState
1216
+ params:
1217
+ closable_per_step_tour_open: false
1218
+ onFinish:
1219
+ - id: closable_per_step_tour_finish
1220
+ type: SetState
1221
+ params:
1222
+ closable_per_step_tour_open: false
1223
+
1224
+ - title: Animation, Scroll, and Disabled Interaction
1225
+ blocks:
1226
+ - id: anim_btns_row
1227
+ type: Box
1228
+ layout:
1229
+ gap: 8
1230
+ blocks:
1231
+ - id: animated_tour_start_btn
1232
+ type: Button
1233
+ layout:
1234
+ flex: 0 0 auto
1235
+ properties:
1236
+ title: Animated
1237
+ color: primary
1238
+ variant: outlined
1239
+ size: small
1240
+ events:
1241
+ onClick:
1242
+ - id: animated_tour_start
1243
+ type: SetState
1244
+ params:
1245
+ animated_tour_open: true
1246
+ - id: no_animation_tour_start_btn
1247
+ type: Button
1248
+ layout:
1249
+ flex: 0 0 auto
1250
+ properties:
1251
+ title: No Animation
1252
+ color: primary
1253
+ variant: outlined
1254
+ size: small
1255
+ events:
1256
+ onClick:
1257
+ - id: no_animation_tour_start
1258
+ type: SetState
1259
+ params:
1260
+ no_animation_tour_open: true
1261
+ - id: disabled_interaction_tour_start_btn
1262
+ type: Button
1263
+ layout:
1264
+ flex: 0 0 auto
1265
+ properties:
1266
+ title: Disabled Interaction
1267
+ color: primary
1268
+ variant: outlined
1269
+ size: small
1270
+ events:
1271
+ onClick:
1272
+ - id: disabled_interaction_tour_start
1273
+ type: SetState
1274
+ params:
1275
+ disabled_interaction_tour_open: true
1276
+ - id: animated_tour
1277
+ type: Tour
1278
+ properties:
1279
+ open:
1280
+ _state: animated_tour_open
1281
+ animated: true
1282
+ scrollIntoViewOptions: true
1283
+ steps:
1284
+ - title: Animated Tour
1285
+ description: Smooth transitions between steps with animation enabled.
1286
+ - title: Auto Scroll
1287
+ description: Target elements automatically scroll into view when a step activates.
1288
+ events:
1289
+ onClose:
1290
+ - id: animated_tour_close
1291
+ type: SetState
1292
+ params:
1293
+ animated_tour_open: false
1294
+ onFinish:
1295
+ - id: animated_tour_finish
1296
+ type: SetState
1297
+ params:
1298
+ animated_tour_open: false
1299
+ - id: no_animation_tour
1300
+ type: Tour
1301
+ properties:
1302
+ open:
1303
+ _state: no_animation_tour_open
1304
+ animated: false
1305
+ scrollIntoViewOptions: false
1306
+ steps:
1307
+ - title: No Animation
1308
+ description: Instant transitions without animation. Scroll to target is also disabled.
1309
+ events:
1310
+ onClose:
1311
+ - id: no_animation_tour_close
1312
+ type: SetState
1313
+ params:
1314
+ no_animation_tour_open: false
1315
+ onFinish:
1316
+ - id: no_animation_tour_finish
1317
+ type: SetState
1318
+ params:
1319
+ no_animation_tour_open: false
1320
+ - id: disabled_interaction_row
1321
+ type: Box
1322
+ layout:
1323
+ gap: 16
1324
+ blocks:
1325
+ - id: disabled_interaction_btn
1326
+ type: Button
1327
+ layout:
1328
+ flex: 0 0 auto
1329
+ properties:
1330
+ title: Cannot Click During Tour
1331
+ color: primary
1332
+ variant: solid
1333
+ icon: AiOutlineLock
1334
+ - id: disabled_interaction_tour
1335
+ type: Tour
1336
+ properties:
1337
+ open:
1338
+ _state: disabled_interaction_tour_open
1339
+ disabledInteraction: true
1340
+ steps:
1341
+ - title: Interaction Disabled
1342
+ description: The highlighted target element cannot be clicked during this tour.
1343
+ target: disabled_interaction_btn
1344
+ - title: Read-Only Tour
1345
+ description: Users can only navigate tour steps, not interact with highlighted elements.
1346
+ events:
1347
+ onClose:
1348
+ - id: disabled_interaction_tour_close
1349
+ type: SetState
1350
+ params:
1351
+ disabled_interaction_tour_open: false
1352
+ onFinish:
1353
+ - id: disabled_interaction_tour_finish
1354
+ type: SetState
1355
+ params:
1356
+ disabled_interaction_tour_open: false
1357
+
1358
+ - title: Gap and Current Step
1359
+ blocks:
1360
+ - id: gap_btns_row
1361
+ type: Box
1362
+ layout:
1363
+ gap: 8
1364
+ blocks:
1365
+ - id: gap_default_tour_start_btn
1366
+ type: Button
1367
+ layout:
1368
+ flex: 0 0 auto
1369
+ properties:
1370
+ title: Default Gap
1371
+ color: primary
1372
+ variant: outlined
1373
+ size: small
1374
+ events:
1375
+ onClick:
1376
+ - id: gap_default_tour_start
1377
+ type: SetState
1378
+ params:
1379
+ gap_default_tour_open: true
1380
+ - id: gap_large_tour_start_btn
1381
+ type: Button
1382
+ layout:
1383
+ flex: 0 0 auto
1384
+ properties:
1385
+ title: Large Gap
1386
+ color: primary
1387
+ variant: outlined
1388
+ size: small
1389
+ events:
1390
+ onClick:
1391
+ - id: gap_large_tour_start
1392
+ type: SetState
1393
+ params:
1394
+ gap_large_tour_open: true
1395
+ - id: gap_tight_tour_start_btn
1396
+ type: Button
1397
+ layout:
1398
+ flex: 0 0 auto
1399
+ properties:
1400
+ title: No Gap
1401
+ color: primary
1402
+ variant: outlined
1403
+ size: small
1404
+ events:
1405
+ onClick:
1406
+ - id: gap_tight_tour_start
1407
+ type: SetState
1408
+ params:
1409
+ gap_tight_tour_open: true
1410
+ - id: current_step_tour_start_btn
1411
+ type: Button
1412
+ layout:
1413
+ flex: 0 0 auto
1414
+ properties:
1415
+ title: Start at Step 2
1416
+ color: primary
1417
+ variant: outlined
1418
+ size: small
1419
+ events:
1420
+ onClick:
1421
+ - id: current_step_tour_start
1422
+ type: SetState
1423
+ params:
1424
+ current_step_tour_open: true
1425
+ - id: gap_row
1426
+ type: Box
1427
+ layout:
1428
+ gap: 16
1429
+ blocks:
1430
+ - id: gap_default_btn
1431
+ type: Button
1432
+ layout:
1433
+ flex: 0 0 auto
1434
+ properties:
1435
+ title: Default Gap
1436
+ color: primary
1437
+ variant: solid
1438
+ - id: gap_large_btn
1439
+ type: Button
1440
+ layout:
1441
+ flex: 0 0 auto
1442
+ properties:
1443
+ title: Large Gap
1444
+ color: purple
1445
+ variant: solid
1446
+ - id: gap_tight_btn
1447
+ type: Button
1448
+ layout:
1449
+ flex: 0 0 auto
1450
+ properties:
1451
+ title: No Gap
1452
+ color: orange
1453
+ variant: solid
1454
+ - id: gap_default_tour
1455
+ type: Tour
1456
+ properties:
1457
+ open:
1458
+ _state: gap_default_tour_open
1459
+ steps:
1460
+ - title: Default Gap
1461
+ description: Standard spacing between the highlighted area and the target.
1462
+ target: gap_default_btn
1463
+ events:
1464
+ onClose:
1465
+ - id: gap_default_tour_close
1466
+ type: SetState
1467
+ params:
1468
+ gap_default_tour_open: false
1469
+ onFinish:
1470
+ - id: gap_default_tour_finish
1471
+ type: SetState
1472
+ params:
1473
+ gap_default_tour_open: false
1474
+ - id: gap_large_tour
1475
+ type: Tour
1476
+ properties:
1477
+ open:
1478
+ _state: gap_large_tour_open
1479
+ gap:
1480
+ x: 20
1481
+ y: 20
1482
+ steps:
1483
+ - title: Large Gap
1484
+ description: Increased gap (20px) around the target for more breathing room.
1485
+ target: gap_large_btn
1486
+ events:
1487
+ onClose:
1488
+ - id: gap_large_tour_close
1489
+ type: SetState
1490
+ params:
1491
+ gap_large_tour_open: false
1492
+ onFinish:
1493
+ - id: gap_large_tour_finish
1494
+ type: SetState
1495
+ params:
1496
+ gap_large_tour_open: false
1497
+ - id: gap_tight_tour
1498
+ type: Tour
1499
+ properties:
1500
+ open:
1501
+ _state: gap_tight_tour_open
1502
+ gap:
1503
+ x: 0
1504
+ y: 0
1505
+ steps:
1506
+ - title: No Gap
1507
+ description: The highlight fits tightly around the target with zero spacing.
1508
+ target: gap_tight_btn
1509
+ events:
1510
+ onClose:
1511
+ - id: gap_tight_tour_close
1512
+ type: SetState
1513
+ params:
1514
+ gap_tight_tour_open: false
1515
+ onFinish:
1516
+ - id: gap_tight_tour_finish
1517
+ type: SetState
1518
+ params:
1519
+ gap_tight_tour_open: false
1520
+ - id: current_step_tour
1521
+ type: Tour
1522
+ properties:
1523
+ open:
1524
+ _state: current_step_tour_open
1525
+ current: 1
1526
+ steps:
1527
+ - title: Step One
1528
+ description: This is the first step, but the tour does not start here.
1529
+ - title: Step Two (Starting Point)
1530
+ description: The tour opens at this step because current is set to 1 (zero-indexed).
1531
+ - title: Step Three
1532
+ description: This is the third and final step.
1533
+ events:
1534
+ onClose:
1535
+ - id: current_step_tour_close
1536
+ type: SetState
1537
+ params:
1538
+ current_step_tour_open: false
1539
+ onFinish:
1540
+ - id: current_step_tour_finish
1541
+ type: SetState
1542
+ params:
1543
+ current_step_tour_open: false
1544
+
1545
+ - title: Z-Index Control
1546
+ blocks:
1547
+ - id: zindex_btns_row
1548
+ type: Box
1549
+ layout:
1550
+ gap: 8
1551
+ blocks:
1552
+ - id: zindex_default_start_btn
1553
+ type: Button
1554
+ layout:
1555
+ flex: 0 0 auto
1556
+ properties:
1557
+ title: Default (1070)
1558
+ color: primary
1559
+ variant: outlined
1560
+ size: small
1561
+ events:
1562
+ onClick:
1563
+ - id: zindex_default_start
1564
+ type: SetState
1565
+ params:
1566
+ zindex_default_tour_open: true
1567
+ - id: zindex_high_start_btn
1568
+ type: Button
1569
+ layout:
1570
+ flex: 0 0 auto
1571
+ properties:
1572
+ title: High (2000)
1573
+ color: primary
1574
+ variant: outlined
1575
+ size: small
1576
+ events:
1577
+ onClick:
1578
+ - id: zindex_high_start
1579
+ type: SetState
1580
+ params:
1581
+ zindex_high_tour_open: true
1582
+ - id: zindex_low_start_btn
1583
+ type: Button
1584
+ layout:
1585
+ flex: 0 0 auto
1586
+ properties:
1587
+ title: Low (900)
1588
+ color: primary
1589
+ variant: outlined
1590
+ size: small
1591
+ events:
1592
+ onClick:
1593
+ - id: zindex_low_start
1594
+ type: SetState
1595
+ params:
1596
+ zindex_low_tour_open: true
1597
+ - id: zindex_default_tour
1598
+ type: Tour
1599
+ properties:
1600
+ open:
1601
+ _state: zindex_default_tour_open
1602
+ steps:
1603
+ - title: Default Z-Index
1604
+ description: Tour uses the default stacking order (1070). Appears above most content.
1605
+ events:
1606
+ onClose:
1607
+ - id: zindex_default_tour_close
1608
+ type: SetState
1609
+ params:
1610
+ zindex_default_tour_open: false
1611
+ onFinish:
1612
+ - id: zindex_default_tour_finish
1613
+ type: SetState
1614
+ params:
1615
+ zindex_default_tour_open: false
1616
+ - id: zindex_high_tour
1617
+ type: Tour
1618
+ properties:
1619
+ open:
1620
+ _state: zindex_high_tour_open
1621
+ zIndex: 2000
1622
+ steps:
1623
+ - title: High Z-Index (2000)
1624
+ description: Tour renders above other overlays such as modals and drawers.
1625
+ events:
1626
+ onClose:
1627
+ - id: zindex_high_tour_close
1628
+ type: SetState
1629
+ params:
1630
+ zindex_high_tour_open: false
1631
+ onFinish:
1632
+ - id: zindex_high_tour_finish
1633
+ type: SetState
1634
+ params:
1635
+ zindex_high_tour_open: false
1636
+ - id: zindex_low_tour
1637
+ type: Tour
1638
+ properties:
1639
+ open:
1640
+ _state: zindex_low_tour_open
1641
+ zIndex: 900
1642
+ steps:
1643
+ - title: Low Z-Index (900)
1644
+ description: Tour renders below some overlays. Fixed headers may appear above it.
1645
+ events:
1646
+ onClose:
1647
+ - id: zindex_low_tour_close
1648
+ type: SetState
1649
+ params:
1650
+ zindex_low_tour_open: false
1651
+ onFinish:
1652
+ - id: zindex_low_tour_finish
1653
+ type: SetState
1654
+ params:
1655
+ zindex_low_tour_open: false
1656
+
1657
+ - title: Events
1658
+ blocks:
1659
+ - id: events_start_btn
1660
+ type: Button
1661
+ layout:
1662
+ flex: 0 0 auto
1663
+ properties:
1664
+ title: Start Events Tour
1665
+ color: primary
1666
+ variant: outlined
1667
+ size: small
1668
+ events:
1669
+ onClick:
1670
+ - id: events_tour_start
1671
+ type: SetState
1672
+ params:
1673
+ events_tour_open: true
1674
+ - id: events_row
1675
+ type: Box
1676
+ layout:
1677
+ gap: 16
1678
+ blocks:
1679
+ - id: events_btn_1
1680
+ type: Button
1681
+ layout:
1682
+ flex: 0 0 auto
1683
+ properties:
1684
+ title: Step 1 Target
1685
+ color: primary
1686
+ variant: solid
1687
+ - id: events_btn_2
1688
+ type: Button
1689
+ layout:
1690
+ flex: 0 0 auto
1691
+ properties:
1692
+ title: Step 2 Target
1693
+ color: green
1694
+ variant: solid
1695
+ - id: events_tour
1696
+ type: Tour
1697
+ properties:
1698
+ open:
1699
+ _state: events_tour_open
1700
+ steps:
1701
+ - title: First Step
1702
+ description: Navigate forward to trigger the onChange event.
1703
+ target: events_btn_1
1704
+ - title: Second Step
1705
+ description: Close the tour or finish to trigger onClose or onFinish.
1706
+ target: events_btn_2
1707
+ events:
1708
+ onChange:
1709
+ - id: events_on_change
1710
+ type: DisplayMessage
1711
+ params:
1712
+ content: Step changed!
1713
+ status: info
1714
+ onClose:
1715
+ - id: events_tour_close
1716
+ type: SetState
1717
+ params:
1718
+ events_tour_open: false
1719
+ - id: events_on_close
1720
+ type: DisplayMessage
1721
+ params:
1722
+ content: Tour closed.
1723
+ status: warning
1724
+ onFinish:
1725
+ - id: events_tour_finish
1726
+ type: SetState
1727
+ params:
1728
+ events_tour_open: false
1729
+ - id: events_on_finish
1730
+ type: DisplayMessage
1731
+ params:
1732
+ content: Tour completed!
1733
+ status: success
1734
+
1735
+ - title: Style and CSS
1736
+ blocks:
1737
+ - id: css_btns_row
1738
+ type: Box
1739
+ layout:
1740
+ gap: 8
1741
+ blocks:
1742
+ - id: css_tailwind_start_btn
1743
+ type: Button
1744
+ layout:
1745
+ flex: 0 0 auto
1746
+ properties:
1747
+ title: Shadow
1748
+ color: primary
1749
+ variant: outlined
1750
+ size: small
1751
+ events:
1752
+ onClick:
1753
+ - id: css_tailwind_start
1754
+ type: SetState
1755
+ params:
1756
+ css_tailwind_tour_open: true
1757
+ - id: css_rounded_start_btn
1758
+ type: Button
1759
+ layout:
1760
+ flex: 0 0 auto
1761
+ properties:
1762
+ title: Rounded
1763
+ color: primary
1764
+ variant: outlined
1765
+ size: small
1766
+ events:
1767
+ onClick:
1768
+ - id: css_rounded_start
1769
+ type: SetState
1770
+ params:
1771
+ css_rounded_tour_open: true
1772
+ - id: css_inline_start_btn
1773
+ type: Button
1774
+ layout:
1775
+ flex: 0 0 auto
1776
+ properties:
1777
+ title: Inline Style
1778
+ color: primary
1779
+ variant: outlined
1780
+ size: small
1781
+ events:
1782
+ onClick:
1783
+ - id: css_inline_start
1784
+ type: SetState
1785
+ params:
1786
+ css_inline_tour_open: true
1787
+ - id: css_dark_tour_start_btn
1788
+ type: Button
1789
+ layout:
1790
+ flex: 0 0 auto
1791
+ properties:
1792
+ title: Dark Background
1793
+ color: primary
1794
+ variant: outlined
1795
+ size: small
1796
+ events:
1797
+ onClick:
1798
+ - id: css_dark_tour_start
1799
+ type: SetState
1800
+ params:
1801
+ css_dark_tour_open: true
1802
+ - id: css_tailwind_tour
1803
+ type: Tour
1804
+ class: shadow-2xl
1805
+ properties:
1806
+ open:
1807
+ _state: css_tailwind_tour_open
1808
+ steps:
1809
+ - title: Tailwind Shadow
1810
+ description: Tailwind utility classes can be applied via the class property.
1811
+ events:
1812
+ onClose:
1813
+ - id: css_tailwind_tour_close
1814
+ type: SetState
1815
+ params:
1816
+ css_tailwind_tour_open: false
1817
+ onFinish:
1818
+ - id: css_tailwind_tour_finish
1819
+ type: SetState
1820
+ params:
1821
+ css_tailwind_tour_open: false
1822
+ - id: css_rounded_tour
1823
+ type: Tour
1824
+ class: rounded-2xl
1825
+ properties:
1826
+ open:
1827
+ _state: css_rounded_tour_open
1828
+ steps:
1829
+ - title: Tailwind Rounded
1830
+ description: Additional border radius applied via Tailwind class.
1831
+ events:
1832
+ onClose:
1833
+ - id: css_rounded_tour_close
1834
+ type: SetState
1835
+ params:
1836
+ css_rounded_tour_open: false
1837
+ onFinish:
1838
+ - id: css_rounded_tour_finish
1839
+ type: SetState
1840
+ params:
1841
+ css_rounded_tour_open: false
1842
+ - id: css_inline_tour
1843
+ type: Tour
1844
+ properties:
1845
+ open:
1846
+ _state: css_inline_tour_open
1847
+ steps:
1848
+ - title: Inline Style
1849
+ description: The element style key controls the tour card appearance.
1850
+ style:
1851
+ .element:
1852
+ maxWidth: 320px
1853
+ events:
1854
+ onClose:
1855
+ - id: css_inline_tour_close
1856
+ type: SetState
1857
+ params:
1858
+ css_inline_tour_open: false
1859
+ onFinish:
1860
+ - id: css_inline_tour_finish
1861
+ type: SetState
1862
+ params:
1863
+ css_inline_tour_open: false
1864
+ - id: css_dark_bg
1865
+ type: Box
1866
+ class: bg-gradient-to-r from-slate-900 to-slate-700 p-4 rounded-lg
1867
+ layout:
1868
+ gap: 8
1869
+ blocks:
1870
+ - id: css_dark_btn
1871
+ type: Button
1872
+ layout:
1873
+ flex: 0 0 auto
1874
+ properties:
1875
+ title: Target on Dark Background
1876
+ ghost: true
1877
+ color: primary
1878
+ variant: outlined
1879
+ - id: css_dark_tour
1880
+ type: Tour
1881
+ properties:
1882
+ open:
1883
+ _state: css_dark_tour_open
1884
+ steps:
1885
+ - title: Dark Background Context
1886
+ description: Tour cards remain visible against dark page backgrounds.
1887
+ target: css_dark_btn
1888
+ events:
1889
+ onClose:
1890
+ - id: css_dark_tour_close
1891
+ type: SetState
1892
+ params:
1893
+ css_dark_tour_open: false
1894
+ onFinish:
1895
+ - id: css_dark_tour_finish
1896
+ type: SetState
1897
+ params:
1898
+ css_dark_tour_open: false
1899
+
1900
+ - title: Theme Token Overrides
1901
+ blocks:
1902
+ - id: theme_btns_row
1903
+ type: Box
1904
+ layout:
1905
+ gap: 8
1906
+ blocks:
1907
+ - id: theme_purple_start_btn
1908
+ type: Button
1909
+ layout:
1910
+ flex: 0 0 auto
1911
+ properties:
1912
+ title: Purple Primary
1913
+ color: primary
1914
+ variant: outlined
1915
+ size: small
1916
+ events:
1917
+ onClick:
1918
+ - id: theme_purple_start
1919
+ type: SetState
1920
+ params:
1921
+ theme_purple_tour_open: true
1922
+ - id: theme_rounded_start_btn
1923
+ type: Button
1924
+ layout:
1925
+ flex: 0 0 auto
1926
+ properties:
1927
+ title: Rounded Card
1928
+ color: primary
1929
+ variant: outlined
1930
+ size: small
1931
+ events:
1932
+ onClick:
1933
+ - id: theme_rounded_start
1934
+ type: SetState
1935
+ params:
1936
+ theme_rounded_tour_open: true
1937
+ - id: theme_large_font_start_btn
1938
+ type: Button
1939
+ layout:
1940
+ flex: 0 0 auto
1941
+ properties:
1942
+ title: Large Text
1943
+ color: primary
1944
+ variant: outlined
1945
+ size: small
1946
+ events:
1947
+ onClick:
1948
+ - id: theme_large_font_start
1949
+ type: SetState
1950
+ params:
1951
+ theme_large_font_tour_open: true
1952
+ - id: theme_combined_start_btn
1953
+ type: Button
1954
+ layout:
1955
+ flex: 0 0 auto
1956
+ properties:
1957
+ title: Combined
1958
+ color: primary
1959
+ variant: outlined
1960
+ size: small
1961
+ events:
1962
+ onClick:
1963
+ - id: theme_combined_start
1964
+ type: SetState
1965
+ params:
1966
+ theme_combined_tour_open: true
1967
+ - id: theme_purple_tour
1968
+ type: Tour
1969
+ properties:
1970
+ open:
1971
+ _state: theme_purple_tour_open
1972
+ type: primary
1973
+ theme:
1974
+ colorPrimary: '#722ed1'
1975
+ steps:
1976
+ - title: Purple Primary
1977
+ description: Custom purple colorPrimary changes background and button colors.
1978
+ - title: Brand Alignment
1979
+ description: Theme tokens align the tour with your brand palette.
1980
+ events:
1981
+ onClose:
1982
+ - id: theme_purple_tour_close
1983
+ type: SetState
1984
+ params:
1985
+ theme_purple_tour_open: false
1986
+ onFinish:
1987
+ - id: theme_purple_tour_finish
1988
+ type: SetState
1989
+ params:
1990
+ theme_purple_tour_open: false
1991
+ - id: theme_rounded_tour
1992
+ type: Tour
1993
+ properties:
1994
+ open:
1995
+ _state: theme_rounded_tour_open
1996
+ theme:
1997
+ borderRadiusLG: 20
1998
+ padding: 24
1999
+ steps:
2000
+ - title: Rounded Card
2001
+ description: Increased border radius (20px) and padding (24px) for a softer look.
2002
+ events:
2003
+ onClose:
2004
+ - id: theme_rounded_tour_close
2005
+ type: SetState
2006
+ params:
2007
+ theme_rounded_tour_open: false
2008
+ onFinish:
2009
+ - id: theme_rounded_tour_finish
2010
+ type: SetState
2011
+ params:
2012
+ theme_rounded_tour_open: false
2013
+ - id: theme_large_font_tour
2014
+ type: Tour
2015
+ properties:
2016
+ open:
2017
+ _state: theme_large_font_tour_open
2018
+ theme:
2019
+ fontSize: 16
2020
+ fontSizeLG: 20
2021
+ steps:
2022
+ - title: Large Text
2023
+ description: Increased font sizes improve readability and accessibility.
2024
+ events:
2025
+ onClose:
2026
+ - id: theme_large_font_tour_close
2027
+ type: SetState
2028
+ params:
2029
+ theme_large_font_tour_open: false
2030
+ onFinish:
2031
+ - id: theme_large_font_tour_finish
2032
+ type: SetState
2033
+ params:
2034
+ theme_large_font_tour_open: false
2035
+ - id: theme_combined_tour
2036
+ type: Tour
2037
+ properties:
2038
+ open:
2039
+ _state: theme_combined_tour_open
2040
+ type: primary
2041
+ theme:
2042
+ colorPrimary: '#fa541c'
2043
+ borderRadiusLG: 12
2044
+ primaryPrevBtnBg: rgba(255, 255, 255, 0.35)
2045
+ arrowOffsetHorizontal: 16
2046
+ steps:
2047
+ - title: Combined Tokens
2048
+ description: Multiple tokens create a cohesive warm-themed tour.
2049
+ - title: Previous Button
2050
+ description: The primaryPrevBtnBg token makes the Previous button more visible.
2051
+ events:
2052
+ onClose:
2053
+ - id: theme_combined_tour_close
2054
+ type: SetState
2055
+ params:
2056
+ theme_combined_tour_open: false
2057
+ onFinish:
2058
+ - id: theme_combined_tour_finish
2059
+ type: SetState
2060
+ params:
2061
+ theme_combined_tour_open: false
2062
+
2063
+ - title: Tour in Onboarding Flow
2064
+ fullWidth: true
2065
+ blocks:
2066
+ - id: onboard_card
2067
+ type: Card
2068
+ properties:
2069
+ title: My Application
2070
+ size: small
2071
+ blocks:
2072
+ - id: onboard_header_row
2073
+ type: Box
2074
+ layout:
2075
+ gap: 16
2076
+ align: center
2077
+ blocks:
2078
+ - id: onboard_search
2079
+ type: TextInput
2080
+ layout:
2081
+ flex: 1 1 auto
2082
+ properties:
2083
+ label:
2084
+ disabled: true
2085
+ placeholder: Search anything...
2086
+ - id: onboard_create_btn
2087
+ type: Button
2088
+ layout:
2089
+ flex: 0 0 auto
2090
+ properties:
2091
+ title: Create New
2092
+ color: primary
2093
+ variant: solid
2094
+ icon: AiOutlinePlus
2095
+ - id: onboard_profile_btn
2096
+ type: Button
2097
+ layout:
2098
+ flex: 0 0 auto
2099
+ properties:
2100
+ title: Profile
2101
+ color: default
2102
+ variant: text
2103
+ icon: AiOutlineUser
2104
+ - id: onboard_settings_btn
2105
+ type: Button
2106
+ layout:
2107
+ flex: 0 0 auto
2108
+ properties:
2109
+ title: Settings
2110
+ color: default
2111
+ variant: text
2112
+ icon: AiOutlineSetting
2113
+ - id: onboard_content
2114
+ type: Markdown
2115
+ properties:
2116
+ content: |
2117
+ Welcome to the application. Click the button below to take a guided tour of the interface.
2118
+ - id: onboard_start_row
2119
+ type: Box
2120
+ layout:
2121
+ gap: 8
2122
+ justify: flex-end
2123
+ blocks:
2124
+ - id: onboard_start_btn
2125
+ type: Button
2126
+ layout:
2127
+ flex: 0 0 auto
2128
+ properties:
2129
+ title: Take the Tour
2130
+ color: primary
2131
+ variant: solid
2132
+ icon: AiOutlineQuestionCircle
2133
+ events:
2134
+ onClick:
2135
+ - id: onboard_start_tour
2136
+ type: SetState
2137
+ params:
2138
+ show_onboard_tour: true
2139
+ - id: onboard_tour
2140
+ type: Tour
2141
+ properties:
2142
+ open:
2143
+ _state: show_onboard_tour
2144
+ type: default
2145
+ mask: true
2146
+ animated: true
2147
+ steps:
2148
+ - title: Welcome
2149
+ description: Let us take a quick tour to get you started.
2150
+ cover: https://gw.alipayobjects.com/zos/bmw-prod/e9a9b1e8-5e62-4e12-a3b7-e3695b0a5f3c.png
2151
+ - title: Search
2152
+ description: Use the search bar to quickly find documents, users, or settings.
2153
+ target: onboard_search
2154
+ placement: bottom
2155
+ - title: Create Content
2156
+ description: Click here to create a new document, project, or workspace item.
2157
+ target: onboard_create_btn
2158
+ placement: bottom
2159
+ - title: Your Profile
2160
+ description: Access your profile to update personal information and preferences.
2161
+ target: onboard_profile_btn
2162
+ placement: bottomRight
2163
+ - title: Settings
2164
+ description: Configure application settings, integrations, and notifications.
2165
+ target: onboard_settings_btn
2166
+ placement: bottomRight
2167
+ events:
2168
+ onClose:
2169
+ - id: onboard_close
2170
+ type: SetState
2171
+ params:
2172
+ show_onboard_tour: false
2173
+ onFinish:
2174
+ - id: onboard_finish_state
2175
+ type: SetState
2176
+ params:
2177
+ show_onboard_tour: false
2178
+ - id: onboard_finish_msg
2179
+ type: DisplayMessage
2180
+ params:
2181
+ content: Tour complete! You are ready to get started.
2182
+ status: success
2183
+
2184
+ - title: Tour in Feature Introduction
2185
+ fullWidth: true
2186
+ blocks:
2187
+ - id: feature_card
2188
+ type: Card
2189
+ properties:
2190
+ title: Document Editor
2191
+ size: small
2192
+ blocks:
2193
+ - id: feature_toolbar
2194
+ type: Box
2195
+ layout:
2196
+ gap: 8
2197
+ align: center
2198
+ blocks:
2199
+ - id: feature_bold_btn
2200
+ type: Button
2201
+ layout:
2202
+ flex: 0 0 auto
2203
+ properties:
2204
+ title: '<b>B</b>'
2205
+ color: default
2206
+ variant: outlined
2207
+ size: small
2208
+ - id: feature_italic_btn
2209
+ type: Button
2210
+ layout:
2211
+ flex: 0 0 auto
2212
+ properties:
2213
+ title: '<i>I</i>'
2214
+ color: default
2215
+ variant: outlined
2216
+ size: small
2217
+ - id: feature_save_btn
2218
+ type: Button
2219
+ layout:
2220
+ flex: 0 0 auto
2221
+ properties:
2222
+ title: Save
2223
+ color: primary
2224
+ variant: solid
2225
+ size: small
2226
+ icon: AiOutlineSave
2227
+ - id: feature_export_btn
2228
+ type: Button
2229
+ layout:
2230
+ flex: 0 0 auto
2231
+ properties:
2232
+ title: Export
2233
+ color: default
2234
+ variant: outlined
2235
+ size: small
2236
+ icon: AiOutlineExport
2237
+ - id: feature_editor
2238
+ type: TextArea
2239
+ properties:
2240
+ label:
2241
+ disabled: true
2242
+ placeholder: Start typing your document here...
2243
+ rows: 4
2244
+ - id: feature_actions
2245
+ type: Box
2246
+ layout:
2247
+ gap: 8
2248
+ justify: flex-end
2249
+ blocks:
2250
+ - id: feature_tour_btn
2251
+ type: Button
2252
+ layout:
2253
+ flex: 0 0 auto
2254
+ properties:
2255
+ title: Learn Editor Features
2256
+ color: primary
2257
+ variant: outlined
2258
+ icon: AiOutlineBulb
2259
+ events:
2260
+ onClick:
2261
+ - id: feature_start_tour
2262
+ type: SetState
2263
+ params:
2264
+ show_feature_tour: true
2265
+ - id: feature_tour
2266
+ type: Tour
2267
+ properties:
2268
+ open:
2269
+ _state: show_feature_tour
2270
+ type: primary
2271
+ mask: true
2272
+ animated: true
2273
+ closable: true
2274
+ steps:
2275
+ - title: Formatting Tools
2276
+ description: Use Bold and Italic buttons to format your text.
2277
+ target: feature_bold_btn
2278
+ placement: bottom
2279
+ type: default
2280
+ - title: Save Your Work
2281
+ description: Click Save to store your document. Your work is automatically backed up every 5 minutes.
2282
+ target: feature_save_btn
2283
+ placement: bottom
2284
+ type: primary
2285
+ - title: Export Options
2286
+ description: Export your document as PDF, Word, or plain text for sharing.
2287
+ target: feature_export_btn
2288
+ placement: bottom
2289
+ type: default
2290
+ events:
2291
+ onClose:
2292
+ - id: feature_close
2293
+ type: SetState
2294
+ params:
2295
+ show_feature_tour: false
2296
+ onFinish:
2297
+ - id: feature_finish_state
2298
+ type: SetState
2299
+ params:
2300
+ show_feature_tour: false
2301
+ - id: feature_finish_msg
2302
+ type: DisplayMessage
2303
+ params:
2304
+ content: You are now familiar with the editor features!
2305
+ status: success