lime-elements-vue 2.2.0 → 3.0.0-beta.1

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 (246) hide show
  1. package/dist/index.d.ts +87 -163
  2. package/package.json +61 -467
  3. package/dist/3d-hover-effect-glow/index.d.ts +0 -13
  4. package/dist/3d-hover-effect-glow/index.mjs +0 -5
  5. package/dist/3d-hover-effect-glow/package.json +0 -5
  6. package/dist/action-bar/index.d.ts +0 -13
  7. package/dist/action-bar/index.mjs +0 -15
  8. package/dist/action-bar/package.json +0 -5
  9. package/dist/action-bar-item/index.d.ts +0 -13
  10. package/dist/action-bar-item/index.mjs +0 -12
  11. package/dist/action-bar-item/package.json +0 -5
  12. package/dist/action-bar-overflow-menu/index.d.ts +0 -13
  13. package/dist/action-bar-overflow-menu/index.mjs +0 -11
  14. package/dist/action-bar-overflow-menu/package.json +0 -5
  15. package/dist/ai-avatar/index.d.ts +0 -13
  16. package/dist/ai-avatar/index.mjs +0 -10
  17. package/dist/ai-avatar/package.json +0 -5
  18. package/dist/badge/index.d.ts +0 -13
  19. package/dist/badge/index.mjs +0 -7
  20. package/dist/badge/package.json +0 -5
  21. package/dist/banner/index.d.ts +0 -13
  22. package/dist/banner/index.mjs +0 -8
  23. package/dist/banner/package.json +0 -5
  24. package/dist/breadcrumbs/index.d.ts +0 -13
  25. package/dist/breadcrumbs/index.mjs +0 -11
  26. package/dist/breadcrumbs/package.json +0 -5
  27. package/dist/button/index.d.ts +0 -13
  28. package/dist/button/index.mjs +0 -13
  29. package/dist/button/package.json +0 -5
  30. package/dist/button-group/index.d.ts +0 -13
  31. package/dist/button-group/index.mjs +0 -11
  32. package/dist/button-group/package.json +0 -5
  33. package/dist/callout/index.d.ts +0 -13
  34. package/dist/callout/index.mjs +0 -10
  35. package/dist/callout/package.json +0 -5
  36. package/dist/card/index.d.ts +0 -13
  37. package/dist/card/index.mjs +0 -19
  38. package/dist/card/package.json +0 -5
  39. package/dist/chart/index.d.ts +0 -13
  40. package/dist/chart/index.mjs +0 -22
  41. package/dist/chart/package.json +0 -5
  42. package/dist/checkbox/index.d.ts +0 -13
  43. package/dist/checkbox/index.mjs +0 -18
  44. package/dist/checkbox/package.json +0 -5
  45. package/dist/chip/index.d.ts +0 -13
  46. package/dist/chip/index.mjs +0 -28
  47. package/dist/chip/package.json +0 -5
  48. package/dist/chip-set/index.d.ts +0 -13
  49. package/dist/chip-set/index.mjs +0 -35
  50. package/dist/chip-set/package.json +0 -5
  51. package/dist/circular-progress/index.d.ts +0 -13
  52. package/dist/circular-progress/index.mjs +0 -12
  53. package/dist/circular-progress/package.json +0 -5
  54. package/dist/code-diff/index.d.ts +0 -13
  55. package/dist/code-diff/index.mjs +0 -16
  56. package/dist/code-diff/package.json +0 -5
  57. package/dist/code-editor/index.d.ts +0 -13
  58. package/dist/code-editor/index.mjs +0 -24
  59. package/dist/code-editor/package.json +0 -5
  60. package/dist/collapsible-section/index.d.ts +0 -13
  61. package/dist/collapsible-section/index.mjs +0 -19
  62. package/dist/collapsible-section/package.json +0 -5
  63. package/dist/color-picker/index.d.ts +0 -13
  64. package/dist/color-picker/index.mjs +0 -21
  65. package/dist/color-picker/package.json +0 -5
  66. package/dist/color-picker-palette/index.d.ts +0 -13
  67. package/dist/color-picker-palette/index.mjs +0 -18
  68. package/dist/color-picker-palette/package.json +0 -5
  69. package/dist/config/index.d.ts +0 -13
  70. package/dist/config/index.mjs +0 -7
  71. package/dist/config/package.json +0 -5
  72. package/dist/date-picker/index.d.ts +0 -13
  73. package/dist/date-picker/index.mjs +0 -21
  74. package/dist/date-picker/package.json +0 -5
  75. package/dist/dialog/index.d.ts +0 -13
  76. package/dist/dialog/index.mjs +0 -15
  77. package/dist/dialog/package.json +0 -5
  78. package/dist/dock/index.d.ts +0 -13
  79. package/dist/dock/index.mjs +0 -21
  80. package/dist/dock/package.json +0 -5
  81. package/dist/dock-button/index.d.ts +0 -13
  82. package/dist/dock-button/index.mjs +0 -16
  83. package/dist/dock-button/package.json +0 -5
  84. package/dist/drag-handle/index.d.ts +0 -13
  85. package/dist/drag-handle/index.mjs +0 -9
  86. package/dist/drag-handle/package.json +0 -5
  87. package/dist/dynamic-label/index.d.ts +0 -13
  88. package/dist/dynamic-label/index.mjs +0 -9
  89. package/dist/dynamic-label/package.json +0 -5
  90. package/dist/email-viewer/index.d.ts +0 -13
  91. package/dist/email-viewer/index.mjs +0 -13
  92. package/dist/email-viewer/package.json +0 -5
  93. package/dist/file/index.d.ts +0 -13
  94. package/dist/file/index.mjs +0 -22
  95. package/dist/file/package.json +0 -5
  96. package/dist/file-dropzone/index.d.ts +0 -13
  97. package/dist/file-dropzone/index.mjs +0 -15
  98. package/dist/file-dropzone/package.json +0 -5
  99. package/dist/file-input/index.d.ts +0 -13
  100. package/dist/file-input/index.mjs +0 -12
  101. package/dist/file-input/package.json +0 -5
  102. package/dist/file-viewer/index.d.ts +0 -13
  103. package/dist/file-viewer/index.mjs +0 -18
  104. package/dist/file-viewer/package.json +0 -5
  105. package/dist/flatpickr-adapter/index.d.ts +0 -13
  106. package/dist/flatpickr-adapter/index.mjs +0 -16
  107. package/dist/flatpickr-adapter/package.json +0 -5
  108. package/dist/flex-container/index.d.ts +0 -13
  109. package/dist/flex-container/index.mjs +0 -10
  110. package/dist/flex-container/package.json +0 -5
  111. package/dist/form/index.d.ts +0 -13
  112. package/dist/form/index.mjs +0 -18
  113. package/dist/form/package.json +0 -5
  114. package/dist/grid/index.d.ts +0 -13
  115. package/dist/grid/index.mjs +0 -5
  116. package/dist/grid/package.json +0 -5
  117. package/dist/header/index.d.ts +0 -13
  118. package/dist/header/index.mjs +0 -11
  119. package/dist/header/package.json +0 -5
  120. package/dist/help/index.d.ts +0 -13
  121. package/dist/help/index.mjs +0 -10
  122. package/dist/help/package.json +0 -5
  123. package/dist/help-content/index.d.ts +0 -13
  124. package/dist/help-content/index.mjs +0 -8
  125. package/dist/help-content/package.json +0 -5
  126. package/dist/helper-line/index.d.ts +0 -13
  127. package/dist/helper-line/index.mjs +0 -11
  128. package/dist/helper-line/package.json +0 -5
  129. package/dist/hotkey/index.d.ts +0 -13
  130. package/dist/hotkey/index.mjs +0 -8
  131. package/dist/hotkey/package.json +0 -5
  132. package/dist/icon/index.d.ts +0 -13
  133. package/dist/icon/index.mjs +0 -10
  134. package/dist/icon/package.json +0 -5
  135. package/dist/icon-button/index.d.ts +0 -13
  136. package/dist/icon-button/index.mjs +0 -11
  137. package/dist/icon-button/package.json +0 -5
  138. package/dist/info-tile/index.d.ts +0 -13
  139. package/dist/info-tile/index.mjs +0 -17
  140. package/dist/info-tile/package.json +0 -5
  141. package/dist/input-field/index.d.ts +0 -13
  142. package/dist/input-field/index.mjs +0 -34
  143. package/dist/input-field/package.json +0 -5
  144. package/dist/linear-progress/index.d.ts +0 -13
  145. package/dist/linear-progress/index.mjs +0 -10
  146. package/dist/linear-progress/package.json +0 -5
  147. package/dist/list/index.d.ts +0 -13
  148. package/dist/list/index.mjs +0 -18
  149. package/dist/list/package.json +0 -5
  150. package/dist/list-item/index.d.ts +0 -13
  151. package/dist/list-item/index.mjs +0 -19
  152. package/dist/list-item/package.json +0 -5
  153. package/dist/markdown/index.d.ts +0 -13
  154. package/dist/markdown/index.mjs +0 -11
  155. package/dist/markdown/package.json +0 -5
  156. package/dist/masonry-layout/index.d.ts +0 -13
  157. package/dist/masonry-layout/index.mjs +0 -7
  158. package/dist/masonry-layout/package.json +0 -5
  159. package/dist/menu/index.d.ts +0 -13
  160. package/dist/menu/index.mjs +0 -27
  161. package/dist/menu/package.json +0 -5
  162. package/dist/menu-item-meta/index.d.ts +0 -13
  163. package/dist/menu-item-meta/index.mjs +0 -11
  164. package/dist/menu-item-meta/package.json +0 -5
  165. package/dist/menu-list/index.d.ts +0 -13
  166. package/dist/menu-list/index.mjs +0 -14
  167. package/dist/menu-list/package.json +0 -5
  168. package/dist/menu-surface/index.d.ts +0 -13
  169. package/dist/menu-surface/index.mjs +0 -11
  170. package/dist/menu-surface/package.json +0 -5
  171. package/dist/notched-outline/index.d.ts +0 -13
  172. package/dist/notched-outline/index.mjs +0 -15
  173. package/dist/notched-outline/package.json +0 -5
  174. package/dist/picker/index.d.ts +0 -13
  175. package/dist/picker/index.mjs +0 -32
  176. package/dist/picker/package.json +0 -5
  177. package/dist/popover/index.d.ts +0 -13
  178. package/dist/popover/index.mjs +0 -11
  179. package/dist/popover/package.json +0 -5
  180. package/dist/popover-surface/index.d.ts +0 -13
  181. package/dist/popover-surface/index.mjs +0 -7
  182. package/dist/popover-surface/package.json +0 -5
  183. package/dist/portal/index.d.ts +0 -13
  184. package/dist/portal/index.mjs +0 -13
  185. package/dist/portal/package.json +0 -5
  186. package/dist/profile-picture/index.d.ts +0 -13
  187. package/dist/profile-picture/index.mjs +0 -24
  188. package/dist/profile-picture/package.json +0 -5
  189. package/dist/progress-flow/index.d.ts +0 -13
  190. package/dist/progress-flow/index.mjs +0 -12
  191. package/dist/progress-flow/package.json +0 -5
  192. package/dist/progress-flow-item/index.d.ts +0 -13
  193. package/dist/progress-flow-item/index.mjs +0 -13
  194. package/dist/progress-flow-item/package.json +0 -5
  195. package/dist/prosemirror-adapter/index.d.ts +0 -13
  196. package/dist/prosemirror-adapter/index.mjs +0 -23
  197. package/dist/prosemirror-adapter/package.json +0 -5
  198. package/dist/radio-button/index.d.ts +0 -13
  199. package/dist/radio-button/index.mjs +0 -11
  200. package/dist/radio-button/package.json +0 -5
  201. package/dist/radio-button-group/index.d.ts +0 -13
  202. package/dist/radio-button-group/index.mjs +0 -14
  203. package/dist/radio-button-group/package.json +0 -5
  204. package/dist/select/index.d.ts +0 -13
  205. package/dist/select/index.mjs +0 -18
  206. package/dist/select/package.json +0 -5
  207. package/dist/shortcut/index.d.ts +0 -13
  208. package/dist/shortcut/index.mjs +0 -11
  209. package/dist/shortcut/package.json +0 -5
  210. package/dist/slider/index.d.ts +0 -13
  211. package/dist/slider/index.mjs +0 -22
  212. package/dist/slider/package.json +0 -5
  213. package/dist/snackbar/index.d.ts +0 -13
  214. package/dist/snackbar/index.mjs +0 -18
  215. package/dist/snackbar/package.json +0 -5
  216. package/dist/spinner/index.d.ts +0 -13
  217. package/dist/spinner/index.mjs +0 -8
  218. package/dist/spinner/package.json +0 -5
  219. package/dist/split-button/index.d.ts +0 -13
  220. package/dist/split-button/index.mjs +0 -16
  221. package/dist/split-button/package.json +0 -5
  222. package/dist/switch/index.d.ts +0 -13
  223. package/dist/switch/index.mjs +0 -16
  224. package/dist/switch/package.json +0 -5
  225. package/dist/tab-bar/index.d.ts +0 -13
  226. package/dist/tab-bar/index.mjs +0 -10
  227. package/dist/tab-bar/package.json +0 -5
  228. package/dist/tab-panel/index.d.ts +0 -13
  229. package/dist/tab-panel/index.mjs +0 -10
  230. package/dist/tab-panel/package.json +0 -5
  231. package/dist/table/index.d.ts +0 -13
  232. package/dist/table/index.mjs +0 -42
  233. package/dist/table/package.json +0 -5
  234. package/dist/text-editor/index.d.ts +0 -13
  235. package/dist/text-editor/index.mjs +0 -36
  236. package/dist/text-editor/package.json +0 -5
  237. package/dist/text-editor-link-menu/index.d.ts +0 -13
  238. package/dist/text-editor-link-menu/index.mjs +0 -16
  239. package/dist/text-editor-link-menu/package.json +0 -5
  240. package/dist/tooltip/index.d.ts +0 -13
  241. package/dist/tooltip/index.mjs +0 -12
  242. package/dist/tooltip/package.json +0 -5
  243. package/dist/tooltip-content/index.d.ts +0 -13
  244. package/dist/tooltip-content/index.mjs +0 -10
  245. package/dist/tooltip-content/package.json +0 -5
  246. package/dist/web-types.json +0 -3999
