@lowdefy/docs-content 6.1.0 → 7.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (284) 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 +7 -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/validate.md +7 -4
  31. package/content/adapter-reference/mongodbauthadapter.md +46 -0
  32. package/content/agents/agent-endpoint-tools.md +24 -0
  33. package/content/agents/agent-properties.md +13 -3
  34. package/content/agents/agent-server-hooks.md +1 -1
  35. package/content/agents/agentchat.md +43 -7
  36. package/content/agents/agentconversations.md +42 -8
  37. package/content/agents/agents-introduction.md +107 -0
  38. package/content/callback-reference/auth0logoutcallback.md +54 -0
  39. package/content/concepts/ai-agent-docs.md +455 -106
  40. package/content/concepts/blocks.md +150 -0
  41. package/content/concepts/connections-and-requests.md +402 -0
  42. package/content/concepts/custom-html.md +42 -0
  43. package/content/concepts/custom-styling.md +50 -5
  44. package/content/concepts/dynamic-page-content.md +309 -0
  45. package/content/concepts/events-and-actions.md +154 -2
  46. package/content/concepts/four-primitives.md +31 -0
  47. package/content/concepts/html-attributes.md +293 -0
  48. package/content/concepts/i18n.md +8 -3
  49. package/content/concepts/keyboard-shortcuts.md +2 -2
  50. package/content/concepts/layout-overview.md +1 -1
  51. package/content/concepts/logger.md +99 -0
  52. package/content/concepts/lowdefy-api.md +1319 -0
  53. package/content/concepts/lowdefy-schema.md +136 -3
  54. package/content/concepts/menus.md +8 -7
  55. package/content/concepts/module-authoring.md +76 -5
  56. package/content/concepts/modules.md +3 -1
  57. package/content/concepts/notifications.md +180 -0
  58. package/content/concepts/operators.md +7 -0
  59. package/content/concepts/page-and-app-state.md +252 -0
  60. package/content/concepts/page-paths.md +209 -0
  61. package/content/concepts/theming.md +582 -0
  62. package/content/connections/aigateway.md +375 -0
  63. package/content/connections/anthropic.md +169 -2
  64. package/content/connections/awss3.md +178 -2
  65. package/content/connections/axioshttp.md +181 -0
  66. package/content/connections/google.md +169 -2
  67. package/content/connections/mongodb.md +1014 -3
  68. package/content/connections/openai-connection.md +169 -2
  69. package/content/connections/sendgridmail.md +2 -0
  70. package/content/connections/smtp.md +3 -1
  71. package/content/connections/treg.md +329 -0
  72. package/content/container-blocks/affix.md +47 -7
  73. package/content/container-blocks/alert.md +76 -24
  74. package/content/container-blocks/badge.md +100 -24
  75. package/content/container-blocks/box.md +9 -9
  76. package/content/container-blocks/card.md +132 -27
  77. package/content/container-blocks/carousel.md +60 -7
  78. package/content/container-blocks/collapse.md +153 -9
  79. package/content/container-blocks/configprovider.md +35 -13
  80. package/content/container-blocks/confirmmodal.md +69 -23
  81. package/content/container-blocks/content.md +62 -98
  82. package/content/container-blocks/descriptions.md +45 -4
  83. package/content/container-blocks/drawer.md +139 -28
  84. package/content/container-blocks/dropdownmenu.md +119 -31
  85. package/content/container-blocks/flex.md +40 -62
  86. package/content/container-blocks/footer.md +15 -11
  87. package/content/container-blocks/googlemapsheatmap.md +1 -1
  88. package/content/container-blocks/googlemapsscript.md +2 -2
  89. package/content/container-blocks/header.md +71 -36
  90. package/content/container-blocks/label.md +34 -7
  91. package/content/container-blocks/layout.md +52 -34
  92. package/content/container-blocks/masonry.md +17 -71
  93. package/content/container-blocks/mobilemenu.md +131 -88
  94. package/content/container-blocks/modal.md +161 -26
  95. package/content/container-blocks/pageheadermenu.md +138 -31
  96. package/content/container-blocks/pagesidebarlayout.md +230 -27
  97. package/content/container-blocks/pagesidermenu.md +153 -43
  98. package/content/container-blocks/popover.md +34 -31
  99. package/content/container-blocks/result.md +32 -21
  100. package/content/container-blocks/sider.md +85 -122
  101. package/content/container-blocks/span.md +7 -7
  102. package/content/container-blocks/spinner.md +3 -3
  103. package/content/container-blocks/splitter.md +150 -68
  104. package/content/container-blocks/tabs.md +64 -12
  105. package/content/container-blocks/tooltip.md +22 -46
  106. package/content/container-blocks/watermark.md +22 -4
  107. package/content/controls/parallel_for.md +21 -2
  108. package/content/controls/reject.md +24 -3
  109. package/content/controls/return.md +17 -1
  110. package/content/controls/throw.md +1 -0
  111. package/content/controls/try.md +4 -2
  112. package/content/controls/while.md +46 -0
  113. package/content/deployment/deployment-environments.md +10 -7
  114. package/content/deployment/docker.md +22 -7
  115. package/content/deployment/node-server.md +4 -0
  116. package/content/deployment/vercel.md +17 -6
  117. package/content/display-blocks/aggrid.md +36 -19
  118. package/content/display-blocks/anchor.md +16 -15
  119. package/content/display-blocks/avatar.md +57 -37
  120. package/content/display-blocks/breadcrumb.md +70 -21
  121. package/content/display-blocks/button.md +93 -19
  122. package/content/display-blocks/calendar.md +12 -0
  123. package/content/display-blocks/clickablehtml.md +239 -0
  124. package/content/display-blocks/dangeroushtml.md +1 -1
  125. package/content/display-blocks/difflist.md +1 -1
  126. package/content/display-blocks/difftimeline.md +1 -1
  127. package/content/display-blocks/divider.md +64 -3
  128. package/content/display-blocks/dropdownbutton.md +81 -30
  129. package/content/display-blocks/echart.md +35 -1
  130. package/content/display-blocks/eventlog.md +363 -0
  131. package/content/display-blocks/floatbutton.md +129 -42
  132. package/content/display-blocks/html.md +61 -1
  133. package/content/display-blocks/icon.md +250 -67
  134. package/content/display-blocks/img.md +2 -2
  135. package/content/display-blocks/menu.md +146 -73
  136. package/content/display-blocks/message.md +38 -124
  137. package/content/display-blocks/notification.md +94 -222
  138. package/content/display-blocks/paragraph.md +59 -9
  139. package/content/display-blocks/pollingtimer.md +263 -0
  140. package/content/display-blocks/progress.md +96 -17
  141. package/content/display-blocks/qrcode.md +19 -4
  142. package/content/display-blocks/s3download.md +1 -1
  143. package/content/display-blocks/search.md +19 -9
  144. package/content/display-blocks/skeletonbutton.md +1 -0
  145. package/content/display-blocks/skeletoninput.md +1 -0
  146. package/content/display-blocks/statistic.md +75 -17
  147. package/content/display-blocks/steps.md +58 -25
  148. package/content/display-blocks/table.md +2527 -0
  149. package/content/display-blocks/tablelight.md +621 -0
  150. package/content/display-blocks/tag.md +102 -17
  151. package/content/display-blocks/title.md +50 -11
  152. package/content/display-blocks/tour.md +33 -23
  153. package/content/input-blocks/autocomplete.md +81 -9
  154. package/content/input-blocks/buttonselector.md +45 -8
  155. package/content/input-blocks/captcha.md +40 -0
  156. package/content/input-blocks/checkboxselector.md +97 -7
  157. package/content/input-blocks/checkboxswitch.md +33 -3
  158. package/content/input-blocks/colorselector.md +63 -14
  159. package/content/input-blocks/daterangeselector.md +165 -45
  160. package/content/input-blocks/dateselector.md +139 -41
  161. package/content/input-blocks/datetimeselector.md +158 -49
  162. package/content/input-blocks/inputgallery.md +3 -3
  163. package/content/input-blocks/intentinput.md +207 -0
  164. package/content/input-blocks/monthselector.md +120 -52
  165. package/content/input-blocks/multipleselector.md +150 -39
  166. package/content/input-blocks/numberinput.md +98 -12
  167. package/content/input-blocks/pagination.md +70 -14
  168. package/content/input-blocks/paragraphinput.md +51 -37
  169. package/content/input-blocks/passwordinput.md +60 -6
  170. package/content/input-blocks/phonenumberinput.md +59 -26
  171. package/content/input-blocks/placesautocomplete.md +319 -0
  172. package/content/input-blocks/radioselector.md +83 -7
  173. package/content/input-blocks/ratingslider.md +57 -26
  174. package/content/input-blocks/s3uploadbutton.md +24 -24
  175. package/content/input-blocks/s3uploaddragger.md +3 -3
  176. package/content/input-blocks/s3uploadphoto.md +5 -5
  177. package/content/input-blocks/segmentedselector.md +72 -32
  178. package/content/input-blocks/selector.md +109 -21
  179. package/content/input-blocks/switch.md +65 -17
  180. package/content/input-blocks/tableinput.md +445 -0
  181. package/content/input-blocks/tagmultipleselector.md +114 -0
  182. package/content/input-blocks/tagselector.md +114 -0
  183. package/content/input-blocks/textarea.md +32 -3
  184. package/content/input-blocks/textinput.md +70 -29
  185. package/content/input-blocks/tiptapinput.md +1 -1
  186. package/content/input-blocks/tiptapmentioninput.md +2 -2
  187. package/content/input-blocks/titleinput.md +39 -12
  188. package/content/input-blocks/treeinput.md +49 -25
  189. package/content/input-blocks/treemultipleselector.md +127 -10
  190. package/content/input-blocks/treeselector.md +97 -9
  191. package/content/input-blocks/upload.md +64 -15
  192. package/content/input-blocks/uploaddragger.md +17 -1
  193. package/content/input-blocks/uploadphoto.md +18 -1
  194. package/content/input-blocks/weekselector.md +120 -55
  195. package/content/learn/introduction.md +27 -0
  196. package/content/learn/quickstart.md +53 -0
  197. package/content/list-blocks/controlledlist.md +24 -15
  198. package/content/list-blocks/list.md +11 -11
  199. package/content/list-blocks/masonrylist.md +7 -34
  200. package/content/migration/auth-upgrade.md +337 -0
  201. package/content/migration/upgrade-guide.md +1 -0
  202. package/content/migration/v3-to-v4.md +417 -0
  203. package/content/migration/v6-to-v7.md +620 -0
  204. package/content/operators/_agent.md +155 -0
  205. package/content/operators/_app.md +2 -1
  206. package/content/operators/_array.md +122 -1
  207. package/content/operators/_build.md +1 -0
  208. package/content/operators/_credential.md +57 -0
  209. package/content/operators/_cron.md +292 -0
  210. package/content/operators/_date.md +2 -0
  211. package/content/operators/_error.md +24 -1
  212. package/content/operators/_get.md +6 -6
  213. package/content/operators/_hmac.md +78 -0
  214. package/content/operators/_js.md +2 -1
  215. package/content/operators/_location.md +1 -1
  216. package/content/operators/_media.md +13 -0
  217. package/content/operators/_module.md +56 -2
  218. package/content/operators/_operator.md +17 -3
  219. package/content/operators/_path_params.md +82 -0
  220. package/content/operators/_ref.md +258 -0
  221. package/content/operators/_request.md +1 -1
  222. package/content/operators/_request_details.md +6 -0
  223. package/content/operators/_type.md +14 -3
  224. package/content/operators/_url_query.md +2 -0
  225. package/content/operators/_user.md +3 -3
  226. package/content/plugins/plugins-actions.md +10 -0
  227. package/content/plugins/plugins-connections.md +25 -0
  228. package/content/plugins/plugins-dev.md +66 -0
  229. package/content/plugins/plugins-icon-sets.md +267 -0
  230. package/content/plugins/plugins-introduction.md +27 -1
  231. package/content/plugins/plugins.md +19 -0
  232. package/content/plugins/posthog.md +359 -0
  233. package/content/provider-reference/auth-js-providers.md +107 -0
  234. package/content/provider-reference/openidconnectprovider.md +44 -0
  235. package/content/recipes/recipes.md +16 -0
  236. package/content/reference/actions-reference.md +31 -0
  237. package/content/reference/blocks-reference.md +35 -0
  238. package/content/reference/cli.md +403 -0
  239. package/content/reference/connections-reference.md +23 -0
  240. package/content/reference/operators-reference.md +47 -0
  241. package/content/reference/reference.md +16 -0
  242. package/content/reference/schema-reference.md +12 -0
  243. package/content/testing/config-tests.md +677 -0
  244. package/content/testing/e2e-configuration.md +31 -1
  245. package/content/testing/e2e-getting-started.md +1 -1
  246. package/content/testing/e2e-introduction.md +1 -1
  247. package/content/testing/e2e-writing-tests.md +12 -1
  248. package/content/testing/explore-pull-request.md +136 -0
  249. package/content/testing/journey-data-sets.md +326 -0
  250. package/content/tutorial/tutorial-actions-operators.md +2 -2
  251. package/content/tutorial/tutorial-add-blocks.md +2 -2
  252. package/content/tutorial/tutorial-create-page.md +48 -2
  253. package/content/tutorial/tutorial-display-data-page.md +3 -3
  254. package/content/tutorial/tutorial-requests-api.md +155 -0
  255. package/content/tutorial/tutorial-requests-sql.md +153 -0
  256. package/content/tutorial/tutorial-start.md +66 -1
  257. package/content/user-authentication/auth-configuration.md +267 -0
  258. package/content/user-authentication/auth-providers.md +24 -0
  259. package/content/user-authentication/auth-steps.md +141 -0
  260. package/content/user-authentication/login-and-logout.md +160 -8
  261. package/content/user-authentication/mcp-oauth.md +424 -0
  262. package/content/user-authentication/organizations.md +246 -0
  263. package/content/user-authentication/protected-pages-apis.md +97 -0
  264. package/content/user-authentication/roles.md +49 -0
  265. package/content/user-authentication/two-factor.md +229 -0
  266. package/content/user-authentication/user-object.md +58 -0
  267. package/content/user-authentication/users-introduction.md +8 -0
  268. package/content/websockets/websocket-publish.md +105 -0
  269. package/content/websockets/websocket-subscriptions.md +136 -0
  270. package/content/websockets/websockets-introduction.md +101 -0
  271. package/hazards.json +44 -0
  272. package/index.json +3691 -14
  273. package/package.json +11 -1
  274. package/scripts/collectImportedFiles.js +80 -0
  275. package/scripts/extractAgentDocs.js +41 -30
  276. package/scripts/hashDocSources.js +38 -0
  277. package/scripts/isRedirectPage.js +26 -0
  278. package/scripts/recordSourceHashes.js +100 -0
  279. package/scripts/resolvePageSections.js +42 -0
  280. package/scripts/sectionKind.js +27 -0
  281. package/content/concepts/cli.md +0 -223
  282. package/content/other/introduction.md +0 -39
  283. package/content/other/next-auth-providers.md +0 -3
  284. /package/content/{other → actions}/updatesession.md +0 -0
