@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,870 @@
1
+ # Descriptions
2
+
3
+ Description list with configurable layout and columns.
4
+
5
+ ```yaml
6
+ - id: basic_array_items
7
+ type: Descriptions
8
+ properties:
9
+ title: User Profile
10
+ items:
11
+ - label: Full Name
12
+ value: Sarah Johnson
13
+ - label: Email
14
+ value: sarah.johnson@example.com
15
+ - label: Phone
16
+ value: +1 (555) 123-4567
17
+ - label: Location
18
+ value: San Francisco, CA
19
+ - label: Role
20
+ value: Senior Developer
21
+ - label: Department
22
+ value: Engineering
23
+ - id: basic_object_items
24
+ type: Descriptions
25
+ properties:
26
+ title: Object Format
27
+ items:
28
+ Name: Alex Chen
29
+ Email: alex.chen@example.com
30
+ Phone: +1 (555) 987-6543
31
+ Location: New York, NY
32
+ Role: Product Manager
33
+ Team: Growth
34
+ ```
35
+
36
+ ```yaml
37
+ - id: bordered_default
38
+ type: Descriptions
39
+ properties:
40
+ title: Borderless (Default)
41
+ items:
42
+ - label: Hostname
43
+ value: prod-web-01
44
+ - label: IP Address
45
+ value: 192.168.1.100
46
+ - label: OS
47
+ value: Ubuntu 22.04 LTS
48
+ - label: CPU
49
+ value: 8 cores
50
+ - label: Memory
51
+ value: 32 GB
52
+ - label: Storage
53
+ value: 500 GB SSD
54
+ - id: bordered_true
55
+ type: Descriptions
56
+ properties:
57
+ title: Bordered
58
+ bordered: true
59
+ items:
60
+ - label: Hostname
61
+ value: prod-web-02
62
+ - label: IP Address
63
+ value: 192.168.1.101
64
+ - label: OS
65
+ value: Debian 12
66
+ - label: CPU
67
+ value: 16 cores
68
+ - label: Memory
69
+ value: 64 GB
70
+ - label: Storage
71
+ value: 1 TB NVMe
72
+ ```
73
+
74
+ ```yaml
75
+ - id: size_default
76
+ type: Descriptions
77
+ properties:
78
+ title: Default Size
79
+ size: default
80
+ bordered: true
81
+ items:
82
+ - label: Product
83
+ value: Widget Pro
84
+ - label: SKU
85
+ value: WGT-PRO-001
86
+ - label: Price
87
+ value: $49.99
88
+ - label: Category
89
+ value: Electronics
90
+ - label: Weight
91
+ value: 0.5 kg
92
+ - label: In Stock
93
+ value: 1,250 units
94
+ - id: size_small
95
+ type: Descriptions
96
+ properties:
97
+ title: Small Size
98
+ size: small
99
+ bordered: true
100
+ items:
101
+ - label: Product
102
+ value: Widget Lite
103
+ - label: SKU
104
+ value: WGT-LIT-002
105
+ - label: Price
106
+ value: $24.99
107
+ - label: Category
108
+ value: Electronics
109
+ - label: Weight
110
+ value: 0.3 kg
111
+ - label: In Stock
112
+ value: 3,480 units
113
+ ```
114
+
115
+ ```yaml
116
+ - id: vertical_borderless
117
+ type: Descriptions
118
+ properties:
119
+ title: Order Summary
120
+ layout: vertical
121
+ items:
122
+ - label: Order Number
123
+ value: ORD-2026-0042
124
+ - label: Date
125
+ value: March 10, 2026
126
+ - label: Status
127
+ value: Shipped
128
+ - label: Total
129
+ value: $129.97
130
+ - id: vertical_bordered
131
+ type: Descriptions
132
+ properties:
133
+ title: Invoice Details
134
+ bordered: true
135
+ layout: vertical
136
+ items:
137
+ - label: Invoice Number
138
+ value: INV-2026-003
139
+ - label: Date Issued
140
+ value: March 1, 2026
141
+ - label: Due Date
142
+ value: March 31, 2026
143
+ - label: Amount
144
+ value: $2,450.00
145
+ - label: Status
146
+ value: Pending
147
+ - label: Payment Method
148
+ value: Wire Transfer
149
+ ```
150
+
151
+ ```yaml
152
+ - id: columns_1
153
+ type: Descriptions
154
+ properties:
155
+ title: Single Column
156
+ column: 1
157
+ bordered: true
158
+ items:
159
+ - label: Full Name
160
+ value: Alex Chen
161
+ - label: Email
162
+ value: alex.chen@example.com
163
+ - label: Phone
164
+ value: +1 (555) 987-6543
165
+ - label: Address
166
+ value: 123 Main Street, New York, NY 10001
167
+ - id: columns_2
168
+ type: Descriptions
169
+ properties:
170
+ title: Two Columns
171
+ column: 2
172
+ bordered: true
173
+ items:
174
+ - label: First Name
175
+ value: Maria
176
+ - label: Last Name
177
+ value: Garcia
178
+ - label: Department
179
+ value: Marketing
180
+ - label: Title
181
+ value: Director
182
+ - label: Start Date
183
+ value: January 15, 2024
184
+ - label: Office
185
+ value: Building A, Floor 3
186
+ - id: columns_4
187
+ type: Descriptions
188
+ properties:
189
+ title: Four Columns
190
+ column: 4
191
+ bordered: true
192
+ items:
193
+ - label: Q1
194
+ value: $125,000
195
+ - label: Q2
196
+ value: $142,500
197
+ - label: Q3
198
+ value: $138,900
199
+ - label: Q4
200
+ value: $167,200
201
+ - label: YoY Growth
202
+ value: +12.4%
203
+ - label: Market Share
204
+ value: 23.1%
205
+ - label: Customers
206
+ value: 4,582
207
+ - label: NPS Score
208
+ value: 72
209
+ ```
210
+
211
+ ```yaml
212
+ - id: responsive_columns
213
+ type: Descriptions
214
+ properties:
215
+ title: Employee Record
216
+ bordered: true
217
+ column:
218
+ xs: 1
219
+ sm: 2
220
+ md: 3
221
+ lg: 3
222
+ xl: 4
223
+ items:
224
+ - label: Employee ID
225
+ value: EMP-1042
226
+ - label: Full Name
227
+ value: Jordan Rivera
228
+ - label: Department
229
+ value: Engineering
230
+ - label: Title
231
+ value: Staff Engineer
232
+ - label: Manager
233
+ value: Pat Williams
234
+ - label: Location
235
+ value: Austin, TX
236
+ - label: Start Date
237
+ value: April 2022
238
+ - label: Level
239
+ value: L5
240
+ ```
241
+
242
+ ```yaml
243
+ - id: spanning_basic
244
+ type: Descriptions
245
+ properties:
246
+ title: Support Ticket
247
+ bordered: true
248
+ items:
249
+ - label: Ticket ID
250
+ value: TICKET-7891
251
+ - label: Priority
252
+ value: High
253
+ - label: Created
254
+ value: March 9, 2026
255
+ - label: Description
256
+ value: Users are unable to log in after the latest deployment. The
257
+ authentication service returns a 503 error when attempting to validate
258
+ credentials against the LDAP directory.
259
+ span: 3
260
+ - id: spanning_mixed
261
+ type: Descriptions
262
+ properties:
263
+ title: Project Overview
264
+ bordered: true
265
+ column: 3
266
+ items:
267
+ - label: Project Name
268
+ value: Phoenix Migration
269
+ - label: Status
270
+ value: In Progress
271
+ - label: Priority
272
+ value: Critical
273
+ - label: Lead
274
+ value: Priya Patel
275
+ - label: Team Size
276
+ value: 12
277
+ - label: Sprint
278
+ value: Sprint 14
279
+ - label: Objective
280
+ value: Migrate all legacy microservices from the monolithic architecture to a
281
+ cloud-native Kubernetes deployment with zero downtime and full
282
+ backwards compatibility.
283
+ span: 2
284
+ - label: Deadline
285
+ value: June 30, 2026
286
+ - id: spanning_full_width
287
+ type: Descriptions
288
+ properties:
289
+ title: API Error Log
290
+ bordered: true
291
+ column: 3
292
+ items:
293
+ - label: Timestamp
294
+ value: 2026-03-10T14:23:07Z
295
+ - label: Endpoint
296
+ value: /api/v2/users/auth
297
+ - label: Status Code
298
+ value: 503
299
+ - label: Stack Trace
300
+ value: "Error: ECONNREFUSED 10.0.1.45:5432 - Connection refused at
301
+ TCPConnectWrap.afterConnect [as oncomplete] (net.js:1141:16)"
302
+ span: 3
303
+ - label: Resolution
304
+ value: Database connection pool exhausted. Increased max_connections from 100 to
305
+ 250 and implemented connection retry logic with exponential backoff.
306
+ span: 3
307
+ ```
308
+
309
+ ```yaml
310
+ - id: colon_true
311
+ type: Descriptions
312
+ properties:
313
+ title: With Colons (Default)
314
+ colon: true
315
+ items:
316
+ - label: Name
317
+ value: Sarah Johnson
318
+ - label: Role
319
+ value: Engineer
320
+ - label: Team
321
+ value: Platform
322
+ - id: colon_false
323
+ type: Descriptions
324
+ properties:
325
+ title: Without Colons
326
+ colon: false
327
+ items:
328
+ - label: Name
329
+ value: Sarah Johnson
330
+ - label: Role
331
+ value: Engineer
332
+ - label: Team
333
+ value: Platform
334
+ ```
335
+
336
+ ```yaml
337
+ - id: no_title_borderless
338
+ type: Descriptions
339
+ properties:
340
+ items:
341
+ - label: Browser
342
+ value: Chrome 122
343
+ - label: Operating System
344
+ value: macOS 15.3
345
+ - label: Screen Resolution
346
+ value: 2560 x 1440
347
+ - label: Language
348
+ value: English (US)
349
+ - label: Timezone
350
+ value: America/Los_Angeles
351
+ - label: User Agent
352
+ value: Mozilla/5.0
353
+ - id: no_title_bordered
354
+ type: Descriptions
355
+ properties:
356
+ bordered: true
357
+ items:
358
+ - label: Protocol
359
+ value: HTTPS
360
+ - label: Method
361
+ value: POST
362
+ - label: Content-Type
363
+ value: application/json
364
+ - label: Response Time
365
+ value: 142ms
366
+ - label: Cache
367
+ value: MISS
368
+ - label: CDN Node
369
+ value: us-west-2a
370
+ ```
371
+
372
+ ```yaml
373
+ - id: html_content
374
+ type: Descriptions
375
+ properties:
376
+ title: Release Notes
377
+ bordered: true
378
+ items:
379
+ - label: <b>Version</b>
380
+ value: '<span style="color: #1677ff;">v3.2.0</span>'
381
+ - label: <b>Release Date</b>
382
+ value: March 10, 2026
383
+ - label: <b>Status</b>
384
+ value: '<span style="color: #52c41a; font-weight: bold;">Stable</span>'
385
+ - label: <b>Changes</b>
386
+ value: Added OAuth2 support, fixed memory leak in worker pool, improved query
387
+ performance by <b>40%</b>
388
+ span: 3
389
+ ```
390
+
391
+ ```yaml
392
+ - id: desc_with_extra
393
+ type: Descriptions
394
+ properties:
395
+ title: Account Details
396
+ bordered: true
397
+ items:
398
+ - label: Account ID
399
+ value: ACC-2026-0891
400
+ - label: Plan
401
+ value: Enterprise
402
+ - label: Status
403
+ value: Active
404
+ - label: Created
405
+ value: January 12, 2024
406
+ - label: Billing Cycle
407
+ value: Annual
408
+ - label: Next Invoice
409
+ value: January 12, 2027
410
+ slots:
411
+ extra:
412
+ blocks:
413
+ - id: desc_extra_button
414
+ type: Button
415
+ layout:
416
+ flex: 0 0 auto
417
+ properties:
418
+ title: Edit
419
+ color: primary
420
+ variant: link
421
+ size: small
422
+ ```
423
+
424
+ ```yaml
425
+ - id: user_account
426
+ type: Descriptions
427
+ properties:
428
+ title: Account Information
429
+ bordered: true
430
+ column: 2
431
+ items:
432
+ - label: Username
433
+ value: sjohnson
434
+ - label: Display Name
435
+ value: Sarah Johnson
436
+ - label: Email
437
+ value: sarah.johnson@acme.com
438
+ - label: Phone
439
+ value: +1 (555) 123-4567
440
+ - label: Role
441
+ value: Administrator
442
+ - label: Last Login
443
+ value: March 10, 2026 at 9:14 AM
444
+ - label: Two-Factor Auth
445
+ value: Enabled
446
+ - label: API Key
447
+ value: sk-****-****-7f3a
448
+ - label: Permissions
449
+ value: Read, Write, Delete, Manage Users, Audit Logs
450
+ span: 2
451
+ ```
452
+
453
+ ```yaml
454
+ - id: order_details
455
+ type: Descriptions
456
+ properties:
457
+ title: "Order #ORD-2026-11583"
458
+ bordered: true
459
+ items:
460
+ - label: Customer
461
+ value: Acme Corporation
462
+ - label: Date Placed
463
+ value: March 8, 2026
464
+ - label: Payment Method
465
+ value: Visa ending in 4242
466
+ - label: Subtotal
467
+ value: $1,249.00
468
+ - label: Tax (8.25%)
469
+ value: $103.04
470
+ - label: Shipping
471
+ value: $0.00 (Free)
472
+ - label: Total
473
+ value: $1,352.04
474
+ span: 3
475
+ - id: order_shipping
476
+ type: Descriptions
477
+ properties:
478
+ title: Shipping Information
479
+ bordered: true
480
+ column: 2
481
+ items:
482
+ - label: Carrier
483
+ value: FedEx Ground
484
+ - label: Tracking Number
485
+ value: 7489 2305 1847
486
+ - label: Ship Date
487
+ value: March 9, 2026
488
+ - label: Est. Delivery
489
+ value: March 14, 2026
490
+ - label: Ship From
491
+ value: Warehouse B, Dallas, TX
492
+ - label: Ship To
493
+ value: 456 Oak Avenue, Portland, OR 97201
494
+ ```
495
+
496
+ ```yaml
497
+ - id: system_info
498
+ type: Descriptions
499
+ properties:
500
+ title: System Health Dashboard
501
+ bordered: true
502
+ size: small
503
+ items:
504
+ - label: Service
505
+ value: api-gateway
506
+ - label: Status
507
+ value: '<span style="color: #52c41a;">Healthy</span>'
508
+ - label: Uptime
509
+ value: 99.97%
510
+ - label: CPU Usage
511
+ value: 34%
512
+ - label: Memory
513
+ value: 12.4 / 32 GB
514
+ - label: Disk
515
+ value: 187 / 500 GB
516
+ - label: Active Connections
517
+ value: 2,847
518
+ - label: Requests/sec
519
+ value: 1,243
520
+ - label: Avg Latency
521
+ value: 23ms
522
+ - label: Error Rate
523
+ value: '<span style="color: #52c41a;">0.02%</span>'
524
+ - label: Last Deploy
525
+ value: March 10, 2026 08:30 UTC
526
+ - label: Version
527
+ value: v2.14.3-rc1
528
+ ```
529
+
530
+ ```yaml
531
+ - id: item_label_styles
532
+ type: Descriptions
533
+ properties:
534
+ title: Styled Labels and Values
535
+ bordered: true
536
+ items:
537
+ - label: Revenue
538
+ value: $487,200
539
+ labelStyle:
540
+ fontWeight: bold
541
+ contentStyle:
542
+ color: "#52c41a"
543
+ fontWeight: bold
544
+ - label: Expenses
545
+ value: $312,100
546
+ labelStyle:
547
+ fontWeight: bold
548
+ contentStyle:
549
+ color: "#ff4d4f"
550
+ fontWeight: bold
551
+ - label: Net Profit
552
+ value: $175,100
553
+ labelStyle:
554
+ fontWeight: bold
555
+ contentStyle:
556
+ color: "#52c41a"
557
+ fontWeight: bold
558
+ fontSize: 16
559
+ - id: item_inline_styles
560
+ type: Descriptions
561
+ properties:
562
+ title: Custom Item Backgrounds
563
+ bordered: true
564
+ items:
565
+ - label: Critical
566
+ value: 2 issues
567
+ - label: Warning
568
+ value: 5 issues
569
+ - label: Info
570
+ value: 12 issues
571
+ ```
572
+
573
+ ```yaml
574
+ - id: css_element
575
+ type: Descriptions
576
+ properties:
577
+ title: Element CSS Key
578
+ bordered: true
579
+ items:
580
+ - label: Name
581
+ value: Jordan Rivera
582
+ - label: Email
583
+ value: jordan@example.com
584
+ - label: Phone
585
+ value: +1 (555) 444-7890
586
+ style:
587
+ .element:
588
+ border: 2px solid
589
+ borderRadius: 8px
590
+ padding: 4px
591
+ - id: css_label_content
592
+ type: Descriptions
593
+ properties:
594
+ title: Label and Content CSS Keys
595
+ bordered: true
596
+ items:
597
+ - label: Service
598
+ value: Production API
599
+ - label: Region
600
+ value: us-east-1
601
+ - label: Tier
602
+ value: Premium
603
+ style:
604
+ .label:
605
+ fontWeight: bold
606
+ color: "#1677ff"
607
+ .content:
608
+ fontStyle: italic
609
+ ```
610
+
611
+ ```yaml
612
+ - id: tailwind_shadow
613
+ type: Descriptions
614
+ class: shadow-md rounded-lg overflow-hidden
615
+ properties:
616
+ title: Card-Style Descriptions
617
+ bordered: true
618
+ items:
619
+ - label: Company
620
+ value: Acme Inc.
621
+ - label: Industry
622
+ value: Technology
623
+ - label: Founded
624
+ value: 2018
625
+ - label: Employees
626
+ value: 250
627
+ - label: Headquarters
628
+ value: San Francisco, CA
629
+ - label: Revenue
630
+ value: $48M ARR
631
+ - id: tailwind_dark_bg
632
+ type: Box
633
+ class: bg-bg-layout p-4 rounded-lg
634
+ blocks:
635
+ - id: tailwind_on_dark
636
+ type: Descriptions
637
+ properties:
638
+ title: '<span style="color: #ffffff;">Dark Background</span>'
639
+ colon: false
640
+ items:
641
+ - label: '<span style="color: #a0aec0;">Status</span>'
642
+ value: '<span style="color: #68d391;">Online</span>'
643
+ - label: '<span style="color: #a0aec0;">Latency</span>'
644
+ value: '<span style="color: #63b3ed;">12ms</span>'
645
+ - label: '<span style="color: #a0aec0;">Region</span>'
646
+ value: '<span style="color: #fc8181;">us-west-2</span>'
647
+ ```
648
+
649
+ ```yaml
650
+ - id: theme_custom_colors
651
+ type: Descriptions
652
+ properties:
653
+ title: Custom Label Colors
654
+ bordered: true
655
+ theme:
656
+ labelColor: "#0958d9"
657
+ contentColor: "#434343"
658
+ items:
659
+ - label: Environment
660
+ value: Production
661
+ - label: Region
662
+ value: us-east-1
663
+ - label: Availability Zone
664
+ value: us-east-1a
665
+ - label: Instance Type
666
+ value: m5.xlarge
667
+ - label: Auto Scaling
668
+ value: Enabled
669
+ - label: Load Balancer
670
+ value: ALB-prod-01
671
+ - id: theme_warm_palette
672
+ type: Descriptions
673
+ properties:
674
+ title: Warm Color Palette
675
+ bordered: true
676
+ theme:
677
+ labelColor: "#ad4e00"
678
+ titleColor: "#ad4e00"
679
+ contentColor: "#613400"
680
+ items:
681
+ - label: Cafe
682
+ value: The Daily Grind
683
+ - label: Location
684
+ value: 42 Roast Avenue
685
+ - label: Hours
686
+ value: 7 AM - 9 PM
687
+ - label: Specialty
688
+ value: Single-origin pour over
689
+ - label: Rating
690
+ value: 4.8 / 5.0
691
+ - label: Price Range
692
+ value: $$
693
+ - id: theme_compact_spacing
694
+ type: Descriptions
695
+ properties:
696
+ title: Compact Spacing
697
+ bordered: true
698
+ size: small
699
+ theme:
700
+ itemPaddingBottom: 4
701
+ itemPaddingEnd: 8
702
+ titleMarginBottom: 8
703
+ items:
704
+ - label: CPU
705
+ value: 24%
706
+ - label: RAM
707
+ value: 8.2 GB
708
+ - label: Disk
709
+ value: 45%
710
+ - label: Network In
711
+ value: 12 Mbps
712
+ - label: Network Out
713
+ value: 8 Mbps
714
+ - label: Processes
715
+ value: 312
716
+ - id: theme_green_palette
717
+ type: Descriptions
718
+ properties:
719
+ title: Success Theme
720
+ bordered: true
721
+ theme:
722
+ labelColor: "#135200"
723
+ titleColor: "#135200"
724
+ contentColor: "#237804"
725
+ items:
726
+ - label: Test Suite
727
+ value: Integration Tests
728
+ - label: Passed
729
+ value: 247 / 247
730
+ - label: Duration
731
+ value: 4m 32s
732
+ - label: Coverage
733
+ value: 94.2%
734
+ - label: Branch
735
+ value: main
736
+ - label: Commit
737
+ value: a3f7b21
738
+ - id: theme_wide_colons
739
+ type: Descriptions
740
+ properties:
741
+ title: Wide Colon Spacing
742
+ theme:
743
+ colonMarginLeft: 4
744
+ colonMarginRight: 16
745
+ items:
746
+ - label: First Name
747
+ value: Taylor
748
+ - label: Last Name
749
+ value: Brooks
750
+ - label: Department
751
+ value: Design
752
+ ```
753
+
754
+ ```yaml
755
+ - id: combined_full_profile
756
+ type: Descriptions
757
+ class: shadow-sm rounded-lg overflow-hidden
758
+ properties:
759
+ title: <b>Employee Profile</b>
760
+ bordered: true
761
+ column: 2
762
+ size: small
763
+ theme:
764
+ labelColor: "#1d39c4"
765
+ items:
766
+ - label: Employee ID
767
+ value: EMP-4521
768
+ - label: Full Name
769
+ value: <b>Priya Patel</b>
770
+ - label: Department
771
+ value: Engineering
772
+ - label: Title
773
+ value: Principal Engineer
774
+ - label: Email
775
+ value: priya.patel@acme.com
776
+ - label: Phone
777
+ value: +1 (555) 867-5309
778
+ - label: Office
779
+ value: Building C, Floor 7
780
+ - label: Manager
781
+ value: David Kim
782
+ - label: Bio
783
+ value: 15+ years of experience in distributed systems and cloud architecture.
784
+ Led the migration of core services to Kubernetes, reducing
785
+ infrastructure costs by 40%.
786
+ span: 2
787
+ - id: combined_invoice
788
+ type: Descriptions
789
+ class: shadow-sm rounded-lg overflow-hidden
790
+ properties:
791
+ title: "Invoice #INV-2026-0847"
792
+ bordered: true
793
+ layout: vertical
794
+ column: 4
795
+ size: small
796
+ items:
797
+ - label: Billed To
798
+ value: Acme Corporation
799
+ - label: Invoice Date
800
+ value: March 1, 2026
801
+ - label: Due Date
802
+ value: March 31, 2026
803
+ - label: Status
804
+ value: '<span style="color: #faad14; font-weight: bold;">Pending</span>'
805
+ - label: Professional Services (160 hrs @ $150/hr)
806
+ value: $24,000.00
807
+ span: 2
808
+ - label: Cloud Infrastructure
809
+ value: $3,200.00
810
+ - label: Support Plan
811
+ value: $1,800.00
812
+ - label: Subtotal
813
+ value: $29,000.00
814
+ - label: Tax (8%)
815
+ value: $2,320.00
816
+ - label: Total Due
817
+ value: '<b style="font-size: 16px;">$31,320.00</b>'
818
+ span: 2
819
+ ```
820
+
821
+ | Property | Type | Default | Description |
822
+ | --- | --- | --- | --- |
823
+ | `bordered` | boolean | `false` | Render items in a table. |
824
+ | `colon` | boolean | `true` | Include a colon in item labels. |
825
+ | `column` | number \| object | `3` | The number of description items in a row. |
826
+ | `column.xs` | integer | - | The number of description items in a row for 'xs' media size. |
827
+ | `column.sm` | integer | - | The number of description items in a row for 'sm' media size. |
828
+ | `column.md` | integer | - | The number of description items in a row for 'md' media size. |
829
+ | `column.lg` | integer | - | The number of description items in a row for 'lg' media size. |
830
+ | `column.xl` | integer | - | The number of description items in a row for 'xl' media size. |
831
+ | `itemOptions` | array | - | |
832
+ | `itemOptions.$.key` | string | - | Item key to which these settings should apply. |
833
+ | `itemOptions.$.span` | number \| object | - | Item span for this key. Can also be a function that receives item and index. |
834
+ | `itemOptions.$.style` | object | - | Item css style for this key. Can also be a function that receives item and index. |
835
+ | `itemOptions.$.transformLabel` | object | - | Function to transform item key or label. Function receives arguments label, item and index. |
836
+ | `itemOptions.$.transformValue` | object | - | Function to transform item value. Function receives arguments value, item and index. |
837
+ | `items` | array \| object | - | List of items to display |
838
+ | `items.$.contentStyle` | object | - | Customize content style. |
839
+ | `items.$.labelStyle` | object | - | Customize label style. |
840
+ | `items.$.label` | string | - | Item label - supports html. |
841
+ | `items.$.value` | string \| number | - | Value of item - supports html. |
842
+ | `items.$.span` | integer | - | Number of columns for this item to span. |
843
+ | `items.$.style` | object | - | Css style object to applied to item. |
844
+ | `layout` | string | `"horizontal"` | Put values next to or below their labels. Enum: `horizontal`, `vertical`. |
845
+ | `size` | string | `"default"` | Size of the block. Enum: `default`, `small`. |
846
+ | `title` | string | - | The title of the description block, placed at the top - supports html. |
847
+ | `theme` | object | - | Antd design token overrides for this block. See [antd design tokens](https://ant.design/components/overview#design-token). See [Ant Design descriptions tokens](https://ant.design/components/descriptions#design-token). |
848
+ | `theme.labelBg` | string | `"rgba(0, 0, 0, 0.02)"` | Background color for labels in bordered mode. |
849
+ | `theme.labelColor` | string | `"rgba(0, 0, 0, 0.45)"` | Text color for labels. |
850
+ | `theme.titleColor` | string | `"rgba(0, 0, 0, 0.88)"` | Color for the component title. |
851
+ | `theme.titleMarginBottom` | number | `20` | Bottom margin spacing for the title. |
852
+ | `theme.itemPaddingBottom` | number | `16` | Bottom padding for description items. |
853
+ | `theme.itemPaddingEnd` | number | `16` | End (right in LTR) padding for description items. |
854
+ | `theme.colonMarginRight` | number | `8` | Right margin for colons after labels. |
855
+ | `theme.colonMarginLeft` | number | `2` | Left margin for colons after labels. |
856
+ | `theme.contentColor` | string | `"rgba(0, 0, 0, 0.88)"` | Text color for content values. |
857
+ | `theme.extraColor` | string | `"rgba(0, 0, 0, 0.88)"` | Color for extra content in the header. |
858
+
859
+ No events defined.
860
+
861
+ | Key | Target |
862
+ | --- | --- |
863
+ | `/block` | Outer block wrapper (always available). |
864
+ | `/element` | The Descriptions element. |
865
+ | `/content` | The Descriptions content. |
866
+ | `/label` | The Descriptions label. |
867
+
868
+ | Slot | Description |
869
+ | --- | --- |
870
+ | `extra` | Extra content in the header. |