@lowdefy/docs-content 6.0.0 → 7.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (285) hide show
  1. package/README.md +1 -0
  2. package/content/actions/downloadcsv.md +1 -1
  3. package/content/actions/emailotpsend.md +58 -0
  4. package/content/actions/emailotpverify.md +79 -0
  5. package/content/actions/getlocalstorage.md +43 -0
  6. package/content/actions/link.md +47 -1
  7. package/content/actions/login.md +25 -5
  8. package/content/actions/logout.md +7 -5
  9. package/content/actions/magiclinkverify.md +117 -0
  10. package/content/actions/pdfmake.md +2 -2
  11. package/content/actions/posthogalias.md +29 -0
  12. package/content/actions/posthogcapture.md +49 -0
  13. package/content/actions/posthogcapturepageleave.md +38 -0
  14. package/content/actions/posthogfeatureflag.md +50 -0
  15. package/content/actions/posthoggroup.md +37 -0
  16. package/content/actions/posthogidentify.md +54 -0
  17. package/content/actions/posthoginit.md +96 -0
  18. package/content/actions/posthogoptin.md +29 -0
  19. package/content/actions/posthogoptout.md +29 -0
  20. package/content/actions/posthogpageview.md +37 -0
  21. package/content/actions/posthogreloadfeatureflags.md +47 -0
  22. package/content/actions/posthogreset.md +28 -0
  23. package/content/actions/posthogsetpersonproperties.md +36 -0
  24. package/content/actions/removelocalstorage.md +28 -0
  25. package/content/actions/resetvalidation.md +5 -3
  26. package/content/actions/setdarkmode.md +3 -3
  27. package/content/actions/setglobal.md +2 -0
  28. package/content/actions/setlocale.md +1 -1
  29. package/content/actions/setlocalstorage.md +34 -0
  30. package/content/actions/setstate.md +2 -0
  31. package/content/actions/validate.md +7 -4
  32. package/content/adapter-reference/mongodbauthadapter.md +46 -0
  33. package/content/agents/agent-endpoint-tools.md +24 -0
  34. package/content/agents/agent-properties.md +13 -3
  35. package/content/agents/agent-server-hooks.md +1 -1
  36. package/content/agents/agentchat.md +41 -4
  37. package/content/agents/agentconversations.md +42 -8
  38. package/content/agents/agents-introduction.md +107 -0
  39. package/content/callback-reference/auth0logoutcallback.md +54 -0
  40. package/content/concepts/ai-agent-docs.md +455 -106
  41. package/content/concepts/blocks.md +150 -0
  42. package/content/concepts/connections-and-requests.md +402 -0
  43. package/content/concepts/custom-html.md +42 -0
  44. package/content/concepts/custom-styling.md +50 -5
  45. package/content/concepts/dynamic-page-content.md +309 -0
  46. package/content/concepts/events-and-actions.md +185 -2
  47. package/content/concepts/four-primitives.md +31 -0
  48. package/content/concepts/html-attributes.md +293 -0
  49. package/content/concepts/i18n.md +12 -3
  50. package/content/concepts/keyboard-shortcuts.md +2 -2
  51. package/content/concepts/layout-overview.md +1 -1
  52. package/content/concepts/logger.md +99 -0
  53. package/content/concepts/lowdefy-api.md +1319 -0
  54. package/content/concepts/lowdefy-schema.md +144 -3
  55. package/content/concepts/menus.md +8 -7
  56. package/content/concepts/module-authoring.md +76 -5
  57. package/content/concepts/modules.md +3 -1
  58. package/content/concepts/notifications.md +180 -0
  59. package/content/concepts/operators.md +7 -0
  60. package/content/concepts/page-and-app-state.md +252 -0
  61. package/content/concepts/page-paths.md +209 -0
  62. package/content/concepts/theming.md +582 -0
  63. package/content/connections/aigateway.md +375 -0
  64. package/content/connections/anthropic.md +169 -2
  65. package/content/connections/awss3.md +178 -2
  66. package/content/connections/axioshttp.md +181 -0
  67. package/content/connections/google.md +169 -2
  68. package/content/connections/mongodb.md +1014 -3
  69. package/content/connections/openai-connection.md +169 -2
  70. package/content/connections/sendgridmail.md +3 -0
  71. package/content/connections/smtp.md +16 -0
  72. package/content/connections/treg.md +329 -0
  73. package/content/container-blocks/affix.md +47 -7
  74. package/content/container-blocks/alert.md +76 -24
  75. package/content/container-blocks/badge.md +100 -24
  76. package/content/container-blocks/box.md +9 -9
  77. package/content/container-blocks/card.md +132 -27
  78. package/content/container-blocks/carousel.md +60 -7
  79. package/content/container-blocks/collapse.md +153 -9
  80. package/content/container-blocks/configprovider.md +35 -13
  81. package/content/container-blocks/confirmmodal.md +69 -23
  82. package/content/container-blocks/content.md +62 -98
  83. package/content/container-blocks/descriptions.md +45 -4
  84. package/content/container-blocks/drawer.md +139 -28
  85. package/content/container-blocks/dropdownmenu.md +119 -31
  86. package/content/container-blocks/flex.md +40 -62
  87. package/content/container-blocks/footer.md +15 -11
  88. package/content/container-blocks/googlemapsheatmap.md +1 -1
  89. package/content/container-blocks/googlemapsscript.md +2 -2
  90. package/content/container-blocks/header.md +71 -36
  91. package/content/container-blocks/label.md +34 -7
  92. package/content/container-blocks/layout.md +52 -34
  93. package/content/container-blocks/masonry.md +17 -71
  94. package/content/container-blocks/mobilemenu.md +131 -88
  95. package/content/container-blocks/modal.md +161 -26
  96. package/content/container-blocks/pageheadermenu.md +138 -31
  97. package/content/container-blocks/pagesidebarlayout.md +230 -27
  98. package/content/container-blocks/pagesidermenu.md +153 -43
  99. package/content/container-blocks/popover.md +34 -31
  100. package/content/container-blocks/result.md +32 -21
  101. package/content/container-blocks/sider.md +85 -122
  102. package/content/container-blocks/span.md +7 -7
  103. package/content/container-blocks/spinner.md +3 -3
  104. package/content/container-blocks/splitter.md +150 -68
  105. package/content/container-blocks/tabs.md +64 -12
  106. package/content/container-blocks/tooltip.md +22 -46
  107. package/content/container-blocks/watermark.md +22 -4
  108. package/content/controls/parallel_for.md +21 -2
  109. package/content/controls/reject.md +26 -3
  110. package/content/controls/return.md +17 -1
  111. package/content/controls/throw.md +30 -2
  112. package/content/controls/try.md +24 -2
  113. package/content/controls/while.md +46 -0
  114. package/content/deployment/deployment-environments.md +146 -0
  115. package/content/deployment/docker.md +23 -7
  116. package/content/deployment/node-server.md +4 -0
  117. package/content/deployment/vercel.md +25 -19
  118. package/content/display-blocks/aggrid.md +33 -16
  119. package/content/display-blocks/anchor.md +16 -15
  120. package/content/display-blocks/avatar.md +57 -37
  121. package/content/display-blocks/breadcrumb.md +70 -21
  122. package/content/display-blocks/button.md +93 -19
  123. package/content/display-blocks/calendar.md +12 -0
  124. package/content/display-blocks/clickablehtml.md +239 -0
  125. package/content/display-blocks/dangeroushtml.md +1 -1
  126. package/content/display-blocks/difflist.md +1 -1
  127. package/content/display-blocks/difftimeline.md +1 -1
  128. package/content/display-blocks/divider.md +64 -3
  129. package/content/display-blocks/dropdownbutton.md +81 -30
  130. package/content/display-blocks/echart.md +35 -1
  131. package/content/display-blocks/eventlog.md +363 -0
  132. package/content/display-blocks/floatbutton.md +129 -42
  133. package/content/display-blocks/html.md +61 -1
  134. package/content/display-blocks/icon.md +250 -67
  135. package/content/display-blocks/img.md +2 -2
  136. package/content/display-blocks/menu.md +146 -73
  137. package/content/display-blocks/message.md +38 -124
  138. package/content/display-blocks/notification.md +94 -222
  139. package/content/display-blocks/paragraph.md +59 -9
  140. package/content/display-blocks/pollingtimer.md +263 -0
  141. package/content/display-blocks/progress.md +96 -17
  142. package/content/display-blocks/qrcode.md +19 -4
  143. package/content/display-blocks/s3download.md +1 -1
  144. package/content/display-blocks/search.md +19 -9
  145. package/content/display-blocks/skeletonbutton.md +1 -0
  146. package/content/display-blocks/skeletoninput.md +1 -0
  147. package/content/display-blocks/statistic.md +75 -17
  148. package/content/display-blocks/steps.md +58 -25
  149. package/content/display-blocks/table.md +2527 -0
  150. package/content/display-blocks/tablelight.md +621 -0
  151. package/content/display-blocks/tag.md +102 -17
  152. package/content/display-blocks/title.md +50 -11
  153. package/content/display-blocks/tour.md +33 -23
  154. package/content/input-blocks/autocomplete.md +81 -9
  155. package/content/input-blocks/buttonselector.md +45 -8
  156. package/content/input-blocks/captcha.md +40 -0
  157. package/content/input-blocks/checkboxselector.md +97 -7
  158. package/content/input-blocks/checkboxswitch.md +33 -3
  159. package/content/input-blocks/colorselector.md +63 -14
  160. package/content/input-blocks/daterangeselector.md +165 -45
  161. package/content/input-blocks/dateselector.md +139 -41
  162. package/content/input-blocks/datetimeselector.md +158 -49
  163. package/content/input-blocks/inputgallery.md +3 -3
  164. package/content/input-blocks/intentinput.md +207 -0
  165. package/content/input-blocks/monthselector.md +120 -52
  166. package/content/input-blocks/multipleselector.md +150 -39
  167. package/content/input-blocks/numberinput.md +98 -12
  168. package/content/input-blocks/pagination.md +70 -14
  169. package/content/input-blocks/paragraphinput.md +51 -37
  170. package/content/input-blocks/passwordinput.md +60 -6
  171. package/content/input-blocks/phonenumberinput.md +59 -26
  172. package/content/input-blocks/placesautocomplete.md +319 -0
  173. package/content/input-blocks/radioselector.md +83 -7
  174. package/content/input-blocks/ratingslider.md +57 -26
  175. package/content/input-blocks/s3uploadbutton.md +24 -24
  176. package/content/input-blocks/s3uploaddragger.md +3 -3
  177. package/content/input-blocks/s3uploadphoto.md +5 -5
  178. package/content/input-blocks/segmentedselector.md +72 -32
  179. package/content/input-blocks/selector.md +109 -21
  180. package/content/input-blocks/switch.md +65 -17
  181. package/content/input-blocks/tableinput.md +445 -0
  182. package/content/input-blocks/tagmultipleselector.md +114 -0
  183. package/content/input-blocks/tagselector.md +114 -0
  184. package/content/input-blocks/textarea.md +32 -3
  185. package/content/input-blocks/textinput.md +70 -29
  186. package/content/input-blocks/tiptapinput.md +1 -1
  187. package/content/input-blocks/tiptapmentioninput.md +2 -2
  188. package/content/input-blocks/titleinput.md +39 -12
  189. package/content/input-blocks/treeinput.md +49 -25
  190. package/content/input-blocks/treemultipleselector.md +127 -10
  191. package/content/input-blocks/treeselector.md +97 -9
  192. package/content/input-blocks/upload.md +64 -15
  193. package/content/input-blocks/uploaddragger.md +17 -1
  194. package/content/input-blocks/uploadphoto.md +18 -1
  195. package/content/input-blocks/weekselector.md +120 -55
  196. package/content/learn/introduction.md +27 -0
  197. package/content/learn/quickstart.md +53 -0
  198. package/content/learn/showcase.md +8 -0
  199. package/content/list-blocks/controlledlist.md +24 -15
  200. package/content/list-blocks/list.md +11 -11
  201. package/content/list-blocks/masonrylist.md +7 -34
  202. package/content/migration/auth-upgrade.md +337 -0
  203. package/content/migration/upgrade-guide.md +1 -0
  204. package/content/migration/v3-to-v4.md +417 -0
  205. package/content/migration/v6-to-v7.md +620 -0
  206. package/content/operators/_agent.md +155 -0
  207. package/content/operators/_app.md +2 -1
  208. package/content/operators/_array.md +122 -1
  209. package/content/operators/_build.md +1 -0
  210. package/content/operators/_credential.md +57 -0
  211. package/content/operators/_cron.md +292 -0
  212. package/content/operators/_date.md +2 -0
  213. package/content/operators/_error.md +196 -0
  214. package/content/operators/_get.md +6 -6
  215. package/content/operators/_hmac.md +78 -0
  216. package/content/operators/_js.md +2 -1
  217. package/content/operators/_location.md +1 -1
  218. package/content/operators/_media.md +13 -0
  219. package/content/operators/_module.md +56 -2
  220. package/content/operators/_operator.md +17 -3
  221. package/content/operators/_path_params.md +82 -0
  222. package/content/operators/_ref.md +258 -0
  223. package/content/operators/_request.md +1 -1
  224. package/content/operators/_request_details.md +6 -0
  225. package/content/operators/_type.md +14 -3
  226. package/content/operators/_url_query.md +2 -0
  227. package/content/operators/_user.md +3 -3
  228. package/content/plugins/plugins-actions.md +10 -0
  229. package/content/plugins/plugins-connections.md +25 -0
  230. package/content/plugins/plugins-dev.md +66 -0
  231. package/content/plugins/plugins-icon-sets.md +267 -0
  232. package/content/plugins/plugins-introduction.md +27 -1
  233. package/content/plugins/plugins.md +19 -0
  234. package/content/plugins/posthog.md +359 -0
  235. package/content/provider-reference/auth-js-providers.md +107 -0
  236. package/content/provider-reference/openidconnectprovider.md +44 -0
  237. package/content/recipes/recipes.md +16 -0
  238. package/content/reference/actions-reference.md +31 -0
  239. package/content/reference/blocks-reference.md +35 -0
  240. package/content/reference/cli.md +403 -0
  241. package/content/reference/connections-reference.md +23 -0
  242. package/content/reference/operators-reference.md +47 -0
  243. package/content/reference/reference.md +16 -0
  244. package/content/reference/schema-reference.md +12 -0
  245. package/content/testing/config-tests.md +677 -0
  246. package/content/testing/e2e-configuration.md +31 -1
  247. package/content/testing/e2e-getting-started.md +1 -1
  248. package/content/testing/e2e-introduction.md +1 -1
  249. package/content/testing/e2e-writing-tests.md +12 -1
  250. package/content/testing/explore-pull-request.md +136 -0
  251. package/content/testing/journey-data-sets.md +326 -0
  252. package/content/tutorial/tutorial-actions-operators.md +2 -2
  253. package/content/tutorial/tutorial-add-blocks.md +2 -2
  254. package/content/tutorial/tutorial-create-page.md +48 -2
  255. package/content/tutorial/tutorial-display-data-page.md +3 -3
  256. package/content/tutorial/tutorial-requests-api.md +155 -0
  257. package/content/tutorial/tutorial-requests-sql.md +153 -0
  258. package/content/tutorial/tutorial-start.md +66 -1
  259. package/content/user-authentication/auth-configuration.md +267 -0
  260. package/content/user-authentication/auth-providers.md +24 -0
  261. package/content/user-authentication/auth-steps.md +141 -0
  262. package/content/user-authentication/login-and-logout.md +160 -8
  263. package/content/user-authentication/mcp-oauth.md +424 -0
  264. package/content/user-authentication/organizations.md +246 -0
  265. package/content/user-authentication/protected-pages-apis.md +97 -0
  266. package/content/user-authentication/roles.md +49 -0
  267. package/content/user-authentication/two-factor.md +229 -0
  268. package/content/user-authentication/user-object.md +58 -0
  269. package/content/user-authentication/users-introduction.md +8 -0
  270. package/content/websockets/websocket-publish.md +105 -0
  271. package/content/websockets/websocket-subscriptions.md +136 -0
  272. package/content/websockets/websockets-introduction.md +101 -0
  273. package/hazards.json +56 -0
  274. package/index.json +3472 -14
  275. package/package.json +10 -1
  276. package/scripts/extractAgentDocs.js +41 -30
  277. package/scripts/hashDocSources.js +38 -0
  278. package/scripts/isRedirectPage.js +26 -0
  279. package/scripts/recordSourceHashes.js +97 -0
  280. package/scripts/resolvePageSections.js +42 -0
  281. package/scripts/sectionKind.js +27 -0
  282. package/content/concepts/cli.md +0 -223
  283. package/content/other/introduction.md +0 -39
  284. package/content/other/next-auth-providers.md +0 -3
  285. /package/content/{other → actions}/updatesession.md +0 -0