@@ -41,6 +41,13 @@ Month picker for selecting year and month.
41
41
  variant: borderless
42
42
  label:
43
43
  disabled: true
44
+ - id: month_variant_underlined
45
+ type: MonthSelector
46
+ properties:
47
+ title: Underlined
48
+ variant: underlined
49
+ label:
50
+ disabled: true
44
51
  ```
45
52
 
46
53
  ```yaml
@@ -130,20 +137,31 @@ Month picker for selecting year and month.
130
137
  ```
131
138
 
132
139
  ```yaml
133
- - id: month_today_enabled
140
+ - id: month_prefix_icon
134
141
  type: MonthSelector
135
142
  properties:
136
- title: Show Today (default)
137
- showToday: true
138
- label:
139
- disabled: true
140
- - id: month_today_disabled
143
+ title: Prefix Icon
144
+ prefixIcon: clock
145
+ suffixIcon:
146
+ name: calendar
147
+ color: "#8c8c8c"
148
+ - id: month_prefix_text
141
149
  type: MonthSelector
142
150
  properties:
143
- title: No Today Button
144
- showToday: false
151
+ title: Prefix Text
152
+ prefix: "From:"
153
+ - id: month_placement
154
+ type: MonthSelector
155
+ properties:
156
+ title: Popup Opens Top Right
157
+ placement: topRight
158
+ - id: month_read_only
159
+ type: MonthSelector
160
+ properties:
161
+ title: Pick From Calendar Only
162
+ inputReadOnly: true
145
163
  label:
