@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,1162 @@
1
+ # Selector
2
+
3
+ Dropdown selector with search, clear, and custom icons.
4
+
5
+ ```yaml
6
+ - id: basic_selector
7
+ type: Selector
8
+ properties:
9
+ title: Favorite Fruit
10
+ options:
11
+ - label: Apple
12
+ value: apple
13
+ - label: Banana
14
+ value: banana
15
+ - label: Cherry
16
+ value: cherry
17
+ - label: Dragonfruit
18
+ value: dragonfruit
19
+ - label: Elderberry
20
+ value: elderberry
21
+ - id: basic_placeholder
22
+ type: Selector
23
+ properties:
24
+ title: Country
25
+ placeholder: Choose a country...
26
+ options:
27
+ - label: United States
28
+ value: us
29
+ - label: United Kingdom
30
+ value: uk
31
+ - label: Canada
32
+ value: ca
33
+ - label: Australia
34
+ value: au
35
+ - label: Germany
36
+ value: de
37
+ ```
38
+
39
+ ```yaml
40
+ - id: string_options
41
+ type: Selector
42
+ properties:
43
+ title: Simple Strings
44
+ placeholder: Pick a color...
45
+ options:
46
+ - Red
47
+ - Orange
48
+ - Yellow
49
+ - Green
50
+ - Blue
51
+ - Indigo
52
+ - Violet
53
+ - id: number_options_mixed
54
+ type: Selector
55
+ properties:
56
+ title: Quantities
57
+ placeholder: Choose quantity...
58
+ options:
59
+ - label: One item
60
+ value: 1
61
+ - label: Five items
62
+ value: 5
63
+ - label: Ten items
64
+ value: 10
65
+ - label: Twenty-five items
66
+ value: 25
67
+ - label: One hundred items
68
+ value: 100
69
+ - id: html_labels
70
+ type: Selector
71
+ properties:
72
+ title: HTML Labels
73
+ placeholder: Select a priority...
74
+ options:
75
+ - label: '<span style="color: #f5222d; font-weight: bold;">Critical</span>'
76
+ value: critical
77
+ - label: '<span style="color: #fa8c16; font-weight: bold;">High</span>'
78
+ value: high
79
+ - label: '<span style="color: #fadb14; font-weight: bold;">Medium</span>'
80
+ value: medium
81
+ - label: '<span style="color: #52c41a; font-weight: bold;">Low</span>'
82
+ value: low
83
+ - label: '<span style="color: #8c8c8c;">None</span>'
84
+ value: none
85
+ - id: styled_options
86
+ type: Selector
87
+ properties:
88
+ title: Color Swatches
89
+ placeholder: Pick a theme color...
90
+ options:
91
+ - label: Ocean Blue
92
+ value: ocean
93
+ style:
94
+ color: "#1677ff"
95
+ fontWeight: bold
96
+ - label: Forest Green
97
+ value: forest
98
+ style:
99
+ color: "#52c41a"
100
+ fontWeight: bold
101
+ - label: Sunset Orange
102
+ value: sunset
103
+ style:
104
+ color: "#fa8c16"
105
+ fontWeight: bold
106
+ - label: Berry Purple
107
+ value: berry
108
+ style:
109
+ color: "#722ed1"
110
+ fontWeight: bold
111
+ - label: Coral Red
112
+ value: coral
113
+ style:
114
+ color: "#f5222d"
115
+ fontWeight: bold
116
+ - id: disabled_options
117
+ type: Selector
118
+ properties:
119
+ title: Product Availability
120
+ placeholder: Select a product...
121
+ options:
122
+ - label: Widget A - In Stock
123
+ value: widget_a
124
+ - label: Widget B - Sold Out
125
+ value: widget_b
126
+ disabled: true
127
+ - label: Widget C - In Stock
128
+ value: widget_c
129
+ - label: Widget D - Coming Soon
130
+ value: widget_d
131
+ disabled: true
132
+ - label: Widget E - In Stock
133
+ value: widget_e
134
+ ```
135
+
136
+ ```yaml
137
+ - id: filter_string
138
+ type: Selector
139
+ properties:
140
+ title: Country (Search by Name or Code)
141
+ showSearch: true
142
+ placeholder: Type name or country code...
143
+ options:
144
+ - label: United States
145
+ value: us
146
+ filterString: United States US USA America
147
+ - label: United Kingdom
148
+ value: uk
149
+ filterString: United Kingdom UK GB Britain England
150
+ - label: Canada
151
+ value: ca
152
+ filterString: Canada CA
153
+ - label: Australia
154
+ value: au
155
+ filterString: Australia AU Aussie
156
+ - label: Germany
157
+ value: de
158
+ filterString: Germany DE Deutschland
159
+ - label: France
160
+ value: fr
161
+ filterString: France FR
162
+ - label: Japan
163
+ value: jp
164
+ filterString: Japan JP Nippon
165
+ - label: Brazil
166
+ value: br
167
+ filterString: Brazil BR Brasil
168
+ - id: filter_string_html
169
+ type: Selector
170
+ properties:
171
+ title: Employee (Search by Name or Department)
172
+ showSearch: true
173
+ placeholder: Search employees...
174
+ options:
175
+ - label: <b>Alice Johnson</b> - <small>Engineering</small>
176
+ value: alice
177
+ filterString: Alice Johnson Engineering Frontend
178
+ - label: <b>Bob Smith</b> - <small>Design</small>
179
+ value: bob
180
+ filterString: Bob Smith Design UI UX
181
+ - label: <b>Carol Williams</b> - <small>Marketing</small>
182
+ value: carol
183
+ filterString: Carol Williams Marketing Content
184
+ - label: <b>Dave Brown</b> - <small>Sales</small>
185
+ value: dave
186
+ filterString: Dave Brown Sales Account
187
+ - id: search_disabled
188
+ type: Selector
189
+ properties:
190
+ title: Non-Searchable
191
+ showSearch: false
192
+ placeholder: Select without search...
193
+ options:
194
+ - label: Option A
195
+ value: a
196
+ - label: Option B
197
+ value: b
198
+ - label: Option C
199
+ value: c
200
+ ```
201
+
202
+ ```yaml
203
+ - id: allow_clear_false
204
+ type: Selector
205
+ properties:
206
+ title: Not Clearable
207
+ allowClear: false
208
+ placeholder: Cannot be cleared once set...
209
+ options:
210
+ - label: Red
211
+ value: red
212
+ - label: Green
213
+ value: green
214
+ - label: Blue
215
+ value: blue
216
+ - id: bordered_false
217
+ type: Selector
218
+ properties:
219
+ title: Borderless
220
+ bordered: false
221
+ options:
222
+ - label: Option A
223
+ value: a
224
+ - label: Option B
225
+ value: b
226
+ - label: Option C
227
+ value: c
228
+ - id: arrow_hidden
229
+ type: Selector
230
+ properties:
231
+ title: Arrow Hidden
232
+ showArrow: false
233
+ options:
234
+ - label: Alpha
235
+ value: alpha
236
+ - label: Beta
237
+ value: beta
238
+ - label: Gamma
239
+ value: gamma
240
+ - id: disabled_selector
241
+ type: Selector
242
+ properties:
243
+ title: Fully Disabled
244
+ disabled: true
245
+ placeholder: This selector is disabled
246
+ options:
247
+ - label: Option A
248
+ value: a
249
+ - label: Option B
250
+ value: b
251
+ - label: Option C
252
+ value: c
253
+ - id: no_label_selector
254
+ type: Selector
255
+ properties:
256
+ label:
257
+ disabled: true
258
+ placeholder: Select a color...
259
+ options:
260
+ - label: Red
261
+ value: red
262
+ - label: Orange
263
+ value: orange
264
+ - label: Yellow
265
+ value: yellow
266
+ - label: Green
267
+ value: green
268
+ - label: Blue
269
+ value: blue
270
+ ```
271
+
272
+ ```yaml
273
+ - id: size_small
274
+ type: Selector
275
+ properties:
276
+ title: Small
277
+ size: small
278
+ placeholder: Small selector...
279
+ options:
280
+ - Apple
281
+ - Banana
282
+ - Cherry
283
+ - Date
284
+ - Elderberry
285
+ - id: size_default
286
+ type: Selector
287
+ properties:
288
+ title: Default
289
+ placeholder: Default selector...
290
+ options:
291
+ - Apple
292
+ - Banana
293
+ - Cherry
294
+ - Date
295
+ - Elderberry
296
+ - id: size_large
297
+ type: Selector
298
+ properties:
299
+ title: Large
300
+ size: large
301
+ placeholder: Large selector...
302
+ options:
303
+ - Apple
304
+ - Banana
305
+ - Cherry
306
+ - Date
307
+ - Elderberry
308
+ ```
309
+
310
+ ```yaml
311
+ - id: custom_suffix_icon
312
+ type: Selector
313
+ properties:
314
+ title: Custom Suffix Icon
315
+ suffixIcon: AiOutlineSearch
316
+ placeholder: Search items...
317
+ options:
318
+ - label: Database
319
+ value: database
320
+ - label: Server
321
+ value: server
322
+ - label: Cloud
323
+ value: cloud
324
+ - id: custom_suffix_icon_object
325
+ type: Selector
326
+ properties:
327
+ title: Styled Suffix Icon
328
+ suffixIcon:
329
+ name: AiOutlineFilter
330
+ color: "#722ed1"
331
+ placeholder: Filter options...
332
+ options:
333
+ - label: All Items
334
+ value: all
335
+ - label: Active Only
336
+ value: active
337
+ - label: Archived
338
+ value: archived
339
+ - id: custom_clear_icon
340
+ type: Selector
341
+ properties:
342
+ title: Custom Clear Icon
343
+ clearIcon: AiOutlineDelete
344
+ placeholder: Select to see custom clear icon...
345
+ options:
346
+ - label: Item One
347
+ value: one
348
+ - label: Item Two
349
+ value: two
350
+ - label: Item Three
351
+ value: three
352
+ - id: custom_clear_icon_object
353
+ type: Selector
354
+ properties:
355
+ title: Styled Clear Icon
356
+ clearIcon:
357
+ name: AiOutlineCloseCircle
358
+ color: "#f5222d"
359
+ placeholder: Select then hover to clear...
360
+ options:
361
+ - label: First
362
+ value: first
363
+ - label: Second
364
+ value: second
365
+ - label: Third
366
+ value: third
367
+ ```
368
+
369
+ ```yaml
370
+ - id: placeholder_default
371
+ type: Selector
372
+ properties:
373
+ title: Default Placeholder
374
+ options:
375
+ - Apple
376
+ - Banana
377
+ - Cherry
378
+ - id: placeholder_custom
379
+ type: Selector
380
+ properties:
381
+ title: Custom Placeholder
382
+ placeholder: Please choose a fruit...
383
+ options:
384
+ - Apple
385
+ - Banana
386
+ - Cherry
387
+ - id: loading_placeholder
388
+ type: Selector
389
+ properties:
390
+ title: Loading Placeholder
391
+ loadingPlaceholder: Fetching results...
392
+ placeholder: Search with onSearch event...
393
+ showSearch: true
394
+ options:
395
+ - label: Result A
396
+ value: a
397
+ - label: Result B
398
+ value: b
399
+ - id: not_found_content
400
+ type: Selector
401
+ properties:
402
+ title: Custom Not Found
403
+ notFoundContent: No matching items found
404
+ showSearch: true
405
+ placeholder: Type something that does not match...
406
+ options:
407
+ - label: Alpha
408
+ value: alpha
409
+ - label: Beta
410
+ value: beta
411
+ ```
412
+
413
+ ```yaml
414
+ - id: label_default
415
+ type: Selector
416
+ properties:
417
+ title: Default Label
418
+ options:
419
+ - Apple
420
+ - Banana
421
+ - Cherry
422
+ - id: label_no_colon
423
+ type: Selector
424
+ properties:
425
+ title: No Colon
426
+ label:
427
+ colon: false
428
+ options:
429
+ - Apple
430
+ - Banana
431
+ - Cherry
432
+ - id: label_inline
433
+ type: Selector
434
+ properties:
435
+ title: Inline Label
436
+ label:
437
+ inline: true
438
+ span: 8
439
+ options:
440
+ - Apple
441
+ - Banana
442
+ - Cherry
443
+ - id: label_inline_right
444
+ type: Selector
445
+ properties:
446
+ title: Inline Right
447
+ label:
448
+ inline: true
449
+ span: 8
450
+ align: right
451
+ options:
452
+ - Apple
453
+ - Banana
454
+ - Cherry
455
+ - id: label_extra
456
+ type: Selector
457
+ properties:
458
+ title: With Extra Text
459
+ label:
460
+ extra: Select your preferred fruit from the list.
461
+ options:
462
+ - Apple
463
+ - Banana
464
+ - Cherry
465
+ ```
466
+
467
+ ```yaml
468
+ - id: css_element
469
+ type: Selector
470
+ properties:
471
+ title: Styled Element
472
+ placeholder: Custom styled selector...
473
+ options:
474
+ - label: Apple
475
+ value: apple
476
+ - label: Banana
477
+ value: banana
478
+ - label: Cherry
479
+ value: cherry
480
+ style:
481
+ .element:
482
+ borderColor: "#4096ff"
483
+ borderRadius: 8
484
+ - id: css_label
485
+ type: Selector
486
+ properties:
487
+ title: Styled Label
488
+ options:
489
+ - label: Alpha
490
+ value: alpha
491
+ - label: Beta
492
+ value: beta
493
+ style:
494
+ .label:
495
+ color: "#722ed1"
496
+ fontWeight: bold
497
+ fontSize: 16
498
+ - id: css_extra
499
+ type: Selector
500
+ properties:
501
+ title: Styled Extra
502
+ label:
503
+ extra: This extra text has custom styling.
504
+ options:
505
+ - Red
506
+ - Green
507
+ - Blue
508
+ style:
509
+ .extra:
510
+ color: "#8c8c8c"
511
+ fontStyle: italic
512
+ - id: css_options
513
+ type: Selector
514
+ properties:
515
+ title: Styled Options
516
+ placeholder: Options have custom padding...
517
+ options:
518
+ - label: Styled Option A
519
+ value: a
520
+ - label: Styled Option B
521
+ value: b
522
+ - label: Styled Option C
523
+ value: c
524
+ style:
525
+ .options:
526
+ padding: 8px 16px
527
+ fontSize: 15
528
+ ```
529
+
530
+ ```yaml
531
+ - id: class_element
532
+ type: Selector
533
+ properties:
534
+ title: Tailwind Classes
535
+ placeholder: Select with classes...
536
+ options:
537
+ - label: One
538
+ value: 1
539
+ - label: Two
540
+ value: 2
541
+ - label: Three
542
+ value: 3
543
+ class:
544
+ element: rounded-lg shadow-sm
545
+ - id: class_label
546
+ type: Selector
547
+ properties:
548
+ title: Styled Label Class
549
+ options:
550
+ - label: Alpha
551
+ value: alpha
552
+ - label: Beta
553
+ value: beta
554
+ class:
555
+ label: text-blue-600 font-semibold
556
+ ```
557
+
558
+ ```yaml
559
+ - id: many_options
560
+ type: Selector
561
+ properties:
562
+ title: Long List
563
+ showSearch: true
564
+ placeholder: Scroll or search through many options...
565
+ options:
566
+ - label: Afghanistan
567
+ value: AF
568
+ - label: Albania
569
+ value: AL
570
+ - label: Algeria
571
+ value: DZ
572
+ - label: Argentina
573
+ value: AR
574
+ - label: Australia
575
+ value: AU
576
+ - label: Austria
577
+ value: AT
578
+ - label: Belgium
579
+ value: BE
580
+ - label: Brazil
581
+ value: BR
582
+ - label: Canada
583
+ value: CA
584
+ - label: Chile
585
+ value: CL
586
+ - label: China
587
+ value: CN
588
+ - label: Colombia
589
+ value: CO
590
+ - label: Czech Republic
591
+ value: CZ
592
+ - label: Denmark
593
+ value: DK
594
+ - label: Egypt
595
+ value: EG
596
+ - label: Finland
597
+ value: FI
598
+ - label: France
599
+ value: FR
600
+ - label: Germany
601
+ value: DE
602
+ - label: Greece
603
+ value: GR
604
+ - label: India
605
+ value: IN
606
+ - label: Indonesia
607
+ value: ID
608
+ - label: Ireland
609
+ value: IE
610
+ - label: Italy
611
+ value: IT
612
+ - label: Japan
613
+ value: JP
614
+ - label: Mexico
615
+ value: MX
616
+ - label: Netherlands
617
+ value: NL
618
+ - label: New Zealand
619
+ value: NZ
620
+ - label: Norway
621
+ value: NO
622
+ - label: Poland
623
+ value: PL
624
+ - label: Portugal
625
+ value: PT
626
+ - label: Russia
627
+ value: RU
628
+ - label: South Africa
629
+ value: ZA
630
+ - label: South Korea
631
+ value: KR
632
+ - label: Spain
633
+ value: ES
634
+ - label: Sweden
635
+ value: SE
636
+ - label: Switzerland
637
+ value: CH
638
+ - label: Thailand
639
+ value: TH
640
+ - label: Turkey
641
+ value: TR
642
+ - label: United Kingdom
643
+ value: GB
644
+ - label: United States
645
+ value: US
646
+ - label: Vietnam
647
+ value: VN
648
+ ```
649
+
650
+ ```yaml
651
+ - id: theme_custom_colors
652
+ type: Selector
653
+ properties:
654
+ title: Custom Selection Colors
655
+ placeholder: Select to see custom highlight...
656
+ options:
657
+ - label: Apple
658
+ value: apple
659
+ - label: Banana
660
+ value: banana
661
+ - label: Cherry
662
+ value: cherry
663
+ - label: Date
664
+ value: date
665
+ - label: Elderberry
666
+ value: elderberry
667
+ theme:
668
+ optionSelectedColor: "#722ed1"
669
+ optionSelectedFontWeight: 700
670
+ - id: theme_border_colors
671
+ type: Selector
672
+ properties:
673
+ title: Custom Border Colors
674
+ placeholder: Focus to see border color...
675
+ options:
676
+ - label: Red
677
+ value: red
678
+ - label: Green
679
+ value: green
680
+ - label: Blue
681
+ value: blue
682
+ theme:
683
+ hoverBorderColor: "#52c41a"
684
+ activeBorderColor: "#389e0d"
685
+ activeOutlineColor: rgba(82, 196, 26, 0.1)
686
+ - id: theme_option_size
687
+ type: Selector
688
+ properties:
689
+ title: Large Options
690
+ placeholder: Options have increased height...
691
+ options:
692
+ - label: Spacious Option A
693
+ value: a
694
+ - label: Spacious Option B
695
+ value: b
696
+ - label: Spacious Option C
697
+ value: c
698
+ theme:
699
+ optionHeight: 44
700
+ optionFontSize: 16
701
+ optionLineHeight: 1.8
702
+ optionPadding: 8px 16px
703
+ - id: theme_size_sm
704
+ type: Selector
705
+ properties:
706
+ title: Custom Small
707
+ size: small
708
+ placeholder: Custom small selector...
709
+ options:
710
+ - Alpha
711
+ - Beta
712
+ - Gamma
713
+ theme:
714
+ controlHeightSM: 20
715
+ borderRadiusSM: 2
716
+ fontSizeSM: 12
717
+ - id: theme_combined
718
+ type: Selector
719
+ properties:
720
+ title: Fully Customized
721
+ placeholder: Purple themed selector...
722
+ options:
723
+ - label: Dashboard
724
+ value: dashboard
725
+ - label: Analytics
726
+ value: analytics
727
+ - label: Reports
728
+ value: reports
729
+ - label: Settings
730
+ value: settings
731
+ theme:
732
+ colorPrimary: "#722ed1"
733
+ borderRadius: 12
734
+ fontSize: 15
735
+ optionSelectedColor: "#531dab"
736
+ hoverBorderColor: "#b37feb"
737
+ activeBorderColor: "#722ed1"
738
+ activeOutlineColor: rgba(114, 46, 209, 0.1)
739
+ optionHeight: 40
740
+ ```
741
+
742
+ ```yaml
743
+ - id: combined_search_styled
744
+ type: Selector
745
+ properties:
746
+ title: Searchable Styled Options
747
+ showSearch: true
748
+ placeholder: Search and select a status...
749
+ suffixIcon: AiOutlineSearch
750
+ options:
751
+ - label: '<span style="color: #52c41a;">Active</span>'
752
+ value: active
753
+ filterString: Active Running Live
754
+ - label: '<span style="color: #faad14;">Pending</span>'
755
+ value: pending
756
+ filterString: Pending Waiting Queue
757
+ - label: '<span style="color: #f5222d;">Error</span>'
758
+ value: error
759
+ filterString: Error Failed Broken
760
+ - label: '<span style="color: #8c8c8c;">Archived</span>'
761
+ value: archived
762
+ filterString: Archived Old Removed
763
+ disabled: true
764
+ - id: combined_large_custom
765
+ type: Selector
766
+ properties:
767
+ title: Large Custom Selector
768
+ size: large
769
+ showSearch: true
770
+ placeholder: Choose a department...
771
+ suffixIcon:
772
+ name: AiOutlineTeam
773
+ color: "#1677ff"
774
+ clearIcon:
775
+ name: AiOutlineClose
776
+ color: "#ff4d4f"
777
+ options:
778
+ - label: <b>Engineering</b>
779
+ value: engineering
780
+ filterString: Engineering Dev Software
781
+ - label: <b>Design</b>
782
+ value: design
783
+ filterString: Design UI UX Creative
784
+ - label: <b>Marketing</b>
785
+ value: marketing
786
+ filterString: Marketing Growth Brand
787
+ - label: <b>Sales</b>
788
+ value: sales
789
+ filterString: Sales Revenue Business
790
+ - label: <b>Support</b>
791
+ value: support
792
+ filterString: Support Help Customer Service
793
+ theme:
794
+ borderRadius: 12
795
+ optionHeight: 40
796
+ - id: combined_borderless_small
797
+ type: Selector
798
+ properties:
799
+ title: Compact Borderless
800
+ size: small
801
+ bordered: false
802
+ showSearch: false
803
+ showArrow: true
804
+ placeholder: Quick pick...
805
+ options:
806
+ - label: Today
807
+ value: today
808
+ - label: This Week
809
+ value: week
810
+ - label: This Month
811
+ value: month
812
+ - label: This Year
813
+ value: year
814
+ - id: combined_inline_themed
815
+ type: Selector
816
+ properties:
817
+ title: Inline Themed
818
+ label:
819
+ inline: true
820
+ span: 6
821
+ colon: false
822
+ placeholder: Select role...
823
+ options:
824
+ - label: Admin
825
+ value: admin
826
+ - label: Editor
827
+ value: editor
828
+ - label: Viewer
829
+ value: viewer
830
+ theme:
831
+ colorPrimary: "#13c2c2"
832
+ borderRadius: 8
833
+ hoverBorderColor: "#13c2c2"
834
+ activeBorderColor: "#08979c"
835
+ ```
836
+
837
+ ```yaml
838
+ - id: applied2_registration_card
839
+ type: Card
840
+ properties:
841
+ title: User Preferences
842
+ blocks:
843
+ - id: applied2_reg_country
844
+ type: Selector
845
+ properties:
846
+ title: Country
847
+ showSearch: true
848
+ placeholder: Select your country...
849
+ suffixIcon: AiOutlineGlobal
850
+ options:
851
+ - label: United States
852
+ value: us
853
+ - label: United Kingdom
854
+ value: uk
855
+ - label: Canada
856
+ value: ca
857
+ - label: Australia
858
+ value: au
859
+ - label: Germany
860
+ value: de
861
+ - label: France
862
+ value: fr
863
+ - label: Japan
864
+ value: jp
865
+ - label: Brazil
866
+ value: br
867
+ - label: South Africa
868
+ value: za
869
+ - id: applied2_reg_language
870
+ type: Selector
871
+ properties:
872
+ title: Preferred Language
873
+ placeholder: Select language...
874
+ options:
875
+ - label: English
876
+ value: en
877
+ - label: Spanish
878
+ value: es
879
+ - label: French
880
+ value: fr
881
+ - label: German
882
+ value: de
883
+ - label: Japanese
884
+ value: ja
885
+ - label: Portuguese
886
+ value: pt
887
+ - id: applied2_reg_timezone
888
+ type: Selector
889
+ properties:
890
+ title: Timezone
891
+ showSearch: true
892
+ placeholder: Select your timezone...
893
+ suffixIcon: AiOutlineClockCircle
894
+ label:
895
+ extra: Used for scheduling and notifications.
896
+ options:
897
+ - label: UTC-8 Pacific Time
898
+ value: america_los_angeles
899
+ - label: UTC-5 Eastern Time
900
+ value: america_new_york
901
+ - label: UTC+0 London
902
+ value: europe_london
903
+ - label: UTC+1 Berlin
904
+ value: europe_berlin
905
+ - label: UTC+8 Singapore
906
+ value: asia_singapore
907
+ - label: UTC+9 Tokyo
908
+ value: asia_tokyo
909
+ - label: UTC+10 Sydney
910
+ value: australia_sydney
911
+ - id: applied2_reg_save_btn
912
+ type: Button
913
+ properties:
914
+ title: Save Preferences
915
+ icon: AiOutlineSave
916
+ type: primary
917
+ size: large
918
+ block: true
919
+ events:
920
+ onClick:
921
+ - id: save_prefs_action
922
+ type: DisplayMessage
923
+ params:
924
+ content: Your preferences have been saved.
925
+ duration: 3
926
+ ```
927
+
928
+ ```yaml
929
+ - id: applied3_order_card
930
+ type: Card
931
+ properties:
932
+ title: Place an Order
933
+ blocks:
934
+ - id: applied3_product
935
+ type: Selector
936
+ properties:
937
+ title: Product
938
+ showSearch: true
939
+ placeholder: Select a product...
940
+ suffixIcon: AiOutlineShopping
941
+ options:
942
+ - label: Laptop Pro 15"
943
+ value: laptop_pro
944
+ - label: Wireless Mouse
945
+ value: mouse
946
+ - label: Mechanical Keyboard
947
+ value: keyboard
948
+ - label: USB-C Hub
949
+ value: hub
950
+ - label: Monitor 27"
951
+ value: monitor
952
+ events:
953
+ onChange:
954
+ - id: set_product_state
955
+ type: SetState
956
+ params:
957
+ selected_product:
958
+ _state: applied3_product
959
+ - id: applied3_quantity
960
+ type: Selector
961
+ properties:
962
+ title: Quantity
963
+ allowClear: false
964
+ placeholder: Select quantity...
965
+ options:
966
+ - label: "1"
967
+ value: 1
968
+ - label: "2"
969
+ value: 2
970
+ - label: "5"
971
+ value: 5
972
+ - label: "10"
973
+ value: 10
974
+ events:
975
+ onChange:
976
+ - id: set_quantity_state
977
+ type: SetState
978
+ params:
979
+ selected_quantity:
980
+ _state: applied3_quantity
981
+ - id: applied3_shipping
982
+ type: Selector
983
+ properties:
984
+ title: Shipping Method
985
+ placeholder: Choose shipping...
986
+ options:
987
+ - label: Standard (5-7 days)
988
+ value: standard
989
+ - label: Express (2-3 days)
990
+ value: express
991
+ - label: Overnight
992
+ value: overnight
993
+ style:
994
+ color: "#1677ff"
995
+ fontWeight: bold
996
+ - id: applied3_place_order_btn
997
+ type: Button
998
+ properties:
999
+ title: Place Order
1000
+ icon: AiOutlineCheckCircle
1001
+ type: primary
1002
+ size: large
1003
+ block: true
1004
+ events:
1005
+ onClick:
1006
+ - id: order_confirmation
1007
+ type: DisplayMessage
1008
+ params:
1009
+ content: Order placed successfully!
1010
+ duration: 3
1011
+ ```
1012
+
1013
+ ```yaml
1014
+ - id: selector_color_solid
1015
+ type: Selector
1016
+ properties:
1017
+ title: Solid — the whole input filled with the selected option color
1018
+ variant: solid
1019
+ options:
1020
+ - label: Low
1021
+ value: low
1022
+ color: "#16a34a"
1023
+ - label: Medium
1024
+ value: medium
1025
+ color: "#d97706"
1026
+ - label: High
1027
+ value: high
1028
+ color: "#dc2626"
1029
+ - id: selector_color_outlined
1030
+ type: Selector
1031
+ properties:
1032
+ title: Outlined — input border + value colored
1033
+ variant: outlined
1034
+ options:
1035
+ - label: Low
1036
+ value: low
1037
+ color: "#16a34a"
1038
+ - label: Medium
1039
+ value: medium
1040
+ color: "#d97706"
1041
+ - label: High
1042
+ value: high
1043
+ color: "#dc2626"
1044
+ ```
1045
+
1046
+ ```yaml
1047
+ - id: data_selector
1048
+ type: Selector
1049
+ properties:
1050
+ title: Plan
1051
+ placeholder: Choose a plan...
1052
+ data:
1053
+ - id: 1
1054
+ name: Starter
1055
+ - id: 2
1056
+ name: Pro
1057
+ - id: 3
1058
+ name: Enterprise
1059
+ html: "{{ item.name }}"
1060
+ valueKey: id
1061
+ ```
1062
+
1063
+ | Property | Type | Default | Description |
1064
+ | --- | --- | --- | --- |
1065
+ | `allowClear` | boolean | `true` | Allow the user to clear the selected value, sets the value to null. |
1066
+ | `autoFocus` | boolean | `false` | Autofocus to the block on page load. |
1067
+ | `bordered` | boolean | `true` | Whether or not the selector has a border style. Deprecated, use variant instead. |
1068
+ | `clearIcon` | string \| object | `"AiOutlineCloseCircle"` | Name of an React-Icon (See all icons) or properties of an Icon block to customize icon at far right position of the selector, shown when user is given option to clear input. |
1069
+ | `label` | object | - | Label properties. |
1070
+ | `label.align` | string | `"left"` | Align label left or right when inline. Enum: `left`, `right`. |
1071
+ | `label.colon` | boolean | `true` | Append label with colon. |
1072
+ | `label.extra` | string | - | Extra text to display beneath the content - supports html. |
1073
+ | `label.title` | string | - | Label title - supports html. |
1074
+ | `label.tooltip` | string \| object | - | Help tooltip shown via an icon beside the label. A string sets the tooltip text (supports html), or an object to also customize the icon and color. Use the block's onTooltipClick event to respond to clicks on the icon. |
1075
+ | `label.tooltip.title` | string | - | Tooltip text shown on hover - supports html. |
1076
+ | `label.tooltip.icon` | string | `"AiOutlineQuestionCircle"` | Name of the icon to show beside the label. |
1077
+ | `label.tooltip.color` | string | - | Color of the tooltip icon. |
1078
+ | `label.span` | number | - | Label inline span. |
1079
+ | `label.disabled` | boolean | `false` | Hide input label. |
1080
+ | `label.hasFeedback` | boolean | `true` | Display feedback extra from validation, this does not disable validation. |
1081
+ | `label.inline` | boolean | `false` | Render input and label inline. |
1082
+ | `disabled` | boolean | `false` | Disable the block if true. |
1083
+ | `data` | array | - | Alternative to `options`: an array of raw rows. Each row is rendered to a label with the `html` template, and `valueKey` selects which field becomes the value. Use this to drive a selector directly from data without building label/value pairs in your request. |
1084
+ | `html` | string | - | Nunjucks template that renders each option label when using `data`. The context exposes `item` (the current row) and `index` (the zero-based row index). Ignored when `options` is used. |
1085
+ | `valueKey` | string | - | Field used as the selected value. With `options` it names the value field (defaults to "value"). With `data` it names the field stored when an option is selected; omit it to store the whole row. Supports dotted paths (e.g. "user.id"). |
1086
+ | `primaryKey` | string | - | Field used to match the current value (e.g. set with SetState) back to an option for highlighting. Defaults to `valueKey`. Set this when the stored value is the whole row but a single field (e.g. "id") uniquely identifies it. In the tree selectors it also serves as each node’s id, referenced by `parentKey`. Supports dotted paths. |
1087
+ | `options` | array | `[]` | Options can either be an array of primitive values, on an array of label, value pairs - supports html. |
1088
+ | `options.$.label` | string | - | Value label shown to user - supports html. |
1089
+ | `options.$.value` | string \| number \| boolean \| object \| array | - | Value selected. Can be of any type. |
1090
+ | `options.$.disabled` | boolean | `false` | Disable the option if true. |
1091
+ | `options.$.filterString` | string | - | String to match against when filtering selector options during. If no filterString is provided the filter method matches against options.label. |
1092
+ | `options.$.style` | object | - | Css style to applied to option. |
1093
+ | `options.$.color` | string | - | Color applied to the selected value shown in the input, and used to tint this option in the dropdown. |
1094
+ | `placeholder` | string | `"Select item"` | Placeholder text inside the block before user selects input. |
1095
+ | `loadingPlaceholder` | string | `"Loading"` | Placeholder text to show in options while the block is loading. |
1096
+ | `notFoundContent` | string | `"not Found"` | Placeholder text to show when list of options are empty. |
1097
+ | `showArrow` | boolean | `true` | Show the suffix icon at the drop-down position of the selector. |
1098
+ | `showSearch` | boolean | `true` | Make the selector options searchable. |
1099
+ | `size` | string | `"default"` | Size of the block. Enum: `small`, `default`, `large`. |
1100
+ | `suffixIcon` | string \| object | `"AiOutlineDown"` | Name of an React-Icon (See all icons) or properties of an Icon block to customize icon at the drop-down position of the selector. |
1101
+ | `title` | string | - | Title to describe the input component, if no title is specified the block id is displayed - supports html. |
1102
+ | `variant` | string | - | Input variant. `solid` fills the whole input with the selected option color; `outlined` colors its border/text. `filled`/`borderless` are the antd input styles. Enum: `solid`, `outlined`, `filled`, `borderless`. |
1103
+ | `theme` | object | - | Antd design token overrides for this block. See [antd design tokens](https://ant.design/components/overview#design-token). See [Ant Design select tokens](https://ant.design/components/select#design-token). |
1104
+ | `theme.borderRadius` | number | `6` | Border radius of the selector. |
1105
+ | `theme.borderRadiusLG` | number | `8` | Border radius for large selectors. |
1106
+ | `theme.borderRadiusSM` | number | `4` | Border radius for small selectors. |
1107
+ | `theme.clearBg` | string | `"#ffffff"` | Background color of the clear button. |
1108
+ | `theme.colorBorder` | string | - | Border color of the selector. |
1109
+ | `theme.colorPrimary` | string | - | Primary color override for the selector. |
1110
+ | `theme.colorText` | string | - | Text color of the selector input. |
1111
+ | `theme.controlHeight` | number | `32` | Height of the selector. |
1112
+ | `theme.controlHeightLG` | number | `40` | Height for large selectors. |
1113
+ | `theme.controlHeightSM` | number | `24` | Height for small selectors. |
1114
+ | `theme.fontSize` | number | `14` | Font size of the selector input text. |
1115
+ | `theme.fontSizeLG` | number | `16` | Font size for large selectors. |
1116
+ | `theme.fontSizeSM` | number | `14` | Font size for small selectors. |
1117
+ | `theme.hoverBorderColor` | string | `"#4096ff"` | Border color when the selector is hovered. |
1118
+ | `theme.activeBorderColor` | string | `"#1677ff"` | Border color when the selector is focused or active. |
1119
+ | `theme.activeOutlineColor` | string | `"rgba(5, 145, 255, 0.1)"` | Outline color when the selector is focused. |
1120
+ | `theme.multipleItemBg` | string | `"rgba(0, 0, 0, 0.06)"` | Background color of selected items in multiple mode. |
1121
+ | `theme.multipleItemBorderColor` | string | `"transparent"` | Border color of selected items in multiple mode. |
1122
+ | `theme.multipleItemHeight` | number | `24` | Height of selected item tags in multiple mode. |
1123
+ | `theme.multipleItemHeightSM` | number | `16` | Height of selected item tags in small multiple mode. |
1124
+ | `theme.multipleItemHeightLG` | number | `32` | Height of selected item tags in large multiple mode. |
1125
+ | `theme.multipleSelectorBgDisabled` | string | `"rgba(0, 0, 0, 0.04)"` | Background of the selector in disabled multiple mode. |
1126
+ | `theme.multipleItemColorDisabled` | string | `"rgba(0, 0, 0, 0.25)"` | Text color of disabled items in multiple mode. |
1127
+ | `theme.multipleItemBorderColorDisabled` | string | `"transparent"` | Border color of disabled items in multiple mode. |
1128
+ | `theme.optionActiveBg` | string | `"rgba(0, 0, 0, 0.04)"` | Background color of an option when hovered or active. |
1129
+ | `theme.optionFontSize` | number | `14` | Font size of option text in the dropdown. |
1130
+ | `theme.optionHeight` | number | `32` | Height of each option in the dropdown. |
1131
+ | `theme.optionLineHeight` | number | - | Line height of option text in the dropdown. |
1132
+ | `theme.optionPadding` | string \| number | `"5px 12px"` | Padding inside each option in the dropdown. |
1133
+ | `theme.optionSelectedBg` | string | `"#e6f4ff"` | Background color of the selected option in the dropdown. |
1134
+ | `theme.optionSelectedColor` | string | `"rgba(0, 0, 0, 0.88)"` | Text color of the selected option in the dropdown. |
1135
+ | `theme.optionSelectedFontWeight` | number | `600` | Font weight of the selected option in the dropdown. |
1136
+ | `theme.selectorBg` | string | `"#ffffff"` | Background color of the selector input area. |
1137
+ | `theme.showArrowPaddingInlineEnd` | number | `18` | Padding at the inline end when the arrow is shown. |
1138
+ | `theme.singleItemHeightLG` | number | `40` | Height of the selector input in large single mode. |
1139
+ | `theme.zIndexPopup` | number | `1050` | Z-index of the dropdown popup. |
1140
+
1141
+ | Event | Event Data | Description |
1142
+ | --- | --- | --- |
1143
+ | `onBlur` | \- | Trigger action event occurs when selector loses focus. |
1144
+ | `onChange` | `{ value }` | Trigger action when selection is changed. |
1145
+ | `onFocus` | \- | Trigger action when selector gets focus. |
1146
+ | `onClear` | \- | Trigger action when selector is cleared. |
1147
+ | `onSearch` | `{ value }` | Trigger actions when input is changed. |
1148
+ | `onTooltipClick` | \- | Trigger actions when the tooltip icon is clicked. |
1149
+
1150
+ | Key | Target |
1151
+ | --- | --- |
1152
+ | `/block` | Outer block wrapper (always available). |
1153
+ | `/element` | The Selector element. |
1154
+ | `/selector` | The inner value/tag container of the Selector (antd `content` semantic slot). |
1155
+ | `/clearIcon` | The clear icon in the Selector. |
1156
+ | `/label` | The Selector label. |
1157
+ | `/extra` | The Selector extra content. |
1158
+ | `/feedback` | The Selector validation feedback. |
1159
+ | `/options` | The Selector options. |
1160
+ | `/suffixIcon` | The suffix icon in the Selector. |
1161
+
1162
+ No slots defined.