@@ -1,6 +1,152 @@
1
1
  # Icon
2
2
 
3
- Display icons from the React Icons library.
3
+ Display a Lucide icon by semantic name (`edit`), Lucide name (`Pencil`) or qualified name (`lucide:Pencil`), with per-icon size, colour and stroke width.
4
+
5
+ Lowdefy draws icons with [Lucide](https://lucide.dev): about 1,850 stroke icons on a 24px grid. The Icon block renders one icon. Every block property that takes an icon, such as `icon` on a Button or a menu link, takes the same names and the same settings.
6
+
7
+ ## Icon names
8
+
9
+ An icon name has one of three forms:
10
+
11
+ | Form | Example | Resolves to |
12
+ | --------- | -------------------------------- | -------------------------------------------------------------------------------------------------------- |
13
+ | Semantic | `edit`, `chevron-down` | A built-in name for a common job, lowercase kebab-case. `edit` draws Lucide `Pencil`. |
14
+ | Set name | `Pencil`, `Receipt` | An icon in the app's default set (`theme.icons.set`, Lucide unless changed), then in Lucide. PascalCase. |
15
+ | Qualified | `lucide:Pencil`, `tabler:Pencil` | That icon in that set only. Use it to reach a set that is not the default. |
16
+
17
+ Use a semantic name when one fits. Blocks and Ant Design components use the same names for their own icons, so `theme.icons.aliases` or an [icon set](/plugins-icon-sets) restyles your icons and the built-in ones together. [Theming](/theming) lists every semantic name.
18
+
19
+ For anything else, use the Lucide name in PascalCase. Search [lucide.dev/icons](https://lucide.dev/icons), then write the name as the React component name: `circle-dollar-sign` on the site is `CircleDollarSign` in config. Lucide's older alias names, such as `Home` for `House`, also work.
20
+
21
+ In a running dev server, AI agents can find names with the `lowdefy_search_icons` tool (see [Docs for AI Agents](/ai-agent-docs)).
22
+
23
+ ```yaml
24
+ - id: edit_icon
25
+ type: Icon
26
+ properties:
27
+ name: edit # semantic
28
+ - id: invoice_icon
29
+ type: Icon
30
+ properties:
31
+ name: Receipt # Lucide
32
+ - id: save_button
33
+ type: Button
34
+ properties:
35
+ title: Save
36
+ icon: save
37
+ ```
38
+
39
+ An unknown icon name in config fails the build, with a suggestion. Old react-icons names such as `AiOutlineUser` fail too; see [V6 to V7](/v6-to-v7) to migrate them.
40
+
41
+ ## Icon settings
42
+
43
+ Set these on the Icon block, or pass an object instead of a name to any `icon` property:
44
+
45
+ | Property | Default | Description |
46
+ | ------------------ | ------- | ---------------------------------------------------------------------------------------------- |
47
+ | `name` | | The icon name. |
48
+ | `size` | `1em` | Width and height. A number is pixels; a string is any CSS length. `1em` follows the font size. |
49
+ | `color` | | CSS colour. It colours stroke and fill icons alike. |
50
+ | `strokeWidth` | `2` | Line width, in units of the icon's 24px grid. |
51
+ | `nonScalingStroke` | `false` | Keep the line width constant in screen pixels at any size. |
52
+ | `rotate` | | Degrees to rotate the icon. |
53
+ | `spin` | `false` | Replace the icon with the spinning `loading` icon. |
54
+ | `title` | | Hover text, read by screen readers. |
55
+
56
+ ```yaml
57
+ - id: delete_button
58
+ type: Button
59
+ properties:
60
+ title: Delete
61
+ danger: true
62
+ icon:
63
+ name: delete
64
+ strokeWidth: 1.5
65
+ - id: status_icon
66
+ type: Icon
67
+ properties:
68
+ name: CircleCheckBig
69
+ size: 32
70
+ color: '#16a34a'
71
+ nonScalingStroke: true
72
+ ```
73
+
74
+ The defaults for `size`, `strokeWidth` and `nonScalingStroke` come from `theme.icons`, so one setting changes every icon in the app. A value on the icon wins over the theme.
75
+
76
+ ## Titles
77
+
78
+ The Icon block adds a hover title made from the name: `Pencil` gives "Pencil", `ArrowLeftRight` gives "Arrow left right", and `more-vertical` gives "More vertical". A qualified name drops its set prefix. Set `title` to change it, or to an empty string for a decorative icon.
79
+
80
+ ## Names only known at runtime
81
+
82
+ The build bundles only the icons your config names. A name that comes from state, a request or a database is not in the config, so list it under `theme.icons.include`. In production each page loads only its own icons, so the first such name a page draws loads the rest of the app's icons; the icon keeps its space until they arrive:
83
+
84
+ ```yaml
85
+ theme:
86
+ icons:
87
+ include:
88
+ - Flag
89
+ - Truck
90
+ ```
91
+
92
+ ```yaml
93
+ - id: semantic_add
94
+ type: Icon
95
+ layout:
96
+ flex: 0 0 auto
97
+ properties:
98
+ name: add
99
+ size: 24
100
+ - id: semantic_edit
101
+ type: Icon
102
+ layout:
103
+ flex: 0 0 auto
104
+ properties:
105
+ name: edit
106
+ size: 24
107
+ - id: semantic_delete
108
+ type: Icon
109
+ layout:
110
+ flex: 0 0 auto
111
+ properties:
112
+ name: delete
113
+ size: 24
114
+ - id: semantic_search
115
+ type: Icon
116
+ layout:
117
+ flex: 0 0 auto
118
+ properties:
119
+ name: search
120
+ size: 24
121
+ - id: semantic_settings
122
+ type: Icon
123
+ layout:
124
+ flex: 0 0 auto
125
+ properties:
126
+ name: settings
127
+ size: 24
128
+ - id: semantic_warning
129
+ type: Icon
130
+ layout:
131
+ flex: 0 0 auto
132
+ properties:
133
+ name: warning
134
+ size: 24
135
+ - id: semantic_info
136
+ type: Icon
137
+ layout:
138
+ flex: 0 0 auto
139
+ properties:
140
+ name: info
141
+ size: 24
142
+ - id: semantic_success
143
+ type: Icon
144
+ layout:
145
+ flex: 0 0 auto
146
+ properties:
147
+ name: success
148
+ size: 24
149
+ ```
4
150
 
5
151
  ```yaml
6
152
  - id: icon_home
@@ -8,84 +154,84 @@ Display icons from the React Icons library.
8
154
  layout:
9
155
  flex: 0 0 auto
10
156
  properties:
11
- name: AiOutlineHome
157
+ name: home
12
158
  size: 24
13
159
  - id: icon_search
14
160
  type: Icon
15
161
  layout:
16
162
  flex: 0 0 auto
17
163
  properties:
18
- name: AiOutlineSearch
164
+ name: search
19
165
  size: 24
20
166
  - id: icon_user
21
167
  type: Icon
22
168
  layout:
23
169
  flex: 0 0 auto
24
170
  properties:
25
- name: AiOutlineUser
171
+ name: user
26
172
  size: 24
27
173
  - id: icon_setting
28
174
  type: Icon
29
175
  layout:
30
176
  flex: 0 0 auto
31
177
  properties:
32
- name: AiOutlineSetting
178
+ name: settings
33
179
  size: 24
34
180
  - id: icon_bell
35
181
  type: Icon
36
182
  layout:
37
183
  flex: 0 0 auto
38
184
  properties:
39
- name: AiOutlineBell
185
+ name: bell
40
186
  size: 24
41
187
  - id: icon_heart
42
188
  type: Icon
43
189
  layout:
44
190
  flex: 0 0 auto
45
191
  properties:
46
- name: AiOutlineHeart
192
+ name: heart
47
193
  size: 24
48
194
  - id: icon_star
49
195
  type: Icon
50
196
  layout:
51
197
  flex: 0 0 auto
52
198
  properties:
53
- name: AiOutlineStar
199
+ name: star
54
200
  size: 24
55
201
  - id: icon_check
56
202
  type: Icon
57
203
  layout:
58
204
  flex: 0 0 auto
59
205
  properties:
60
- name: AiOutlineCheck
206
+ name: check
61
207
  size: 24
62
208
  - id: icon_close
63
209
  type: Icon
64
210
  layout:
65
211
  flex: 0 0 auto
66
212
  properties:
67
- name: AiOutlineClose
213
+ name: close
68
214
  size: 24
69
215
  - id: icon_info
70
216
  type: Icon
71
217
  layout:
72
218
  flex: 0 0 auto
73
219
  properties:
74
- name: AiOutlineInfoCircle
220
+ name: info
75
221
  size: 24
76
222
  - id: icon_warning
77
223
  type: Icon
78
224
  layout:
79
225
  flex: 0 0 auto
80
226
  properties:
81
- name: AiOutlineWarning
227
+ name: warning
82
228
  size: 24
83
229
  - id: icon_mail
84
230
  type: Icon
85
231
  layout:
86
232
  flex: 0 0 auto
87
233
  properties:
88
- name: AiOutlineMail
234
+ name: mail
89
235
  size: 24
90
236
  ```
91
237
 
@@ -95,35 +241,35 @@ Display icons from the React Icons library.
95
241
  layout:
96
242
  flex: 0 0 auto
97
243
  properties:
98
- name: AiOutlineRocket
244
+ name: Rocket
99
245
  size: 16
100
246
  - id: size_24
101
247
  type: Icon
102
248
  layout:
103
249
  flex: 0 0 auto
104
250
  properties:
105
- name: AiOutlineRocket
251
+ name: Rocket
106
252
  size: 24
107
253
  - id: size_32
108
254
  type: Icon
109
255
  layout:
110
256
  flex: 0 0 auto
111
257
  properties:
112
- name: AiOutlineRocket
258
+ name: Rocket
113
259
  size: 32
114
260
  - id: size_48
115
261
  type: Icon
116
262
  layout:
117
263
  flex: 0 0 auto
118
264
  properties:
119
- name: AiOutlineRocket
265
+ name: Rocket
120
266
  size: 48
121
267
  - id: size_64
122
268
  type: Icon
123
269
  layout:
124
270
  flex: 0 0 auto
125
271
  properties:
126
- name: AiOutlineRocket
272
+ name: Rocket
127
273
  size: 64
128
274
  ```
129
275
 
@@ -133,7 +279,7 @@ Display icons from the React Icons library.
133
279
  layout:
134
280
  flex: 0 0 auto
135
281
  properties:
136
- name: AiOutlineHeart
282
+ name: heart
137
283
  size: 32
138
284
  color: red
139
285
  - id: color_blue
@@ -141,7 +287,7 @@ Display icons from the React Icons library.
141
287
  layout:
142
288
  flex: 0 0 auto
143
289
  properties:
144
- name: AiOutlineHeart
290
+ name: heart
145
291
  size: 32
146
292
  color: blue
147
293
  - id: color_green
@@ -149,7 +295,7 @@ Display icons from the React Icons library.
149
295
  layout:
150
296
  flex: 0 0 auto
151
297
  properties:
152
- name: AiOutlineHeart
298
+ name: heart
153
299
  size: 32
154
300
  color: green
155
301
  - id: color_orange
@@ -157,7 +303,7 @@ Display icons from the React Icons library.
157
303
  layout:
158
304
  flex: 0 0 auto
159
305
  properties:
160
- name: AiOutlineHeart
306
+ name: heart
161
307
  size: 32
162
308
  color: orange
163
309
  - id: color_purple
@@ -165,7 +311,7 @@ Display icons from the React Icons library.
165
311
  layout:
166
312
  flex: 0 0 auto
167
313
  properties:
168
- name: AiOutlineHeart
314
+ name: heart
169
315
  size: 32
170
316
  color: purple
171
317
  - id: color_tomato
@@ -173,7 +319,7 @@ Display icons from the React Icons library.
173
319
  layout:
174
320
  flex: 0 0 auto
175
321
  properties:
176
- name: AiOutlineHeart
322
+ name: heart
177
323
  size: 32
178
324
  color: tomato
179
325
  - id: color_teal
@@ -181,7 +327,7 @@ Display icons from the React Icons library.
181
327
  layout:
182
328
  flex: 0 0 auto
183
329
  properties:
184
- name: AiOutlineHeart
330
+ name: heart
185
331
  size: 32
186
332
  color: teal
187
333
  - id: color_coral
@@ -189,7 +335,7 @@ Display icons from the React Icons library.
189
335
  layout:
190
336
  flex: 0 0 auto
191
337
  properties:
192
- name: AiOutlineHeart
338
+ name: heart
193
339
  size: 32
194
340
  color: coral
195
341
  ```
@@ -200,7 +346,7 @@ Display icons from the React Icons library.
200
346
  layout:
201
347
  flex: 0 0 auto
202
348
  properties:
203
- name: AiOutlineThunderbolt
349
+ name: Zap
204
350
  size: 40
205
351
  color: "#1677ff"
206
352
  - id: hex_green
@@ -208,7 +354,7 @@ Display icons from the React Icons library.
208
354
  layout:
209
355
  flex: 0 0 auto
210
356
  properties:
211
- name: AiOutlineThunderbolt
357
+ name: Zap
212
358
  size: 40
213
359
  color: "#52c41a"
214
360
  - id: hex_red
@@ -216,7 +362,7 @@ Display icons from the React Icons library.
216
362
  layout:
217
363
  flex: 0 0 auto
218
364
  properties:
219
- name: AiOutlineThunderbolt
365
+ name: Zap
220
366
  size: 40
221
367
  color: "#f5222d"
222
368
  - id: hex_orange
@@ -224,7 +370,7 @@ Display icons from the React Icons library.
224
370
  layout:
225
371
  flex: 0 0 auto
226
372
  properties:
227
- name: AiOutlineThunderbolt
373
+ name: Zap
228
374
  size: 40
229
375
  color: "#fa8c16"
230
376
  - id: hex_purple
@@ -232,7 +378,7 @@ Display icons from the React Icons library.
232
378
  layout:
233
379
  flex: 0 0 auto
234
380
  properties:
235
- name: AiOutlineThunderbolt
381
+ name: Zap
236
382
  size: 40
237
383
  color: "#722ed1"
238
384
  - id: hex_cyan
@@ -240,7 +386,7 @@ Display icons from the React Icons library.
240
386
  layout:
241
387
  flex: 0 0 auto
242
388
  properties:
243
- name: AiOutlineThunderbolt
389
+ name: Zap
244
390
  size: 40
245
391
  color: "#13c2c2"
246
392
  - id: hex_coral
@@ -248,7 +394,7 @@ Display icons from the React Icons library.
248
394
  layout:
249
395
  flex: 0 0 auto
250
396
  properties:
251
- name: AiOutlineThunderbolt
397
+ name: Zap
252
398
  size: 40
253
399
  color: "#ff6b6b"
254
400
  - id: hex_indigo
@@ -256,7 +402,7 @@ Display icons from the React Icons library.
256
402
  layout:
257
403
  flex: 0 0 auto
258
404
  properties:
259
- name: AiOutlineThunderbolt
405
+ name: Zap
260
406
  size: 40
261
407
  color: "#4c6ef5"
262
408
  - id: hex_pink
@@ -264,7 +410,7 @@ Display icons from the React Icons library.
264
410
  layout:
265
411
  flex: 0 0 auto
266
412
  properties:
267
- name: AiOutlineThunderbolt
413
+ name: Zap
268
414
  size: 40
269
415
  color: "#e64980"
270
416
  - id: hex_amber
@@ -272,7 +418,7 @@ Display icons from the React Icons library.
272
418
  layout:
273
419
  flex: 0 0 auto
274
420
  properties:
275
- name: AiOutlineThunderbolt
421
+ name: Zap
276
422
  size: 40
277
423
  color: "#fab005"
278
424
  ```
@@ -283,7 +429,7 @@ Display icons from the React Icons library.
283
429
  layout:
284
430
  flex: 0 0 auto
285
431
  properties:
286
- name: AiOutlineLoading
432
+ name: loading
287
433
  size: 32
288
434
  spin: true
289
435
  color: "#1677ff"
@@ -292,7 +438,7 @@ Display icons from the React Icons library.
292
438
  layout:
293
439
  flex: 0 0 auto
294
440
  properties:
295
- name: AiOutlineLoading3Quarters
441
+ name: loading
296
442
  size: 32
297
443
  spin: true
298
444
  color: "#52c41a"
@@ -301,7 +447,7 @@ Display icons from the React Icons library.
301
447
  layout:
302
448
  flex: 0 0 auto
303
449
  properties:
304
- name: AiOutlineSync
450
+ name: RefreshCw
305
451
  size: 32
306
452
  spin: true
307
453
  color: "#fa8c16"
@@ -310,7 +456,7 @@ Display icons from the React Icons library.
310
456
  layout:
311
457
  flex: 0 0 auto
312
458
  properties:
313
- name: AiOutlineSetting
459
+ name: settings
314
460
  size: 32
315
461
  spin: true
316
462
  color: "#722ed1"
@@ -319,7 +465,7 @@ Display icons from the React Icons library.
319
465
  layout:
320
466
  flex: 0 0 auto
321
467
  properties:
322
- name: AiOutlineReload
468
+ name: refresh
323
469
  size: 32
324
470
  spin: true
325
471
  color: "#f5222d"
@@ -331,7 +477,7 @@ Display icons from the React Icons library.
331
477
  layout:
332
478
  flex: 0 0 auto
333
479
  properties:
334
- name: AiOutlineArrowUp
480
+ name: arrow-up
335
481
  size: 32
336
482
  rotate: 0
337
483
  color: "#1677ff"
@@ -340,7 +486,7 @@ Display icons from the React Icons library.
340
486
  layout:
341
487
  flex: 0 0 auto
342
488
  properties:
343
- name: AiOutlineArrowUp
489
+ name: arrow-up
344
490
  size: 32
345
491
  rotate: 45
346
492
  color: "#1677ff"
@@ -349,7 +495,7 @@ Display icons from the React Icons library.
349
495
  layout:
350
496
  flex: 0 0 auto
351
497
  properties:
352
- name: AiOutlineArrowUp
498
+ name: arrow-up
353
499
  size: 32
354
500
  rotate: 90
355
501
  color: "#1677ff"
@@ -358,7 +504,7 @@ Display icons from the React Icons library.
358
504
  layout:
359
505
  flex: 0 0 auto
360
506
  properties:
361
- name: AiOutlineArrowUp
507
+ name: arrow-up
362
508
  size: 32
363
509
  rotate: 135
364
510
  color: "#1677ff"
@@ -367,7 +513,7 @@ Display icons from the React Icons library.
367
513
  layout:
368
514
  flex: 0 0 auto
369
515
  properties:
370
- name: AiOutlineArrowUp
516
+ name: arrow-up
371
517
  size: 32
372
518
  rotate: 180
373
519
  color: "#1677ff"
@@ -376,19 +522,54 @@ Display icons from the React Icons library.
376
522
  layout:
377
523
  flex: 0 0 auto
378
524
  properties:
379
- name: AiOutlineArrowUp
525
+ name: arrow-up
380
526
  size: 32
381
527
  rotate: 270
382
528
  color: "#1677ff"
383
529
  ```
384
530
 
531
+ ```yaml
532
+ - id: stroke_width_1
533
+ type: Icon
534
+ layout:
535
+ flex: 0 0 auto
536
+ properties:
537
+ name: heart
538
+ size: 32
539
+ strokeWidth: 1
540
+ - id: stroke_width_2
541
+ type: Icon
542
+ layout:
543
+ flex: 0 0 auto
544
+ properties:
545
+ name: heart
546
+ size: 32
547
+ strokeWidth: 2
548
+ - id: stroke_width_3
549
+ type: Icon
550
+ layout:
551
+ flex: 0 0 auto
552
+ properties:
553
+ name: heart
554
+ size: 32
555
+ strokeWidth: 3
556
+ - id: non_scaling_stroke
557
+ type: Icon
558
+ layout:
559
+ flex: 0 0 auto
560
+ properties:
561
+ name: heart
562
+ size: 64
563
+ nonScalingStroke: true
564
+ ```
565
+
385
566
  ```yaml
386
567
  - id: title_info
387
568
  type: Icon
388
569
  layout:
389
570
  flex: 0 0 auto
390
571
  properties:
391
- name: AiOutlineInfoCircle
572
+ name: info
392
573
  size: 32
393
574
  color: "#1677ff"
394
575
  title: More information
@@ -397,7 +578,7 @@ Display icons from the React Icons library.
397
578
  layout:
398
579
  flex: 0 0 auto
399
580
  properties:
400
- name: AiOutlineWarning
581
+ name: warning
401
582
  size: 32
402
583
  color: "#faad14"
403
584
  title: Warning - proceed with caution
@@ -406,7 +587,7 @@ Display icons from the React Icons library.
406
587
  layout:
407
588
  flex: 0 0 auto
408
589
  properties:
409
- name: AiOutlineQuestionCircle
590
+ name: help
410
591
  size: 32
411
592
  color: "#722ed1"
412
593
  title: Click for help
@@ -431,7 +612,7 @@ Display icons from the React Icons library.
431
612
  layout:
432
613
  flex: 0 0 auto
433
614
  properties:
434
- name: AiOutlineCloud
615
+ name: Cloud
435
616
  size: 40
436
617
  color: "#69b1ff"
437
618
  - id: dark_bg_green
@@ -452,7 +633,7 @@ Display icons from the React Icons library.
452
633
  layout:
453
634
  flex: 0 0 auto
454
635
  properties:
455
- name: AiOutlineCheckCircle
636
+ name: check-circle
456
637
  size: 40
457
638
  color: "#95de64"
458
639
  - id: dark_bg_red
@@ -473,7 +654,7 @@ Display icons from the React Icons library.
473
654
  layout:
474
655
  flex: 0 0 auto
475
656
  properties:
476
- name: AiOutlineCloseCircle
657
+ name: close-circle
477
658
  size: 40
478
659
  color: "#ff7875"
479
660
  - id: dark_bg_purple
@@ -494,7 +675,7 @@ Display icons from the React Icons library.
494
675
  layout:
495
676
  flex: 0 0 auto
496
677
  properties:
497
- name: AiOutlineStar
678
+ name: star
498
679
  size: 40
499
680
  color: "#b37feb"
500
681
  ```
@@ -519,7 +700,7 @@ Display icons from the React Icons library.
519
700
  layout:
520
701
  flex: 0 0 auto
521
702
  properties:
522
- name: AiOutlineCheckCircle
703
+ name: check-circle
523
704
  size: 36
524
705
  color: "#52c41a"
525
706
  - id: colored_bg_warning
@@ -541,7 +722,7 @@ Display icons from the React Icons library.
541
722
  layout:
542
723
  flex: 0 0 auto
543
724
  properties:
544
- name: AiOutlineExclamationCircle
725
+ name: CircleAlert
545
726
  size: 36
546
727
  color: "#faad14"
547
728
  - id: colored_bg_error
@@ -563,7 +744,7 @@ Display icons from the React Icons library.
563
744
  layout:
564
745
  flex: 0 0 auto
565
746
  properties:
566
- name: AiOutlineCloseCircle
747
+ name: close-circle
567
748
  size: 36
568
749
  color: "#ff4d4f"
569
750
  - id: colored_bg_info
@@ -585,7 +766,7 @@ Display icons from the React Icons library.
585
766
  layout:
586
767
  flex: 0 0 auto
587
768
  properties:
588
- name: AiOutlineInfoCircle
769
+ name: info
589
770
  size: 36
590
771
  color: "#1677ff"
591
772
  ```
@@ -601,7 +782,7 @@ Display icons from the React Icons library.
601
782
  padding: 12
602
783
  borderRadius: 50%
603
784
  properties:
604
- name: AiOutlineUser
785
+ name: user
605
786
  size: 32
606
787
  color: "#1677ff"
607
788
  - id: style_bordered
@@ -614,7 +795,7 @@ Display icons from the React Icons library.
614
795
  padding: 10
615
796
  borderRadius: 8
616
797
  properties:
617
- name: AiOutlineSetting
798
+ name: settings
618
799
  size: 28
619
800
  color: "#595959"
620
801
  - id: style_shadow
@@ -628,7 +809,7 @@ Display icons from the React Icons library.
628
809
  borderRadius: 12
629
810
  boxShadow: 0 2px 8px rgba(0, 0, 0, 0.15)
630
811
  properties:
631
- name: AiOutlineBell
812
+ name: bell
632
813
  size: 30
633
814
  color: "#fa8c16"
634
815
  - id: style_gradient_bg
@@ -641,7 +822,7 @@ Display icons from the React Icons library.
641
822
  padding: 14
642
823
  borderRadius: 12
643
824
  properties:
644
- name: AiOutlineThunderbolt
825
+ name: Zap
645
826
  size: 30
646
827
  color: "#ffffff"
647
828
  - id: style_circle_bg
@@ -657,7 +838,7 @@ Display icons from the React Icons library.
657
838
  alignItems: center
658
839
  justifyContent: center
659
840
  properties:
660
- name: AiOutlineHeart
841
+ name: heart
661
842
  size: 24
662
843
  color: "#ffffff"
663
844
  ```
@@ -676,7 +857,7 @@ Display icons from the React Icons library.
676
857
  layout:
677
858
  flex: 0 0 auto
678
859
  properties:
679
- name: AiOutlineEdit
860
+ name: edit
680
861
  size: 32
681
862
  color: "#1677ff"
682
863
  disableLoadingIcon: false
@@ -689,7 +870,7 @@ Display icons from the React Icons library.
689
870
  layout:
690
871
  flex: 0 0 auto
691
872
  properties:
692
- name: AiOutlineEdit
873
+ name: edit
693
874
  size: 32
694
875
  color: "#1677ff"
695
876
  disableLoadingIcon: true
@@ -698,16 +879,18 @@ Display icons from the React Icons library.
698
879
  | Property | Type | Default | Description |
699
880
  | --- | --- | --- | --- |
700
881
  | `color` | string | - | Primary icon color. |
701
- | `name` | string | `"AiOutlineCloseCircle"` | Name of icon to be displayed. |
882
+ | `name` | string | - | Icon name: a semantic name like `edit`, a Lucide icon name like `Pencil`, or a set-qualified name like `tabler:Pencil`. Add your own semantic names with `theme.icons.aliases`. |
883
+ | `nonScalingStroke` | boolean | - | Keep the stroke width constant at any icon size. Defaults to `theme.icons.nonScalingStroke`. |
702
884
  | `rotate` | number | - | Number of degrees to rotate the icon. |
703
885
  | `size` | string \| number | - | Size of the icon. |
886
+ | `strokeWidth` | number | - | Stroke width of the icon lines, in pixels of the 24px icon grid. Defaults to `theme.icons.strokeWidth` (2). |
704
887
  | `spin` | boolean | `false` | Continuously spin icon with animation. |
705
888
  | `title` | string | - | Icon hover title for accessibility. |
706
889
  | `disableLoadingIcon` | boolean | `false` | While loading after the icon has been clicked, don't render the loading icon. |
707
890
 
708
891
  | Event | Event Data | Description |
709
892
  | --- | --- | --- |
710
- | `onClick` | \- | Trigger actions when icon is clicked. |
893
+ | `onClick` | \- | Trigger actions when icon is clicked. The icon then takes keyboard focus, and Enter or Space trigger it too. |
711
894
 
712
895
  | Key | Target |
713
896
  | --- | --- |