146
- disabled: true
164
+ extra: The input is read-only, so touch devices do not open the keyboard.
147
165
  ```
148
166
 
149
167
  ```yaml
@@ -157,14 +175,14 @@ Month picker for selecting year and month.
157
175
  type: MonthSelector
158
176
  properties:
159
177
  title: Clock Icon
160
- suffixIcon: AiOutlineClockCircle
178
+ suffixIcon: clock
161
179
  label:
162
180
  disabled: true
163
181
  - id: month_icon_schedule
164
182
  type: MonthSelector
165
183
  properties:
166
184
  title: Schedule Icon
167
- suffixIcon: AiOutlineSchedule
185
+ suffixIcon: CalendarDays
168
186
  label:
169
187
  disabled: true
170
188
  - id: month_icon_custom_color
@@ -172,7 +190,7 @@ Month picker for selecting year and month.
172
190
  properties:
173
191
  title: Custom Color Icon
174
192
  suffixIcon:
175
- name: AiOutlineCalendar
193
+ name: calendar
176
194
  color: "#1677ff"
177
195
  label:
178
196
  disabled: true
@@ -181,7 +199,7 @@ Month picker for selecting year and month.
181
199
  properties:
182
200
  title: Heart Icon
183
201
  suffixIcon:
184
- name: AiOutlineHeart
202
+ name: heart
185
203
  color: "#ff4d4f"