@@ -1,3999 +0,0 @@
1
- {
2
- "$schema": "https://raw.githubusercontent.com/JetBrains/web-types/master/schema/web-types.json",
3
- "framework": "vue",
4
- "name": "lime-elements-vue",
5
- "version": "2.2.0",
6
- "js-types-syntax": "typescript",
7
- "description-markup": "markdown",
8
- "contributions": {
9
- "html": {
10
- "vue-components": [
11
- {
12
- "name": "Limel3dHoverEffectGlow",
13
- "source": {
14
- "module": "lime-elements-vue",
15
- "symbol": "Limel3dHoverEffectGlow"
16
- },
17
- "description": "This component enhances the visual effects, when the `tiltFollowingTheCursor`\r\nutility function from `3d-tilt-hover-effect.ts` is implemented in a component.\r\n\r\nThis component should be added to the HTML structure of the consumer component.\r\n\r\nThis component carries its own styles which are needed to create a glow effect on the\r\n3D element within the parent element, when the parent is hovered.\r\n\r\nThe parent element must be using the `tiltFollowingTheCursor` utility function\r\nimported from `3d-tilt-hover-effect.ts`. This function will dynamically\r\naffect parts of the styles of this 3D glow effect.",
18
- "props": []
19
- },
20
- {
21
- "name": "LimelActionBar",
22
- "source": {
23
- "module": "lime-elements-vue",
24
- "symbol": "LimelActionBar"
25
- },
26
- "description": "An action bar is a user interface element commonly found in software applications and websites.\r\nIt typically appears at the top of the screen or within a specific section\r\nand serves as a centralized hub for accessing various actions and commands\r\nrelevant to the current context or page.\r\n\r\nThe action bar often contains a set of clickable icons or buttons (icons + labels)\r\nthat represent specific actions, such as saving, deleting, editing, sharing,\r\nor bulk operations for selected items.\r\n\r\nThe purpose of an action bar is to provide quick and convenient access to\r\nfrequently used functionalities, enabling users to perform common tasks efficiently.\r\nIt enhances usability by organizing important actions in a visually prominent and easily accessible location.\r\n\r\nThe action bar's design and layout can vary based on the platform or application,\r\nbut its primary goal remains consistent—to\r\nempower users to interact with the software and perform desired actions effortlessly.",
27
- "props": [
28
- {
29
- "name": "accessibleLabel",
30
- "description": "A label used to describe the purpose of the element to users\r\nof assistive technologies, like screen readers.\r\nIf not set, a localized default (\"Action bar\" in English, translated\r\nvia the `language` prop) is used, so the element is never announced\r\nwithout a name. Override this when a more specific label would help\r\nusers tell multiple action bars apart — for example \"Bulk actions\"\r\nor \"Contextual actions\".",
31
- "type": "any",
32
- "default": "",
33
- "required": false
34
- },
35
- {
36
- "name": "language",
37
- "description": "Defines the language for translations.",
38
- "type": "any",
39
- "default": "'en'",
40
- "required": false
41
- },
42
- {
43
- "name": "layout",
44
- "description": "- When set to `fullWidth`, the component will take the\r\nentire width of its container.\r\n- When set to `floating`, the component will get basic stylings\r\nto visualize the floating state.\r\n:::note\r\nYou should still properly position the component\r\naccording to the structure of your user interface.\r\nFor example, use an `absolute` or `fixed` position.\r\n:::",
45
- "type": "any",
46
- "default": "",
47
- "required": false
48
- },
49
- {
50
- "name": "collapsible",
51
- "description": "",
52
- "type": "any",
53
- "default": "false",
54
- "required": false
55
- },
56
- {
57
- "name": "openDirection",
58
- "description": "Defines the location that the content of the overflow menu\r\nappears, in relation to its trigger.",
59
- "type": "any",
60
- "default": "",
61
- "required": false
62
- }
63
- ]
64
- },
65
- {
66
- "name": "LimelActionBarItem",
67
- "source": {
68
- "module": "lime-elements-vue",
69
- "symbol": "LimelActionBarItem"
70
- },
71
- "description": "",
72
- "props": [
73
- {
74
- "name": "isVisible",
75
- "description": "When the item is displayed in the available width,\r\nthis will be `false`.",
76
- "type": "any",
77
- "default": "true",
78
- "required": false
79
- },
80
- {
81
- "name": "selected",
82
- "description": "When the item is selected, this will be `true`.",
83
- "type": "any",
84
- "default": "false",
85
- "required": false
86
- }
87
- ]
88
- },
89
- {
90
- "name": "LimelActionBarOverflowMenu",
91
- "source": {
92
- "module": "lime-elements-vue",
93
- "symbol": "LimelActionBarOverflowMenu"
94
- },
95
- "description": "",
96
- "props": [
97
- {
98
- "name": "openDirection",
99
- "description": "Defines the location that the content of the overflow menu\r\nappears, in relation to its trigger.\r\nIt defaults to `bottom-end`, since in normal scenarios\r\n(for example when the action bar is not floating at the bottom of the screen)\r\nthis menu is the right-most item in the user interface of the component.",
100
- "type": "any",
101
- "default": "'bottom-end'",
102
- "required": false
103
- }
104
- ]
105
- },
106
- {
107
- "name": "LimelAiAvatar",
108
- "source": {
109
- "module": "lime-elements-vue",
110
- "symbol": "LimelAiAvatar"
111
- },
112
- "description": "This component displays an avatar, representing Lime AI assistants.\r\n\r\n:::warning\r\nThis is a private component used internally in Lime's various applications,\r\nwhich is the reason for having it in Lime Elements —to ease the distribution\r\nof the component across all our apps.\r\n\r\n3rd party developers are not allowed use this component directly.\r\n:::",
113
- "props": [
114
- {
115
- "name": "isThinking",
116
- "description": "",
117
- "type": "any",
118
- "default": "false",
119
- "required": false
120
- },
121
- {
122
- "name": "mode",
123
- "description": "Represents the current activity of the AI agent. The avatar uses this\r\nto drive its visual state and animations. Defaults to `idle`.",
124
- "type": "any",
125
- "default": "'idle'",
126
- "required": false
127
- },
128
- {
129
- "name": "variant",
130
- "description": "Selects the avatar's visual style. The `detailed` variant is the fully\r\ndetailed orb; the `minimal` variant is a simplified design with a\r\nsingle gradient orb, a stroked outline, and a soft halo. Eye and\r\nmouth shapes (and all animations driving them) are shared across\r\nvariants.",
131
- "type": "any",
132
- "default": "'minimal'",
133
- "required": false
134
- },
135
- {
136
- "name": "language",
137
- "description": "Defines the language for translations.",
138
- "type": "any",
139
- "default": "document.documentElement.lang as Languages",
140
- "required": false
141
- }
142
- ]
143
- },
144
- {
145
- "name": "LimelBadge",
146
- "source": {
147
- "module": "lime-elements-vue",
148
- "symbol": "LimelBadge"
149
- },
150
- "description": "The Badge component can be used to display a notification badge,\r\noptionally with a number or a text label.",
151
- "props": [
152
- {
153
- "name": "label",
154
- "description": "Label to display in the badge.\r\nNumeric labels larger than 999 will be rounded and abbreviated.\r\nString labels get truncated if their length is longer than\r\nsix characters.",
155
- "type": "any",
156
- "default": "",
157
- "required": false
158
- }
159
- ]
160
- },
161
- {
162
- "name": "LimelBanner",
163
- "source": {
164
- "module": "lime-elements-vue",
165
- "symbol": "LimelBanner"
166
- },
167
- "description": "",
168
- "props": [
169
- {
170
- "name": "message",
171
- "description": "The text to show on the banner.",
172
- "type": "any",
173
- "default": "",
174
- "required": false
175
- },
176
- {
177
- "name": "icon",
178
- "description": "Set icon for the banner",
179
- "type": "any",
180
- "default": "",
181
- "required": false
182
- }
183
- ],
184
- "slots": [
185
- {
186
- "name": "buttons",
187
- "description": "Buttons to show in the banner"
188
- }
189
- ]
190
- },
191
- {
192
- "name": "LimelBreadcrumbs",
193
- "source": {
194
- "module": "lime-elements-vue",
195
- "symbol": "LimelBreadcrumbs"
196
- },
197
- "description": "A Breadcrumb consists of a list of distinct \"places\" that a user has gone through,\r\nbefore ending up where they are right now, in a website or an application.\r\n\r\nThese \"places\" can be for example _pages_ of a website, which are hierarchically\r\nlaid out before the current page that the user is looking at.\r\nThey could also be _steps_ which the user has gone through, which perhaps have no\r\nhierarchical relation with each other, but has eventually led the user \"here\".\r\n\r\n:::note\r\n- Where the user currently is, is always the last step of the breadcrumb.\r\n- A breadcrumbs never shows where users can go after this place.\r\nIt only illustrates where user has been before ending up here.\r\nIf the path that a user can take is not changing and if next steps are clear,\r\nyou can use the [Progress flow component](#/component/limel-progress-flow) instead.\r\n:::\r\n\r\nBreadcrumbs are often placed horizontally before the main content of the current screen.",
198
- "props": [
199
- {
200
- "name": "divider",
201
- "description": "The visual divider that separates items.\r\nIt must be a single character such as `-` or `,`.",
202
- "type": "any",
203
- "default": "'›'",
204
- "required": false
205
- }
206
- ]
207
- },
208
- {
209
- "name": "LimelButton",
210
- "source": {
211
- "module": "lime-elements-vue",
212
- "symbol": "LimelButton"
213
- },
214
- "description": "Buttons allow users to take actions with a single tap or click.\r\nThey are intentionally designed to look and feel clickable,\r\nand should clearly communicate the action that will happen\r\nwhen the user interacts with them.\r\n\r\nThe component offers three visual variants — **default**, **primary**,\r\nand **outlined** — that together establish a hierarchy of actions.\r\nSee the examples below for guidance on when to use each variant.\r\n\r\nFor more guidance on how to arrange buttons and choose between\r\nprimary and secondary actions, see our\r\n[Action buttons design guidelines](#/DesignGuidelines/action-buttons.md/).",
215
- "props": [
216
- {
217
- "name": "label",
218
- "description": "The text to show on the button.",
219
- "type": "any",
220
- "default": "",
221
- "required": false
222
- },
223
- {
224
- "name": "primary",
225
- "description": "Set to `true` to make the button primary.",
226
- "type": "any",
227
- "default": "false",
228
- "required": false
229
- },
230
- {
231
- "name": "outlined",
232
- "description": "Set to `true` to make the button outlined.",
233
- "type": "any",
234
- "default": "false",
235
- "required": false
236
- },
237
- {
238
- "name": "icon",
239
- "description": "Set icon for the button",
240
- "type": "any",
241
- "default": "",
242
- "required": false
243
- },
244
- {
245
- "name": "disabled",
246
- "description": "Set to `true` to disable the button.",
247
- "type": "any",
248
- "default": "false",
249
- "required": false
250
- },
251
- {
252
- "name": "loading",
253
- "description": "Set to `true` to put the button in the `loading` state.\r\nThis also disables the button.",
254
- "type": "any",
255
- "default": "false",
256
- "required": false
257
- },
258
- {
259
- "name": "loadingFailed",
260
- "description": "Set to `true` to indicate failure instead of success when the button is\r\nno longer in the `loading` state.",
261
- "type": "any",
262
- "default": "false",
263
- "required": false
264
- }
265
- ]
266
- },
267
- {
268
- "name": "LimelButtonGroup",
269
- "source": {
270
- "module": "lime-elements-vue",
271
- "symbol": "LimelButtonGroup"
272
- },
273
- "description": "A button group control is a linear set of two or more buttons.\r\n\r\n## Usage\r\n\r\nButton groups are often used to display different views of the same thing. A\r\ncommon example of this component is when you switch between [ Map | Transit\r\n| Satellite ] views to look at an area on the map.\r\n\r\nIn some cases, button groups may serve as quick filters as well. For example\r\na list of contacts, in which the user can switch to [ All | Favorites\r\n| Frequently contacted ] can incorporate a button group to quickly filter out\r\nitems and display subsets of them.\r\n\r\n## Layout\r\n\r\nThe button groups are usually placed in top headers and action bars,\r\nsometimes with other elements. Since the group items will always be rendered\r\nin a row, you must make sure not to have too many buttons in the group.\r\nBecause if the container of your button group does not get enough space to\r\nfit in all its buttons, they will have to truncate their text and may appear\r\nvery cramped together. Always think about how your button group will appear\r\non a small screen such as phones.\r\n:::note\r\nButton can contain text or icons, but not both simultaneously!\r\n:::\r\n\r\nWithin the group, icon buttons will all have the same width, while each text button\r\ninherits its width from its content.",
274
- "props": [
275
- {
276
- "name": "disabled",
277
- "description": "True if the button-group should be disabled",
278
- "type": "any",
279
- "default": "false",
280
- "required": false
281
- }
282
- ]
283
- },
284
- {
285
- "name": "LimelCallout",
286
- "source": {
287
- "module": "lime-elements-vue",
288
- "symbol": "LimelCallout"
289
- },
290
- "description": "Callouts—also known as Admonitions—are useful for including supportive or\r\nspecial content within a large piece of text, or even inside a user\r\ninterface.\r\n\r\nWhen used in a document or text based user interface, the callout attracts\r\nthe reader's attention to a particular piece of information, without\r\nsignificantly interrupting their flow of reading the document.\r\n\r\nIn a user interface, a callout is more intrusive to the end-user. Still, it\r\ncould be a good choice when you intend to slightly disturb the user's\r\nattention, and challenge them to pay extra attention to the information\r\npresented. In such cases, a callout should not be used as a static and\r\nconstantly present element of the UI. Rather, it should be displayed when\r\nsomething unusual or remarkable demands the user's attention.",
291
- "props": [
292
- {
293
- "name": "heading",
294
- "description": "Heading of the callout, which can be used to override the\r\ndefault heading which is displayed based on the chosen `type`.",
295
- "type": "any",
296
- "default": "",
297
- "required": false
298
- },
299
- {
300
- "name": "icon",
301
- "description": "Icon of the callout, which can be used to override the\r\ndefault icon which is displayed based on the chosen `type`.",
302
- "type": "any",
303
- "default": "",
304
- "required": false
305
- },
306
- {
307
- "name": "type",
308
- "description": "Defines how the component is visualized, for example\r\nwhich heading, color or icon is used in its user interface.",
309
- "type": "any",
310
- "default": "'note'",
311
- "required": false
312
- },
313
- {
314
- "name": "language",
315
- "description": "Defines the language for translations.\r\nWill translate the default headings for supported languages.",
316
- "type": "any",
317
- "default": "'en'",
318
- "required": false
319
- }
320
- ]
321
- },
322
- {
323
- "name": "LimelCard",
324
- "source": {
325
- "module": "lime-elements-vue",
326
- "symbol": "LimelCard"
327
- },
328
- "description": "Card is a component that displays content about a single topic,\r\nin a structured way. It can contain a header, and some supporting media such\r\nas an image or an icon, a body of text, or optional actions.",
329
- "props": [
330
- {
331
- "name": "heading",
332
- "description": "Heading of the card,\r\nto provide a short title about the context.",
333
- "type": "any",
334
- "default": "",
335
- "required": false
336
- },
337
- {
338
- "name": "subheading",
339
- "description": "Subheading of the card\r\nto provide a short description of the context.",
340
- "type": "any",
341
- "default": "",
342
- "required": false
343
- },
344
- {
345
- "name": "icon",
346
- "description": "An icon, to display along with the heading and subheading.",
347
- "type": "any",
348
- "default": "",
349
- "required": false
350
- },
351
- {
352
- "name": "value",
353
- "description": "The content of the card.\r\nSupports markdown, to provide a rich text experience.",
354
- "type": "any",
355
- "default": "",
356
- "required": false
357
- },
358
- {
359
- "name": "clickable",
360
- "description": "When true, improve the accessibility of the component and hints the user\r\nthat the card can be interacted width.",
361
- "type": "any",
362
- "default": "false",
363
- "required": false
364
- },
365
- {
366
- "name": "orientation",
367
- "description": "The orientation of the card,\r\nspecially useful when the card has an image.",
368
- "type": "any",
369
- "default": "'portrait'",
370
- "required": false
371
- },
372
- {
373
- "name": "selected",
374
- "description": "When `true`, the card displays a visual selected state (highlighted border shadow).\r\nShould be used together with `clickable` to let users toggle selection.",
375
- "type": "any",
376
- "default": "false",
377
- "required": false
378
- },
379
- {
380
- "name": "show-3dEffect",
381
- "description": "When `true`, the card displays a glow effect on hover,\r\nfollowing the 3D tilt hover effect.",
382
- "type": "any",
383
- "default": "true",
384
- "required": false
385
- }
386
- ]
387
- },
388
- {
389
- "name": "LimelChart",
390
- "source": {
391
- "module": "lime-elements-vue",
392
- "symbol": "LimelChart"
393
- },
394
- "description": "A chart is a graphical representation of data, in which\r\nvisual symbols such as such bars, dots, lines, or slices, represent\r\neach data point, in comparison to others.",
395
- "props": [
396
- {
397
- "name": "language",
398
- "description": "Defines the language for translations.\r\nWill translate the translatable strings on the components.",
399
- "type": "any",
400
- "default": "'en'",
401
- "required": false
402
- },
403
- {
404
- "name": "accessibleLabel",
405
- "description": "Helps users of assistive technologies to understand\r\nthe context of the chart, and what is being displayed.",
406
- "type": "any",
407
- "default": "",
408
- "required": false
409
- },
410
- {
411
- "name": "accessibleItemsLabel",
412
- "description": "Helps users of assistive technologies to understand\r\nwhat the items in the chart represent.\r\nDefaults to the translation for \"items\" in the current language.",
413
- "type": "any",
414
- "default": "",
415
- "required": false
416
- },
417
- {
418
- "name": "accessibleValuesLabel",
419
- "description": "Helps users of assistive technologies to understand\r\nwhat the values in the chart represent.\r\nDefaults to the translation for \"value\" in the current language.",
420
- "type": "any",
421
- "default": "",
422
- "required": false
423
- },
424
- {
425
- "name": "displayAxisLabels",
426
- "description": "When set to true, renders visible labels for X and Y axes.\r\nOnly affects chart types with X and Y axes, such as area, bar, and line charts.",
427
- "type": "any",
428
- "default": "false",
429
- "required": false
430
- },
431
- {
432
- "name": "displayItemText",
433
- "description": "Makes the `text` of chart items constantly visible,\r\nBy default, item texts are displayed in a tooltip,\r\nwhen the item is hovered or focused.\r\nOnly affects chart types with X and Y axes, such as area, bar, and line charts.",
434
- "type": "any",
435
- "default": "false",
436
- "required": false
437
- },
438
- {
439
- "name": "displayItemValue",
440
- "description": "Makes the `value` (or `formattedValue`) of chart items constantly visible,\r\nBy default, item values are displayed in a tooltip,\r\nwhen the item is hovered or focused.\r\nOnly affects chart types with X and Y axes, such as area, bar, and line charts.",
441
- "type": "any",
442
- "default": "false",
443
- "required": false
444
- },
445
- {
446
- "name": "type",
447
- "description": "Defines how items are visualized in the chart.",
448
- "type": "any",
449
- "default": "'stacked-bar'",
450
- "required": false
451
- },
452
- {
453
- "name": "orientation",
454
- "description": "Defines whether the chart is intended to be displayed wide or tall.\r\nDoes not have any effect on chart types which generate circular forms.",
455
- "type": "any",
456
- "default": "'landscape'",
457
- "required": false
458
- },
459
- {
460
- "name": "maxValue",
461
- "description": "Specifies the range that items' values could be in.\r\nThis is used in calculation of the size of the items in the chart.\r\nWhen not provided, the sum of all values in the items will be considered as the range.",
462
- "type": "any",
463
- "default": "",
464
- "required": false
465
- },
466
- {
467
- "name": "axisIncrement",
468
- "description": "Specifies the increment for the axis lines.",
469
- "type": "any",
470
- "default": "",
471
- "required": false
472
- },
473
- {
474
- "name": "loading",
475
- "description": "Indicates whether the chart is in a loading state.",
476
- "type": "any",
477
- "default": "false",
478
- "required": false
479
- }
480
- ]
481
- },
482
- {
483
- "name": "LimelCheckbox",
484
- "source": {
485
- "module": "lime-elements-vue",
486
- "symbol": "LimelCheckbox"
487
- },
488
- "description": "The Checkbox component is a classic and essential element in UI design that allows\r\nusers to make multiple selections from a predefined list of options. The Checkbox component is commonly used in forms and settings interfaces to enable users to\r\nselect one or more items from a list of choices.\r\n\r\n## States of a Checkbox\r\nWhen a user clicks or taps on the box, it toggles between two states:\r\nChecked and Unchecked.\r\n\r\nHowever, a Checkbox can visualize a third state called the \"Indeterminate\" state.\r\nIn this state, the checkbox appears as a filled box with a horizontal line or dash inside it.\r\n\r\nThe Indeterminate state is typically used when dealing with checkbox groups\r\nthat have hierarchical relationships or when the group contains sub-items.\r\nThis state is used to indicate that that some, but not all, of the items in a group are selected.\r\n\r\n:::important\r\nCheckboxes are sometimes used interchangeably with switches in user interfaces.\r\nBut there is an important difference between the two! Please read our guidelines about\r\n[Switch vs. Checkbox](#/DesignGuidelines/switch-vs-checkbox.md/).",
489
- "props": [
490
- {
491
- "name": "disabled",
492
- "description": "Disables the checkbox when `true`. Works exactly the same as `readonly`.\r\nIf either property is `true`, the checkbox will be disabled.",
493
- "type": "any",
494
- "default": "false",
495
- "required": false
496
- },
497
- {
498
- "name": "readonly",
499
- "description": "Disables the checkbox when `true`. This visualizes the checkbox slightly differently.\r\nBut shows no visual sign indicating that the checkbox is disabled\r\nor can ever become interactable.",
500
- "type": "any",
501
- "default": "false",
502
- "required": false
503
- },
504
- {
505
- "name": "invalid",
506
- "description": "Set to `true` to indicate that the current value is invalid.",
507
- "type": "any",
508
- "default": "",
509
- "required": false
510
- },
511
- {
512
- "name": "label",
513
- "description": "The checkbox label.",
514
- "type": "any",
515
- "default": "",
516
- "required": false
517
- },
518
- {
519
- "name": "helperText",
520
- "description": "Optional helper text to display below the checkbox",
521
- "type": "any",
522
- "default": "",
523
- "required": false
524
- },
525
- {
526
- "name": "checked",
527
- "description": "The value of the checkbox. Set to `true` to make the checkbox checked.",
528
- "type": "any",
529
- "default": "false",
530
- "required": false
531
- },
532
- {
533
- "name": "indeterminate",
534
- "description": "Enables indeterminate state. Set to `true` to signal indeterminate check.",
535
- "type": "any",
536
- "default": "false",
537
- "required": false
538
- },
539
- {
540
- "name": "required",
541
- "description": "Set to `true` to indicate that the checkbox must be checked.",
542
- "type": "any",
543
- "default": "false",
544
- "required": false
545
- }
546
- ]
547
- },
548
- {
549
- "name": "LimelChip",
550
- "source": {
551
- "module": "lime-elements-vue",
552
- "symbol": "LimelChip"
553
- },
554
- "description": "Chips and buttons are both interactive elements in UI design,\r\nbut they serve different purposes and are used in different contexts.\r\n\r\n:::warning\r\nDo not use the chip component carelessly, as an alternative for\r\n[`limel-button`](#/component/limel-button/) in the UI design!\r\n\r\n**Buttons:**\r\nButtons are used to trigger actions. They are typically used to\r\nsubmit forms, open dialogs, initiate a process, or perform any action\r\nthat changes the state of the application.\r\nButtons' labels usually contain action words, in other words, the labels is\r\na _verb in imperative mood_ such as \"Submit\" or \"Delete\".\r\nButtons are placed in areas where it's clear they will initiate\r\nan action when clicked.\r\n\r\n**Chips:**\r\nChips however are elements which may look like buttons, but they are\r\nrepresenting choices, filters, or tags, in a small block\r\nor clearly bundled into a group. Chips are rarely used alone in the\r\nuser interface.\r\nThey are often used in a so called \"chip-set\", or placed together in\r\na section of the UI, where the user can expect more than one chip to be present.\r\n\r\nFor example, a chip may represent a filter in a filter bar, or a tag in a tag list,\r\nor an item in a shopping list.\r\nClicking a chip can also trigger an action, for example toggling a filter ON or OFF,\r\nor opening a page with all posts tagged with the tag represented by the chip,\r\nor navigating to a page with more information about the item in the shopping list.\r\n:::",
555
- "props": [
556
- {
557
- "name": "language",
558
- "description": "Defines the language for translations.\r\nWill translate the translatable strings on the components.",
559
- "type": "any",
560
- "default": "'en'",
561
- "required": false
562
- },
563
- {
564
- "name": "text",
565
- "description": "Label displayed on the chip",
566
- "type": "any",
567
- "default": "",
568
- "required": false
569
- },
570
- {
571
- "name": "icon",
572
- "description": "Icon of the chip.",
573
- "type": "any",
574
- "default": "",
575
- "required": false
576
- },
577
- {
578
- "name": "badge",
579
- "description": "The value of the badge, displayed on the chip.",
580
- "type": "any",
581
- "default": "",
582
- "required": false
583
- },
584
- {
585
- "name": "disabled",
586
- "description": "Set to `true` to disable the chip.",
587
- "type": "any",
588
- "default": "false",
589
- "required": false
590
- },
591
- {
592
- "name": "readonly",
593
- "description": "Set to `true` to render the chip as a static UI element.\r\nUseful when the parent component has a `readonly` state.",
594
- "type": "any",
595
- "default": "false",
596
- "required": false
597
- },
598
- {
599
- "name": "selected",
600
- "description": "Set to `true` to visualize the chip in a \"selected\" state.\r\nThis is typically used when the chip is used in a chip-set\r\nalong with other chips.",
601
- "type": "any",
602
- "default": "false",
603
- "required": false
604
- },
605
- {
606
- "name": "invalid",
607
- "description": "Set to `true` to visualize the chip in an \"invalid\" or \"error\" state.",
608
- "type": "any",
609
- "default": "false",
610
- "required": false
611
- },
612
- {
613
- "name": "removable",
614
- "description": "Set to `true` to render a remove button on the chip.",
615
- "type": "any",
616
- "default": "false",
617
- "required": false
618
- },
619
- {
620
- "name": "type",
621
- "description": "Set to `filter` to render the chip with a distinct style\r\nsuitable for visualizing filters.",
622
- "type": "any",
623
- "default": "'default'",
624
- "required": false
625
- },
626
- {
627
- "name": "loading",
628
- "description": "Set to `true` to put the component in the `loading` state,\r\nand render an indeterminate progress indicator inside the chip.\r\nThis does _not_ disable the interactivity of the chip!",
629
- "type": "any",
630
- "default": "false",
631
- "required": false
632
- },
633
- {
634
- "name": "progress",
635
- "description": "Reflects the current value of a progress bar on the chip,\r\nvisualizing the percentage of an ongoing process.\r\nMust be a number between `0` and `100`.",
636
- "type": "any",
637
- "default": "",
638
- "required": false
639
- },
640
- {
641
- "name": "identifier",
642
- "description": "Identifier for the chip. Must be unique.",
643
- "type": "any",
644
- "default": "crypto.randomUUID()",
645
- "required": false
646
- },
647
- {
648
- "name": "size",
649
- "description": "Defines the size of the chip.",
650
- "type": "any",
651
- "default": "'default'",
652
- "required": false
653
- }
654
- ]
655
- },
656
- {
657
- "name": "LimelChipSet",
658
- "source": {
659
- "module": "lime-elements-vue",
660
- "symbol": "LimelChipSet"
661
- },
662
- "description": ":::note\r\n**Regarding `click` and `interact` events:**\r\n\r\nThe `interact` event is emitted when a chip is interacted with, and is\r\nthe recommended way to listen for chip interactions.\r\n\r\nHowever, if you need to handle clicks differently depending on which chip\r\nwas clicked, or whether the click was on a chip or elsewhere, you need to\r\nlisten to the native `click` event instead.\r\n\r\nNative `click` events are passed through, and if the click came from\r\na chip, the chip object is available in the event object under\r\n`<event object>.Lime.chip`.\r\n\r\nExample usage:\r\n```ts\r\nprivate handleClick(event: Event) {\r\n if (event && 'Lime' in event && (event.Lime as any).chip) {\r\n if ((event.Lime as { chip: Chip }).chip.href) {\r\n // Chip has href, so let the browser open the link.\r\n return;\r\n }\r\n // handle click on chip without href\r\n } else {\r\n // handle click elsewhere\r\n }\r\n}\r\n```\r\n:::",
663
- "props": [
664
- {
665
- "name": "type",
666
- "description": "Type of chip set\r\n\r\n- `choice` renders a set of selectable chips where only one is selectable. The `removable` property is ignored\r\n- `filter` renders a set of selectable chips where all are selectable.\r\n- `input` renders a set of chips that can be used in conjunction with an input field\r\n\r\nIf no type is set, a basic set of chips without additional functionality will be rendered",
667
- "type": "any",
668
- "default": "",
669
- "required": false
670
- },
671
- {
672
- "name": "label",
673
- "description": "Label for the chip-set",
674
- "type": "any",
675
- "default": "",
676
- "required": false
677
- },
678
- {
679
- "name": "helperText",
680
- "description": "Optional helper text to display below the chipset.\r\nWhen type is `input`, the helper text is displayed below the\r\ninput field when it has focus.\r\nWhen type is not `input`, the helper text is always displayed\r\nif the device is touch screen; otherwise it is shown when chip-set\r\nis hovered or focused using keyboard navigation.",
681
- "type": "any",
682
- "default": "",
683
- "required": false
684
- },
685
- {
686
- "name": "disabled",
687
- "description": "True if the chip set should be disabled",
688
- "type": "any",
689
- "default": "false",
690
- "required": false
691
- },
692
- {
693
- "name": "readonly",
694
- "description": "For chip-sets of type `input`, set to `true` to disable adding and\r\nremoving chips, but allow interaction with existing chips in the set.\r\nFor any other types, setting either `readonly` or `disabled` disables\r\nthe chip-set.",
695
- "type": "any",
696
- "default": "false",
697
- "required": false
698
- },
699
- {
700
- "name": "invalid",
701
- "description": "Set to `true` to indicate that the current value of the input field is\r\ninvalid.",
702
- "type": "any",
703
- "default": "false",
704
- "required": false
705
- },
706
- {
707
- "name": "inputType",
708
- "description": "For chip-sets of type `input`. Value to use for the `type` attribute on the\r\ninput field inside the chip-set.",
709
- "type": "any",
710
- "default": "'text'",
711
- "required": false
712
- },
713
- {
714
- "name": "maxItems",
715
- "description": "For chip-sets of type `input`. Limits the maximum number of chips.\r\nWhen the value is `0` or not set, no limit is applied.",
716
- "type": "any",
717
- "default": "",
718
- "required": false
719
- },
720
- {
721
- "name": "required",
722
- "description": "True if the control requires a value",
723
- "type": "any",
724
- "default": "false",
725
- "required": false
726
- },
727
- {
728
- "name": "searchLabel",
729
- "description": "Search label to display when type is `input` and component is in search mode",
730
- "type": "any",
731
- "default": "",
732
- "required": false
733
- },
734
- {
735
- "name": "emptyInputOnBlur",
736
- "description": "Whether the input field should be emptied when the chip-set loses focus.",
737
- "type": "any",
738
- "default": "true",
739
- "required": false
740
- },
741
- {
742
- "name": "emptyInputOnChange",
743
- "description": "Whether the input field should be emptied when the set of chips\r\nchanges (i.e. when the `value` prop is updated — a chip is added,\r\nremoved, or the array is replaced).\r\n\r\nDefaults to `true`, which is the right behavior for a standalone\r\ninput chip-set where the typed text *becomes* the next chip on\r\n<kbd>Enter</kbd>. The input is then cleared to make room for the\r\nnext chip, and help user type a new keyword from scratch.\r\n\r\nSet to `false` when the input represents a search query over an\r\nexternal suggestion list (as in `limel-picker`), so the typed keyword\r\nsurvives while chips are added or removed (when user selects items from\r\nthe search results list, while it is open).",
744
- "type": "any",
745
- "default": "true",
746
- "required": false
747
- },
748
- {
749
- "name": "clearAllButton",
750
- "description": "Whether the \"Clear all\" buttons should be shown",
751
- "type": "any",
752
- "default": "true",
753
- "required": false
754
- },
755
- {
756
- "name": "leadingIcon",
757
- "description": "For chip-sets of type `input`. When the value is null, no leading icon is used.\r\nLeading icon to show to the far left in the text field",
758
- "type": "any",
759
- "default": "null",
760
- "required": false
761
- },
762
- {
763
- "name": "delimiter",
764
- "description": "For chip-set of type `input`. Sets delimiters between chips.",
765
- "type": "any",
766
- "default": "null",
767
- "required": false
768
- },
769
- {
770
- "name": "autocomplete",
771
- "description": "For chip-set of type `input`, defines whether the input field should have autocomplete enabled.\r\nRead more about the `autocomplete` attribute\r\n[here](https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/autocomplete).",
772
- "type": "any",
773
- "default": "'off'",
774
- "required": false
775
- },
776
- {
777
- "name": "language",
778
- "description": "Defines the language for translations.\r\nWill translate the translatable strings on the components. For example, the clear all chips label.",
779
- "type": "any",
780
- "default": "'en'",
781
- "required": false
782
- }
783
- ]
784
- },
785
- {
786
- "name": "LimelCircularProgress",
787
- "source": {
788
- "module": "lime-elements-vue",
789
- "symbol": "LimelCircularProgress"
790
- },
791
- "description": "The circular progress component can be used to visualize the curent state of\r\na progress in a scale; for example percentage of completion of a task.\r\n\r\nIts compact UI makes the component suitable when there is not enough screen\r\nspace available to visualise such information.\r\n\r\nThis component allows you to define your scale, from `0` to a desired\r\n`maxValue`; and also lets you chose a proper `suffix` for your scale.\r\n\r\n:::note\r\nThe component will round up the value when it is displayed, and only shows\r\none decimal digit.\r\nIt also abbreviates large numbers. For example 1234 will be displayed as 1.2k.\r\nOf course such numbers, if bigger than `maxValue` will be visualized as a\r\nfull progress.\r\n:::",
792
- "props": [
793
- {
794
- "name": "value",
795
- "description": "The value of the progress bar.",
796
- "type": "any",
797
- "default": "0",
798
- "required": false
799
- },
800
- {
801
- "name": "maxValue",
802
- "description": "The maximum value within the scale that the progress bar should visualize. Defaults to `100`.",
803
- "type": "any",
804
- "default": "100",
805
- "required": false
806
- },
807
- {
808
- "name": "prefix",
809
- "description": "The prefix which is displayed before the `value`, must be a few characters characters long.",
810
- "type": "any",
811
- "default": "null",
812
- "required": false
813
- },
814
- {
815
- "name": "suffix",
816
- "description": "The suffix which is displayed after the `value`, must be one or two characters long. Defaults to `%`",
817
- "type": "any",
818
- "default": "'%'",
819
- "required": false
820
- },
821
- {
822
- "name": "displayPercentageColors",
823
- "description": "When set to `true`, makes the filled section showing the percentage colorful. Colors change with intervals of 10%.",
824
- "type": "any",
825
- "default": "false",
826
- "required": false
827
- },
828
- {
829
- "name": "size",
830
- "description": "Determines the visual size of the visualization from a preset size. This property can override the `--circular-progress-size` variable if it is specified.",
831
- "type": "any",
832
- "default": "",
833
- "required": false
834
- }
835
- ]
836
- },
837
- {
838
- "name": "LimelCodeDiff",
839
- "source": {
840
- "module": "lime-elements-vue",
841
- "symbol": "LimelCodeDiff"
842
- },
843
- "description": "Displays a visual diff between two text values, modeled on\r\nGitHub's code difference view.\r\n\r\nSupports unified and split (side-by-side) views with line numbers,\r\ncolor-coded additions and removals, word-level inline highlighting,\r\nand collapsible unchanged context sections.",
844
- "props": [
845
- {
846
- "name": "oldValue",
847
- "description": "The \"before\" value to compare.\r\nCan be a string or an object (which will be serialized to JSON).",
848
- "type": "any",
849
- "default": "''",
850
- "required": false
851
- },
852
- {
853
- "name": "newValue",
854
- "description": "The \"after\" value to compare.\r\nCan be a string or an object (which will be serialized to JSON).",
855
- "type": "any",
856
- "default": "''",
857
- "required": false
858
- },
859
- {
860
- "name": "oldHeading",
861
- "description": "Heading for the original (before) version, displayed in the diff header.\r\nDefaults to `\"Original\"`, localized via `translationLanguage`.",
862
- "type": "any",
863
- "default": "",
864
- "required": false
865
- },
866
- {
867
- "name": "newHeading",
868
- "description": "Heading for the modified (after) version, displayed in the diff header.\r\nDefaults to `\"Modified\"`, localized via `translationLanguage`.",
869
- "type": "any",
870
- "default": "",
871
- "required": false
872
- },
873
- {
874
- "name": "layout",
875
- "description": "The layout of the diff view.\r\n- `unified` — single column with interleaved additions and removals\r\n- `split` — side-by-side comparison with old on left, new on right",
876
- "type": "any",
877
- "default": "'unified'",
878
- "required": false
879
- },
880
- {
881
- "name": "contextLines",
882
- "description": "Number of unchanged context lines to display around each change.",
883
- "type": "any",
884
- "default": "3",
885
- "required": false
886
- },
887
- {
888
- "name": "lineWrapping",
889
- "description": "When `true`, long lines are wrapped instead of causing\r\nhorizontal scrolling. Useful when comparing prose or\r\nconfig files with long values.",
890
- "type": "any",
891
- "default": "true",
892
- "required": false
893
- },
894
- {
895
- "name": "language",
896
- "description": "Language for syntax highlighting.\r\nCurrently supports `\"json\"`. When set, code tokens are\r\ncolorized (strings, numbers, keys, etc.) alongside the\r\ndiff highlighting.",
897
- "type": "any",
898
- "default": "",
899
- "required": false
900
- },
901
- {
902
- "name": "reformatJson",
903
- "description": "When `true`, JSON values are parsed, keys are sorted,\r\nand indentation is normalized before diffing.\r\nThis eliminates noise from formatting or key-order differences.",
904
- "type": "any",
905
- "default": "false",
906
- "required": false
907
- },
908
- {
909
- "name": "translationLanguage",
910
- "description": "Defines the language for translations.\r\nWill translate all visible labels and announcements.",
911
- "type": "any",
912
- "default": "'en'",
913
- "required": false
914
- }
915
- ]
916
- },
917
- {
918
- "name": "LimelCodeEditor",
919
- "source": {
920
- "module": "lime-elements-vue",
921
- "symbol": "LimelCodeEditor"
922
- },
923
- "description": "",
924
- "props": [
925
- {
926
- "name": "value",
927
- "description": "The code to be rendered",
928
- "type": "any",
929
- "default": "''",
930
- "required": false
931
- },
932
- {
933
- "name": "language",
934
- "description": "The language of the code",
935
- "type": "any",
936
- "default": "",
937
- "required": false
938
- },
939
- {
940
- "name": "readonly",
941
- "description": "Set to `true` to make the editor read-only.\r\nUse `readonly` when the editor is only there to present the data it holds,\r\nand will not become possible for the current user to edit.",
942
- "type": "any",
943
- "default": "false",
944
- "required": false
945
- },
946
- {
947
- "name": "disabled",
948
- "description": "Set to `true` to disable the editor.\r\nUse `disabled` to indicate that the editor can normally be interacted\r\nwith, but is currently disabled. This tells the user that if certain\r\nrequirements are met, the editor may become enabled again.",
949
- "type": "any",
950
- "default": "false",
951
- "required": false
952
- },
953
- {
954
- "name": "invalid",
955
- "description": "Set to `true` to indicate that the current value of the input editor is\r\ninvalid.",
956
- "type": "any",
957
- "default": "false",
958
- "required": false
959
- },
960
- {
961
- "name": "required",
962
- "description": "Set to `true` to indicate that the field is required.",
963
- "type": "any",
964
- "default": "false",
965
- "required": false
966
- },
967
- {
968
- "name": "label",
969
- "description": "The input label.",
970
- "type": "any",
971
- "default": "",
972
- "required": false
973
- },
974
- {
975
- "name": "helperText",
976
- "description": "Optional helper text to display below the input field when it has focus",
977
- "type": "any",
978
- "default": "",
979
- "required": false
980
- },
981
- {
982
- "name": "lineNumbers",
983
- "description": "Displays line numbers in the editor",
984
- "type": "any",
985
- "default": "false",
986
- "required": false
987
- },
988
- {
989
- "name": "lineWrapping",
990
- "description": "Wraps long lines instead of showing horizontal scrollbar",
991
- "type": "any",
992
- "default": "false",
993
- "required": false
994
- },
995
- {
996
- "name": "fold",
997
- "description": "Allows the user to fold code",
998
- "type": "any",
999
- "default": "false",
1000
- "required": false
1001
- },
1002
- {
1003
- "name": "lint",
1004
- "description": "Enables linting of JSON content",
1005
- "type": "any",
1006
- "default": "false",
1007
- "required": false
1008
- },
1009
- {
1010
- "name": "colorScheme",
1011
- "description": "Select color scheme for the editor",
1012
- "type": "any",
1013
- "default": "'auto'",
1014
- "required": false
1015
- },
1016
- {
1017
- "name": "translationLanguage",
1018
- "description": "Defines the language for translations.\r\nWill translate the translatable strings on the components.",
1019
- "type": "any",
1020
- "default": "'en'",
1021
- "required": false
1022
- },
1023
- {
1024
- "name": "showCopyButton",
1025
- "description": "Set to false to hide the copy button",
1026
- "type": "any",
1027
- "default": "true",
1028
- "required": false
1029
- }
1030
- ]
1031
- },
1032
- {
1033
- "name": "LimelCollapsibleSection",
1034
- "source": {
1035
- "module": "lime-elements-vue",
1036
- "symbol": "LimelCollapsibleSection"
1037
- },
1038
- "description": "A collapsible section can be used to group related content together\r\nand hide the group when not needed.\r\nUsing this component can help to:\r\n- Save vertical space by hiding non-essential content\r\n- Improve content organization and scannability of the user interface\r\n- Reduce cognitive load by displaying only a set of relevant information at a time\r\n- Or disclose complex information, progressively to the user",
1039
- "props": [
1040
- {
1041
- "name": "isOpen",
1042
- "description": "`true` if the section is expanded, `false` if collapsed.",
1043
- "type": "any",
1044
- "default": "false",
1045
- "required": false
1046
- },
1047
- {
1048
- "name": "header",
1049
- "description": "Text to display in the header of the section",
1050
- "type": "any",
1051
- "default": "",
1052
- "required": false
1053
- },
1054
- {
1055
- "name": "icon",
1056
- "description": "Icon to display in the header of the section",
1057
- "type": "any",
1058
- "default": "",
1059
- "required": false
1060
- },
1061
- {
1062
- "name": "invalid",
1063
- "description": "`true` if the section is invalid, `false` if valid.\r\nThis can be used to indicate that the content inside the section is invalid.",
1064
- "type": "any",
1065
- "default": "false",
1066
- "required": false
1067
- },
1068
- {
1069
- "name": "language",
1070
- "description": "Defines the language for translations.\r\nWill translate the translatable strings on the components.",
1071
- "type": "any",
1072
- "default": "'en'",
1073
- "required": false
1074
- }
1075
- ],
1076
- "slots": [
1077
- {
1078
- "name": "default",
1079
- "description": "Content to put inside the collapsible section"
1080
- },
1081
- {
1082
- "name": "header",
1083
- "description": "Optional slot for custom header content"
1084
- }
1085
- ]
1086
- },
1087
- {
1088
- "name": "LimelColorPicker",
1089
- "source": {
1090
- "module": "lime-elements-vue",
1091
- "symbol": "LimelColorPicker"
1092
- },
1093
- "description": "This component enables you to select a swatch from out color palette, simply\r\nby clicking on it. You can then copy the css variable name of the chosen color\r\nand use it where desired.\r\n\r\nThe color picker can also show you a preview of any valid color name or color value.\r\n\r\n:::note\r\nMake sure to read our [guidelines about usage of colors](#/DesignGuidelines/color-system.md/) from our palette.\r\n:::",
1094
- "props": [
1095
- {
1096
- "name": "value",
1097
- "description": "Name or code of the chosen color",
1098
- "type": "any",
1099
- "default": "",
1100
- "required": false
1101
- },
1102
- {
1103
- "name": "label",
1104
- "description": "The label of the input field",
1105
- "type": "any",
1106
- "default": "",
1107
- "required": false
1108
- },
1109
- {
1110
- "name": "helperText",
1111
- "description": "Helper text of the input field",
1112
- "type": "any",
1113
- "default": "",
1114
- "required": false
1115
- },
1116
- {
1117
- "name": "tooltipLabel",
1118
- "description": "Displayed as tooltips when picker is hovered.",
1119
- "type": "any",
1120
- "default": "",
1121
- "required": false
1122
- },
1123
- {
1124
- "name": "required",
1125
- "description": "Set to `true` if a value is required",
1126
- "type": "any",
1127
- "default": "",
1128
- "required": false
1129
- },
1130
- {
1131
- "name": "disabled",
1132
- "description": "Set to `true` to disable the field.\r\nUse `disabled` to indicate that the field can normally be interacted\r\nwith, but is currently disabled. This tells the user that if certain\r\nrequirements are met, the field may become enabled again.",
1133
- "type": "any",
1134
- "default": "false",
1135
- "required": false
1136
- },
1137
- {
1138
- "name": "readonly",
1139
- "description": "Set to `true` to make the field read-only.\r\nUse `readonly` when the field is only there to present the data it holds,\r\nand will not become possible for the current user to edit.",
1140
- "type": "any",
1141
- "default": "false",
1142
- "required": false
1143
- },
1144
- {
1145
- "name": "invalid",
1146
- "description": "Set to `true` to indicate that the current value of the input field is\r\ninvalid.",
1147
- "type": "any",
1148
- "default": "false",
1149
- "required": false
1150
- },
1151
- {
1152
- "name": "placeholder",
1153
- "description": "The placeholder text shown inside the input field,\r\nwhen the field is focused and empty.",
1154
- "type": "any",
1155
- "default": "",
1156
- "required": false
1157
- },
1158
- {
1159
- "name": "manualInput",
1160
- "description": "Set to `false` to disallow custom color values to be typed into the input field.\r\nSetting this to `false` does not completely disable the color picker.\r\nIt will only allow users to pick from the provided color palette.",
1161
- "type": "any",
1162
- "default": "true",
1163
- "required": false
1164
- },
1165
- {
1166
- "name": "paletteColumnCount",
1167
- "description": "Defines the number of columns in the color swatch grid.\r\nIf not provided, it will default to the number of colors in the palette;\r\nbut stops at a maximum of 25 columns.",
1168
- "type": "any",
1169
- "default": "",
1170
- "required": false
1171
- }
1172
- ]
1173
- },
1174
- {
1175
- "name": "LimelColorPickerPalette",
1176
- "source": {
1177
- "module": "lime-elements-vue",
1178
- "symbol": "LimelColorPickerPalette"
1179
- },
1180
- "description": "",
1181
- "props": [
1182
- {
1183
- "name": "value",
1184
- "description": "Color value that is manually typed by the user",
1185
- "type": "any",
1186
- "default": "",
1187
- "required": false
1188
- },
1189
- {
1190
- "name": "label",
1191
- "description": "Label of the input field",
1192
- "type": "any",
1193
- "default": "",
1194
- "required": false
1195
- },
1196
- {
1197
- "name": "helperText",
1198
- "description": "Helper text of the input field",
1199
- "type": "any",
1200
- "default": "",
1201
- "required": false
1202
- },
1203
- {
1204
- "name": "placeholder",
1205
- "description": "The placeholder text shown inside the input field,\r\nwhen the field is focused and empty.",
1206
- "type": "any",
1207
- "default": "",
1208
- "required": false
1209
- },
1210
- {
1211
- "name": "required",
1212
- "description": "Set to `true` if a value is required",
1213
- "type": "any",
1214
- "default": "",
1215
- "required": false
1216
- },
1217
- {
1218
- "name": "invalid",
1219
- "description": "Set to `true` to indicate that the current value of the input field is\r\ninvalid.",
1220
- "type": "any",
1221
- "default": "false",
1222
- "required": false
1223
- },
1224
- {
1225
- "name": "manualInput",
1226
- "description": "Set to `false` to disallow custom color values to be typed into the input field.",
1227
- "type": "any",
1228
- "default": "true",
1229
- "required": false
1230
- },
1231
- {
1232
- "name": "columnCount",
1233
- "description": "Defines the number of columns in the color swatch grid.\r\nIf not provided, it will default to the number of colors in the palette.",
1234
- "type": "any",
1235
- "default": "",
1236
- "required": false
1237
- }
1238
- ]
1239
- },
1240
- {
1241
- "name": "LimelConfig",
1242
- "source": {
1243
- "module": "lime-elements-vue",
1244
- "symbol": "LimelConfig"
1245
- },
1246
- "description": "Component used to set global configuration for Lime Elements.\r\n\r\n:::warning\r\n**Building something for Lime CRM?** Then you should _NOT_ use this component.\r\nLime CRM already uses this component to set the global configuration for\r\nLime Elements. No matter what problem you are facing at the moment, using\r\nthis component will not help, and might cause other problems.\r\n:::\r\n\r\nBuilding your own software, which is using Lime Elements?\r\nThen you _might_ need to use this component.",
1247
- "props": []
1248
- },
1249
- {
1250
- "name": "LimelDatePicker",
1251
- "source": {
1252
- "module": "lime-elements-vue",
1253
- "symbol": "LimelDatePicker"
1254
- },
1255
- "description": "",
1256
- "props": [
1257
- {
1258
- "name": "disabled",
1259
- "description": "Set to `true` to disable the field.\r\nUse `disabled` to indicate that the field can normally be interacted\r\nwith, but is currently disabled. This tells the user that if certain\r\nrequirements are met, the field may become enabled again.",
1260
- "type": "any",
1261
- "default": "false",
1262
- "required": false
1263
- },
1264
- {
1265
- "name": "readonly",
1266
- "description": "Set to `true` to make the field read-only.\r\nUse `readonly` when the field is only there to present the data it holds,\r\nand will not become possible for the current user to edit.",
1267
- "type": "any",
1268
- "default": "false",
1269
- "required": false
1270
- },
1271
- {
1272
- "name": "invalid",
1273
- "description": "Set to `true` to indicate that the current value of the date picker is\r\ninvalid.",
1274
- "type": "any",
1275
- "default": "false",
1276
- "required": false
1277
- },
1278
- {
1279
- "name": "label",
1280
- "description": "Text to display next to the date picker",
1281
- "type": "any",
1282
- "default": "",
1283
- "required": false
1284
- },
1285
- {
1286
- "name": "placeholder",
1287
- "description": "The placeholder text shown inside the input field, when the field is focused and empty",
1288
- "type": "any",
1289
- "default": "",
1290
- "required": false
1291
- },
1292
- {
1293
- "name": "helperText",
1294
- "description": "Optional helper text to display below the input field when it has focus",
1295
- "type": "any",
1296
- "default": "",
1297
- "required": false
1298
- },
1299
- {
1300
- "name": "required",
1301
- "description": "Set to `true` to indicate that the field is required.",
1302
- "type": "any",
1303
- "default": "false",
1304
- "required": false
1305
- },
1306
- {
1307
- "name": "type",
1308
- "description": "Type of date picker.",
1309
- "type": "any",
1310
- "default": "'datetime'",
1311
- "required": false
1312
- },
1313
- {
1314
- "name": "format",
1315
- "description": "Format to display the selected date in.",
1316
- "type": "any",
1317
- "default": "",
1318
- "required": false
1319
- },
1320
- {
1321
- "name": "language",
1322
- "description": "Defines the localisation for translations and date formatting.\r\nProperty `format` customizes the localized date format.",
1323
- "type": "any",
1324
- "default": "'en'",
1325
- "required": false
1326
- }
1327
- ]
1328
- },
1329
- {
1330
- "name": "LimelDialog",
1331
- "source": {
1332
- "module": "lime-elements-vue",
1333
- "symbol": "LimelDialog"
1334
- },
1335
- "description": ":::note\r\nRegarding the `close` event: When putting other elements that emit `close`\r\nevents inside a dialog, those events must be caught and stopped inside the\r\ndialog. If not, they will bubble to the event handler listening for `close`\r\nevents on the dialog, which will close the dialog too.\r\n\r\nSee the example _Nested `close` events_.\r\n:::\r\n\r\n:::important\r\nAre you developing for\r\n[Lime CRM](https://www.lime-technologies.com/en/lime-crm/)? Please note that\r\nyou should use the [DialogRenderer](https://lundalogik.github.io/lime-web-components/versions/latest/interfaces/DialogRenderer.html)\r\nfrom Lime Web Components to open dialogs in Lime CRM.\r\n:::",
1336
- "props": [
1337
- {
1338
- "name": "heading",
1339
- "description": "The heading for the dialog, if any.",
1340
- "type": "any",
1341
- "default": "",
1342
- "required": false
1343
- },
1344
- {
1345
- "name": "fullscreen",
1346
- "description": "Set to `true` to make the dialog \"fullscreen\".",
1347
- "type": "any",
1348
- "default": "false",
1349
- "required": false
1350
- },
1351
- {
1352
- "name": "open",
1353
- "description": "`true` if the dialog is open, `false` otherwise.",
1354
- "type": "any",
1355
- "default": "false",
1356
- "required": false
1357
- }
1358
- ],
1359
- "slots": [
1360
- {
1361
- "name": "default",
1362
- "description": "Content to put inside the dialog"
1363
- },
1364
- {
1365
- "name": "header",
1366
- "description": "actions The dialog header buttons"
1367
- },
1368
- {
1369
- "name": "button",
1370
- "description": "The dialog buttons"
1371
- }
1372
- ]
1373
- },
1374
- {
1375
- "name": "LimelDock",
1376
- "source": {
1377
- "module": "lime-elements-vue",
1378
- "symbol": "LimelDock"
1379
- },
1380
- "description": "",
1381
- "props": [
1382
- {
1383
- "name": "accessibleLabel",
1384
- "description": "A label used to describe the purpose of the navigation element to users\r\nof assistive technologies, like screen readers. Especially useful when\r\nthere are multiple navigation elements in the user interface.\r\nExample value: \"Primary navigation\"",
1385
- "type": "any",
1386
- "default": "",
1387
- "required": false
1388
- },
1389
- {
1390
- "name": "expanded",
1391
- "description": "Defines the width of the component, when it loads.\r\n- `true`: shows both icons and labels of the Dock items.\r\n- `false`: only shows icons of the doc items, and displays\r\ntheir labels as tooltip.\r\n\r\nNote: when `useMobileLayout` is `true`, labels will always\r\nbe shown as tooltips. Read more below…",
1392
- "type": "any",
1393
- "default": "false",
1394
- "required": false
1395
- },
1396
- {
1397
- "name": "allowResize",
1398
- "description": "Set to `false` if you do not want to allow end-users\r\nto exapnd or shrink the Dock. This will hide the\r\nexpand/shrink button, and the only things that defines\r\nthe layout will be the `expanded` property, and\r\nthe `mobileBreakPoint`.",
1399
- "type": "any",
1400
- "default": "true",
1401
- "required": false
1402
- },
1403
- {
1404
- "name": "mobileBreakPoint",
1405
- "description": "Defines the breakpoint in pixles, at which the component will be rendered\r\nin a hoizontal layout. Default breakpoint is `700` pixels, which means\r\nwhen the screen size is smaller than `700px`, the component will automatically\r\nswitch to a horizontal layout.",
1406
- "type": "any",
1407
- "default": "700",
1408
- "required": false
1409
- }
1410
- ]
1411
- },
1412
- {
1413
- "name": "LimelDockButton",
1414
- "source": {
1415
- "module": "lime-elements-vue",
1416
- "symbol": "LimelDockButton"
1417
- },
1418
- "description": "",
1419
- "props": [
1420
- {
1421
- "name": "expanded",
1422
- "description": "When the dock is expanded or collapsed, dock items\r\nshow labels and tooltips as suitable for the layout.",
1423
- "type": "any",
1424
- "default": "false",
1425
- "required": false
1426
- },
1427
- {
1428
- "name": "useMobileLayout",
1429
- "description": "When dock is using mobile layout, dock items\r\nshow labels and tooltips as suitable for the layout.",
1430
- "type": "any",
1431
- "default": "false",
1432
- "required": false
1433
- }
1434
- ]
1435
- },
1436
- {
1437
- "name": "LimelDragHandle",
1438
- "source": {
1439
- "module": "lime-elements-vue",
1440
- "symbol": "LimelDragHandle"
1441
- },
1442
- "description": "This component resembles a drag handle button, but is implemented\r\nas a `private` component to allow for easier styling and future extensions.\r\n\r\n:::important\r\nThis component has its `shadow` set to `false` in order to\r\nintegrate well with the drag-and-drop functionality, as well as\r\nproviding a better accessibility.\r\n\r\nKeep in mind that its styles might be affected by the consumer\r\ncomponent, due to its light dom.\r\n:::\r\n\r\n:::tip\r\nIt's recommended to place the drag handle on the right side of\r\nthe item it is meant to reorder, to ensure consistent layout\r\ndesign conventions.\r\n:::",
1443
- "props": [
1444
- {
1445
- "name": "dragDirection",
1446
- "description": "The direction in which the drag handle can be used to reorder items.",
1447
- "type": "any",
1448
- "default": "'vertical'",
1449
- "required": false
1450
- },
1451
- {
1452
- "name": "tooltipOpenDirection",
1453
- "description": "The preferred direction for the tooltip to open.\r\nDefaults to 'left', as our recommended placement for a drag handle\r\nin the UI is on the far right side of draggable elements.",
1454
- "type": "any",
1455
- "default": "'left'",
1456
- "required": false
1457
- },
1458
- {
1459
- "name": "language",
1460
- "description": "Language to use for translations.",
1461
- "type": "any",
1462
- "default": "'en'",
1463
- "required": false
1464
- }
1465
- ]
1466
- },
1467
- {
1468
- "name": "LimelDynamicLabel",
1469
- "source": {
1470
- "module": "lime-elements-vue",
1471
- "symbol": "LimelDynamicLabel"
1472
- },
1473
- "description": "This components displays a different label depending on the current given\r\nvalue. A label can consist of a text and an optional icon. If no matching\r\nlabel is found among the given `labels`, the `defaultLabel` will be displayed.\r\n\r\nOne use case of the component is to enhance the visualization of a `boolean`\r\nfield like a checkbox or switch in a `readonly` state.\r\n\r\nThe reason we offer this component is that the default styling\r\nof the Checkbox or Toggle switch in the `readonly` state may not always\r\nprovide the best way of _visualizing information_, potentially leading to\r\nconfusion and negatively affecting the end-users' experience.",
1474
- "props": [
1475
- {
1476
- "name": "value",
1477
- "description": "The current value of the component which is used to match with the given\r\n`labels` to determine what label to display.\r\n\r\nIf not matching label is found, the `defaultLabel` is displayed.",
1478
- "type": "any",
1479
- "default": "",
1480
- "required": false
1481
- }
1482
- ]
1483
- },
1484
- {
1485
- "name": "LimelEmailViewer",
1486
- "source": {
1487
- "module": "lime-elements-vue",
1488
- "symbol": "LimelEmailViewer"
1489
- },
1490
- "description": "This is a private component, used to render `.eml` files inside\r\n`limel-file-viewer`.\r\n\r\n:::note\r\nIf `bodyHtml` is provided, it will be rendered using `innerHTML`.\r\nConsumers should pre-sanitize `bodyHtml` before passing it to the component.\r\n:::",
1491
- "props": [
1492
- {
1493
- "name": "fallbackUrl",
1494
- "description": "Optional URL to render as a final fallback using an `<object type=\"text/plain\">`.",
1495
- "type": "any",
1496
- "default": "",
1497
- "required": false
1498
- },
1499
- {
1500
- "name": "language",
1501
- "description": "Defines the localization for translations.",
1502
- "type": "any",
1503
- "default": "'en'",
1504
- "required": false
1505
- },
1506
- {
1507
- "name": "allowRemoteImages",
1508
- "description": "Controls whether remote images (http/https) are loaded.\r\n\r\nIf omitted, the component treats this as a per-email setting.\r\nConsumers that want to remember the choice (per session/global) can\r\nprovide this prop and listen for `allowRemoteImagesChange`.",
1509
- "type": "any",
1510
- "default": "",
1511
- "required": false
1512
- }
1513
- ]
1514
- },
1515
- {
1516
- "name": "LimelFile",
1517
- "source": {
1518
- "module": "lime-elements-vue",
1519
- "symbol": "LimelFile"
1520
- },
1521
- "description": "This component lets end-users select a *single* file from their device\r\nstorage. Regardless of the user's device or operating system, this component\r\nopens up a file picker dialog that allows the user to choose a file.\r\n\r\n## Using correct labels\r\n\r\nThis file picker can be used in different contexts. The component's distinct\r\nvisual design including the upload icon hints end-users that this is not a\r\nnormal input field like other fields in the form for example.\r\n\r\n:::important\r\nyou need to use a descriptive `label` that clarifies the\r\nfunctionality of the file picker, and/or provides users with clear\r\ninstructions.\r\n\r\nDepending on the context, you may need to avoid labels such as:\r\n- File\r\n- Document\r\n\r\nand instead consider using labels like:\r\n- Attach a file\r\n- Upload a file\r\n- Choose a document\r\n- Choose a file\r\n\r\nand similar phrases...\r\n:::",
1522
- "props": [
1523
- {
1524
- "name": "label",
1525
- "description": "The input label.",
1526
- "type": "any",
1527
- "default": "",
1528
- "required": false
1529
- },
1530
- {
1531
- "name": "helperText",
1532
- "description": "Optional helper text to display below the component.",
1533
- "type": "any",
1534
- "default": "",
1535
- "required": false
1536
- },
1537
- {
1538
- "name": "required",
1539
- "description": "Set to `true` to indicate that the field is required.",
1540
- "type": "any",
1541
- "default": "false",
1542
- "required": false
1543
- },
1544
- {
1545
- "name": "disabled",
1546
- "description": "True if the input should be disabled",
1547
- "type": "any",
1548
- "default": "false",
1549
- "required": false
1550
- },
1551
- {
1552
- "name": "readonly",
1553
- "description": "Set to `true` to disable adding and removing files, but allow interaction\r\nwith any already existing file.",
1554
- "type": "any",
1555
- "default": "false",
1556
- "required": false
1557
- },
1558
- {
1559
- "name": "invalid",
1560
- "description": "Set to `true` to indicate that the current value of the chosen file is\r\ninvalid.",
1561
- "type": "any",
1562
- "default": "false",
1563
- "required": false
1564
- },
1565
- {
1566
- "name": "loading",
1567
- "description": "Set to `true` to put the component in the `loading` state, and render an\r\nindeterminate progress indicator. This does _not_ disable the\r\ninteractivity of the component!",
1568
- "type": "any",
1569
- "default": "false",
1570
- "required": false
1571
- },
1572
- {
1573
- "name": "accept",
1574
- "description": "The [accepted file types](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input/file#unique_file_type_specifiers)",
1575
- "type": "any",
1576
- "default": "'*'",
1577
- "required": false
1578
- },
1579
- {
1580
- "name": "language",
1581
- "description": "Defines the localisation for translations.",
1582
- "type": "any",
1583
- "default": "'en'",
1584
- "required": false
1585
- }
1586
- ]
1587
- },
1588
- {
1589
- "name": "LimelFileDropzone",
1590
- "source": {
1591
- "module": "lime-elements-vue",
1592
- "symbol": "LimelFileDropzone"
1593
- },
1594
- "description": "This component enables you to seamlessly convert any region of the user interface into\r\na file dropzone area, just by wrapping it inside the `limel-file-dropzone`.\r\n\r\nThe file dropzone can then be used to allow end-users to upload files\r\nby dragging and dropping them into the specified area, for example to trigger an upload process.\r\n\r\nAfter receiving the files, the component emits a `filesSelected` event. For unsupported\r\nfiles (specified with the `accept` prop) a `filesRejected` event will be emitted.\r\n\r\nThe event detail would be an array of `FileInfo` objects,\r\neach representing a file dropped into the dropzone.",
1595
- "props": [
1596
- {
1597
- "name": "accept",
1598
- "description": "Specifies the types of files that the dropzone will accept. By default, all file types are accepted.\r\n\r\nFor media files, formats can be specified using: `audio/*`, `video/*`, `image/*`.\r\nUnique file type specifiers can also be used, for example: `.jpg`, `.pdf`.\r\nA comma-separated list of file extensions or MIME types is also acceptable, e.g., `image/png, image/jpeg` or\r\n`.png, .jpg, .jpeg`.",
1599
- "type": "any",
1600
- "default": "'*'",
1601
- "required": false
1602
- },
1603
- {
1604
- "name": "disabled",
1605
- "description": "Set to `true` to disable the file dropzone.",
1606
- "type": "any",
1607
- "default": "false",
1608
- "required": false
1609
- },
1610
- {
1611
- "name": "text",
1612
- "description": "Is displayed when the user is dragging a file over the dropzone.\r\nA suitable text could for instance be \"Drop your files here\".",
1613
- "type": "any",
1614
- "default": "",
1615
- "required": false
1616
- },
1617
- {
1618
- "name": "helperText",
1619
- "description": "Is displayed to provide supplementary information to the end users,\r\nfor instance, which filetypes or file sizes are accepted.",
1620
- "type": "any",
1621
- "default": "''",
1622
- "required": false
1623
- }
1624
- ]
1625
- },
1626
- {
1627
- "name": "LimelFileInput",
1628
- "source": {
1629
- "module": "lime-elements-vue",
1630
- "symbol": "LimelFileInput"
1631
- },
1632
- "description": "This component enables you to seamlessly transform any other clickable component that\r\ngenerates a `click` event into a file input selector.\r\n\r\nTo use it, just wrap any clickable component inside the `limel-file-input` component.\r\nUpon reception of the `click` event this component will open the native file selection\r\ndialog.\r\n\r\nAfter receiving the files, the component emits a `filesSelected` event.\r\n\r\nThe event detail would be an array of `FileInfo` objects,\r\neach representing a file dropped into the dropzone.",
1633
- "props": [
1634
- {
1635
- "name": "accept",
1636
- "description": "Specifies the types of files that the dropzone will accept. By default, all file types are accepted.\r\n\r\nFor media files, formats can be specified using: `audio/*`, `video/*`, `image/*`.\r\nUnique file type specifiers can also be used, for example: `.jpg`, `.pdf`.\r\nA comma-separated list of file extensions or MIME types is also acceptable, e.g., `image/png, image/jpeg` or\r\n`.png, .jpg, .jpeg`.",
1637
- "type": "any",
1638
- "default": "'*'",
1639
- "required": false
1640
- },
1641
- {
1642
- "name": "disabled",
1643
- "description": "Set to `true` to disable file input selection.",
1644
- "type": "any",
1645
- "default": "false",
1646
- "required": false
1647
- },
1648
- {
1649
- "name": "multiple",
1650
- "description": "Set to `true` to enable selection of multiple files",
1651
- "type": "any",
1652
- "default": "false",
1653
- "required": false
1654
- }
1655
- ]
1656
- },
1657
- {
1658
- "name": "LimelFileViewer",
1659
- "source": {
1660
- "module": "lime-elements-vue",
1661
- "symbol": "LimelFileViewer"
1662
- },
1663
- "description": "This is a smart component that automatically detects\r\nthe most common file types such as image, audio, video, and text,\r\nand properly displays them in the browser.\r\nThe component is also capable to render the most common office files.\r\n\r\n:::note\r\nImage files will always be contained in their containers, which means\r\nthey automatically increase or decrease in size to fill their containing box\r\nwhilst preserving their aspect-ratio.\r\n\r\nText and PDF files will also always respect the width and height of the\r\ncontainer in which the `limel-file-viewer` is loaded.\r\n:::\r\n\r\nFor some file types such as text and images, the component will display a\r\ndownload button and a button to open the file in a new browser tab.\r\nThis will allow users to preview the file in a fullscreen mode with the\r\nbrowser and take advantage of for example native zooming and panning\r\nfunctionalities.",
1664
- "props": [
1665
- {
1666
- "name": "url",
1667
- "description": "Link to the file",
1668
- "type": "any",
1669
- "default": "",
1670
- "required": false
1671
- },
1672
- {
1673
- "name": "filename",
1674
- "description": "The name of the file that must also contains its extension.\r\nThis overrides the filename that the `url` ends with.\r\nUseful when the `url` does not contain the filename.\r\nWhen specified, the `filename` will be used as filename of\r\nthe downloaded file.",
1675
- "type": "any",
1676
- "default": "",
1677
- "required": false
1678
- },
1679
- {
1680
- "name": "alt",
1681
- "description": "An optional alternative text, mainly for assistive technologies and screen readers.\r\nIt is used for only image files, as an `alt` attribute.\r\nShould optimally hold a description of the image,\r\nwhich is also displayed on the page if the image can't be loaded for some reason.",
1682
- "type": "any",
1683
- "default": "",
1684
- "required": false
1685
- },
1686
- {
1687
- "name": "allowFullscreen",
1688
- "description": "Displays a button that allows the user to view the file\r\nin fullscreen mode.\r\nNot displayed for office files!",
1689
- "type": "any",
1690
- "default": "false",
1691
- "required": false
1692
- },
1693
- {
1694
- "name": "allowOpenInNewTab",
1695
- "description": "Displays a button that allows the user to open the file\r\nin a new browser tab.\r\nNot displayed for office files!",
1696
- "type": "any",
1697
- "default": "false",
1698
- "required": false
1699
- },
1700
- {
1701
- "name": "allowDownload",
1702
- "description": "Displays a button that allows the user to download the file.\r\nNote that due to the browser's security policies,\r\nthe file should be hosted on the same domain\r\nfor the download button to work properly.\r\nNot displayed for office files!",
1703
- "type": "any",
1704
- "default": "false",
1705
- "required": false
1706
- },
1707
- {
1708
- "name": "language",
1709
- "description": "Defines the localization for translations.",
1710
- "type": "any",
1711
- "default": "'en'",
1712
- "required": false
1713
- },
1714
- {
1715
- "name": "officeViewer",
1716
- "description": "Defines the third-party viewer that should be used to render\r\nthe content of office files, such as word processing documents,\r\npresentations, or spreadsheets.",
1717
- "type": "any",
1718
- "default": "'microsoft-office'",
1719
- "required": false
1720
- }
1721
- ]
1722
- },
1723
- {
1724
- "name": "LimelFlatpickrAdapter",
1725
- "source": {
1726
- "module": "lime-elements-vue",
1727
- "symbol": "LimelFlatpickrAdapter"
1728
- },
1729
- "description": "This component is internal and only supposed to be used by\r\nthe limel-date-picker. This component is needed in order for us\r\nto render the flatpickr calendar in a portal.",
1730
- "props": [
1731
- {
1732
- "name": "type",
1733
- "description": "Type of date picker.",
1734
- "type": "any",
1735
- "default": "'datetime'",
1736
- "required": false
1737
- },
1738
- {
1739
- "name": "format",
1740
- "description": "Format to display the selected date in.",
1741
- "type": "any",
1742
- "default": "",
1743
- "required": false
1744
- },
1745
- {
1746
- "name": "isOpen",
1747
- "description": "Set to `true` if the calendar should be open.",
1748
- "type": "any",
1749
- "default": "",
1750
- "required": false
1751
- },
1752
- {
1753
- "name": "language",
1754
- "description": "Defines the localisation for translations and date formatting.\r\nProperty `format` customizes the localized date format.",
1755
- "type": "any",
1756
- "default": "'en'",
1757
- "required": false
1758
- }
1759
- ]
1760
- },
1761
- {
1762
- "name": "LimelFlexContainer",
1763
- "source": {
1764
- "module": "lime-elements-vue",
1765
- "symbol": "LimelFlexContainer"
1766
- },
1767
- "description": "This component is deprecated and will be removed in a future version of\r\nLime Elements. Please use CSS for your flexible container needs 🙂\r\nhttps://developer.mozilla.org/en-US/docs/Web/CSS/CSS_Flexible_Box_Layout/Basic_Concepts_of_Flexbox",
1768
- "props": [
1769
- {
1770
- "name": "direction",
1771
- "description": "Direction of the main axis",
1772
- "type": "any",
1773
- "default": "'horizontal'",
1774
- "required": false
1775
- },
1776
- {
1777
- "name": "justify",
1778
- "description": "Specify how items are aligned along the main axis",
1779
- "type": "any",
1780
- "default": "'space-between'",
1781
- "required": false
1782
- },
1783
- {
1784
- "name": "align",
1785
- "description": "Specify how items are aligned along the cross axis",
1786
- "type": "any",
1787
- "default": "'center'",
1788
- "required": false
1789
- },
1790
- {
1791
- "name": "reverse",
1792
- "description": "Reverse the order of the items",
1793
- "type": "any",
1794
- "default": "false",
1795
- "required": false
1796
- }
1797
- ],
1798
- "slots": [
1799
- {
1800
- "name": "default",
1801
- "description": "Container content"
1802
- }
1803
- ]
1804
- },
1805
- {
1806
- "name": "LimelForm",
1807
- "source": {
1808
- "module": "lime-elements-vue",
1809
- "symbol": "LimelForm"
1810
- },
1811
- "description": "",
1812
- "props": [
1813
- {
1814
- "name": "disabled",
1815
- "description": "Set to `true` to disable the whole form.",
1816
- "type": "any",
1817
- "default": "false",
1818
- "required": false
1819
- },
1820
- {
1821
- "name": "revealErrors",
1822
- "description": "Set to `true` to render every field with a validation error as\r\ninvalid, even untouched ones, and to reflect that on each\r\ncontaining collapsible section's header. Defaults to `false`,\r\nwhich keeps untouched required-empty fields silent.",
1823
- "type": "any",
1824
- "default": "false",
1825
- "required": false
1826
- }
1827
- ]
1828
- },
1829
- {
1830
- "name": "LimelGrid",
1831
- "source": {
1832
- "module": "lime-elements-vue",
1833
- "symbol": "LimelGrid"
1834
- },
1835
- "description": "This component is deprecated and will be removed in a future version of\r\nLime Elements. Please use CSS for your flexible container needs 🙂",
1836
- "props": [],
1837
- "slots": [
1838
- {
1839
- "name": "default",
1840
- "description": "Grid content"
1841
- }
1842
- ]
1843
- },
1844
- {
1845
- "name": "LimelHeader",
1846
- "source": {
1847
- "module": "lime-elements-vue",
1848
- "symbol": "LimelHeader"
1849
- },
1850
- "description": "A header is the top most visual element in a component, page, card, or a view.\r\n\r\n## Usage\r\nA header is the first thing that clarifies a context for users.\r\nDue to their positions in the UI hierarchy, headers are the most\r\nprominent elements of a user interface; and because of that, they carry both\r\nvital information and fundamental controls for the area of the interface\r\nthey represent.\r\n\r\nFor example, when a header is placed on top of a card, it should quickly\r\nexplain the card to the user. When placed on top of a modal, it should easily\r\nclarify what the modal is about. When displayed on top of a fullscreen view,\r\nit should indicate where in the system users are, and what part of the app\r\nthey are looking at.\r\n\r\n\r\n## Layout\r\nThe vital information in a header is usually manifested in form of an icon,\r\nand a heading. A subheading also could be added to provide supplementary\r\ninformation. There is also a third place for displaying supplementary information\r\nor \"supporting text\", which will be rendered as a part of the subheading.\r\nAlong with this information, headers can also include actions, controls, or\r\nmenus.\r\n\r\n:::important\r\nSuch actions or menus must affect the entire section of the interface\r\nwhich the header is representing. For example, a _Delete_ button on a card\r\nheader must delete that entire card and its respective contents all together,\r\nnot for example a selected item which is visible in the content of that card.\r\n:::\r\n\r\n\r\n:::warning\r\nDo not user background color on icons in the headers. It is much better and\r\nmuch easier for the eye if your icon itself has a color.\r\nBackground colors behind icons make them look like \"call to action\" buttons\r\nand take a lot of attention from users.\r\n:::",
1851
- "props": [
1852
- {
1853
- "name": "icon",
1854
- "description": "Icon to display",
1855
- "type": "any",
1856
- "default": "",
1857
- "required": false
1858
- },
1859
- {
1860
- "name": "heading",
1861
- "description": "Title to display",
1862
- "type": "any",
1863
- "default": "",
1864
- "required": false
1865
- },
1866
- {
1867
- "name": "subheading",
1868
- "description": "Subheading to display",
1869
- "type": "any",
1870
- "default": "",
1871
- "required": false
1872
- },
1873
- {
1874
- "name": "supportingText",
1875
- "description": "An extra string of text to display along with with the Subheading",
1876
- "type": "any",
1877
- "default": "",
1878
- "required": false
1879
- },
1880
- {
1881
- "name": "subheadingDivider",
1882
- "description": "The visual divider that separates the `subheading` and the `supportingText`.\r\nIt must be a single character such as `-` or `,`.",
1883
- "type": "any",
1884
- "default": "'·'",
1885
- "required": false
1886
- }
1887
- ],
1888
- "slots": [
1889
- {
1890
- "name": "actions",
1891
- "description": "Content (actions) to be put inside the far right surface of\r\nthe header"
1892
- },
1893
- {
1894
- "name": "[no name]",
1895
- "description": "DEPRECATED. The `actions` slot used to be unnamed. This\r\nbehavior has been deprecated, and support will be dropped in a future\r\nversion. Please add `slot=\"actions\"` to your elements to ensure your code\r\nwill continue to work with future versions of Lime Elements."
1896
- }
1897
- ]
1898
- },
1899
- {
1900
- "name": "LimelHelp",
1901
- "source": {
1902
- "module": "lime-elements-vue",
1903
- "symbol": "LimelHelp"
1904
- },
1905
- "description": "A good design is self-explanatory! However, sometimes concepts are\r\ntoo complex to understand, no matter how well-designed a user interface is.\r\nIn such cases, contextual help can be a great way to provide users with\r\nhelp precisely where and when users need it.\r\n\r\nIn app interface design, providing contextual help emerges as a viable practice\r\nfor enhancing user experience and usability.\r\nContextual help serves as a quick-to-access guiding,\r\nempowering users to more easily understand and navigate through\r\nthe intricacies of an application.\r\n\r\nUsing this component designers empower users to grasp the functionality\r\nof an app more effortlessly, minimizes the learning curve,\r\ntransforming complex features into accessible opportunities for exploration.",
1906
- "props": [
1907
- {
1908
- "name": "value",
1909
- "description": "{@inheritdoc Help.value}",
1910
- "type": "any",
1911
- "default": "",
1912
- "required": false
1913
- },
1914
- {
1915
- "name": "trigger",
1916
- "description": "{@inheritdoc Help.trigger}",
1917
- "type": "any",
1918
- "default": "'?'",
1919
- "required": false
1920
- },
1921
- {
1922
- "name": "openDirection",
1923
- "description": "{@inheritdoc Help.openDirection}",
1924
- "type": "any",
1925
- "default": "'top-start'",
1926
- "required": false
1927
- }
1928
- ]
1929
- },
1930
- {
1931
- "name": "LimelHelpContent",
1932
- "source": {
1933
- "module": "lime-elements-vue",
1934
- "symbol": "LimelHelpContent"
1935
- },
1936
- "description": "Help content\r\nThis is scrollable content that is placed in the popover of the Help component.\r\nMoved here mostly to avoid having inlined styles in the parent component.\r\nSince you cannot send styles to the Portal component, we need to have this\r\nchild component.",
1937
- "props": [
1938
- {
1939
- "name": "value",
1940
- "description": "",
1941
- "type": "any",
1942
- "default": "",
1943
- "required": false
1944
- }
1945
- ]
1946
- },
1947
- {
1948
- "name": "LimelHelperLine",
1949
- "source": {
1950
- "module": "lime-elements-vue",
1951
- "symbol": "LimelHelperLine"
1952
- },
1953
- "description": "This is an internal and private component that many input fields\r\nuse to display a helper text, along with a character counter below the\r\ninput field.\r\n\r\nWe created this to keep the visual styles the same everywhere\r\nand to avoid importing styles separately.\r\n\r\nAlso this enables us to open the helper line in limel-portal,\r\nmore easily without having to send the styles to the portal.",
1954
- "props": [
1955
- {
1956
- "name": "helperText",
1957
- "description": "The helper text that is displayed on the left side.",
1958
- "type": "any",
1959
- "default": "",
1960
- "required": false
1961
- },
1962
- {
1963
- "name": "length",
1964
- "description": "Length of the current input value, coming from the parent component.\r\nUsed in the character counter section on the right side.",
1965
- "type": "any",
1966
- "default": "",
1967
- "required": false
1968
- },
1969
- {
1970
- "name": "maxLength",
1971
- "description": "Maximum length of the characters, defined on the parent component.\r\nUsed in the character counter section on the right side.",
1972
- "type": "any",
1973
- "default": "",
1974
- "required": false
1975
- },
1976
- {
1977
- "name": "invalid",
1978
- "description": "Turns `true`, when the parent component is invalid.\r\nFor example, when the parent component is `required` but is left empty.\r\nOr when the input format is invalid.",
1979
- "type": "any",
1980
- "default": "false",
1981
- "required": false
1982
- },
1983
- {
1984
- "name": "helperTextId",
1985
- "description": "Used by `aria-controls` and `aria-describedby` in the parent component.",
1986
- "type": "any",
1987
- "default": "",
1988
- "required": false
1989
- }
1990
- ]
1991
- },
1992
- {
1993
- "name": "LimelHotkey",
1994
- "source": {
1995
- "module": "lime-elements-vue",
1996
- "symbol": "LimelHotkey"
1997
- },
1998
- "description": "This is a display-only component used to visualize keyboard shortcuts.\r\nIt renders hotkey strings as styled `<kbd>` elements with\r\nplatform-aware glyphs (e.g. `⌘` on macOS, `⊞ Win` on Windows).\r\n\r\nIt does **not** listen for or handle any keyboard events.\r\nKeyboard event handling is the responsibility of the parent component\r\n(e.g. `limel-menu` or `limel-select`).",
1999
- "props": [
2000
- {
2001
- "name": "value",
2002
- "description": "The hotkey string to visualize, e.g. `\"meta+c\"` or `\"shift+enter\"`.",
2003
- "type": "any",
2004
- "default": "",
2005
- "required": false
2006
- },
2007
- {
2008
- "name": "disabled",
2009
- "description": "When `true`, the hotkey is rendered in a visually disabled state.",
2010
- "type": "any",
2011
- "default": "false",
2012
- "required": false
2013
- }
2014
- ]
2015
- },
2016
- {
2017
- "name": "LimelIcon",
2018
- "source": {
2019
- "module": "lime-elements-vue",
2020
- "symbol": "LimelIcon"
2021
- },
2022
- "description": ":::important\r\nTo install your icon set correctly, please read the [documentation here](#/).\r\n:::\r\n\r\nThe size and color of the icon is normally set in CSS, however there are a few\r\nstandard sizes defined that can be used with the `size` property.",
2023
- "props": [
2024
- {
2025
- "name": "size",
2026
- "description": "Size of the icon",
2027
- "type": "any",
2028
- "default": "",
2029
- "required": false
2030
- },
2031
- {
2032
- "name": "name",
2033
- "description": "Name of the icon",
2034
- "type": "any",
2035
- "default": "",
2036
- "required": false
2037
- },
2038
- {
2039
- "name": "badge",
2040
- "description": "Set to `true` to give the icon a round background with some padding.\r\nOnly works when the `size` attribute is also set.",
2041
- "type": "any",
2042
- "default": "",
2043
- "required": false
2044
- },
2045
- {
2046
- "name": "svgClass",
2047
- "description": "Sets the `class` attribute on the inner `<svg>` element rendered by\r\nthis component, replacing whatever class the source SVG shipped with.\r\n\r\nThis is meant for icons whose SVG file contains internal `<style>`\r\nblocks with rules that respond to classes — a single file that ships\r\nwith multiple visual states selectable via class names. Setting\r\n`svgClass` is how a consumer reaches across the shadow boundary to\r\npick which of those states is active.\r\n\r\nFor typical stateless icons, this prop has no visible effect.",
2048
- "type": "any",
2049
- "default": "",
2050
- "required": false
2051
- }
2052
- ]
2053
- },
2054
- {
2055
- "name": "LimelIconButton",
2056
- "source": {
2057
- "module": "lime-elements-vue",
2058
- "symbol": "LimelIconButton"
2059
- },
2060
- "description": "",
2061
- "props": [
2062
- {
2063
- "name": "icon",
2064
- "description": "The icon to display.",
2065
- "type": "any",
2066
- "default": "",
2067
- "required": false
2068
- },
2069
- {
2070
- "name": "elevated",
2071
- "description": "Set to `true` to give the button our standard \"elevated\" look, lifting\r\nit off the flat layout.",
2072
- "type": "any",
2073
- "default": "false",
2074
- "required": false
2075
- },
2076
- {
2077
- "name": "label",
2078
- "description": "The text to show to screenreaders and other assistive tech.\r\nIt is also displayed as a tooltip when the user hovers\r\nor focuses the button.",
2079
- "type": "any",
2080
- "default": "",
2081
- "required": false
2082
- },
2083
- {
2084
- "name": "helperLabel",
2085
- "description": "Additional helper text for the tooltip.\r\nExample usage can be a keyboard shortcut to activate\r\nthe function of the button.",
2086
- "type": "any",
2087
- "default": "",
2088
- "required": false
2089
- },
2090
- {
2091
- "name": "disabled",
2092
- "description": "Set to `true` to disable the button.",
2093
- "type": "any",
2094
- "default": "false",
2095
- "required": false
2096
- }
2097
- ]
2098
- },
2099
- {
2100
- "name": "LimelInfoTile",
2101
- "source": {
2102
- "module": "lime-elements-vue",
2103
- "symbol": "LimelInfoTile"
2104
- },
2105
- "description": "This component can be used on places such as a start page or a dashboard.\r\nIt offers features for visualizing aggregated data along with supplementary\r\ninformation.\r\n\r\nIf clicking on the component should navigate the user to\r\na new screen or web page, you need to provide a URL,\r\nusing the `link` property.",
2106
- "props": [
2107
- {
2108
- "name": "value",
2109
- "description": "A piece of text or number that is the main piece of information\r\nwhich the component is intended to visualize.",
2110
- "type": "any",
2111
- "default": "",
2112
- "required": false
2113
- },
2114
- {
2115
- "name": "icon",
2116
- "description": "Name of icon for the info tile.",
2117
- "type": "any",
2118
- "default": "",
2119
- "required": false
2120
- },
2121
- {
2122
- "name": "label",
2123
- "description": "The text to show below the info tile. Long labels will be truncated.",
2124
- "type": "any",
2125
- "default": "null",
2126
- "required": false
2127
- },
2128
- {
2129
- "name": "prefix",
2130
- "description": "A string of text that is visually placed before the value.",
2131
- "type": "any",
2132
- "default": "",
2133
- "required": false
2134
- },
2135
- {
2136
- "name": "suffix",
2137
- "description": "A string of text that is visually placed after the value.",
2138
- "type": "any",
2139
- "default": "",
2140
- "required": false
2141
- },
2142
- {
2143
- "name": "disabled",
2144
- "description": "Set to `true` if info tile is disabled.",
2145
- "type": "any",
2146
- "default": "false",
2147
- "required": false
2148
- },
2149
- {
2150
- "name": "reducedPresence",
2151
- "description": "Set to `true` to render the tile with a reduced visual presence —\r\nlower saturation and opacity, so the tile draws less attention.",
2152
- "type": "any",
2153
- "default": "false",
2154
- "required": false
2155
- },
2156
- {
2157
- "name": "badge",
2158
- "description": "If supplied, the info tile will display a notification badge.",
2159
- "type": "any",
2160
- "default": "",
2161
- "required": false
2162
- },
2163
- {
2164
- "name": "loading",
2165
- "description": "Set to `true` to put the component in the `loading` state.\r\nThis does _not_ disable the link. To do so, the\r\n`disabled` property should be set to `true` as well.",
2166
- "type": "any",
2167
- "default": "false",
2168
- "required": false
2169
- }
2170
- ]
2171
- },
2172
- {
2173
- "name": "LimelInputField",
2174
- "source": {
2175
- "module": "lime-elements-vue",
2176
- "symbol": "LimelInputField"
2177
- },
2178
- "description": "",
2179
- "props": [
2180
- {
2181
- "name": "disabled",
2182
- "description": "Set to `true` to disable the field.\r\nUse `disabled` to indicate that the field can normally be interacted\r\nwith, but is currently disabled. This tells the user that if certain\r\nrequirements are met, the field may become enabled again.",
2183
- "type": "any",
2184
- "default": "false",
2185
- "required": false
2186
- },
2187
- {
2188
- "name": "readonly",
2189
- "description": "Set to `true` to make the field read-only.\r\nUse `readonly` when the field is only there to present the data it holds,\r\nand will not become possible for the current user to edit.",
2190
- "type": "any",
2191
- "default": "false",
2192
- "required": false
2193
- },
2194
- {
2195
- "name": "invalid",
2196
- "description": "Set to `true` to indicate that the current value of the input field is\r\ninvalid.",
2197
- "type": "any",
2198
- "default": "false",
2199
- "required": false
2200
- },
2201
- {
2202
- "name": "label",
2203
- "description": "The input label.",
2204
- "type": "any",
2205
- "default": "",
2206
- "required": false
2207
- },
2208
- {
2209
- "name": "placeholder",
2210
- "description": "The placeholder text shown inside the input field, when the field is focused and empty.",
2211
- "type": "any",
2212
- "default": "",
2213
- "required": false
2214
- },
2215
- {
2216
- "name": "helperText",
2217
- "description": "Optional helper text to display below the input field when it has focus",
2218
- "type": "any",
2219
- "default": "",
2220
- "required": false
2221
- },
2222
- {
2223
- "name": "prefix",
2224
- "description": "A short piece of text to display before the value inside the input field.\r\nDisplayed for all types except `textarea`.",
2225
- "type": "any",
2226
- "default": "",
2227
- "required": false
2228
- },
2229
- {
2230
- "name": "suffix",
2231
- "description": "A short piece of text to display after the value inside the input field.\r\nDisplayed for all types except `textarea`.",
2232
- "type": "any",
2233
- "default": "",
2234
- "required": false
2235
- },
2236
- {
2237
- "name": "required",
2238
- "description": "Set to `true` to indicate that the field is required.",
2239
- "type": "any",
2240
- "default": "false",
2241
- "required": false
2242
- },
2243
- {
2244
- "name": "value",
2245
- "description": "The value of the field.",
2246
- "type": "any",
2247
- "default": "",
2248
- "required": false
2249
- },
2250
- {
2251
- "name": "trailingIcon",
2252
- "description": "Trailing icon to show to the far right in the field.",
2253
- "type": "any",
2254
- "default": "",
2255
- "required": false
2256
- },
2257
- {
2258
- "name": "leadingIcon",
2259
- "description": "Leading icon to show to the far left in the field.",
2260
- "type": "any",
2261
- "default": "",
2262
- "required": false
2263
- },
2264
- {
2265
- "name": "pattern",
2266
- "description": "Regular expression that the current value of the input field must match.\r\nNo forward slashes should be specified around the pattern.\r\nOnly used if type is `text`, `tel`, `email`, `url`, `urlAsText`,\r\n`password`, or `search`.",
2267
- "type": "any",
2268
- "default": "",
2269
- "required": false
2270
- },
2271
- {
2272
- "name": "type",
2273
- "description": "Type of input.\r\n\r\nNote** regarding type `url`: `limel-input` uses the native validation\r\nbuilt into the browser for many types of input fields. The native\r\nvalidation for `url` is very strict, and does not allow relative urls,\r\nnor any other formats that are not a \"fully qualified\" url. To allow\r\nsuch urls, use the type `urlAsText` instead. `urlAsText` works exactly\r\nlike `text` in all regards, except that it enables use of the `showLink`\r\nproperty.",
2274
- "type": "any",
2275
- "default": "'text'",
2276
- "required": false
2277
- },
2278
- {
2279
- "name": "formatNumber",
2280
- "description": "Set to `true` to format the current value of the input field only\r\nif the field is of type number.\r\nThe number format is determined by the current language of the browser.",
2281
- "type": "any",
2282
- "default": "true",
2283
- "required": false
2284
- },
2285
- {
2286
- "name": "step",
2287
- "description": "Defines which numeric values are valid and the increment/decrement interval.\r\nFor example, `step={0.1}` allows decimals and steps by 0.1.\r\nSet to `'any'` to allow any numeric value.\r\nOnly applies when `type` is `number`.",
2288
- "type": "any",
2289
- "default": "'any'",
2290
- "required": false
2291
- },
2292
- {
2293
- "name": "max",
2294
- "description": "Maximum allowed value if input type is `number`.",
2295
- "type": "any",
2296
- "default": "",
2297
- "required": false
2298
- },
2299
- {
2300
- "name": "min",
2301
- "description": "Minimum allowed value if input type is `number`.",
2302
- "type": "any",
2303
- "default": "",
2304
- "required": false
2305
- },
2306
- {
2307
- "name": "maxlength",
2308
- "description": "Maximum length of the value if type is `password`, `search`, `tel`,\r\n`text`, `url`, or `urlAsText`.",
2309
- "type": "any",
2310
- "default": "",
2311
- "required": false
2312
- },
2313
- {
2314
- "name": "minlength",
2315
- "description": "Minimum length of the value if type is `password`, `search`, `tel`,\r\n`text`, `url`, or `urlAsText`.",
2316
- "type": "any",
2317
- "default": "",
2318
- "required": false
2319
- },
2320
- {
2321
- "name": "showLink",
2322
- "description": "For inputs of type `email`, `tel`, `url`, and `urlAsText`, set this to\r\n`true` to show a trailing icon with a `mailto:`,`tel:`, or normal link,\r\nrespectively. The default icon can be overridden using the `trailingIcon`\r\nproperty.",
2323
- "type": "any",
2324
- "default": "false",
2325
- "required": false
2326
- },
2327
- {
2328
- "name": "locale",
2329
- "description": "The locale to use for formatting numbers.",
2330
- "type": "any",
2331
- "default": "globalConfig.defaultLocale",
2332
- "required": false
2333
- }
2334
- ]
2335
- },
2336
- {
2337
- "name": "LimelLinearProgress",
2338
- "source": {
2339
- "module": "lime-elements-vue",
2340
- "symbol": "LimelLinearProgress"
2341
- },
2342
- "description": "The linear progress component can be used to visualize the current state of a progress in a scale;\r\nfor example percentage of completion of a task.",
2343
- "props": [
2344
- {
2345
- "name": "language",
2346
- "description": "Defines the language for translations.\r\nWill translate the translatable strings on the components.",
2347
- "type": "any",
2348
- "default": "'en'",
2349
- "required": false
2350
- },
2351
- {
2352
- "name": "value",
2353
- "description": "The value of the progress bar. Should be between `0` and `1`.",
2354
- "type": "any",
2355
- "default": "0",
2356
- "required": false
2357
- },
2358
- {
2359
- "name": "indeterminate",
2360
- "description": "Puts the progress bar in an indeterminate state",
2361
- "type": "any",
2362
- "default": "false",
2363
- "required": false
2364
- },
2365
- {
2366
- "name": "accessibleLabel",
2367
- "description": "A label used to describe the purpose of the element to users\r\nof assistive technologies, like screen readers.\r\nIf not provided, the generic word of \"Progress bar\" will be used.",
2368
- "type": "any",
2369
- "default": "",
2370
- "required": false
2371
- }
2372
- ]
2373
- },
2374
- {
2375
- "name": "LimelList",
2376
- "source": {
2377
- "module": "lime-elements-vue",
2378
- "symbol": "LimelList"
2379
- },
2380
- "description": "",
2381
- "props": [
2382
- {
2383
- "name": "badgeIcons",
2384
- "description": "Set to `true` if the list should display larger icons with a background",
2385
- "type": "any",
2386
- "default": "",
2387
- "required": false
2388
- },
2389
- {
2390
- "name": "iconSize",
2391
- "description": "Size of the icons in the list",
2392
- "type": "any",
2393
- "default": "'small'",
2394
- "required": false
2395
- },
2396
- {
2397
- "name": "type",
2398
- "description": "The type of the list, omit to get a regular list. Available types are:\r\n`selectable`: regular list with single selection.\r\n`radio`: radio button list with single selection.\r\n`checkbox`: checkbox list with multiple selection.",
2399
- "type": "any",
2400
- "default": "",
2401
- "required": false
2402
- },
2403
- {
2404
- "name": "maxLinesSecondaryText",
2405
- "description": "By default, lists will display 3 lines of text, and then truncate the rest.\r\nConsumers can increase or decrease this number by specifying\r\n`maxLinesSecondaryText`. If consumer enters zero or negative\r\nnumbers we default to 1; and if they type decimals we round up.",
2406
- "type": "any",
2407
- "default": "3",
2408
- "required": false
2409
- }
2410
- ]
2411
- },
2412
- {
2413
- "name": "LimelListItem",
2414
- "source": {
2415
- "module": "lime-elements-vue",
2416
- "symbol": "LimelListItem"
2417
- },
2418
- "description": "This components displays the list item.\r\nThis centralizes styles and functionality, and helps reduce redundant code\r\nin consumer components such as `limel-list` and `limel-menu-list`.\r\n\r\n:::note\r\nThe component has `shadow: false`. There are a few reasons for it:\r\n1. This is to improve performance, and ensure that its internal elements are\r\nconsidered as internal parts of the consumer's DOM.\r\n2. The consumer does not need to implement the interactive styles\r\n(such as `visualize-keyboard-focus` mixin) on their own. Since there is no\r\nshadow DOM, our mixins can be applied directly to the `limel-list-item` elements,\r\nwithin the component's own styles.\r\n3. Most importantly, the MDCList checks the light DOM of each list item\r\nto find native inputs to decide the list mode (checkbox/radio).\r\nWith `shadow: true`, those inputs would be hidden inside the `limel-list-items`’s\r\nshadow DOM, so MDC wouldn’t detect them and therefore throw errors, when given\r\nan array index (for the items).\r\nWith `shadow: false`, the native `<input type=\"checkbox/radio\">` from this template\r\nwould be visible to MDC.\r\n:::",
2419
- "props": [
2420
- {
2421
- "name": "language",
2422
- "description": "Defines the language for translations.\r\nWill translate the translatable strings on the components.",
2423
- "type": "any",
2424
- "default": "'en'",
2425
- "required": false
2426
- },
2427
- {
2428
- "name": "value",
2429
- "description": "{@inheritdoc ListItem.value}",
2430
- "type": "any",
2431
- "default": "",
2432
- "required": false
2433
- },
2434
- {
2435
- "name": "text",
2436
- "description": "{@inheritdoc ListItem.text}",
2437
- "type": "any",
2438
- "default": "",
2439
- "required": false
2440
- },
2441
- {
2442
- "name": "secondaryText",
2443
- "description": "{@inheritdoc ListItem.secondaryText}",
2444
- "type": "any",
2445
- "default": "",
2446
- "required": false
2447
- },
2448
- {
2449
- "name": "disabled",
2450
- "description": "{@inheritdoc ListItem.disabled}",
2451
- "type": "any",
2452
- "default": "false",
2453
- "required": false
2454
- },
2455
- {
2456
- "name": "icon",
2457
- "description": "{@inheritdoc ListItem.icon}",
2458
- "type": "any",
2459
- "default": "",
2460
- "required": false
2461
- },
2462
- {
2463
- "name": "iconSize",
2464
- "description": "Size of the icon displayed for this item.",
2465
- "type": "any",
2466
- "default": "'small'",
2467
- "required": false
2468
- },
2469
- {
2470
- "name": "badgeIcon",
2471
- "description": "Set to `true` if the list should display larger icons with a background",
2472
- "type": "any",
2473
- "default": "false",
2474
- "required": false
2475
- },
2476
- {
2477
- "name": "selected",
2478
- "description": "{@inheritdoc ListItem.selected}",
2479
- "type": "any",
2480
- "default": "false",
2481
- "required": false
2482
- },
2483
- {
2484
- "name": "type",
2485
- "description": "The semantic role of the list item. This affects the ARIA role\r\nand the interaction behavior.\r\n\r\n- 'option' → selectable via click/Enter/Space, aria-selected\r\n- 'radio'/'checkbox' → selectable, aria-checked\r\n- 'menuitem'/'listitem' → activation only, no selection toggle",
2486
- "type": "any",
2487
- "default": "'listitem'",
2488
- "required": false
2489
- }
2490
- ]
2491
- },
2492
- {
2493
- "name": "LimelMarkdown",
2494
- "source": {
2495
- "module": "lime-elements-vue",
2496
- "symbol": "LimelMarkdown"
2497
- },
2498
- "description": "The Markdown component receives markdown syntax\r\nand renders it as HTML.\r\n\r\nA built-in set of lime-elements components is whitelisted by default\r\nand can be used directly in markdown content without any configuration.\r\nConsumers can extend this list via the `whitelist` prop or `limel-config`.\r\n\r\nWhen custom elements use JSON attribute values, any URL-bearing\r\nproperties (`href`, `src`, `cite`, `longDesc`) are automatically\r\nsanitized using the same protocol allowlists as rehype-sanitize.\r\nURLs with dangerous schemes (e.g. `javascript:`, `data:`) are\r\nremoved (with a console warning) to prevent script injection.",
2499
- "props": [
2500
- {
2501
- "name": "value",
2502
- "description": "The input text. Treated as GitHub Flavored Markdown, with the addition\r\nthat any included HTML will be parsed and rendered as HTML, rather than\r\nas text.",
2503
- "type": "any",
2504
- "default": "''",
2505
- "required": false
2506
- },
2507
- {
2508
- "name": "lazyLoadImages",
2509
- "description": "Enable lazy loading for images",
2510
- "type": "any",
2511
- "default": "false",
2512
- "required": false
2513
- },
2514
- {
2515
- "name": "removeEmptyParagraphs",
2516
- "description": "Set to `false` to preserve empty paragraphs before rendering.\r\nEmpty paragraphs are paragraphs that do not contain\r\nany meaningful content (text, images, etc.), or only contain\r\nwhitespace (`<br />` or `&nbsp;`).",
2517
- "type": "any",
2518
- "default": "true",
2519
- "required": false
2520
- },
2521
- {
2522
- "name": "adaptColorContrast",
2523
- "description": "Adapt rendered inline `color:` declarations to the surrounding\r\nsurface. After each markdown re-render the component walks the\r\nrendered DOM and removes any inline `color` whose contrast against\r\nthe resolved background falls below WCAG 3:1, letting the surface's\r\nthemed text color inherit through. Brand colors that already meet\r\ncontrast are left alone.\r\n\r\nDefault `false` so the component remains a neutral renderer; turn\r\nthis on for surfaces that render externally-authored content\r\n(e.g. imported email bodies) where the host application's theme\r\ndrives the surrounding text color.",
2524
- "type": "any",
2525
- "default": "false",
2526
- "required": false
2527
- }
2528
- ]
2529
- },
2530
- {
2531
- "name": "LimelMasonryLayout",
2532
- "source": {
2533
- "module": "lime-elements-vue",
2534
- "symbol": "LimelMasonryLayout"
2535
- },
2536
- "description": "A responsive masonry grid layout component.\r\n\r\nThis component arranges slotted elements into a masonry-style grid,\r\nwhere items are placed in the shortest column, resulting in a\r\nPinterest-like layout with minimal vertical gaps.\r\n\r\nThe component uses JavaScript to calculate positions, providing\r\nreliable cross-browser support — unlike CSS-only approaches such as\r\n`columns` or `grid-template-rows: masonry`, which have limited\r\nbrowser support or produce poor results.\r\n\r\nThe number of columns is determined automatically based on the\r\navailable width and the minimum column width.",
2537
- "props": [
2538
- {
2539
- "name": "ordered",
2540
- "description": "When `true`, items are placed left-to-right in DOM order.\r\nWhen `false` (default), items are placed in the shortest column.",
2541
- "type": "any",
2542
- "default": "false",
2543
- "required": false
2544
- }
2545
- ],
2546
- "slots": [
2547
- {
2548
- "name": "default",
2549
- "description": "Items to arrange in the masonry layout"
2550
- }
2551
- ]
2552
- },
2553
- {
2554
- "name": "LimelMenu",
2555
- "source": {
2556
- "module": "lime-elements-vue",
2557
- "symbol": "LimelMenu"
2558
- },
2559
- "description": "",
2560
- "props": [
2561
- {
2562
- "name": "disabled",
2563
- "description": "Sets the disabled state of the menu.",
2564
- "type": "any",
2565
- "default": "false",
2566
- "required": false
2567
- },
2568
- {
2569
- "name": "openDirection",
2570
- "description": "Decides the menu's location in relation to its trigger",
2571
- "type": "any",
2572
- "default": "'bottom-start'",
2573
- "required": false
2574
- },
2575
- {
2576
- "name": "surfaceWidth",
2577
- "description": "Decides the width of menu's dropdown",
2578
- "type": "any",
2579
- "default": "'inherit-from-items'",
2580
- "required": false
2581
- },
2582
- {
2583
- "name": "open",
2584
- "description": "Sets the open state of the menu.",
2585
- "type": "any",
2586
- "default": "false",
2587
- "required": false
2588
- },
2589
- {
2590
- "name": "badgeIcons",
2591
- "description": "Defines whether the menu should show badges.",
2592
- "type": "any",
2593
- "default": "false",
2594
- "required": false
2595
- },
2596
- {
2597
- "name": "gridLayout",
2598
- "description": "Renders list items in a grid layout, rather than a vertical list",
2599
- "type": "any",
2600
- "default": "false",
2601
- "required": false
2602
- },
2603
- {
2604
- "name": "loading",
2605
- "description": ":::warning Internal Use Only\r\nThis property is for internal use only. We need it for now, but want to\r\nfind a better implementation of the functionality it currently enables.\r\nIf and when we do so, this property will be removed without prior\r\nnotice. If you use it, your code _will_ break in the future.\r\n:::",
2606
- "type": "any",
2607
- "default": "false",
2608
- "required": false
2609
- },
2610
- {
2611
- "name": "searchPlaceholder",
2612
- "description": "Placeholder text for the search input field.",
2613
- "type": "any",
2614
- "default": "",
2615
- "required": false
2616
- },
2617
- {
2618
- "name": "emptyResultMessage",
2619
- "description": "Message to display when search returns 0 results.",
2620
- "type": "any",
2621
- "default": "",
2622
- "required": false
2623
- },
2624
- {
2625
- "name": "keepOpenOnSelect",
2626
- "description": "When `true`, the menu stays open after an item is selected.",
2627
- "type": "any",
2628
- "default": "false",
2629
- "required": false
2630
- }
2631
- ],
2632
- "slots": [
2633
- {
2634
- "name": "trigger",
2635
- "description": "Element to use as a trigger for the menu."
2636
- }
2637
- ]
2638
- },
2639
- {
2640
- "name": "LimelMenuItemMeta",
2641
- "source": {
2642
- "module": "lime-elements-vue",
2643
- "symbol": "LimelMenuItemMeta"
2644
- },
2645
- "description": "Meta content for menu list items\r\n\r\nThis sub-component is intended to be passed as `primaryComponent`\r\nto `limel-list-item`, when it is used in the menu list.\r\nIt includes command text, badge, and chevron, which are the\r\nfeatures of menu list items.",
2646
- "props": [
2647
- {
2648
- "name": "commandText",
2649
- "description": "Use to display optional keyboard shortcut or command hint, e.g. `⌘ + K`",
2650
- "type": "any",
2651
- "default": "",
2652
- "required": false
2653
- },
2654
- {
2655
- "name": "hotkey",
2656
- "description": "Hotkey to display. When provided, `commandText` is ignored.",
2657
- "type": "any",
2658
- "default": "",
2659
- "required": false
2660
- },
2661
- {
2662
- "name": "disabled",
2663
- "description": "Will be set to `true` when the menu item is disabled.",
2664
- "type": "any",
2665
- "default": "false",
2666
- "required": false
2667
- },
2668
- {
2669
- "name": "badge",
2670
- "description": "Optional badge value",
2671
- "type": "any",
2672
- "default": "",
2673
- "required": false
2674
- },
2675
- {
2676
- "name": "showChevron",
2677
- "description": "Shows a submenu chevron to indicate nested items",
2678
- "type": "any",
2679
- "default": "false",
2680
- "required": false
2681
- }
2682
- ]
2683
- },
2684
- {
2685
- "name": "LimelMenuList",
2686
- "source": {
2687
- "module": "lime-elements-vue",
2688
- "symbol": "LimelMenuList"
2689
- },
2690
- "description": "",
2691
- "props": [
2692
- {
2693
- "name": "badgeIcons",
2694
- "description": "Set to `true` if the list should display larger icons with a background",
2695
- "type": "any",
2696
- "default": "",
2697
- "required": false
2698
- },
2699
- {
2700
- "name": "iconSize",
2701
- "description": "Size of the icons in the list",
2702
- "type": "any",
2703
- "default": "'small'",
2704
- "required": false
2705
- }
2706
- ]
2707
- },
2708
- {
2709
- "name": "LimelMenuSurface",
2710
- "source": {
2711
- "module": "lime-elements-vue",
2712
- "symbol": "LimelMenuSurface"
2713
- },
2714
- "description": "",
2715
- "props": [
2716
- {
2717
- "name": "open",
2718
- "description": "True if the menu surface is open, false otherwise",
2719
- "type": "any",
2720
- "default": "false",
2721
- "required": false
2722
- }
2723
- ],
2724
- "slots": [
2725
- {
2726
- "name": "default",
2727
- "description": "Content to put inside the surface"
2728
- }
2729
- ]
2730
- },
2731
- {
2732
- "name": "LimelNotchedOutline",
2733
- "source": {
2734
- "module": "lime-elements-vue",
2735
- "symbol": "LimelNotchedOutline"
2736
- },
2737
- "description": "This is a private component, used to render a notched outline\r\naround all input elements that can have a floating label.\r\nInspired by Material Design's styles for input fields.\r\nWe use it in various components to unify styles and avoid\r\nrepeating code.\r\n\r\n:::note\r\nThe component has `shadow: false`. This is to improve performance,\r\nand ensure that its internal elements are considered as internal parts\r\nof the consumer's DOM. This way, the value `for` in `<label for=\"id-of-input-element\">`\r\nwould be correctly associated with the input element's `id`, in the consumer component.\r\n:::",
2738
- "props": [
2739
- {
2740
- "name": "required",
2741
- "description": "Set to `true` when the input element is required.\r\nThis applies proper visual styles, such as inclusion of an asterisk\r\nbeside the label.",
2742
- "type": "any",
2743
- "default": "false",
2744
- "required": false
2745
- },
2746
- {
2747
- "name": "readonly",
2748
- "description": "Set to `true` when the input element is readonly.\r\nThis applies proper visual styles, such as making the outline transparent.",
2749
- "type": "any",
2750
- "default": "false",
2751
- "required": false
2752
- },
2753
- {
2754
- "name": "invalid",
2755
- "description": "Set to `true` to indicate that the current value of the input element is\r\ninvalid. This applies proper visual styles, such as making the outlines red.",
2756
- "type": "any",
2757
- "default": "false",
2758
- "required": false
2759
- },
2760
- {
2761
- "name": "disabled",
2762
- "description": "Set to `true` to indicate that the input element is\r\ndisabled. This applies proper visual styles, such as making the outlines\r\nand the label transparent.",
2763
- "type": "any",
2764
- "default": "false",
2765
- "required": false
2766
- },
2767
- {
2768
- "name": "label",
2769
- "description": "Label to display for the input element.\r\n:::important\r\nNote that the input element of the consumer component will be\r\nlabeled by this label, using the `labelId` prop.\r\n:::",
2770
- "type": "any",
2771
- "default": "",
2772
- "required": false
2773
- },
2774
- {
2775
- "name": "labelId",
2776
- "description": "The `id` of the input element which should be\r\nlabeled by the provided label.",
2777
- "type": "any",
2778
- "default": "",
2779
- "required": false
2780
- },
2781
- {
2782
- "name": "hasValue",
2783
- "description": "Set to `true` when the user has entered a value for the input element,\r\nshrinking the label in size, and visually rendering it above the entered value.",
2784
- "type": "any",
2785
- "default": "false",
2786
- "required": false
2787
- },
2788
- {
2789
- "name": "hasLeadingIcon",
2790
- "description": "Set to `true` when the consumer element displays a leading icon.\r\nThis applies proper visual styles, such as rendering the label\r\ncorrectly placed beside the leading icon.",
2791
- "type": "any",
2792
- "default": "false",
2793
- "required": false
2794
- },
2795
- {
2796
- "name": "hasFloatingLabel",
2797
- "description": "Set to `true` when the consumer element needs to render the\r\nlabel above the input element, despite existence of a `value`.\r\nFor example in the `text-editor` or `limel-select`,\r\nwhere the default layout requires a floating label.",
2798
- "type": "any",
2799
- "default": "false",
2800
- "required": false
2801
- }
2802
- ]
2803
- },
2804
- {
2805
- "name": "LimelPicker",
2806
- "source": {
2807
- "module": "lime-elements-vue",
2808
- "symbol": "LimelPicker"
2809
- },
2810
- "description": "",
2811
- "props": [
2812
- {
2813
- "name": "disabled",
2814
- "description": "True if the picker should be disabled",
2815
- "type": "any",
2816
- "default": "false",
2817
- "required": false
2818
- },
2819
- {
2820
- "name": "readonly",
2821
- "description": "Set to `true` to disable adding and removing items,\r\nbut allow interaction with existing items.",
2822
- "type": "any",
2823
- "default": "false",
2824
- "required": false
2825
- },
2826
- {
2827
- "name": "label",
2828
- "description": "Text to display for the input field of the picker",
2829
- "type": "any",
2830
- "default": "",
2831
- "required": false
2832
- },
2833
- {
2834
- "name": "searchLabel",
2835
- "description": "Search label to display in the input field when searching",
2836
- "type": "any",
2837
- "default": "",
2838
- "required": false
2839
- },
2840
- {
2841
- "name": "helperText",
2842
- "description": "Optional helper text to display below the input field when it has focus",
2843
- "type": "any",
2844
- "default": "",
2845
- "required": false
2846
- },
2847
- {
2848
- "name": "leadingIcon",
2849
- "description": "Leading icon to show to the far left in the text field",
2850
- "type": "any",
2851
- "default": "",
2852
- "required": false
2853
- },
2854
- {
2855
- "name": "emptyResultMessage",
2856
- "description": "A message to display when the search returned an empty result.\r\n\r\nIf unset (or set to an empty string), the picker shows a\r\ndefault translated message (`No results matching \"X\"` in\r\nEnglish, where `X` is the current query) chosen by the\r\n`language` prop. Set this to override the default with custom\r\ntext — for example, when the picker's domain calls for more\r\nspecific wording like \"No matching participants found\".",
2857
- "type": "any",
2858
- "default": "",
2859
- "required": false
2860
- },
2861
- {
2862
- "name": "language",
2863
- "description": "Defines the language for translations. Affects the labels\r\nrendered by the picker itself, such as the \"Results matching\"\r\nheader shown above the suggestion list while the user is typing.",
2864
- "type": "any",
2865
- "default": "'en'",
2866
- "required": false
2867
- },
2868
- {
2869
- "name": "required",
2870
- "description": "True if the control requires a value",
2871
- "type": "any",
2872
- "default": "false",
2873
- "required": false
2874
- },
2875
- {
2876
- "name": "invalid",
2877
- "description": "Set to `true` to indicate that the current value of the input field is\r\ninvalid.",
2878
- "type": "any",
2879
- "default": "false",
2880
- "required": false
2881
- },
2882
- {
2883
- "name": "multiple",
2884
- "description": "True if multiple values are allowed",
2885
- "type": "any",
2886
- "default": "false",
2887
- "required": false
2888
- },
2889
- {
2890
- "name": "delimiter",
2891
- "description": "Sets delimiters between chips. Works only when `multiple` is `true`.",
2892
- "type": "any",
2893
- "default": "null",
2894
- "required": false
2895
- },
2896
- {
2897
- "name": "actionPosition",
2898
- "description": "Position of the custom static actions in the picker's results dropdown.\r\nCan be set to `'top'` or `'bottom'`.",
2899
- "type": "any",
2900
- "default": "'bottom'",
2901
- "required": false
2902
- },
2903
- {
2904
- "name": "actionScrollBehavior",
2905
- "description": "Scroll behavior of the custom static actions, when user scrolls\r\nin the picker's results dropdown. Can be set to `'scroll'` which means\r\nthe action items will scroll together with the list, or `'sticky'` which\r\nretains their position at the top or bottom of the drop down while\r\nscrolling.",
2906
- "type": "any",
2907
- "default": "'sticky'",
2908
- "required": false
2909
- },
2910
- {
2911
- "name": "badgeIcons",
2912
- "description": "Whether badge icons should be used in the result list or not",
2913
- "type": "any",
2914
- "default": "false",
2915
- "required": false
2916
- }
2917
- ]
2918
- },
2919
- {
2920
- "name": "LimelPopover",
2921
- "source": {
2922
- "module": "lime-elements-vue",
2923
- "symbol": "LimelPopover"
2924
- },
2925
- "description": "A popover is an impermanent layer that is displayed on top of other content\r\nwhen user taps an element that triggers the popover. This element can be\r\npractically anything, a button, piece of text, and icon, etc.\r\n\r\nPopovers are nonmodal, thus they don't have a semi-transparent backdrop layer\r\nthat darkens the content below them. Also for the same reason, they can be\r\ndismissed by tapping or clicking another part of the screen, but not by a\r\nclicking a button or link on the popover itself.\r\n\r\n## Usage\r\nUse a popover to show **options** or **information** related to the trigger\r\nonscreen. A typical use case for popovers is a tooltip, in which you show\r\nhelp text or contextual information to users.\r\n\r\nPopovers are most appropriate on larger screens but can be used on smaller\r\nscreens too, as long as their content is responsive and takes into account\r\nthe context they are displayed on.\r\n\r\nWhen a popover is displayed, interactions with other controls are blocked,\r\nuntil user dismisses the popover.\r\n\r\n\r\n## Layout\r\nPopovers has only one slot in which you can import a custom web-component.\r\n\r\n:::note\r\nYou must make sure that web-components that you import into the slot has\r\na `width: 100%;` style so that it can horizontally stretch across the popover.\r\n\r\nHowever, `width` of the popover can be controlled by specifying a CSS variable\r\nof `--popover-surface-width`. If you don't specify any width, the popover\r\nwill grow as wide as its content.\r\n:::\r\n\r\n:::important\r\nDo not make a popover too big. They should never take over the entire screen.\r\nIf your content is that big, you should probably be using a Modal instead.\r\n:::",
2926
- "props": [
2927
- {
2928
- "name": "open",
2929
- "description": "True if the content within the popover should be visible",
2930
- "type": "any",
2931
- "default": "false",
2932
- "required": false
2933
- },
2934
- {
2935
- "name": "openDirection",
2936
- "description": "Decides the popover's location in relation to its trigger",
2937
- "type": "any",
2938
- "default": "",
2939
- "required": false
2940
- }
2941
- ],
2942
- "slots": [
2943
- {
2944
- "name": "default",
2945
- "description": "Content to put inside the surface"
2946
- }
2947
- ]
2948
- },
2949
- {
2950
- "name": "LimelPopoverSurface",
2951
- "source": {
2952
- "module": "lime-elements-vue",
2953
- "symbol": "LimelPopoverSurface"
2954
- },
2955
- "description": "",
2956
- "props": [],
2957
- "slots": [
2958
- {
2959
- "name": "default",
2960
- "description": "Content to put inside the surface"
2961
- }
2962
- ]
2963
- },
2964
- {
2965
- "name": "LimelPortal",
2966
- "source": {
2967
- "module": "lime-elements-vue",
2968
- "symbol": "LimelPortal"
2969
- },
2970
- "description": "The portal component provides a way to render children into a DOM node that\r\nexist outside the DOM hierarchy of the parent component.\r\n\r\nWhen the limel-portal component is used, it creates a new DOM node (a div element)\r\nand appends it to a parent element (by default, the body of the document).\r\nThe child elements of the limel-portal are then moved from\r\ntheir original location in the DOM to this new div element.\r\n\r\nThis technique is often used to overcome CSS stacking context issues,\r\nor to render UI elements like modals, dropdowns, tooltips, etc.,\r\nthat need to visually \"break out\" of their container.\r\n\r\nUsing this component, we ensure that the content is always rendered in the\r\ncorrect position, and never covers its own trigger, or another component\r\nthat is opened in the stacking layer. This way, we don't need to worry about\r\nz-indexes, or other stacking context issues.\r\n\r\n:::important\r\nThere are some caveats when using this component\r\n\r\n1. Events might not bubble up as expected since the content is moved out to\r\nanother DOM node.\r\n2. Any styling that is applied to content from the parent will be lost, if the\r\ncontent is just another web-component it will work without any issues.\r\nAlternatively, use the `style=\"\"` html attribute.\r\n3. Any component that is placed inside the container must have a style of\r\n`max-height: inherit`. This ensures that its placement is calculated\r\ncorrectly in relation to the trigger, and that it never covers its own\r\ntrigger.\r\n4. When the node is moved in the DOM, `disconnectedCallback` and\r\n`connectedCallback` will be invoked, so if `disconnectedCallback` is used\r\nto do any tear-down, the appropriate setup will have to be done again on\r\n`connectedCallback`.\r\n:::",
2971
- "props": [
2972
- {
2973
- "name": "openDirection",
2974
- "description": "Decides which direction the portal content should open.",
2975
- "type": "any",
2976
- "default": "'bottom'",
2977
- "required": false
2978
- },
2979
- {
2980
- "name": "position",
2981
- "description": "Position of the content.",
2982
- "type": "any",
2983
- "default": "'absolute'",
2984
- "required": false
2985
- },
2986
- {
2987
- "name": "containerId",
2988
- "description": "A unique ID.",
2989
- "type": "any",
2990
- "default": "",
2991
- "required": false
2992
- },
2993
- {
2994
- "name": "inheritParentWidth",
2995
- "description": "Used to make a dropdown have the same width as the trigger, for example\r\nin `limel-picker`.",
2996
- "type": "any",
2997
- "default": "false",
2998
- "required": false
2999
- },
3000
- {
3001
- "name": "visible",
3002
- "description": "True if the content within the portal should be visible.\r\n\r\nIf the content is from within a dialog for instance, this can be set to\r\ntrue from false when the dialog opens to position the content properly.",
3003
- "type": "any",
3004
- "default": "false",
3005
- "required": false
3006
- }
3007
- ],
3008
- "slots": [
3009
- {
3010
- "name": "default",
3011
- "description": "Content to put inside the portal"
3012
- }
3013
- ]
3014
- },
3015
- {
3016
- "name": "LimelProfilePicture",
3017
- "source": {
3018
- "module": "lime-elements-vue",
3019
- "symbol": "LimelProfilePicture"
3020
- },
3021
- "description": "This component displays a profile picture, while allowing the user\r\nto change it via a file input or drag-and-drop.\r\n\r\nIt supports client-side image resizing and conversion,\r\nas well as a simple lazy-loading mechanism.",
3022
- "props": [
3023
- {
3024
- "name": "language",
3025
- "description": "Defines the language for translations.\r\nWill translate the translatable strings on the components.",
3026
- "type": "any",
3027
- "default": "'en'",
3028
- "required": false
3029
- },
3030
- {
3031
- "name": "label",
3032
- "description": "Accessible label for the the browse button.",
3033
- "type": "any",
3034
- "default": "",
3035
- "required": false
3036
- },
3037
- {
3038
- "name": "icon",
3039
- "description": "Placeholder icon of the component, displayed when no image is present.",
3040
- "type": "any",
3041
- "default": "'user'",
3042
- "required": false
3043
- },
3044
- {
3045
- "name": "helperText",
3046
- "description": "Helper text shown as a tooltip on hover or focus.",
3047
- "type": "any",
3048
- "default": "",
3049
- "required": false
3050
- },
3051
- {
3052
- "name": "disabled",
3053
- "description": "Disables user interaction.\r\nPrevents uploading new pictures or removing existing ones.",
3054
- "type": "any",
3055
- "default": "false",
3056
- "required": false
3057
- },
3058
- {
3059
- "name": "readonly",
3060
- "description": "Readonly prevents changing the value but allows interaction like focus.",
3061
- "type": "any",
3062
- "default": "false",
3063
- "required": false
3064
- },
3065
- {
3066
- "name": "required",
3067
- "description": "Marks the control as required.",
3068
- "type": "any",
3069
- "default": "false",
3070
- "required": false
3071
- },
3072
- {
3073
- "name": "invalid",
3074
- "description": "Marks the control as invalid.",
3075
- "type": "any",
3076
- "default": "false",
3077
- "required": false
3078
- },
3079
- {
3080
- "name": "loading",
3081
- "description": "Set to `true` to put the component in the `loading` state,\r\nand render an indeterminate progress indicator inside.\r\nThis does _not_ disable the interactivity of the component!",
3082
- "type": "any",
3083
- "default": "false",
3084
- "required": false
3085
- },
3086
- {
3087
- "name": "value",
3088
- "description": "Current image to display. Either a URL string or a `FileInfo` with an href.",
3089
- "type": "any",
3090
- "default": "",
3091
- "required": false
3092
- },
3093
- {
3094
- "name": "imageFit",
3095
- "description": "How the image should fit within the container.\r\n- `cover` will fill the container and crop excess parts.\r\n- `contain` will scale the image to fit within the container without cropping.",
3096
- "type": "any",
3097
- "default": "'cover'",
3098
- "required": false
3099
- },
3100
- {
3101
- "name": "accept",
3102
- "description": "A comma-separated list of accepted file types.",
3103
- "type": "any",
3104
- "default": "'image/jpeg,image/png,image/heic,.jpg,.jpeg,.png,.heic'",
3105
- "required": false
3106
- }
3107
- ]
3108
- },
3109
- {
3110
- "name": "LimelProgressFlow",
3111
- "source": {
3112
- "module": "lime-elements-vue",
3113
- "symbol": "LimelProgressFlow"
3114
- },
3115
- "description": "",
3116
- "props": [
3117
- {
3118
- "name": "disabled",
3119
- "description": "Set to `true` to disable the progress flow.\r\nUse `disabled` to indicate that the component can normally be interacted\r\nwith, but is currently disabled. This tells the user that if certain\r\nrequirements are met, the field may become enabled again.",
3120
- "type": "any",
3121
- "default": "false",
3122
- "required": false
3123
- },
3124
- {
3125
- "name": "readonly",
3126
- "description": "Disables the progress flow when `true`.\r\nThis does not visualize the component that much differently.\r\nBut since the component does not provide any feedback that users can\r\ninteract with the component, it makes it perfect for illustrative and\r\ninformative porpuses.",
3127
- "type": "any",
3128
- "default": "false",
3129
- "required": false
3130
- }
3131
- ]
3132
- },
3133
- {
3134
- "name": "LimelProgressFlowItem",
3135
- "source": {
3136
- "module": "lime-elements-vue",
3137
- "symbol": "LimelProgressFlowItem"
3138
- },
3139
- "description": "",
3140
- "props": [
3141
- {
3142
- "name": "disabled",
3143
- "description": "True if the flow item should be disabled",
3144
- "type": "any",
3145
- "default": "false",
3146
- "required": false
3147
- },
3148
- {
3149
- "name": "readonly",
3150
- "description": "True if the flow item should be readonly",
3151
- "type": "any",
3152
- "default": "false",
3153
- "required": false
3154
- },
3155
- {
3156
- "name": "currentStep",
3157
- "description": "True for current step",
3158
- "type": "any",
3159
- "default": "false",
3160
- "required": false
3161
- }
3162
- ]
3163
- },
3164
- {
3165
- "name": "LimelProsemirrorAdapter",
3166
- "source": {
3167
- "module": "lime-elements-vue",
3168
- "symbol": "LimelProsemirrorAdapter"
3169
- },
3170
- "description": "The ProseMirror adapter offers a rich text editing experience with markdown support.\r\n[Read more...](https://prosemirror.net/)",
3171
- "props": [
3172
- {
3173
- "name": "contentType",
3174
- "description": "The type of content that the editor should handle and emit, defaults to `markdown`\r\n\r\nAssumed to be set only once, so not reactive to changes",
3175
- "type": "any",
3176
- "default": "'markdown'",
3177
- "required": false
3178
- },
3179
- {
3180
- "name": "value",
3181
- "description": "The value of the editor, expected to be markdown",
3182
- "type": "any",
3183
- "default": "",
3184
- "required": false
3185
- },
3186
- {
3187
- "name": "language",
3188
- "description": "Defines the language for translations.",
3189
- "type": "any",
3190
- "default": "",
3191
- "required": false
3192
- },
3193
- {
3194
- "name": "disabled",
3195
- "description": "Set to `true` to disable the field.\r\nUse `disabled` to indicate that the field can normally be interacted\r\nwith, but is currently disabled. This tells the user that if certain\r\nrequirements are met, the field may become enabled again.",
3196
- "type": "any",
3197
- "default": "false",
3198
- "required": false
3199
- },
3200
- {
3201
- "name": "ui",
3202
- "description": "Specifies the visual appearance of the editor.",
3203
- "type": "any",
3204
- "default": "'standard'",
3205
- "required": false
3206
- }
3207
- ]
3208
- },
3209
- {
3210
- "name": "LimelRadioButton",
3211
- "source": {
3212
- "module": "lime-elements-vue",
3213
- "symbol": "LimelRadioButton"
3214
- },
3215
- "description": "This is a low-level private component that renders individual radio button elements.\r\nIt's used internally by the list-item component to render radio buttons when\r\n`type=\"radio\"` is specified.\r\n\r\n## Usage in the Library\r\n\r\nThis template is primarily used by:\r\n- `limel-list` component when `type=\"radio\"`\r\n- `limel-radio-button-group` component (which wraps `limel-list`)\r\n\r\n## Why This Exists\r\n\r\nWhile we have `limel-radio-button-group` for most use cases, this template provides\r\nthe actual radio button HTML structure with proper MDC classes and accessibility\r\nattributes. It ensures consistent styling and behavior across all radio button\r\nimplementations in the library.\r\n\r\n## Design Philosophy\r\n\r\nThis follows the principle that individual radio buttons should not be standalone\r\ncomponents, as a single radio button is never useful in a UI. Instead, this template\r\nis used to build groups of radio buttons through higher-level components.\r\n\r\nHowever, since this is a private component, consumers who need to use a radio button\r\noutside of the context of a list or group, can still use the `limel-radio-button`\r\ncomponent directly according to in their UI needs.",
3216
- "props": [
3217
- {
3218
- "name": "checked",
3219
- "description": "Indicates whether the radio button is checked.",
3220
- "type": "any",
3221
- "default": "",
3222
- "required": false
3223
- },
3224
- {
3225
- "name": "disabled",
3226
- "description": "Disables the radio button when set to `true`.",
3227
- "type": "any",
3228
- "default": "",
3229
- "required": false
3230
- },
3231
- {
3232
- "name": "id",
3233
- "description": "Associates the internal input with an external label.",
3234
- "type": "any",
3235
- "default": "",
3236
- "required": true
3237
- },
3238
- {
3239
- "name": "label",
3240
- "description": "Visual label shown next to the radio button.",
3241
- "type": "any",
3242
- "default": "",
3243
- "required": false
3244
- }
3245
- ]
3246
- },
3247
- {
3248
- "name": "LimelRadioButtonGroup",
3249
- "source": {
3250
- "module": "lime-elements-vue",
3251
- "symbol": "LimelRadioButtonGroup"
3252
- },
3253
- "description": "The Radio Button component provides a convenient way to create a group of radio buttons\r\nfrom an array of options. Radio buttons allow users to select a single option from\r\nmultiple choices, making them ideal for exclusive selections.\r\n\r\n:::note\r\nA single radio button is never useful in a UI. Radio buttons should always come in groups\r\nof at least 2 options where only one can be selected at a time.\r\n:::",
3254
- "props": [
3255
- {
3256
- "name": "disabled",
3257
- "description": "Disables all radio buttons when `true`",
3258
- "type": "any",
3259
- "default": "false",
3260
- "required": false
3261
- },
3262
- {
3263
- "name": "badgeIcons",
3264
- "description": "Set to `true` if the radio button group should display larger icons with a background",
3265
- "type": "any",
3266
- "default": "",
3267
- "required": false
3268
- },
3269
- {
3270
- "name": "maxLinesSecondaryText",
3271
- "description": "By default, lists will display 3 lines of text, and then truncate the rest.\r\nConsumers can increase or decrease this number by specifying\r\n`maxLinesSecondaryText`. If consumer enters zero or negative\r\nnumbers we default to 1; and if they type decimals we round up.",
3272
- "type": "any",
3273
- "default": "3",
3274
- "required": false
3275
- }
3276
- ]
3277
- },
3278
- {
3279
- "name": "LimelSelect",
3280
- "source": {
3281
- "module": "lime-elements-vue",
3282
- "symbol": "LimelSelect"
3283
- },
3284
- "description": "",
3285
- "props": [
3286
- {
3287
- "name": "disabled",
3288
- "description": "Set to `true` to make the field disabled.\r\nand visually shows that the `select` component is editable but disabled.\r\nThis tells the users that if certain requirements are met,\r\nthe component may become interactable.",
3289
- "type": "any",
3290
- "default": "false",
3291
- "required": false
3292
- },
3293
- {
3294
- "name": "readonly",
3295
- "description": "Set to `true` to make the field read-only.\r\nThis visualizes the component slightly differently.\r\nBut shows no visual sign indicating that the component is disabled\r\nor can ever become interactable.",
3296
- "type": "any",
3297
- "default": "false",
3298
- "required": false
3299
- },
3300
- {
3301
- "name": "invalid",
3302
- "description": "Set to `true` to indicate that the current value of the select is\r\ninvalid.",
3303
- "type": "any",
3304
- "default": "",
3305
- "required": false
3306
- },
3307
- {
3308
- "name": "required",
3309
- "description": "True if the control requires a value.",
3310
- "type": "any",
3311
- "default": "false",
3312
- "required": false
3313
- },
3314
- {
3315
- "name": "label",
3316
- "description": "Text to display next to the select.",
3317
- "type": "any",
3318
- "default": "",
3319
- "required": false
3320
- },
3321
- {
3322
- "name": "helperText",
3323
- "description": "Optional helper text to display below the input field when it has focus.",
3324
- "type": "any",
3325
- "default": "",
3326
- "required": false
3327
- },
3328
- {
3329
- "name": "multiple",
3330
- "description": "Set to `true` to allow multiple values to be selected.",
3331
- "type": "any",
3332
- "default": "false",
3333
- "required": false
3334
- }
3335
- ]
3336
- },
3337
- {
3338
- "name": "LimelShortcut",
3339
- "source": {
3340
- "module": "lime-elements-vue",
3341
- "symbol": "LimelShortcut"
3342
- },
3343
- "description": "This component can be used on places such as a start page or a dashboard.\r\nClicking on the component should navigate the user to a new screen,\r\nto which you need to provide a URL, by specifying an `href` for the `link` property.\r\n\r\nBy default, this navigation will happen within the same browser tab.\r\nHowever, it is possible to override that behavior, by specifying a `target`\r\nfor the `link` property",
3344
- "props": [
3345
- {
3346
- "name": "icon",
3347
- "description": "Name of icon for the shortcut.",
3348
- "type": "any",
3349
- "default": "",
3350
- "required": false
3351
- },
3352
- {
3353
- "name": "label",
3354
- "description": "The text to show below the shortcut. Long label will be truncated.",
3355
- "type": "any",
3356
- "default": "null",
3357
- "required": false
3358
- },
3359
- {
3360
- "name": "disabled",
3361
- "description": "Set to `true` if shortcut is disabled.",
3362
- "type": "any",
3363
- "default": "false",
3364
- "required": false
3365
- },
3366
- {
3367
- "name": "badge",
3368
- "description": "If specified, will display a notification badge\r\non the shortcut.",
3369
- "type": "any",
3370
- "default": "",
3371
- "required": false
3372
- }
3373
- ]
3374
- },
3375
- {
3376
- "name": "LimelSlider",
3377
- "source": {
3378
- "module": "lime-elements-vue",
3379
- "symbol": "LimelSlider"
3380
- },
3381
- "description": "",
3382
- "props": [
3383
- {
3384
- "name": "disabled",
3385
- "description": "Disables the slider when `true`,\r\nand visually shows that the field is editable but disabled.\r\nThis tells the users that if certain requirements are met,\r\nthe slider may become interactable.",
3386
- "type": "any",
3387
- "default": "false",
3388
- "required": false
3389
- },
3390
- {
3391
- "name": "readonly",
3392
- "description": "Disables the slider when `true`. This visualizes the slider slightly differently.\r\nBut shows no visual sign indicating that the slider field\r\nis disabled or can ever become interactable.",
3393
- "type": "any",
3394
- "default": "false",
3395
- "required": false
3396
- },
3397
- {
3398
- "name": "factor",
3399
- "description": "Default value: 1.\r\nThe factor that the properties `value`, `valuemax`, `valuemin`, and\r\n`step` are multiplied by. On `change` divides the value by the factor,\r\nso the original format stays the same.",
3400
- "type": "any",
3401
- "default": "1",
3402
- "required": false
3403
- },
3404
- {
3405
- "name": "label",
3406
- "description": "Label to display next to the input",
3407
- "type": "any",
3408
- "default": "",
3409
- "required": false
3410
- },
3411
- {
3412
- "name": "helperText",
3413
- "description": "Optional helper text to display below the slider",
3414
- "type": "any",
3415
- "default": "",
3416
- "required": false
3417
- },
3418
- {
3419
- "name": "required",
3420
- "description": "Set to `true` to indicate that the slider is required.",
3421
- "type": "any",
3422
- "default": "false",
3423
- "required": false
3424
- },
3425
- {
3426
- "name": "invalid",
3427
- "description": "Set to `true` to indicate that the current value of the slider is invalid.",
3428
- "type": "any",
3429
- "default": "false",
3430
- "required": false
3431
- },
3432
- {
3433
- "name": "displaysPercentageColors",
3434
- "description": "Set to `true` to display percentage-based colors on the slider.\r\nThe colors change in intervals of 10% as the value changes,\r\ncreating a color spectrum from red (low) → orange → yellow → green → teal (high).",
3435
- "type": "any",
3436
- "default": "false",
3437
- "required": false
3438
- },
3439
- {
3440
- "name": "unit",
3441
- "description": "Unit to display next to the value",
3442
- "type": "any",
3443
- "default": "''",
3444
- "required": false
3445
- },
3446
- {
3447
- "name": "value",
3448
- "description": "The value of the input",
3449
- "type": "any",
3450
- "default": "",
3451
- "required": false
3452
- },
3453
- {
3454
- "name": "valuemax",
3455
- "description": "The maximum value allowed",
3456
- "type": "any",
3457
- "default": "100",
3458
- "required": false
3459
- },
3460
- {
3461
- "name": "valuemin",
3462
- "description": "The minimum value allowed",
3463
- "type": "any",
3464
- "default": "0",
3465
- "required": false
3466
- },
3467
- {
3468
- "name": "step",
3469
- "description": "The stepping interval to use when adjusting the value",
3470
- "type": "any",
3471
- "default": "",
3472
- "required": false
3473
- }
3474
- ]
3475
- },
3476
- {
3477
- "name": "LimelSnackbar",
3478
- "source": {
3479
- "module": "lime-elements-vue",
3480
- "symbol": "LimelSnackbar"
3481
- },
3482
- "description": "A Snackbar –also known as \"Toast\"– is used to inform the end user\r\nabout an action or a process in the system.\r\nThe information could vary from announcing that a process has just started,\r\nis taking place now, has ended, or has been interrupted or canceled.\r\n\r\nThe information that you provide using a snackbar should be:\r\n- temporary\r\n- contextual\r\n- short\r\n- and most importantly, ignorable.\r\n\r\nIt means if the user misses the information, it shouldn't be a big deal.\r\n\r\n:::note\r\nIf the information you want to display has a higher importance or priority,\r\nand you need to make sure that the user takes an action to dismiss it,\r\nconsider using the [Banner](#/component/limel-banner/) component instead.\r\nFor more complex interactions and for delivering more detailed information,\r\n[Dialog](#/component/limel-dialog/) is a better choice.\r\n:::",
3483
- "props": [
3484
- {
3485
- "name": "open",
3486
- "description": "`true` if the snackbar is open, `false` otherwise.",
3487
- "type": "any",
3488
- "default": "false",
3489
- "required": false
3490
- },
3491
- {
3492
- "name": "message",
3493
- "description": "The message to display.\r\n\r\nSupports [Markdown](#/component/limel-markdown/) for light inline\r\nemphasis such as `**bold**` or `*italic*`. See the Markdown example\r\nbelow for UX guidance.\r\n\r\n:::important\r\nWhen the message is composed from dynamic content such as user\r\ninput or translated strings, escape Markdown-sensitive characters\r\n(`*`, `_`, backtick, `#`, `[`, `]`) with a leading backslash to\r\nprevent unintended formatting.\r\n:::",
3494
- "type": "any",
3495
- "default": "",
3496
- "required": false
3497
- },
3498
- {
3499
- "name": "timeout",
3500
- "description": "The amount of time in milliseconds to show the snackbar.\r\nIf set to `-1`, the snackbar will be persistent.\r\nThis means:\r\n- either the end user will need to close it manually,\r\nwhich requires the `dismissible` property to be set to `true`.\r\n- or the snackbar needs to be closed programmatically.",
3501
- "type": "any",
3502
- "default": "5000",
3503
- "required": false
3504
- },
3505
- {
3506
- "name": "actionText",
3507
- "description": "The text to display for the action button.",
3508
- "type": "any",
3509
- "default": "",
3510
- "required": false
3511
- },
3512
- {
3513
- "name": "dismissible",
3514
- "description": "When `true` displays a dismiss button on the snackbar,\r\nallowing users to close it.",
3515
- "type": "any",
3516
- "default": "true",
3517
- "required": false
3518
- },
3519
- {
3520
- "name": "multiline",
3521
- "description": "Whether to show the snackbar with space for multiple lines of text",
3522
- "type": "any",
3523
- "default": "",
3524
- "required": false
3525
- },
3526
- {
3527
- "name": "language",
3528
- "description": "Defines the language for translations.",
3529
- "type": "any",
3530
- "default": "'en'",
3531
- "required": false
3532
- }
3533
- ]
3534
- },
3535
- {
3536
- "name": "LimelSpinner",
3537
- "source": {
3538
- "module": "lime-elements-vue",
3539
- "symbol": "LimelSpinner"
3540
- },
3541
- "description": "",
3542
- "props": [
3543
- {
3544
- "name": "size",
3545
- "description": "Determines the size of the spinner.",
3546
- "type": "any",
3547
- "default": "'mini'",
3548
- "required": false
3549
- },
3550
- {
3551
- "name": "limeBranded",
3552
- "description": "Gives the spinner the shape of Lime Technologies' logo",
3553
- "type": "any",
3554
- "default": "false",
3555
- "required": false
3556
- }
3557
- ]
3558
- },
3559
- {
3560
- "name": "LimelSplitButton",
3561
- "source": {
3562
- "module": "lime-elements-vue",
3563
- "symbol": "LimelSplitButton"
3564
- },
3565
- "description": "A split button is a button with two components:\r\na button and a side-menu attached to it.\r\n\r\nClicking on the button runs a default action,\r\nand clicking on the arrow opens up a list of other possible actions.\r\n\r\n:::warning\r\n- Never use a split button for navigation purposes, such as going to next page.\r\nThe button should only be used for performing commands!\r\n- Never use this component instead of a Select or Menu component!\r\n:::",
3566
- "props": [
3567
- {
3568
- "name": "label",
3569
- "description": "The text to show on the default action part of the button.",
3570
- "type": "any",
3571
- "default": "",
3572
- "required": false
3573
- },
3574
- {
3575
- "name": "primary",
3576
- "description": "Set to `true` to make the button primary.",
3577
- "type": "any",
3578
- "default": "false",
3579
- "required": false
3580
- },
3581
- {
3582
- "name": "icon",
3583
- "description": "Set icon for the button",
3584
- "type": "any",
3585
- "default": "",
3586
- "required": false
3587
- },
3588
- {
3589
- "name": "disabled",
3590
- "description": "Set to `true` to disable the button.",
3591
- "type": "any",
3592
- "default": "false",
3593
- "required": false
3594
- },
3595
- {
3596
- "name": "loading",
3597
- "description": "Set to `true` to put the button in the `loading` state.\r\nThis also disables the button.",
3598
- "type": "any",
3599
- "default": "false",
3600
- "required": false
3601
- },
3602
- {
3603
- "name": "loadingFailed",
3604
- "description": "Set to `true` to indicate failure instead of success when the button is\r\nno longer in the `loading` state.",
3605
- "type": "any",
3606
- "default": "false",
3607
- "required": false
3608
- }
3609
- ]
3610
- },
3611
- {
3612
- "name": "LimelSwitch",
3613
- "source": {
3614
- "module": "lime-elements-vue",
3615
- "symbol": "LimelSwitch"
3616
- },
3617
- "description": "The Switch component is a fundamental element in UI design that serves as a toggle switch\r\nto control the state of a specific setting or option in an application or website.\r\nThe two distinct positions of the Switch are visually indicative of the two states:\r\nON and OFF; making it easy for users to understand the current state of the controlled feature.\r\n\r\nThe Switch component is widely used in user interfaces to enable users to\r\nquickly and intuitively change binary settings.\r\n\r\n:::important\r\nCheckboxes are sometimes used interchangeably with switches in user interfaces.\r\nBut there is an important difference between the two! Please read our guidelines about\r\n[Switch vs. Checkbox](#/DesignGuidelines/switch-vs-checkbox.md/).",
3618
- "props": [
3619
- {
3620
- "name": "label",
3621
- "description": "Label to display next to the switch",
3622
- "type": "any",
3623
- "default": "",
3624
- "required": false
3625
- },
3626
- {
3627
- "name": "disabled",
3628
- "description": "Disables the switch when `true`,\r\nand visually shows that the switch is editable but disabled.\r\nThis tells the users that if certain requirements are met,\r\nthe switch may become interactable.",
3629
- "type": "any",
3630
- "default": "false",
3631
- "required": false
3632
- },
3633
- {
3634
- "name": "readonly",
3635
- "description": "Disables the switch when `true`. This visualizes the switch slightly differently.\r\nBut shows no visual sign indicating that the switch is disabled\r\nor can ever become interactable.",
3636
- "type": "any",
3637
- "default": "false",
3638
- "required": false
3639
- },
3640
- {
3641
- "name": "invalid",
3642
- "description": "Set to `true` to indicate that the current value is invalid.",
3643
- "type": "any",
3644
- "default": "",
3645
- "required": false
3646
- },
3647
- {
3648
- "name": "value",
3649
- "description": "The value of the switch",
3650
- "type": "any",
3651
- "default": "false",
3652
- "required": false
3653
- },
3654
- {
3655
- "name": "helperText",
3656
- "description": "Optional helper text to display below the switch",
3657
- "type": "any",
3658
- "default": "",
3659
- "required": false
3660
- }
3661
- ]
3662
- },
3663
- {
3664
- "name": "LimelTabBar",
3665
- "source": {
3666
- "module": "lime-elements-vue",
3667
- "symbol": "LimelTabBar"
3668
- },
3669
- "description": "Tabs are great to organize information hierarchically in the interface and divide it into distinct categories. Using tabs, you can create groups of content that are related and at the same level in the hierarchy.\r\n:::warning\r\nTab bars should be strictly used for navigation at the top levels.\r\nThey should never be used to perform actions, or navigate away from the view which contains them.\r\n:::\r\nAn exception for using tab bars in a high level of hierarchy is their usage in modals. This is because modals are perceived as a separate place and not a part of the current context. Therefore you can use tab bars in a modal to group and organize its content.\r\nA tab bar can contain an unlimited number of tabs. However, depending on the device width and width of the tabs, the number of tabs that are visible at the same time will vary. When there is limited horizontal space, the component shows a left-arrow and/or right-arrow button, which scrolls and reveals the additional tabs. The tab bar can also be swiped left and right on a touch-device.\r\n:::tip Other things to consider\r\nNever divide the content of a tab using a nested tab bar.\r\nNever place two tab bars within the same screen.\r\nNever use background color for icons in tabs.\r\nAvoid having long labels for tabs.\r\nA tab will never be removed or get disabled, even if there is no content under it.\r\n:::",
3670
- "props": []
3671
- },
3672
- {
3673
- "name": "LimelTabPanel",
3674
- "source": {
3675
- "module": "lime-elements-vue",
3676
- "symbol": "LimelTabPanel"
3677
- },
3678
- "description": "The `limel-tab-panel` component uses the `limel-tab-bar` component together\r\nwith custom slotted components and will display the content for the currently\r\nactive tab. Each slotted component must have an id equal to the id of the\r\ncorresponding tab it belongs to. These components should implement the\r\n[TabPanelComponent](#/type/TabPanelComponent/) interface.\r\n\r\nThe `limel-tab-panel` component will automatically set each tab configuration\r\non the corresponding slotted component as a property named `tab` so that the\r\ncomponent can take action upon that. Sometimes it might be desirable to not\r\nload data or render anything until the tab is active.\r\n\r\nThe slotted components can also emit the `changeTab` event to update anything\r\ninside the actual tab, e.g. to change the icon, color or badge.",
3679
- "props": [],
3680
- "slots": [
3681
- {
3682
- "name": "default",
3683
- "description": "Content to put inside the `limel tab panel`. Each slotted element\r\nmust have the `id` attribute equal to the id of the tab it belongs to."
3684
- }
3685
- ]
3686
- },
3687
- {
3688
- "name": "LimelTable",
3689
- "source": {
3690
- "module": "lime-elements-vue",
3691
- "symbol": "LimelTable"
3692
- },
3693
- "description": "",
3694
- "props": [
3695
- {
3696
- "name": "mode",
3697
- "description": "Set to either `local` or `remote` to change how the table handles the\r\nloaded data. When in `local` mode, all sorting and pagination will be\r\ndone locally with the data given. When in `remote` mode, the consumer\r\nis responsible to give the table new data when a `load` event occurs",
3698
- "type": "any",
3699
- "default": "'local'",
3700
- "required": false
3701
- },
3702
- {
3703
- "name": "layout",
3704
- "description": "Defines the layout of the table, based on how width of the columns are calculated.\r\n\r\n- `default`: makes columns as wide as their contents.\r\n- `stretchLastColumn`: makes columns as wide as their contents, stretch the last column to fill up the remaining table width.\r\n- `stretchColumns`: stretches all columns to fill the available width when possible.\r\n- `lowDensity`: makes columns as wide as their contents, and creates a low density and airy layout.",
3705
- "type": "any",
3706
- "default": "",
3707
- "required": false
3708
- },
3709
- {
3710
- "name": "pageSize",
3711
- "description": "Number of rows per page",
3712
- "type": "any",
3713
- "default": "",
3714
- "required": false
3715
- },
3716
- {
3717
- "name": "totalRows",
3718
- "description": "The number of total rows available for the data",
3719
- "type": "any",
3720
- "default": "",
3721
- "required": false
3722
- },
3723
- {
3724
- "name": "movableColumns",
3725
- "description": "Set to `true` to enable reordering of the columns by dragging them",
3726
- "type": "any",
3727
- "default": "",
3728
- "required": false
3729
- },
3730
- {
3731
- "name": "movableRows",
3732
- "description": "Set to `true` to enable reordering of the rows by dragging them.\r\nA drag handle will be rendered at the start of each row.\r\nListen for the `reorder` event and update the `data` prop accordingly —\r\nthe table will not persist the new order on its own.",
3733
- "type": "any",
3734
- "default": "",
3735
- "required": false
3736
- },
3737
- {
3738
- "name": "sortableColumns",
3739
- "description": "Set to `false` to disable column sorting through header interactions.\r\nProgrammatic sorting through the `sorting` prop and `sort` event remains available.",
3740
- "type": "any",
3741
- "default": "true",
3742
- "required": false
3743
- },
3744
- {
3745
- "name": "loading",
3746
- "description": "Set to `true` to trigger loading animation",
3747
- "type": "any",
3748
- "default": "false",
3749
- "required": false
3750
- },
3751
- {
3752
- "name": "page",
3753
- "description": "The page to show",
3754
- "type": "any",
3755
- "default": "1",
3756
- "required": false
3757
- },
3758
- {
3759
- "name": "emptyMessage",
3760
- "description": "A message to display when the table has no data",
3761
- "type": "any",
3762
- "default": "",
3763
- "required": false
3764
- },
3765
- {
3766
- "name": "selectable",
3767
- "description": "Enables row selection",
3768
- "type": "any",
3769
- "default": "",
3770
- "required": false
3771
- },
3772
- {
3773
- "name": "language",
3774
- "description": "Defines the language for translations.",
3775
- "type": "any",
3776
- "default": "'en'",
3777
- "required": false
3778
- },
3779
- {
3780
- "name": "paginationLocation",
3781
- "description": "Location of the pagination controls.\r\n- `top`: Display pagination controls at the top of the table\r\n- `bottom`: Display pagination controls at the bottom of the table (default)",
3782
- "type": "any",
3783
- "default": "'bottom'",
3784
- "required": false
3785
- }
3786
- ]
3787
- },
3788
- {
3789
- "name": "LimelTextEditor",
3790
- "source": {
3791
- "module": "lime-elements-vue",
3792
- "symbol": "LimelTextEditor"
3793
- },
3794
- "description": "A rich text editor that offers a rich text editing experience with markdown support,\r\nin the sense that you can easily type markdown syntax and see the rendered\r\nresult as rich text in real-time. For instance, you can type `# Hello, world!`\r\nand see it directly turning to a heading 1 (an `<h1>` HTML element).\r\n\r\nNaturally, you can use standard keyboard hotkeys such as <kbd>Ctrl</kbd> + <kbd>B</kbd>\r\nto toggle bold text, <kbd>Ctrl</kbd> + <kbd>I</kbd> to toggle italic text, and so on.",
3795
- "props": [
3796
- {
3797
- "name": "contentType",
3798
- "description": "The type of content that the editor should handle and emit, defaults to `markdown`\r\n\r\nAssumed to be set only once, so not reactive to changes",
3799
- "type": "any",
3800
- "default": "'markdown'",
3801
- "required": false
3802
- },
3803
- {
3804
- "name": "language",
3805
- "description": "Defines the language for translations.",
3806
- "type": "any",
3807
- "default": "'en'",
3808
- "required": false
3809
- },
3810
- {
3811
- "name": "disabled",
3812
- "description": "Set to `true` to disable the field.\r\nUse `disabled` to indicate that the field can normally be interacted\r\nwith, but is currently disabled. This tells the user that if certain\r\nrequirements are met, the field may become enabled again.",
3813
- "type": "any",
3814
- "default": "false",
3815
- "required": false
3816
- },
3817
- {
3818
- "name": "readonly",
3819
- "description": "Set to `true` to make the component read-only.\r\nUse `readonly` when the field is only there to present the data it holds,\r\nand will not become possible for the current user to edit.\r\n:::note\r\nConsider that it might be better to use `limel-markdown`\r\ninstead of `limel-text-editor` when the goal is visualizing data.\r\n:::",
3820
- "type": "any",
3821
- "default": "false",
3822
- "required": false
3823
- },
3824
- {
3825
- "name": "helperText",
3826
- "description": "Optional helper text to display below the input field when it has focus",
3827
- "type": "any",
3828
- "default": "",
3829
- "required": false
3830
- },
3831
- {
3832
- "name": "placeholder",
3833
- "description": "The placeholder text shown inside the input field,\r\nwhen the field is empty.",
3834
- "type": "any",
3835
- "default": "",
3836
- "required": false
3837
- },
3838
- {
3839
- "name": "label",
3840
- "description": "The label of the editor",
3841
- "type": "any",
3842
- "default": "",
3843
- "required": false
3844
- },
3845
- {
3846
- "name": "invalid",
3847
- "description": "Set to `true` to indicate that the current value of the editor is\r\ninvalid.",
3848
- "type": "any",
3849
- "default": "false",
3850
- "required": false
3851
- },
3852
- {
3853
- "name": "value",
3854
- "description": "Description of the text inside the editor as markdown",
3855
- "type": "any",
3856
- "default": "",
3857
- "required": false
3858
- },
3859
- {
3860
- "name": "required",
3861
- "description": "Set to `true` to indicate that the field is required.\r\n\r\n:::important\r\nAn empty but required field is not automatically considered invalid.\r\nYou must make sure to check the validity of the field on your own,\r\nand properly handle the `invalid` state.\r\n:::",
3862
- "type": "any",
3863
- "default": "false",
3864
- "required": false
3865
- },
3866
- {
3867
- "name": "allowResize",
3868
- "description": "Set to `true` to allow the user to vertically resize the editor.\r\nSet to `false` to disable the resize functionality.",
3869
- "type": "any",
3870
- "default": "true",
3871
- "required": false
3872
- },
3873
- {
3874
- "name": "ui",
3875
- "description": "Specifies the visual appearance of the editor.\r\n\r\n- `standard`: The default editor appearance with a full toolbar and\r\n standard layout.\r\n- `minimal`: A compact editor appearance, ideal for limited space\r\n scenarios such as mobile devices. In this mode, the toolbar is hidden\r\n until the editor is focused.\r\n- `no-toolbar`: A basic textarea appearance without any text styling toolbar.\r\n This mode is suitable for scenarios where you want to provide a simple\r\n text input without any visible formatting options; but still provide\r\n support for markdown syntax and rich text, using hotkeys or when pasting.",
3876
- "type": "any",
3877
- "default": "'standard'",
3878
- "required": false
3879
- }
3880
- ]
3881
- },
3882
- {
3883
- "name": "LimelTextEditorLinkMenu",
3884
- "source": {
3885
- "module": "lime-elements-vue",
3886
- "symbol": "LimelTextEditorLinkMenu"
3887
- },
3888
- "description": "This component is a menu for editing a link in the text editor.\r\nIt allows the user to input the text and url for the link.",
3889
- "props": [
3890
- {
3891
- "name": "language",
3892
- "description": "Defines the language for translations.",
3893
- "type": "any",
3894
- "default": "'en'",
3895
- "required": false
3896
- },
3897
- {
3898
- "name": "isOpen",
3899
- "description": "Open state of the link-menu dialog",
3900
- "type": "any",
3901
- "default": "false",
3902
- "required": false
3903
- }
3904
- ]
3905
- },
3906
- {
3907
- "name": "LimelTooltip",
3908
- "source": {
3909
- "module": "lime-elements-vue",
3910
- "symbol": "LimelTooltip"
3911
- },
3912
- "description": "A tooltip can be used to display a descriptive text for any element.\r\nThe displayed content must be a brief and supplemental string of text,\r\nidentifying the element or describing its function for the user,\r\nhelping them better understand unfamiliar objects that aren't described\r\ndirectly in the UI.\r\n\r\n## Interaction\r\nThe tooltip appears after a slight delay, when the element is hovered;\r\nand disappears as soon as the cursor leaves the element.\r\nTherefore, users cannot interact with the tip, but if the trigger element\r\nitself is interactive, it will remain interactible even with a tooltip bound\r\nto it.\r\n\r\n## Usage\r\n- Keep in mind that tooltips can be distracting, and can be perceived as an interruption.\r\nUse them only when they add significant value.\r\n- A good tip is concise, helpful, and informative.\r\nDon't explain the obvious or simply repeat what is already on the screen.\r\nWhen used correctly, supplemental info of a tooltip helps to [declutter the UI](#/DesignGuidelines/decluttering.md/).\r\n- If the tip is essential to the primary tasks that the user is performing,\r\nsuch as warnings or important notes, include the information directly in the\r\ninterface instead.\r\n- When a component offers a helper text (e.g. [Input field](#/component/limel-input-field/)),\r\nuse that, not a tooltip.\r\n- Make sure to use the tooltip on an element that users naturally and\r\neffortlessly recognize can be hovered.",
3913
- "props": [
3914
- {
3915
- "name": "elementId",
3916
- "description": "ID of the owner element that the tooltip should describe.\r\nMust be a child within the same document fragment as the tooltip element\r\nitself.",
3917
- "type": "any",
3918
- "default": "",
3919
- "required": true
3920
- },
3921
- {
3922
- "name": "label",
3923
- "description": "Short descriptive text of the owner element.",
3924
- "type": "any",
3925
- "default": "",
3926
- "required": true
3927
- },
3928
- {
3929
- "name": "helperLabel",
3930
- "description": "Additional helper text for the element.",
3931
- "type": "any",
3932
- "default": "",
3933
- "required": false
3934
- },
3935
- {
3936
- "name": "hotkey",
3937
- "description": "Keyboard shortcut to visualize inside the tooltip, e.g. `\"ctrl+f\"`.\r\nDisplay-only: the tooltip does not listen for the keystroke.\r\nCatching the hotkey is the consumer's responsibility.",
3938
- "type": "any",
3939
- "default": "",
3940
- "required": false
3941
- },
3942
- {
3943
- "name": "maxlength",
3944
- "description": "The maximum amount of characters before rendering 'label' and\r\n'helperLabel' in two rows.",
3945
- "type": "any",
3946
- "default": "50",
3947
- "required": false
3948
- },
3949
- {
3950
- "name": "openDirection",
3951
- "description": "Decides the tooltip's location in relation to its trigger.",
3952
- "type": "any",
3953
- "default": "'top'",
3954
- "required": false
3955
- }
3956
- ]
3957
- },
3958
- {
3959
- "name": "LimelTooltipContent",
3960
- "source": {
3961
- "module": "lime-elements-vue",
3962
- "symbol": "LimelTooltipContent"
3963
- },
3964
- "description": "This component is used internally by `limel-tooltip`.",
3965
- "props": [
3966
- {
3967
- "name": "label",
3968
- "description": "Read more in tooltip.tsx",
3969
- "type": "any",
3970
- "default": "",
3971
- "required": true
3972
- },
3973
- {
3974
- "name": "helperLabel",
3975
- "description": "Read more in tooltip.tsx",
3976
- "type": "any",
3977
- "default": "",
3978
- "required": false
3979
- },
3980
- {
3981
- "name": "maxlength",
3982
- "description": "Read more in tooltip.tsx",
3983
- "type": "any",
3984
- "default": "",
3985
- "required": false
3986
- },
3987
- {
3988
- "name": "hotkey",
3989
- "description": "Read more in tooltip.tsx",
3990
- "type": "any",
3991
- "default": "",
3992
- "required": false
3993
- }
3994
- ]
3995
- }
3996
- ]
3997
- }
3998
- }
3999
- }