@lowdefy/docs-content 0.0.0-experimental-20260710073520

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