186
204
  label:
187
205
  disabled: true
@@ -435,7 +453,8 @@ Month picker for selecting year and month.
435
453
  - id: month_style_element
436
454
  type: MonthSelector
437
455
  style:
438
- .element: null
456
+ .element:
457
+ backgroundColor: var(--ant-color-primary-bg)
439
458
  properties:
440
459
  title: Custom Background
441
460
  label:
@@ -520,7 +539,7 @@ Month picker for selecting year and month.
520
539
  placeholder: Select billing month
521
540
  format: MMMM YYYY
522
541
  size: large
523
- suffixIcon: AiOutlineSchedule
542
+ suffixIcon: CalendarDays
524
543
  showToday: true
525
544
  allowClear: true
526
545
  label:
@@ -545,7 +564,7 @@ Month picker for selecting year and month.
545
564
  placeholder: Select fiscal month
546
565
  format: MMM YYYY
547
566
  suffixIcon:
548
- name: AiOutlineCalendar
567
+ name: calendar
549
568
  color: "#1677ff"
550
569
  disabledDates:
551
570
  min: 2026-01-01
@@ -561,7 +580,7 @@ Month picker for selecting year and month.
561
580
  format: MMMM YYYY
562
581
  placeholder: Choose a special month...
563
582
  suffixIcon:
564
- name: AiOutlineHeart
583
+ name: heart
565
584
  color: "#eb2f96"
566
585
  label:
567
586
  disabled: true
@@ -585,7 +604,7 @@ Month picker for selecting year and month.
585
604
  placeholder: Select month
586
605
  format: MMMM YYYY
587
606
  size: large
588
- suffixIcon: AiOutlineCalendar
607
+ suffixIcon: calendar
589
608
  label:
590
609
  extra: Choose the month for this budget entry.
591
610
  - id: applied2_budget_category
@@ -611,14 +630,14 @@ Month picker for selecting year and month.
611
630
  properties:
612
631
  title: Amount
613
632
  placeholder: Enter amount
614
- prefixIcon: AiOutlineDollar
633
+ prefixIcon: DollarSign
615
634
  label:
616
635
  extra: Enter the budgeted amount for this category.
617
636
  - id: applied2_budget_save_btn
618
637
  type: Button
619
638
  properties:
620
639
  title: Save Budget Entry
621
- icon: AiOutlineSave
640
+ icon: save
622
641
  type: primary
623
642
  size: large
624
643
  block: true
@@ -644,7 +663,7 @@ Month picker for selecting year and month.
644
663
  placeholder: Select start month
645
664
  format: MMMM YYYY
646
665
  size: large
647
- suffixIcon: AiOutlineCalendar
666
+ suffixIcon: calendar
648
667
  label:
649
668
  extra: Choose when the subscription billing begins.
650
669
  disabledDates:
@@ -671,7 +690,7 @@ Month picker for selecting year and month.
671
690
  type: Button
672
691
  properties:
673
692
  title: Confirm Subscription
674
- icon: AiOutlineCreditCard
693
+ icon: CreditCard
675
694
  type: primary
676
695
  size: large
677
696
  block: true
@@ -690,7 +709,7 @@ Month picker for selecting year and month.
690
709
  | `autoFocus` | boolean | `false` | Autofocus to the block on page load. |
691
710
  | `bordered` | boolean | `true` | Deprecated - use variant: 'borderless'. Whether or not the input has a border style. |
692
711
  | `disabled` | boolean | `false` | Disable the block if true. |
693
- | `variant` | string | `"outlined"` | Variant style of the input. Use 'borderless' instead of bordered: false. Enum: `outlined`, `filled`, `borderless`. |
712
+ | `variant` | string | `"outlined"` | Variant style of the input. Use 'borderless' instead of bordered: false. Enum: `outlined`, `filled`, `borderless`, `underlined`. |
694
713
  | `disabledDates` | object | - | Disable specific dates so that they can not be chosen. |
695
714
  | `disabledDates.min` | string \| object | - | Disable all dates less than the minimum date. Can be a date string or a _date object. |
696
715
  | `disabledDates.max` | string \| object | - | Disable all dates greater than the maximum date. Can be a date string or a _date object. |
@@ -699,64 +718,112 @@ Month picker for selecting year and month.
699
718
  | `disabledDates.ranges.$.from` | string \| object | - | Start of the disabled range. |
700
719
  | `disabledDates.ranges.$.to` | string \| object | - | End of the disabled range. |
701
720
  | `format` | string | - | Format in which to format the date value, eg. "MMMM YYYY" will format a date value of 1999-12-31 as "December 1999". The format has to conform to dayjs formats. Defaults to the active locale's month format, or "YYYY-MM" when no locale is configured. |
721
+ | `inputReadOnly` | boolean | `false` | Make the text input read-only, so a date can only be chosen from the calendar. This also stops the on-screen keyboard opening on touch devices. |
702
722
  | `placeholder` | string | - | Placeholder text inside the block before user types input. |
723
+ | `placement` | string | `"bottomLeft"` | Position of the calendar popup relative to the input. Enum: `bottomLeft`, `bottomRight`, `topLeft`, `topRight`. |
724
+ | `prefix` | string | - | Prefix text shown before the date in the input, priority over prefixIcon. |
725
+ | `prefixIcon` | string \| object | - | Icon name (a semantic name like `edit`, a Lucide icon name like `Pencil`, or a set-qualified name like `tabler:Pencil`) or properties of an Icon block to customize icon on the left-hand side of the date picker. |
726
+ | `prefixIcon.name` | string | - | Icon name: a semantic name like `edit`, a Lucide icon name like `Pencil`, or a set-qualified name like `tabler:Pencil`. |
727
+ | `prefixIcon.color` | string | - | Icon color. |
728
+ | `prefixIcon.size` | string \| number | - | Size of the icon. Defaults to `theme.icons.size`. |
729
+ | `prefixIcon.rotate` | number | - | Number of degrees to rotate the icon. |
730
+ | `prefixIcon.spin` | boolean | - | Continuously spin the icon with animation. |
731
+ | `prefixIcon.strokeWidth` | number | - | Stroke width of the icon lines, in pixels of the 24px icon grid. Defaults to `theme.icons.strokeWidth` (2). |
732
+ | `prefixIcon.nonScalingStroke` | boolean | - | Keep the stroke width constant at any icon size. Defaults to `theme.icons.nonScalingStroke`. |
733
+ | `prefixIcon.title` | string | - | Icon hover title for accessibility. An empty string marks the icon as decorative. |
734
+ | `prefixIcon.disableLoadingIcon` | boolean | - | While loading after the icon has been clicked, don't render the loading icon. |
703
735
  | `presets` | array | - | Shortcuts listed next to the calendar to quickly select a month. Presets are re-evaluated every time the block config is evaluated, so operator based values like "_date: now" stay current. A preset is offered on the same terms as the calendar cells: a shortcut with nothing it may select is listed as disabled. |
704
736
  | `presets.$.label` | string | - | Text shown for the shortcut - supports html. |
705
737
  | `presets.$.value` | string \| number \| object | - | A date string, a timestamp, or a _date object. Dates are read as UTC, the same as the block value, so a fixed date like "2026-01-01" resolves to the same month in every timezone. A date relative to now is an instant, not a calendar date, so end a _dayjs chain with a format step to pin it to the local calendar: "_dayjs: [now, {startOf: month}, {format: YYYY-MM-DD}]". Without the format step the chain resolves to an instant, which can select the month before or after the current one, depending on the browser timezone and the time of day. |
706
- | `showToday` | boolean | `true` | Shows a button to easily select the current date if true. |
738
+ | `showToday` | boolean | `true` | Deprecated - has no effect. The month picker has no button to select the current date. |
707
739
  | `size` | string | `"default"` | Size of the block. Enum: `small`, `default`, `large`. |
708
- | `suffixIcon` | string \| object | `"AiOutlineCalendar"` | Name of an React-Icon (See all icons) or properties of an Icon block to customize icon on right-hand side of the date picker. |
740
+ | `suffixIcon` | string \| object | `"calendar"` | Icon name (a semantic name like `edit`, a Lucide icon name like `Pencil`, or a set-qualified name like `tabler:Pencil`) or properties of an Icon block to customize icon on right-hand side of the date picker. |
741
+ | `suffixIcon.name` | string | - | Icon name: a semantic name like `edit`, a Lucide icon name like `Pencil`, or a set-qualified name like `tabler:Pencil`. |
742
+ | `suffixIcon.color` | string | - | Icon color. |
743
+ | `suffixIcon.size` | string \| number | - | Size of the icon. Defaults to `theme.icons.size`. |
744
+ | `suffixIcon.rotate` | number | - | Number of degrees to rotate the icon. |
745
+ | `suffixIcon.spin` | boolean | - | Continuously spin the icon with animation. |
746
+ | `suffixIcon.strokeWidth` | number | - | Stroke width of the icon lines, in pixels of the 24px icon grid. Defaults to `theme.icons.strokeWidth` (2). |
747
+ | `suffixIcon.nonScalingStroke` | boolean | - | Keep the stroke width constant at any icon size. Defaults to `theme.icons.nonScalingStroke`. |
748
+ | `suffixIcon.title` | string | - | Icon hover title for accessibility. An empty string marks the icon as decorative. |
749
+ | `suffixIcon.disableLoadingIcon` | boolean | - | While loading after the icon has been clicked, don't render the loading icon. |
709
750
  | `label` | object | - | Label properties. |
751
+ | `label.xs` | object | - | Label width on extra small screens (below 576px) when the label is not inline. |
752
+ | `label.xs.span` | number | - | Label width in columns, out of 24. The content takes the remaining columns. |
753
+ | `label.sm` | object | - | Label width on small screens (576px and up) when the label is not inline. Also applies below 576px unless `xs` is set. |
754
+ | `label.sm.span` | number | - | Label width in columns, out of 24. The content takes the remaining columns. |
755
+ | `label.md` | object | - | Label width on medium screens (768px and up) when the label is not inline. Overrides `span`. |
756
+ | `label.md.span` | number | - | Label width in columns, out of 24. The content takes the remaining columns. |
757
+ | `label.lg` | object | - | Label width on large screens (992px and up) when the label is not inline. |
758
+ | `label.lg.span` | number | - | Label width in columns, out of 24. The content takes the remaining columns. |
759
+ | `label.xl` | object | - | Label width on extra large screens (1200px and up) when the label is not inline. |
760
+ | `label.xl.span` | number | - | Label width in columns, out of 24. The content takes the remaining columns. |
761
+ | `label.xxl` | object | - | Label width on extra extra large screens (1600px and up) when the label is not inline. |
762
+ | `label.xxl.span` | number | - | Label width in columns, out of 24. The content takes the remaining columns. |
710
763
  | `label.align` | string | `"left"` | Align label left or right when inline. Enum: `left`, `right`. |
711
764
  | `label.colon` | boolean | `true` | Append label with colon. |
712
765
  | `label.extra` | string | - | Extra text to display beneath the content - supports html. |
713
766
  | `label.title` | string | - | Label title - supports html. |
714
767
  | `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. |
715
768
  | `label.tooltip.title` | string | - | Tooltip text shown on hover - supports html. |
716
- | `label.tooltip.icon` | string | `"AiOutlineQuestionCircle"` | Name of the icon to show beside the label. |
769
+ | `label.tooltip.icon` | string | `"help"` | Icon name to show beside the label: a semantic name like `help`, a Lucide icon name like `CircleQuestionMark`, or a set-qualified name like `tabler:HelpCircle`. |
717
770
  | `label.tooltip.color` | string | - | Color of the tooltip icon. |
718
- | `label.span` | number | - | Label inline span. |
771
+ | `label.span` | number | - | Label width in columns, out of 24, on medium screens (768px) and up when the label is not inline. The content takes the remaining columns. |
719
772
  | `label.disabled` | boolean | `false` | Hide input label. |
720
773
  | `label.hasFeedback` | boolean | `true` | Display feedback extra from validation, this does not disable validation. |
721
774
  | `label.inline` | boolean | `false` | Render input and label inline. |
775
+ | `label.wrap` | boolean | `false` | Wrap long label text onto multiple lines when the label is inline. Labels above their input always wrap. |
722
776
  | `title` | string | - | Month selector label title - supports html. |
723
777
  | `theme` | object | - | Antd design token overrides for this block. See [antd design tokens](https://ant.design/components/overview#design-token). See [Ant Design date-picker tokens](https://ant.design/components/date-picker#design-token). |
778
+ | `theme.activeBg` | string | `"#ffffff"` | Background color of the input when the picker is active/focused. |
724
779
  | `theme.activeBorderColor` | string | - | Border color when the picker is active/focused. |
725
- | `theme.activeShadow` | string | - | Shadow effect when the picker is active/focused. |
726
- | `theme.hoverBorderColor` | string | - | Border color when hovering over the picker. |
727
- | `theme.cellHeight` | number | `24` | Height of a calendar cell. |
728
- | `theme.cellWidth` | number | `36` | Width of a calendar cell. |
729
- | `theme.cellHoverBg` | string | `"rgba(0, 0, 0, 0.04)"` | Background color of a calendar cell on hover. |
730
- | `theme.cellActiveWithRangeBg` | string | `"#e6f4ff"` | Background color of active cell within a range selection. |
731
- | `theme.cellHoverWithRangeBg` | string | - | Background color of cells within range on hover. |
732
- | `theme.cellBgDisabled` | string | - | Background color of disabled cells. |
733
- | `theme.cellRangeBorderColor` | string | - | Border color of range selection cells. |
734
- | `theme.addonBg` | string | `"rgba(0, 0, 0, 0.02)"` | Background color of the footer addon area. |
735
- | `theme.zIndexPopup` | number | `1050` | Z-index of the picker popup layer. |
736
- | `theme.paddingBlock` | number | `4` | Vertical padding for the default size picker. |
737
- | `theme.paddingBlockSM` | number | `0` | Vertical padding for the small size picker. |
738
- | `theme.paddingBlockLG` | number | `7` | Vertical padding for the large size picker. |
739
- | `theme.paddingInline` | number | `11` | Horizontal padding for the default size picker. |
740
- | `theme.paddingInlineSM` | number | `7` | Horizontal padding for the small size picker. |
741
- | `theme.paddingInlineLG` | number | `11` | Horizontal padding for the large size picker. |
780
+ | `theme.activeShadow` | string | `"0 0 0 2px rgba(5,145,255,0.1)"` | Shadow effect when the picker is active/focused. |
742
781
  | `theme.borderRadius` | number | `6` | Border radius of the picker input. |
743
- | `theme.borderRadiusSM` | number | `4` | Border radius for the small picker. |
744
782
  | `theme.borderRadiusLG` | number | `8` | Border radius for the large picker and popup panel. |
783
+ | `theme.borderRadiusSM` | number | `4` | Border radius for the small picker. |
784
+ | `theme.cellActiveWithRangeBg` | string | `"#e6f4ff"` | Background color of cells within the selected range. |
785
+ | `theme.cellBgDisabled` | string | `"rgba(0,0,0,0.04)"` | Background color of disabled cells. |
786
+ | `theme.cellHeight` | number | `24` | Height of a calendar cell. |
787
+ | `theme.cellHoverBg` | string | `"rgba(0, 0, 0, 0.04)"` | Background color of a calendar cell on hover. |
788
+ | `theme.cellHoverWithRangeBg` | string | `"#cbe0fd"` | Background color of cells within range on hover. |
789
+ | `theme.cellRangeBorderColor` | string | `"#82b4f9"` | Border color of range selection cells. |
790
+ | `theme.cellWidth` | number | `36` | Width of a calendar cell. |
791
+ | `theme.colorBgContainer` | string | - | Background color of the picker input. |
792
+ | `theme.colorBorder` | string | - | Border color of the picker input. |
793
+ | `theme.colorPrimary` | string | - | Primary color used for the selected date and active states. |
794
+ | `theme.colorText` | string | - | Text color of the picker input and calendar cells. |
795
+ | `theme.colorTextPlaceholder` | string | - | Color of the placeholder text. |
745
796
  | `theme.controlHeight` | number | `32` | Height of the picker input. |
746
- | `theme.controlHeightSM` | number | `24` | Height of the small picker input. |
747
797
  | `theme.controlHeightLG` | number | `40` | Height of the large picker input. |
798
+ | `theme.controlHeightSM` | number | `24` | Height of the small picker input. |
799
+ | `theme.errorActiveShadow` | string | `"0 0 0 2px rgba(255,38,5,0.06)"` | Shadow effect when the picker has error status and is focused. |
748
800
  | `theme.fontSize` | number | `14` | Font size of the picker input. |
749
- | `theme.fontSizeSM` | number | `14` | Font size for the small picker. |
750
801
  | `theme.fontSizeLG` | number | `16` | Font size for the large picker. |
802
+ | `theme.fontSizeSM` | number | `14` | Font size for the small picker. |
803
+ | `theme.hoverBg` | string | `"#ffffff"` | Background color of the input when hovering over the picker. |
804
+ | `theme.hoverBorderColor` | string | - | Border color when hovering over the picker. |
751
805
  | `theme.lineWidth` | number | `1` | Border width of the picker input. |
752
- | `theme.colorPrimary` | string | - | Primary color used for selected month and active states. |
753
- | `theme.colorBgContainer` | string | - | Background color of the picker input. |
754
- | `theme.colorText` | string | - | Text color of the picker input and calendar cells. |
755
- | `theme.colorBorder` | string | - | Border color of the picker input. |
756
- | `theme.colorTextPlaceholder` | string | - | Color of the placeholder text. |
806
+ | `theme.paddingBlock` | number | `4` | Vertical padding for the default size picker. |
807
+ | `theme.paddingBlockLG` | number | `7` | Vertical padding for the large size picker. |
808
+ | `theme.paddingBlockSM` | number | `0` | Vertical padding for the small size picker. |
809
+ | `theme.paddingInline` | number | `11` | Horizontal padding for the default size picker. |
810
+ | `theme.paddingInlineLG` | number | `11` | Horizontal padding for the large size picker. |
811
+ | `theme.paddingInlineSM` | number | `7` | Horizontal padding for the small size picker. |
812
+ | `theme.presetsMaxWidth` | number | `200` | Maximum width of the presets list next to the calendar. |
813
+ | `theme.presetsWidth` | number | `120` | Width of the presets list next to the calendar. |
814
+ | `theme.timeCellHeight` | number | `28` | Height of a time cell in the time panel. |
815
+ | `theme.timeColumnHeight` | number | `224` | Height of the time panel column. |
816
+ | `theme.timeColumnWidth` | number | `56` | Width of the time panel column. |
817
+ | `theme.warningActiveShadow` | string | `"0 0 0 2px rgba(255,215,5,0.1)"` | Shadow effect when the picker has warning status and is focused. |
818
+ | `theme.withoutTimeCellHeight` | number | `66` | Height of the cells of the month, week, quarter, year and decade panels. |
819
+ | `theme.zIndexPopup` | number | `1050` | Z-index of the picker popup layer. |
757
820
 
758
821
  | Event | Event Data | Description |
759
822
  | --- | --- | --- |
823
+ | `onBlur` | \- | Trigger actions when the picker loses focus. |
824
+ | `onClear` | \- | Trigger actions when the clear button is clicked. |
825
+ | `onFocus` | \- | Trigger actions when the picker gets focus. |
826
+ | `onOpenChange` | `{ open }` | Trigger actions when the calendar popup opens or closes. |
760
827
  | `onChange` | `{ value }` | Trigger actions when selection is changed. |
761
828
  | `onTooltipClick` | \- | Trigger actions when the tooltip icon is clicked. |
762
829
 
@@ -768,6 +835,7 @@ Month picker for selecting year and month.
768
835
  | `/extra` | The MonthSelector extra content. |
769
836
  | `/feedback` | The MonthSelector validation feedback. |
770
837
  | `/popup` | The MonthSelector popup. |
838
+ | `/prefixIcon` | The prefix icon in the MonthSelector. |
771
839
  | `/suffixIcon` | The suffix icon in the MonthSelector. |
772
840
 
773
841
  No slots defined.