@lwc-bolts/lightning-base-components 0.0.0-stage → 1.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE.md +7 -0
- package/README.md +56 -2
- package/dist/components.generated.d.ts +3 -0
- package/dist/components.generated.js +4190 -0
- package/dist/index.d.ts +2 -0
- package/dist/index.js +1 -0
- package/dist/types.d.ts +13 -0
- package/dist/types.js +2 -0
- package/package.json +42 -4
|
@@ -0,0 +1,4190 @@
|
|
|
1
|
+
// Generated by scripts/generate.ts from the sources in lightning/sources.json and the
|
|
2
|
+
// manual changes in lightning/overrides.jsonc; don't edit it by hand. The sources' licenses:
|
|
3
|
+
//
|
|
4
|
+
// @salesforce/lwc-language-server@4.12.13:
|
|
5
|
+
//
|
|
6
|
+
// Copyright (c) 2020, Salesforce.com, inc.
|
|
7
|
+
// All rights reserved.
|
|
8
|
+
//
|
|
9
|
+
// Redistribution and use in source and binary forms, with or without modification,
|
|
10
|
+
// are permitted provided that the following conditions are met:
|
|
11
|
+
//
|
|
12
|
+
// * Redistributions of source code must retain the above copyright notice, this
|
|
13
|
+
// list of conditions and the following disclaimer.
|
|
14
|
+
//
|
|
15
|
+
// * Redistributions in binary form must reproduce the above copyright notice, this
|
|
16
|
+
// list of conditions and the following disclaimer in the documentation and/or
|
|
17
|
+
// other materials provided with the distribution.
|
|
18
|
+
//
|
|
19
|
+
// * Neither the name of Salesforce.com nor the names of its contributors may be
|
|
20
|
+
// used to endorse or promote products derived from this software without specific
|
|
21
|
+
// prior written permission.
|
|
22
|
+
//
|
|
23
|
+
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
|
|
24
|
+
// ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
|
|
25
|
+
// WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
|
|
26
|
+
// DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR
|
|
27
|
+
// ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
|
|
28
|
+
// (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
|
|
29
|
+
// LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
|
|
30
|
+
// ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
|
|
31
|
+
// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
|
|
32
|
+
// SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
|
33
|
+
//
|
|
34
|
+
// @salesforce/sfdx-lwc-jest@7.9.0:
|
|
35
|
+
//
|
|
36
|
+
// MIT LICENSE
|
|
37
|
+
//
|
|
38
|
+
// Copyright (c) 2018, Salesforce.com, Inc.
|
|
39
|
+
// All rights reserved.
|
|
40
|
+
//
|
|
41
|
+
// Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
|
|
42
|
+
//
|
|
43
|
+
// The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
|
|
44
|
+
//
|
|
45
|
+
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
|
46
|
+
/** The `lightning-*` base components, by tag. */
|
|
47
|
+
export const LIGHTNING_COMPONENTS = {
|
|
48
|
+
"lightning-accordion": {
|
|
49
|
+
"description": "A collection of vertically stacked sections with multiple content areas. [View in Component Library](https://developer.salesforce.com/docs/component-library/bundle/lightning-accordion)",
|
|
50
|
+
"properties": {
|
|
51
|
+
"activeSectionName": {
|
|
52
|
+
"type": "string | number",
|
|
53
|
+
"description": "Expands the specified accordion sections. Section names are case-sensitive. To support multiple expanded sections, include allow-multiple-sections-open in your markup. By default, only the first section in the accordion is expanded."
|
|
54
|
+
},
|
|
55
|
+
"allowMultipleSectionsOpen": {
|
|
56
|
+
"type": "boolean",
|
|
57
|
+
"description": "If present, the accordion allows multiple open sections. Otherwise, opening a section closes another that's currently open."
|
|
58
|
+
},
|
|
59
|
+
"title": {
|
|
60
|
+
"type": "string | number",
|
|
61
|
+
"description": "Displays tooltip text when the mouse moves over the element."
|
|
62
|
+
}
|
|
63
|
+
},
|
|
64
|
+
"methods": {},
|
|
65
|
+
"events": {
|
|
66
|
+
"sectiontoggle": {
|
|
67
|
+
"type": "CustomEvent<{ openSections: any }>",
|
|
68
|
+
"description": "The event that's fired when an accordion loads with at least one active section or when a section is toggled. Doesn't bubble."
|
|
69
|
+
}
|
|
70
|
+
}
|
|
71
|
+
},
|
|
72
|
+
"lightning-accordion-section": {
|
|
73
|
+
"description": "A single section that is nested in an accordion component. [View in Component Library](https://developer.salesforce.com/docs/component-library/bundle/lightning-accordion-section)",
|
|
74
|
+
"properties": {
|
|
75
|
+
"headingLevel": {
|
|
76
|
+
"type": "any"
|
|
77
|
+
},
|
|
78
|
+
"label": {
|
|
79
|
+
"type": "string | number",
|
|
80
|
+
"description": "The text that displays as the title of the section."
|
|
81
|
+
},
|
|
82
|
+
"name": {
|
|
83
|
+
"type": "string | number",
|
|
84
|
+
"description": "The unique section name to use with the active-section-name attribute in the accordion component."
|
|
85
|
+
},
|
|
86
|
+
"title": {
|
|
87
|
+
"type": "string | number",
|
|
88
|
+
"description": "Displays a tooltip text when the mouse moves over the element."
|
|
89
|
+
}
|
|
90
|
+
},
|
|
91
|
+
"methods": {},
|
|
92
|
+
"events": {}
|
|
93
|
+
},
|
|
94
|
+
"lightning-alert": {
|
|
95
|
+
"properties": {
|
|
96
|
+
"label": {
|
|
97
|
+
"type": "any"
|
|
98
|
+
},
|
|
99
|
+
"message": {
|
|
100
|
+
"type": "any"
|
|
101
|
+
},
|
|
102
|
+
"theme": {
|
|
103
|
+
"type": "any"
|
|
104
|
+
},
|
|
105
|
+
"variant": {
|
|
106
|
+
"type": "any"
|
|
107
|
+
}
|
|
108
|
+
},
|
|
109
|
+
"methods": {},
|
|
110
|
+
"events": {}
|
|
111
|
+
},
|
|
112
|
+
"lightning-avatar": {
|
|
113
|
+
"description": "A visual representation of an object. [View in Component Library](https://developer.salesforce.com/docs/component-library/bundle/lightning-avatar)",
|
|
114
|
+
"properties": {
|
|
115
|
+
"alternativeText": {
|
|
116
|
+
"type": "string | number",
|
|
117
|
+
"description": "The alternative text used to describe the avatar, which is displayed as hover text on the image."
|
|
118
|
+
},
|
|
119
|
+
"fallbackIconName": {
|
|
120
|
+
"type": "string | number",
|
|
121
|
+
"description": "The Lightning Design System name of the icon used as a fallback when the image fails to load. The initials fallback relies on this for its background color. Names are written in the format 'standard:account' where 'standard' is the category, and 'account' is the specific icon to be displayed. Only icons from the standard and custom categories are allowed."
|
|
122
|
+
},
|
|
123
|
+
"initials": {
|
|
124
|
+
"type": "string | number",
|
|
125
|
+
"description": "If the record name contains two words, like first and last name, use the first capitalized letter of each. For records that only have a single word name, use the first two letters of that word using one capital and one lower case letter."
|
|
126
|
+
},
|
|
127
|
+
"size": {
|
|
128
|
+
"type": "string | number",
|
|
129
|
+
"description": "The size of the avatar. Valid values are x-small, small, medium, and large. This value defaults to medium."
|
|
130
|
+
},
|
|
131
|
+
"src": {
|
|
132
|
+
"type": "string | number",
|
|
133
|
+
"description": "The URL for the image."
|
|
134
|
+
},
|
|
135
|
+
"title": {
|
|
136
|
+
"type": "string | number",
|
|
137
|
+
"description": "Displays tooltip text when the mouse moves over the element."
|
|
138
|
+
},
|
|
139
|
+
"variant": {
|
|
140
|
+
"type": "string | number",
|
|
141
|
+
"description": "The variant changes the shape of the avatar. Valid values are empty, circle, and square. This value defaults to square."
|
|
142
|
+
}
|
|
143
|
+
},
|
|
144
|
+
"methods": {},
|
|
145
|
+
"events": {}
|
|
146
|
+
},
|
|
147
|
+
"lightning-badge": {
|
|
148
|
+
"description": "Represents a label which holds a small amount of information, such as the number of unread notifications. [View in Component Library](https://developer.salesforce.com/docs/component-library/bundle/lightning-badge)",
|
|
149
|
+
"properties": {
|
|
150
|
+
"iconAlternativeText": {
|
|
151
|
+
"type": "any"
|
|
152
|
+
},
|
|
153
|
+
"iconName": {
|
|
154
|
+
"type": "any"
|
|
155
|
+
},
|
|
156
|
+
"iconPosition": {
|
|
157
|
+
"type": "any"
|
|
158
|
+
},
|
|
159
|
+
"label": {
|
|
160
|
+
"type": "string | number",
|
|
161
|
+
"description": "The text to be displayed inside the badge."
|
|
162
|
+
},
|
|
163
|
+
"title": {
|
|
164
|
+
"type": "string | number",
|
|
165
|
+
"description": "Displays tooltip text when the mouse moves over the element."
|
|
166
|
+
}
|
|
167
|
+
},
|
|
168
|
+
"methods": {},
|
|
169
|
+
"events": {}
|
|
170
|
+
},
|
|
171
|
+
"lightning-breadcrumb": {
|
|
172
|
+
"description": "An item in the hierarchy path of the page the user is on. [View in Component Library](https://developer.salesforce.com/docs/component-library/bundle/lightning-breadcrumb)",
|
|
173
|
+
"properties": {
|
|
174
|
+
"href": {
|
|
175
|
+
"type": "string | number",
|
|
176
|
+
"description": "The URL of the page that the breadcrumb goes to."
|
|
177
|
+
},
|
|
178
|
+
"label": {
|
|
179
|
+
"type": "string | number",
|
|
180
|
+
"description": "The text label for the breadcrumb."
|
|
181
|
+
},
|
|
182
|
+
"name": {
|
|
183
|
+
"type": "string | number",
|
|
184
|
+
"description": "The name for the breadcrumb component. This value is optional and can be used to identify the breadcrumb in a callback."
|
|
185
|
+
},
|
|
186
|
+
"title": {
|
|
187
|
+
"type": "string | number",
|
|
188
|
+
"description": "Displays tooltip text when the mouse moves over the element."
|
|
189
|
+
}
|
|
190
|
+
},
|
|
191
|
+
"methods": {},
|
|
192
|
+
"events": {}
|
|
193
|
+
},
|
|
194
|
+
"lightning-breadcrumbs": {
|
|
195
|
+
"description": "A hierarchy path of the page you're currently visiting within the website or app. [View in Component Library](https://developer.salesforce.com/docs/component-library/bundle/lightning-breadcrumbs)",
|
|
196
|
+
"properties": {
|
|
197
|
+
"title": {
|
|
198
|
+
"type": "string | number",
|
|
199
|
+
"description": "Displays tooltip text when the mouse moves over the element."
|
|
200
|
+
}
|
|
201
|
+
},
|
|
202
|
+
"methods": {},
|
|
203
|
+
"events": {}
|
|
204
|
+
},
|
|
205
|
+
"lightning-button": {
|
|
206
|
+
"description": "Represents a button element. [View in Component Library](https://developer.salesforce.com/docs/component-library/bundle/lightning-button)",
|
|
207
|
+
"properties": {
|
|
208
|
+
"accessKey": {
|
|
209
|
+
"type": "string | number",
|
|
210
|
+
"description": "Specifies a shortcut key to activate or focus an element."
|
|
211
|
+
},
|
|
212
|
+
"ariaAtomic": {
|
|
213
|
+
"type": "string | number",
|
|
214
|
+
"description": "Indicates whether assistive technologies will present all, or only parts of, the changed region. Valid values are 'true' or 'false'."
|
|
215
|
+
},
|
|
216
|
+
"ariaControls": {
|
|
217
|
+
"type": "string | number",
|
|
218
|
+
"description": "A space-separated list of element IDs that this button controls the contents or presence of."
|
|
219
|
+
},
|
|
220
|
+
"ariaDescribedBy": {
|
|
221
|
+
"type": "string | number",
|
|
222
|
+
"description": "A space-separated list of element IDs that provides descriptive labels for the button."
|
|
223
|
+
},
|
|
224
|
+
"ariaExpanded": {
|
|
225
|
+
"type": "string | number",
|
|
226
|
+
"description": "Indicates whether an element the button controls is expanded or collapsed. Valid values are 'true' or 'false'."
|
|
227
|
+
},
|
|
228
|
+
"ariaLabel": {
|
|
229
|
+
"type": "string | number",
|
|
230
|
+
"description": "Label describing the button to assistive technologies."
|
|
231
|
+
},
|
|
232
|
+
"ariaLive": {
|
|
233
|
+
"type": "string | number",
|
|
234
|
+
"description": "Indicates that the button will be updated. Valid values are 'assertive', 'polite', or 'off'."
|
|
235
|
+
},
|
|
236
|
+
"disableAnimation": {
|
|
237
|
+
"type": "any"
|
|
238
|
+
},
|
|
239
|
+
"disabled": {
|
|
240
|
+
"type": "boolean",
|
|
241
|
+
"description": "Specifies whether this button should be displayed in a disabled state. Disabled buttons can't be clicked. This value defaults to false."
|
|
242
|
+
},
|
|
243
|
+
"iconName": {
|
|
244
|
+
"type": "string | number",
|
|
245
|
+
"description": "The Lightning Design System name of the icon. Names are written in the format 'utility:down' where 'utility' is the category, and 'down' is the specific icon to be displayed."
|
|
246
|
+
},
|
|
247
|
+
"iconPosition": {
|
|
248
|
+
"type": "string | number",
|
|
249
|
+
"description": "Describes the position of the icon with respect to body. Options include left and right. This value defaults to left."
|
|
250
|
+
},
|
|
251
|
+
"label": {
|
|
252
|
+
"type": "string | number",
|
|
253
|
+
"description": "The text to be displayed inside the button."
|
|
254
|
+
},
|
|
255
|
+
"name": {
|
|
256
|
+
"type": "string | number",
|
|
257
|
+
"description": "The name for the button element. This value is optional and can be used to identify the button in a callback."
|
|
258
|
+
},
|
|
259
|
+
"stretch": {
|
|
260
|
+
"type": "any"
|
|
261
|
+
},
|
|
262
|
+
"tabIndex": {
|
|
263
|
+
"type": "number | string",
|
|
264
|
+
"description": "Specifies the tab order of an element (when the tab button is used for navigating)."
|
|
265
|
+
},
|
|
266
|
+
"title": {
|
|
267
|
+
"type": "string | number",
|
|
268
|
+
"description": "Displays tooltip text when the mouse moves over the element."
|
|
269
|
+
},
|
|
270
|
+
"type": {
|
|
271
|
+
"type": "string | number",
|
|
272
|
+
"description": "Specifies the type of button. Valid values are button, reset, and submit. This value defaults to button."
|
|
273
|
+
},
|
|
274
|
+
"value": {
|
|
275
|
+
"type": "any",
|
|
276
|
+
"description": "The value for the button element. This value is optional and can be used when submitting a form."
|
|
277
|
+
},
|
|
278
|
+
"variant": {
|
|
279
|
+
"type": "string | number",
|
|
280
|
+
"description": "The variant changes the appearance of the button. Accepted variants include base, neutral, brand, destructive, inverse and success. This value defaults to neutral."
|
|
281
|
+
}
|
|
282
|
+
},
|
|
283
|
+
"methods": {},
|
|
284
|
+
"events": {}
|
|
285
|
+
},
|
|
286
|
+
"lightning-button-group": {
|
|
287
|
+
"description": "Represents a group of buttons. [View in Component Library](https://developer.salesforce.com/docs/component-library/bundle/lightning-button-group)",
|
|
288
|
+
"properties": {
|
|
289
|
+
"title": {
|
|
290
|
+
"type": "string | number",
|
|
291
|
+
"description": "Displays tooltip text when the mouse moves over the element."
|
|
292
|
+
}
|
|
293
|
+
},
|
|
294
|
+
"methods": {},
|
|
295
|
+
"events": {}
|
|
296
|
+
},
|
|
297
|
+
"lightning-button-icon": {
|
|
298
|
+
"description": "An icon-only HTML button. [View in Component Library](https://developer.salesforce.com/docs/component-library/bundle/lightning-button-icon)",
|
|
299
|
+
"properties": {
|
|
300
|
+
"accessKey": {
|
|
301
|
+
"type": "string | number",
|
|
302
|
+
"description": "Specifies a shortcut key to activate or focus an element."
|
|
303
|
+
},
|
|
304
|
+
"alternativeText": {
|
|
305
|
+
"type": "string | number",
|
|
306
|
+
"description": "The alternative text used to describe the icon. This text should describe what happens when you click the button, for example 'Upload File', not what the icon looks like, 'Paperclip'."
|
|
307
|
+
},
|
|
308
|
+
"ariaAtomic": {
|
|
309
|
+
"type": "string | number",
|
|
310
|
+
"description": "Indicates whether assistive technologies will present all, or only parts of, the changed region. Valid values are 'true' or 'false'."
|
|
311
|
+
},
|
|
312
|
+
"ariaControls": {
|
|
313
|
+
"type": "string | number",
|
|
314
|
+
"description": "A space-separated list of element IDs that this button controls the contents or presence of."
|
|
315
|
+
},
|
|
316
|
+
"ariaDescribedBy": {
|
|
317
|
+
"type": "string | number",
|
|
318
|
+
"description": "A space-separated list of element IDs that provides descriptive labels for the button."
|
|
319
|
+
},
|
|
320
|
+
"ariaExpanded": {
|
|
321
|
+
"type": "string | number",
|
|
322
|
+
"description": "Indicates whether an element the button controls is expanded or collapsed. Valid values are 'true' or 'false'."
|
|
323
|
+
},
|
|
324
|
+
"ariaLabel": {
|
|
325
|
+
"type": "string | number",
|
|
326
|
+
"description": "Label describing the button to assistive technologies."
|
|
327
|
+
},
|
|
328
|
+
"ariaLive": {
|
|
329
|
+
"type": "string | number",
|
|
330
|
+
"description": "Indicates that the button will be updated. Valid values are 'assertive', 'polite', or 'off'."
|
|
331
|
+
},
|
|
332
|
+
"disabled": {
|
|
333
|
+
"type": "boolean",
|
|
334
|
+
"description": "Specifies whether this button should be displayed in a disabled state. Disabled buttons can't be clicked. This value defaults to false."
|
|
335
|
+
},
|
|
336
|
+
"iconClass": {
|
|
337
|
+
"type": "string | number",
|
|
338
|
+
"description": "The class to be applied to the contained icon element."
|
|
339
|
+
},
|
|
340
|
+
"iconName": {
|
|
341
|
+
"type": "string | number",
|
|
342
|
+
"description": "The Lightning Design System name of the icon. Names are written in the format 'utility:down' where 'utility' is the category, and 'down' is the specific icon to be displayed. Only utility icons can be used in this component."
|
|
343
|
+
},
|
|
344
|
+
"name": {
|
|
345
|
+
"type": "string | number",
|
|
346
|
+
"description": "The name for the button element. This value is optional and can be used to identify the button in a callback."
|
|
347
|
+
},
|
|
348
|
+
"size": {
|
|
349
|
+
"type": "string | number",
|
|
350
|
+
"description": "The size of the buttonIcon. For the bare variant, options include x-small, small, medium, and large. For non-bare variants, options include xx-small, x-small, small, and medium. This value defaults to medium."
|
|
351
|
+
},
|
|
352
|
+
"tabIndex": {
|
|
353
|
+
"type": "number | string",
|
|
354
|
+
"description": "Specifies the tab order of an element (when the tab button is used for navigating)."
|
|
355
|
+
},
|
|
356
|
+
"title": {
|
|
357
|
+
"type": "string | number",
|
|
358
|
+
"description": "Displays tooltip text when the mouse moves over the element."
|
|
359
|
+
},
|
|
360
|
+
"tooltip": {
|
|
361
|
+
"type": "any"
|
|
362
|
+
},
|
|
363
|
+
"type": {
|
|
364
|
+
"type": "string | number",
|
|
365
|
+
"description": "Specifies the type of button. Valid values are button, reset, and submit. This value defaults to button."
|
|
366
|
+
},
|
|
367
|
+
"value": {
|
|
368
|
+
"type": "any",
|
|
369
|
+
"description": "The value for the button element. This value is optional and can be used when submitting a form."
|
|
370
|
+
},
|
|
371
|
+
"variant": {
|
|
372
|
+
"type": "string | number",
|
|
373
|
+
"description": "The variant changes the appearance of buttonIcon. Accepted variants include bare, container, brand, border, border-filled, bare-inverse, and border-inverse. This value defaults to border."
|
|
374
|
+
}
|
|
375
|
+
},
|
|
376
|
+
"methods": {},
|
|
377
|
+
"events": {}
|
|
378
|
+
},
|
|
379
|
+
"lightning-button-icon-stateful": {
|
|
380
|
+
"description": "An icon-only button that retains state. This component requires API version 41.0 and later. [View in Component Library](https://developer.salesforce.com/docs/component-library/bundle/lightning-button-icon-stateful)",
|
|
381
|
+
"properties": {
|
|
382
|
+
"accessKey": {
|
|
383
|
+
"type": "string | number",
|
|
384
|
+
"description": "Specifies a shortcut key to activate or focus an element."
|
|
385
|
+
},
|
|
386
|
+
"alternativeText": {
|
|
387
|
+
"type": "string | number",
|
|
388
|
+
"description": "The alternative text used to describe the icon. This text should describe what happens when you click the button, for example 'Upload File', not what the icon looks like, 'Paperclip'."
|
|
389
|
+
},
|
|
390
|
+
"disabled": {
|
|
391
|
+
"type": "boolean",
|
|
392
|
+
"description": "Specifies whether this button should be displayed in a disabled state. Disabled buttons can't be clicked. This value defaults to false."
|
|
393
|
+
},
|
|
394
|
+
"iconName": {
|
|
395
|
+
"type": "string | number",
|
|
396
|
+
"description": "The Lightning Design System name of the icon. Names are written in the format 'utility:down' where 'utility' is the category, and 'down' is the specific icon to be displayed. Note: Only utility icons can be used in this component."
|
|
397
|
+
},
|
|
398
|
+
"name": {
|
|
399
|
+
"type": "string | number",
|
|
400
|
+
"description": "The name for the button element. This value is optional and can be used to identify the button in a callback."
|
|
401
|
+
},
|
|
402
|
+
"selected": {
|
|
403
|
+
"type": "boolean",
|
|
404
|
+
"description": "Specifies whether button is in selected state or not"
|
|
405
|
+
},
|
|
406
|
+
"size": {
|
|
407
|
+
"type": "string | number",
|
|
408
|
+
"description": "The size of the buttonIcon. Options include xx-small, x-small, small, and medium. This value defaults to medium."
|
|
409
|
+
},
|
|
410
|
+
"tabIndex": {
|
|
411
|
+
"type": "number | string",
|
|
412
|
+
"description": "Specifies the tab order of an element (when the tab button is used for navigating)."
|
|
413
|
+
},
|
|
414
|
+
"title": {
|
|
415
|
+
"type": "string | number",
|
|
416
|
+
"description": "Displays tooltip text when the mouse moves over the element."
|
|
417
|
+
},
|
|
418
|
+
"value": {
|
|
419
|
+
"type": "any",
|
|
420
|
+
"description": "The value for the button element. This value is optional and can be used when submitting a form."
|
|
421
|
+
},
|
|
422
|
+
"variant": {
|
|
423
|
+
"type": "string | number",
|
|
424
|
+
"description": "The variant changes the appearance of buttonIcon. Accepted variants include border, border-filled, and border-inverse. This value defaults to border."
|
|
425
|
+
}
|
|
426
|
+
},
|
|
427
|
+
"methods": {},
|
|
428
|
+
"events": {}
|
|
429
|
+
},
|
|
430
|
+
"lightning-button-menu": {
|
|
431
|
+
"description": "Represents a dropdown menu with a list of actions or functions. [View in Component Library](https://developer.salesforce.com/docs/component-library/bundle/lightning-button-menu)",
|
|
432
|
+
"properties": {
|
|
433
|
+
"accessKey": {
|
|
434
|
+
"type": "string | number",
|
|
435
|
+
"description": "Specifies a shortcut key to activate or focus an element."
|
|
436
|
+
},
|
|
437
|
+
"alternativeText": {
|
|
438
|
+
"type": "string | number",
|
|
439
|
+
"description": "The assistive text for the button."
|
|
440
|
+
},
|
|
441
|
+
"disabled": {
|
|
442
|
+
"type": "boolean",
|
|
443
|
+
"description": "If present, the menu can be opened by users."
|
|
444
|
+
},
|
|
445
|
+
"draftAlternativeText": {
|
|
446
|
+
"type": "string | number",
|
|
447
|
+
"description": "Describes the reason for showing the draft indicator. This is required when is-draft is true."
|
|
448
|
+
},
|
|
449
|
+
"groupOrder": {
|
|
450
|
+
"type": "any"
|
|
451
|
+
},
|
|
452
|
+
"iconName": {
|
|
453
|
+
"type": "string | number",
|
|
454
|
+
"description": "The name of the icon to be used in the format 'utility:down'. If an icon other than 'utility:down' or 'utility:chevrondown' is used, a utility:down icon is appended to the right of that icon. This value defaults to utility:down."
|
|
455
|
+
},
|
|
456
|
+
"iconSize": {
|
|
457
|
+
"type": "string | number",
|
|
458
|
+
"description": "The size of the icon. Options include xx-small, x-small, medium, or large. This value defaults to medium."
|
|
459
|
+
},
|
|
460
|
+
"isDraft": {
|
|
461
|
+
"type": "boolean",
|
|
462
|
+
"description": "If present, the menu trigger shows a draft indicator."
|
|
463
|
+
},
|
|
464
|
+
"isLoading": {
|
|
465
|
+
"type": "boolean",
|
|
466
|
+
"description": "If present, the menu is in a loading state and shows a spinner."
|
|
467
|
+
},
|
|
468
|
+
"label": {
|
|
469
|
+
"type": "string | number",
|
|
470
|
+
"description": "Optional text to be shown on the button."
|
|
471
|
+
},
|
|
472
|
+
"loadingStateAlternativeText": {
|
|
473
|
+
"type": "string | number",
|
|
474
|
+
"description": "Message displayed while the menu is in the loading state."
|
|
475
|
+
},
|
|
476
|
+
"menuAlignment": {
|
|
477
|
+
"type": "string | number",
|
|
478
|
+
"description": "Determines the alignment of the menu relative to the button. Available options are: auto, left, center, right, bottom-left, bottom-center, bottom-right. The auto option aligns the dropdown menu based on available space. This value defaults to left."
|
|
479
|
+
},
|
|
480
|
+
"name": {
|
|
481
|
+
"type": "string | number",
|
|
482
|
+
"description": "The name for the button element. This value is optional and can be used to identify the button in a callback."
|
|
483
|
+
},
|
|
484
|
+
"nubbin": {
|
|
485
|
+
"type": "any",
|
|
486
|
+
"description": "If present, a nubbin is present on the menu. A nubbin is a stub that protrudes from the menu item towards the button menu. The nubbin position is based on the menu-alignment."
|
|
487
|
+
},
|
|
488
|
+
"size": {
|
|
489
|
+
"type": "any"
|
|
490
|
+
},
|
|
491
|
+
"tabIndex": {
|
|
492
|
+
"type": "number | string",
|
|
493
|
+
"description": "Specifies the tab order of an element (when the tab button is used for navigating)."
|
|
494
|
+
},
|
|
495
|
+
"title": {
|
|
496
|
+
"type": "string | number",
|
|
497
|
+
"description": "Displays tooltip text when the mouse moves over the button menu."
|
|
498
|
+
},
|
|
499
|
+
"tooltip": {
|
|
500
|
+
"type": "any"
|
|
501
|
+
},
|
|
502
|
+
"value": {
|
|
503
|
+
"type": "any",
|
|
504
|
+
"description": "The value for the button element. This value is optional and can be used when submitting a form."
|
|
505
|
+
},
|
|
506
|
+
"variant": {
|
|
507
|
+
"type": "string | number",
|
|
508
|
+
"description": "The variant changes the look of the button. Accepted variants include bare, container, border, border-filled, bare-inverse, and border-inverse. This value defaults to border."
|
|
509
|
+
},
|
|
510
|
+
"visible": {
|
|
511
|
+
"type": "boolean",
|
|
512
|
+
"description": "If true, the menu items are displayed. This value defaults to false."
|
|
513
|
+
}
|
|
514
|
+
},
|
|
515
|
+
"methods": {},
|
|
516
|
+
"events": {
|
|
517
|
+
"close": {
|
|
518
|
+
"type": "CustomEvent<any>",
|
|
519
|
+
"description": "The event fired when you close the dropdown menu in one of the following ways. Doesn't bubble."
|
|
520
|
+
},
|
|
521
|
+
"open": {
|
|
522
|
+
"type": "CustomEvent<any>",
|
|
523
|
+
"description": "The event fired when you open the dropdown menu in one of the following ways. Doesn't bubble."
|
|
524
|
+
},
|
|
525
|
+
"select": {
|
|
526
|
+
"type": "CustomEvent<{ value: string }>",
|
|
527
|
+
"description": "The event fired when the menu is selected. Doesn't bubble."
|
|
528
|
+
}
|
|
529
|
+
}
|
|
530
|
+
},
|
|
531
|
+
"lightning-button-stateful": {
|
|
532
|
+
"description": "A button that toggles between states. [View in Component Library](https://developer.salesforce.com/docs/component-library/bundle/lightning-button-stateful)",
|
|
533
|
+
"properties": {
|
|
534
|
+
"accessKey": {
|
|
535
|
+
"type": "string | number",
|
|
536
|
+
"description": "Specifies a shortcut key to activate or focus an element."
|
|
537
|
+
},
|
|
538
|
+
"groupOrder": {
|
|
539
|
+
"type": "any"
|
|
540
|
+
},
|
|
541
|
+
"iconNameWhenHover": {
|
|
542
|
+
"type": "string | number",
|
|
543
|
+
"description": "The name of the icon to be used in the format 'utility:close' when the state is true and the button receives focus."
|
|
544
|
+
},
|
|
545
|
+
"iconNameWhenOff": {
|
|
546
|
+
"type": "string | number",
|
|
547
|
+
"description": "The name of the icon to be used in the format 'utility:add' when the state is false."
|
|
548
|
+
},
|
|
549
|
+
"iconNameWhenOn": {
|
|
550
|
+
"type": "string | number",
|
|
551
|
+
"description": "The name of the icon to be used in the format 'utility:check' when the state is true."
|
|
552
|
+
},
|
|
553
|
+
"labelWhenHover": {
|
|
554
|
+
"type": "string | number",
|
|
555
|
+
"description": "The text to be displayed inside the button when state is true and the button receives focus."
|
|
556
|
+
},
|
|
557
|
+
"labelWhenOff": {
|
|
558
|
+
"type": "string | number",
|
|
559
|
+
"description": "The text to be displayed inside the button when state is false."
|
|
560
|
+
},
|
|
561
|
+
"labelWhenOn": {
|
|
562
|
+
"type": "string | number",
|
|
563
|
+
"description": "The text to be displayed inside the button when state is true."
|
|
564
|
+
},
|
|
565
|
+
"selected": {
|
|
566
|
+
"type": "any",
|
|
567
|
+
"description": "If present, the button is in the selected state."
|
|
568
|
+
},
|
|
569
|
+
"state": {
|
|
570
|
+
"type": "boolean",
|
|
571
|
+
"description": "The state of the button, which shows whether the button has been selected or not. The default state is false."
|
|
572
|
+
},
|
|
573
|
+
"tabIndex": {
|
|
574
|
+
"type": "number | string",
|
|
575
|
+
"description": "Specifies the tab order of an element (when the tab button is used for navigating)."
|
|
576
|
+
},
|
|
577
|
+
"title": {
|
|
578
|
+
"type": "string | number",
|
|
579
|
+
"description": "Displays tooltip text when the mouse moves over the element."
|
|
580
|
+
},
|
|
581
|
+
"variant": {
|
|
582
|
+
"type": "string | number",
|
|
583
|
+
"description": "The variant changes the appearance of the button. Accepted variants include brand, destructive, inverse, neutral, success, and text."
|
|
584
|
+
}
|
|
585
|
+
},
|
|
586
|
+
"methods": {},
|
|
587
|
+
"events": {}
|
|
588
|
+
},
|
|
589
|
+
"lightning-card": {
|
|
590
|
+
"description": "Cards apply a container around a related grouping of information. [View in Component Library](https://developer.salesforce.com/docs/component-library/bundle/lightning-card)",
|
|
591
|
+
"properties": {
|
|
592
|
+
"headingLevel": {
|
|
593
|
+
"type": "any"
|
|
594
|
+
},
|
|
595
|
+
"hideHeader": {
|
|
596
|
+
"type": "any"
|
|
597
|
+
},
|
|
598
|
+
"iconName": {
|
|
599
|
+
"type": "string | number",
|
|
600
|
+
"description": "The Lightning Design System name of the icon. Names are written in the format 'utility:down' where 'utility' is the category, and 'down' is the specific icon to be displayed. The icon is displayed in the header to the left of the title."
|
|
601
|
+
},
|
|
602
|
+
"label": {
|
|
603
|
+
"type": "any"
|
|
604
|
+
},
|
|
605
|
+
"title": {
|
|
606
|
+
"type": "any",
|
|
607
|
+
"description": "The title can include text, and is displayed in the header. To include additional markup or another component, use the title slot."
|
|
608
|
+
},
|
|
609
|
+
"variant": {
|
|
610
|
+
"type": "string | number",
|
|
611
|
+
"description": "The variant changes the appearance of the card. Accepted variants include base or narrow. This value defaults to base."
|
|
612
|
+
}
|
|
613
|
+
},
|
|
614
|
+
"methods": {},
|
|
615
|
+
"events": {}
|
|
616
|
+
},
|
|
617
|
+
"lightning-carousel": {
|
|
618
|
+
"description": "A collection of images that are displayed one at a time. [View in Component Library](https://developer.salesforce.com/docs/component-library/bundle/lightning-carousel)",
|
|
619
|
+
"properties": {
|
|
620
|
+
"disableAutoRefresh": {
|
|
621
|
+
"type": "boolean",
|
|
622
|
+
"description": "If present, the carousel stops looping after the last item is displayed."
|
|
623
|
+
},
|
|
624
|
+
"disableAutoScroll": {
|
|
625
|
+
"type": "boolean",
|
|
626
|
+
"description": "If present, images do not automatically scroll and users must click the indicators to scroll."
|
|
627
|
+
},
|
|
628
|
+
"scrollDuration": {
|
|
629
|
+
"type": "number | string",
|
|
630
|
+
"description": "The auto scroll duration. The default is 5 seconds, after that the next image is displayed."
|
|
631
|
+
},
|
|
632
|
+
"title": {
|
|
633
|
+
"type": "string | number",
|
|
634
|
+
"description": "Displays tooltip text when the mouse moves over the element."
|
|
635
|
+
}
|
|
636
|
+
},
|
|
637
|
+
"methods": {},
|
|
638
|
+
"events": {}
|
|
639
|
+
},
|
|
640
|
+
"lightning-carousel-image": {
|
|
641
|
+
"properties": {
|
|
642
|
+
"alternativeText": {
|
|
643
|
+
"type": "any"
|
|
644
|
+
},
|
|
645
|
+
"description": {
|
|
646
|
+
"type": "any"
|
|
647
|
+
},
|
|
648
|
+
"header": {
|
|
649
|
+
"type": "any"
|
|
650
|
+
},
|
|
651
|
+
"href": {
|
|
652
|
+
"type": "any"
|
|
653
|
+
},
|
|
654
|
+
"src": {
|
|
655
|
+
"type": "any"
|
|
656
|
+
}
|
|
657
|
+
},
|
|
658
|
+
"methods": {},
|
|
659
|
+
"events": {}
|
|
660
|
+
},
|
|
661
|
+
"lightning-checkbox-group": {
|
|
662
|
+
"description": "A checkbox group that enables selection of single or multiple options. [View in Component Library](https://developer.salesforce.com/docs/component-library/bundle/lightning-checkbox-group)",
|
|
663
|
+
"properties": {
|
|
664
|
+
"accessKey": {
|
|
665
|
+
"type": "string | number",
|
|
666
|
+
"description": "Specifies a shortcut key to activate or focus an element."
|
|
667
|
+
},
|
|
668
|
+
"disabled": {
|
|
669
|
+
"type": "boolean",
|
|
670
|
+
"description": "If present, the checkbox group is disabled. Checkbox selections can't be changed for a disabled checkbox group."
|
|
671
|
+
},
|
|
672
|
+
"label": {
|
|
673
|
+
"type": "string | number",
|
|
674
|
+
"description": "Text label for the checkbox group."
|
|
675
|
+
},
|
|
676
|
+
"messageWhenValueMissing": {
|
|
677
|
+
"type": "string | number",
|
|
678
|
+
"description": "Optional message to be displayed when no checkbox is selected and the required attribute is set."
|
|
679
|
+
},
|
|
680
|
+
"name": {
|
|
681
|
+
"type": "string | number",
|
|
682
|
+
"description": "The name of the checkbox group."
|
|
683
|
+
},
|
|
684
|
+
"options": {
|
|
685
|
+
"type": "readonly unknown[]",
|
|
686
|
+
"description": "Array of label-value pairs for each checkbox."
|
|
687
|
+
},
|
|
688
|
+
"required": {
|
|
689
|
+
"type": "boolean",
|
|
690
|
+
"description": "If present, at least one checkbox must be selected."
|
|
691
|
+
},
|
|
692
|
+
"tabIndex": {
|
|
693
|
+
"type": "number | string",
|
|
694
|
+
"description": "Specifies the tab order of an element (when the tab button is used for navigating)."
|
|
695
|
+
},
|
|
696
|
+
"title": {
|
|
697
|
+
"type": "string | number",
|
|
698
|
+
"description": "Displays tooltip text when the mouse moves over the element."
|
|
699
|
+
},
|
|
700
|
+
"validity": {
|
|
701
|
+
"type": "any",
|
|
702
|
+
"description": "Represents the validity states that an element can be in, with respect to constraint validation."
|
|
703
|
+
},
|
|
704
|
+
"value": {
|
|
705
|
+
"type": "any",
|
|
706
|
+
"description": "The list of selected checkboxes. Each array entry contains the value of a selected checkbox. The value of each checkbox is set in the options attribute."
|
|
707
|
+
},
|
|
708
|
+
"variant": {
|
|
709
|
+
"type": "any",
|
|
710
|
+
"description": "The variant changes the appearance of the checkbox group. Accepted variants include standard, label-hidden, label-inline, and label-stacked. This value defaults to standard. Use label-hidden to hide the label but make it available to assistive technology. Use label-inline to horizontally align the label and checkbox group. Use label-stacked to place the label above the checkbox group."
|
|
711
|
+
}
|
|
712
|
+
},
|
|
713
|
+
"methods": {
|
|
714
|
+
"checkValidity": {
|
|
715
|
+
"type": "() => boolean",
|
|
716
|
+
"description": "Returns the valid attribute value (Boolean) on the ValidityState object."
|
|
717
|
+
},
|
|
718
|
+
"reportValidity": {
|
|
719
|
+
"type": "() => boolean",
|
|
720
|
+
"description": "Displays the error messages and returns false if the input is invalid. If the input is valid, reportValidity() clears displayed error messages and returns true."
|
|
721
|
+
},
|
|
722
|
+
"setCustomValidity": {
|
|
723
|
+
"type": "(message: string) => void",
|
|
724
|
+
"description": "Sets a custom error message to be displayed when the checkbox value is submitted."
|
|
725
|
+
},
|
|
726
|
+
"showHelpMessageIfInvalid": {
|
|
727
|
+
"type": "() => void",
|
|
728
|
+
"description": "Displays an error message if the checkbox value is required and no option is selected."
|
|
729
|
+
}
|
|
730
|
+
},
|
|
731
|
+
"events": {
|
|
732
|
+
"change": {
|
|
733
|
+
"type": "CustomEvent<{ value: string[] }>",
|
|
734
|
+
"description": "The checked options changed."
|
|
735
|
+
}
|
|
736
|
+
}
|
|
737
|
+
},
|
|
738
|
+
"lightning-click-to-dial": {
|
|
739
|
+
"description": "Renders a formatted phone number as click-to-dial enabled or disabled for Open CTI and Voice. [View in Component Library](https://developer.salesforce.com/docs/component-library/bundle/lightning-click-to-dial)",
|
|
740
|
+
"properties": {
|
|
741
|
+
"params": {
|
|
742
|
+
"type": "string | number",
|
|
743
|
+
"description": "Comma-separated list of parameters to pass to the third-party phone system."
|
|
744
|
+
},
|
|
745
|
+
"recordId": {
|
|
746
|
+
"type": "string | number",
|
|
747
|
+
"description": "The Salesforce record Id that's associated with the phone number. This Id is passed by the component and does not get validated."
|
|
748
|
+
},
|
|
749
|
+
"title": {
|
|
750
|
+
"type": "string | number",
|
|
751
|
+
"description": "Displays tooltip text when the mouse moves over the element."
|
|
752
|
+
},
|
|
753
|
+
"value": {
|
|
754
|
+
"type": "any",
|
|
755
|
+
"description": "The phone number to be dialed."
|
|
756
|
+
}
|
|
757
|
+
},
|
|
758
|
+
"methods": {},
|
|
759
|
+
"events": {}
|
|
760
|
+
},
|
|
761
|
+
"lightning-combobox": {
|
|
762
|
+
"description": "A widget that provides an input field that is readonly, accompanied by a dropdown list of selectable options. [View in Component Library](https://developer.salesforce.com/docs/component-library/bundle/lightning-combobox)",
|
|
763
|
+
"properties": {
|
|
764
|
+
"accessKey": {
|
|
765
|
+
"type": "string | number",
|
|
766
|
+
"description": "Specifies a shortcut key to activate or focus an element."
|
|
767
|
+
},
|
|
768
|
+
"ariaDescribedBy": {
|
|
769
|
+
"type": "any",
|
|
770
|
+
"description": "Reserved for internal use. Use the standard aria-describedby instead. A space-separated list of element IDs that provide descriptive labels for the combobox."
|
|
771
|
+
},
|
|
772
|
+
"ariaLabelledBy": {
|
|
773
|
+
"type": "any",
|
|
774
|
+
"description": "Reserved for internal use. Use the standard aria-labelledby instead. A space-separated list of element IDs that provide labels for the combobox."
|
|
775
|
+
},
|
|
776
|
+
"autocomplete": {
|
|
777
|
+
"type": "any"
|
|
778
|
+
},
|
|
779
|
+
"disabled": {
|
|
780
|
+
"type": "boolean",
|
|
781
|
+
"description": "If present, the combobox is disabled and users cannot interact with it."
|
|
782
|
+
},
|
|
783
|
+
"dropdownAlignment": {
|
|
784
|
+
"type": "string | number",
|
|
785
|
+
"description": "Specifies where the drop-down list is aligned with or anchored to the selection field. By default the list is aligned with the selection field at the top left so the list opens down. Use bottom-left to make the selection field display at the bottom so the list opens above it. Use auto to let the component determine where to open the list based on space available."
|
|
786
|
+
},
|
|
787
|
+
"fieldLevelHelp": {
|
|
788
|
+
"type": "string | number",
|
|
789
|
+
"description": "Help text detailing the purpose and function of the combobox."
|
|
790
|
+
},
|
|
791
|
+
"label": {
|
|
792
|
+
"type": "string | number",
|
|
793
|
+
"description": "Text label for the combobox."
|
|
794
|
+
},
|
|
795
|
+
"messageWhenValueMissing": {
|
|
796
|
+
"type": "string | number",
|
|
797
|
+
"description": "Error message to be displayed when the value is missing and input is required."
|
|
798
|
+
},
|
|
799
|
+
"name": {
|
|
800
|
+
"type": "string | number",
|
|
801
|
+
"description": "Specifies the name of the combobox."
|
|
802
|
+
},
|
|
803
|
+
"options": {
|
|
804
|
+
"type": "any",
|
|
805
|
+
"description": "A list of options that are available for selection. Each option has the following attributes: label and value."
|
|
806
|
+
},
|
|
807
|
+
"placeholder": {
|
|
808
|
+
"type": "string | number",
|
|
809
|
+
"description": "Text that is displayed before an option is selected, to prompt the user to select an option. The default is \"Select an Option\"."
|
|
810
|
+
},
|
|
811
|
+
"readOnly": {
|
|
812
|
+
"type": "boolean",
|
|
813
|
+
"description": "Specifies that an input field is read-only. This value defaults to false."
|
|
814
|
+
},
|
|
815
|
+
"required": {
|
|
816
|
+
"type": "boolean",
|
|
817
|
+
"description": "If present, a value must be selected before the form can be submitted."
|
|
818
|
+
},
|
|
819
|
+
"spinnerActive": {
|
|
820
|
+
"type": "boolean",
|
|
821
|
+
"description": "If present, a spinner is displayed below the menu items to indicate loading activity."
|
|
822
|
+
},
|
|
823
|
+
"tabIndex": {
|
|
824
|
+
"type": "number | string",
|
|
825
|
+
"description": "Specifies the tab order of an element (when the tab button is used for navigating)."
|
|
826
|
+
},
|
|
827
|
+
"title": {
|
|
828
|
+
"type": "string | number",
|
|
829
|
+
"description": "Displays tooltip text when the mouse moves over the element."
|
|
830
|
+
},
|
|
831
|
+
"validity": {
|
|
832
|
+
"type": "any",
|
|
833
|
+
"description": "Represents the validity states that an element can be in, with respect to constraint validation."
|
|
834
|
+
},
|
|
835
|
+
"value": {
|
|
836
|
+
"type": "any",
|
|
837
|
+
"description": "Specifies the value of an input element."
|
|
838
|
+
},
|
|
839
|
+
"variant": {
|
|
840
|
+
"type": "string | number",
|
|
841
|
+
"description": "The variant changes the appearance of the combobox. Accepted variants include standard, label-hidden, label-inline, and label-stacked. This value defaults to standard. Use label-hidden to hide the label but make it available to assistive technology. Use label-inline to horizontally align the label and combobox. Use label-stacked to place the label above the combobox."
|
|
842
|
+
}
|
|
843
|
+
},
|
|
844
|
+
"methods": {
|
|
845
|
+
"checkValidity": {
|
|
846
|
+
"type": "() => boolean",
|
|
847
|
+
"description": "Returns the valid attribute value (Boolean) on the ValidityState object."
|
|
848
|
+
},
|
|
849
|
+
"reportValidity": {
|
|
850
|
+
"type": "() => boolean",
|
|
851
|
+
"description": "Displays the error messages and returns false if the input is invalid. If the input is valid, reportValidity() clears displayed error messages and returns true."
|
|
852
|
+
},
|
|
853
|
+
"setCustomValidity": {
|
|
854
|
+
"type": "(message: string) => void",
|
|
855
|
+
"description": "Sets a custom error message to be displayed when the combobox value is submitted."
|
|
856
|
+
},
|
|
857
|
+
"showHelpMessageIfInvalid": {
|
|
858
|
+
"type": "() => void",
|
|
859
|
+
"description": "Shows the help message if the combobox is in an invalid state."
|
|
860
|
+
}
|
|
861
|
+
},
|
|
862
|
+
"events": {
|
|
863
|
+
"change": {
|
|
864
|
+
"type": "CustomEvent<{ value: string }>",
|
|
865
|
+
"description": "The event fired when an item is selected in the combobox. Bubbles, and crosses the component's shadow boundary (composed)."
|
|
866
|
+
},
|
|
867
|
+
"open": {
|
|
868
|
+
"type": "CustomEvent<any>",
|
|
869
|
+
"description": "The event fired when the dropdown is opened. Doesn't bubble."
|
|
870
|
+
}
|
|
871
|
+
}
|
|
872
|
+
},
|
|
873
|
+
"lightning-confirm": {
|
|
874
|
+
"properties": {
|
|
875
|
+
"label": {
|
|
876
|
+
"type": "any"
|
|
877
|
+
},
|
|
878
|
+
"message": {
|
|
879
|
+
"type": "any"
|
|
880
|
+
},
|
|
881
|
+
"theme": {
|
|
882
|
+
"type": "any"
|
|
883
|
+
},
|
|
884
|
+
"variant": {
|
|
885
|
+
"type": "any"
|
|
886
|
+
}
|
|
887
|
+
},
|
|
888
|
+
"methods": {},
|
|
889
|
+
"events": {}
|
|
890
|
+
},
|
|
891
|
+
"lightning-datatable": {
|
|
892
|
+
"description": "A table that displays rows and columns of data. [View in Component Library](https://developer.salesforce.com/docs/component-library/bundle/lightning-datatable)",
|
|
893
|
+
"properties": {
|
|
894
|
+
"columns": {
|
|
895
|
+
"type": "readonly unknown[]",
|
|
896
|
+
"description": "Array of the columns object that's used to define the data types. Required properties include 'label', 'fieldName', and 'type'. The default type is 'text'. See the Documentation tab for more information."
|
|
897
|
+
},
|
|
898
|
+
"columnWidthsMode": {
|
|
899
|
+
"type": "any"
|
|
900
|
+
},
|
|
901
|
+
"data": {
|
|
902
|
+
"type": "any",
|
|
903
|
+
"description": "The array of data to be displayed."
|
|
904
|
+
},
|
|
905
|
+
"defaultSortDirection": {
|
|
906
|
+
"type": "string | number",
|
|
907
|
+
"description": "Specifies the default sorting direction on an unsorted column. Valid options include 'asc' and 'desc'. The default is 'asc' for sorting in ascending order."
|
|
908
|
+
},
|
|
909
|
+
"disabledRows": {
|
|
910
|
+
"type": "any"
|
|
911
|
+
},
|
|
912
|
+
"draftValues": {
|
|
913
|
+
"type": "any",
|
|
914
|
+
"description": "The current values per row that are provided during inline edit."
|
|
915
|
+
},
|
|
916
|
+
"enableInfiniteLoading": {
|
|
917
|
+
"type": "boolean",
|
|
918
|
+
"description": "If present, you can load a subset of data and then display more when users scroll to the end of the table. Use with the onloadmore event handler to retrieve more data."
|
|
919
|
+
},
|
|
920
|
+
"errors": {
|
|
921
|
+
"type": "any",
|
|
922
|
+
"description": "Specifies an object containing information about cell level, row level, and table level errors. When it's set, error messages are displayed on the table accordingly."
|
|
923
|
+
},
|
|
924
|
+
"hideCheckboxColumn": {
|
|
925
|
+
"type": "boolean",
|
|
926
|
+
"description": "If present, the checkbox column for row selection is hidden."
|
|
927
|
+
},
|
|
928
|
+
"hideTableHeader": {
|
|
929
|
+
"type": "any",
|
|
930
|
+
"description": "If present, the table header is hidden."
|
|
931
|
+
},
|
|
932
|
+
"isLoading": {
|
|
933
|
+
"type": "boolean",
|
|
934
|
+
"description": "If present, a spinner is shown to indicate that more data is loading."
|
|
935
|
+
},
|
|
936
|
+
"keyField": {
|
|
937
|
+
"type": "string | number",
|
|
938
|
+
"description": "Required for better performance. Associates each row with a unique ID."
|
|
939
|
+
},
|
|
940
|
+
"loadMoreOffset": {
|
|
941
|
+
"type": "number | string",
|
|
942
|
+
"description": "Determines when to trigger infinite loading based on how many pixels the table's scroll position is from the bottom of the table. The default is 20."
|
|
943
|
+
},
|
|
944
|
+
"maxColumnWidth": {
|
|
945
|
+
"type": "number | string",
|
|
946
|
+
"description": "The maximum width for all columns. The default is 1000px."
|
|
947
|
+
},
|
|
948
|
+
"maxRowSelection": {
|
|
949
|
+
"type": "number | string",
|
|
950
|
+
"description": "The maximum number of rows that can be selected. Checkboxes are used for selection by default, and radio buttons are used when maxRowSelection is 1."
|
|
951
|
+
},
|
|
952
|
+
"minColumnWidth": {
|
|
953
|
+
"type": "number | string",
|
|
954
|
+
"description": "The minimum width for all columns. The default is 50px."
|
|
955
|
+
},
|
|
956
|
+
"renderConfig": {
|
|
957
|
+
"type": "any"
|
|
958
|
+
},
|
|
959
|
+
"renderMode": {
|
|
960
|
+
"type": "any"
|
|
961
|
+
},
|
|
962
|
+
"resizeColumnDisabled": {
|
|
963
|
+
"type": "boolean",
|
|
964
|
+
"description": "If present, column resizing is disabled."
|
|
965
|
+
},
|
|
966
|
+
"resizeStep": {
|
|
967
|
+
"type": "number | string",
|
|
968
|
+
"description": "The width to resize the column when a user presses left or right arrow. The default is 10px."
|
|
969
|
+
},
|
|
970
|
+
"rowNumberOffset": {
|
|
971
|
+
"type": "number | string",
|
|
972
|
+
"description": "Determines where to start counting the row number. The default is 0."
|
|
973
|
+
},
|
|
974
|
+
"selectedRows": {
|
|
975
|
+
"type": "readonly unknown[]",
|
|
976
|
+
"description": "Enables programmatic row selection with a list of key-field values."
|
|
977
|
+
},
|
|
978
|
+
"showRowNumberColumn": {
|
|
979
|
+
"type": "boolean",
|
|
980
|
+
"description": "If present, the row numbers are shown in the first column."
|
|
981
|
+
},
|
|
982
|
+
"singleRowSelectionMode": {
|
|
983
|
+
"type": "any"
|
|
984
|
+
},
|
|
985
|
+
"sortedBy": {
|
|
986
|
+
"type": "string | number",
|
|
987
|
+
"description": "The column fieldName that controls the sorting order. Sort the data using the onsort event handler."
|
|
988
|
+
},
|
|
989
|
+
"sortedDirection": {
|
|
990
|
+
"type": "string | number",
|
|
991
|
+
"description": "Specifies the sorting direction. Sort the data using the onsort event handler. Valid options include 'asc' and 'desc'."
|
|
992
|
+
},
|
|
993
|
+
"suppressBottomBar": {
|
|
994
|
+
"type": "any",
|
|
995
|
+
"description": "If present, the footer that displays the Save and Cancel buttons is hidden during inline editing."
|
|
996
|
+
},
|
|
997
|
+
"title": {
|
|
998
|
+
"type": "string | number",
|
|
999
|
+
"description": "Displays tooltip text when the mouse moves over the element."
|
|
1000
|
+
},
|
|
1001
|
+
"wrapTableHeader": {
|
|
1002
|
+
"type": "any"
|
|
1003
|
+
},
|
|
1004
|
+
"wrapTextMaxLines": {
|
|
1005
|
+
"type": "any",
|
|
1006
|
+
"description": "This value specifies the number of lines after which the content will be cut off and hidden. It must be at least 1 or more. The text in the last line is truncated and shown with an ellipsis."
|
|
1007
|
+
}
|
|
1008
|
+
},
|
|
1009
|
+
"methods": {
|
|
1010
|
+
"getSelectedRows": {
|
|
1011
|
+
"type": "(...args: any[]) => any",
|
|
1012
|
+
"description": "Returns data in each selected row."
|
|
1013
|
+
},
|
|
1014
|
+
"openInlineEdit": {
|
|
1015
|
+
"type": "(...args: any[]) => any",
|
|
1016
|
+
"description": "Opens the inline edit panel for the datatable's currently active cell. If the active cell is not editable, then the panel is instead opened for the first editable cell in the table. Given two distinct cells, C_x and C_y, C_x is considered \"first\" in the cell ordering if the following condition evaluates to true: (C_x.rowIndex < C_y.rowIndex) || (C_x.rowIndex === C_y.rowIndex && C_x.columnIndex < C_y.columnIndex) If there is no data in the table or there are no editable cells in the table then calling this function results in a no-op."
|
|
1017
|
+
},
|
|
1018
|
+
"scrollToTop": {
|
|
1019
|
+
"type": "() => any",
|
|
1020
|
+
"description": "Scrolls to the top of the datatable."
|
|
1021
|
+
}
|
|
1022
|
+
},
|
|
1023
|
+
"events": {
|
|
1024
|
+
"cancel": {
|
|
1025
|
+
"type": "CustomEvent<any>",
|
|
1026
|
+
"description": "The event fired when the cancel button is pressed during inline editing. Doesn't bubble."
|
|
1027
|
+
},
|
|
1028
|
+
"cellchange": {
|
|
1029
|
+
"type": "CustomEvent<{ draftValues: any[] }>",
|
|
1030
|
+
"description": "An inline edit changed a cell."
|
|
1031
|
+
},
|
|
1032
|
+
"headeraction": {
|
|
1033
|
+
"type": "CustomEvent<{ action: any; columnDefinition: any }>",
|
|
1034
|
+
"description": "The event fired when a header action is selected, such as text wrapping, text clipping, or a custom header action. Doesn't bubble."
|
|
1035
|
+
},
|
|
1036
|
+
"loadmore": {
|
|
1037
|
+
"type": "CustomEvent<{ enableInfiniteLoading: boolean; isLoading: boolean; loadMoreOffset: number }>",
|
|
1038
|
+
"description": "The event fired when you scroll to the bottom of the table to load more data, until there are no more data to load. Doesn't bubble."
|
|
1039
|
+
},
|
|
1040
|
+
"resize": {
|
|
1041
|
+
"type": "CustomEvent<{ columnWidths: any; isUserTriggered: boolean }>",
|
|
1042
|
+
"description": "The event fired when the a table column is resized, which depends on which width mode you're using. Doesn't bubble."
|
|
1043
|
+
},
|
|
1044
|
+
"rowaction": {
|
|
1045
|
+
"type": "CustomEvent<{ action: any; row: any }>",
|
|
1046
|
+
"description": "A row action was clicked."
|
|
1047
|
+
},
|
|
1048
|
+
"rowselection": {
|
|
1049
|
+
"type": "CustomEvent<{ selectedRows: any[]; config?: { action?: string; value?: any } }>",
|
|
1050
|
+
"description": "The event fired when the row is selected. Doesn't bubble."
|
|
1051
|
+
},
|
|
1052
|
+
"save": {
|
|
1053
|
+
"type": "CustomEvent<{ draftValues: any[] }>",
|
|
1054
|
+
"description": "The event fired when data is saved during inline editing. Doesn't bubble."
|
|
1055
|
+
},
|
|
1056
|
+
"sort": {
|
|
1057
|
+
"type": "CustomEvent<{ fieldName: string; sortDirection: \"asc\" | \"desc\"; isMultiColumnSort?: boolean }>",
|
|
1058
|
+
"description": "The event fired when a column is sorted. Doesn't bubble."
|
|
1059
|
+
}
|
|
1060
|
+
}
|
|
1061
|
+
},
|
|
1062
|
+
"lightning-dual-listbox": {
|
|
1063
|
+
"description": "A pair of listboxes that enables multiple options to be selected and reordered. [View in Component Library](https://developer.salesforce.com/docs/component-library/bundle/lightning-dual-listbox)",
|
|
1064
|
+
"properties": {
|
|
1065
|
+
"accessKey": {
|
|
1066
|
+
"type": "string | number",
|
|
1067
|
+
"description": "Specifies a shortcut key to activate or focus an element."
|
|
1068
|
+
},
|
|
1069
|
+
"addButtonLabel": {
|
|
1070
|
+
"type": "string | number",
|
|
1071
|
+
"description": "Label for add button."
|
|
1072
|
+
},
|
|
1073
|
+
"disabled": {
|
|
1074
|
+
"type": "boolean",
|
|
1075
|
+
"description": "If present, the listbox is disabled and users cannot interact with it."
|
|
1076
|
+
},
|
|
1077
|
+
"disableReordering": {
|
|
1078
|
+
"type": "boolean",
|
|
1079
|
+
"description": "If present, the Up and Down buttons used for reordering the selected list items are hidden."
|
|
1080
|
+
},
|
|
1081
|
+
"downButtonLabel": {
|
|
1082
|
+
"type": "string | number",
|
|
1083
|
+
"description": "Label for down button."
|
|
1084
|
+
},
|
|
1085
|
+
"fieldLevelHelp": {
|
|
1086
|
+
"type": "string | number",
|
|
1087
|
+
"description": "Help text detailing the purpose and function of the dual listbox."
|
|
1088
|
+
},
|
|
1089
|
+
"label": {
|
|
1090
|
+
"type": "string | number",
|
|
1091
|
+
"description": "Label for the dual listbox."
|
|
1092
|
+
},
|
|
1093
|
+
"max": {
|
|
1094
|
+
"type": "number | string",
|
|
1095
|
+
"description": "Maximum number of options allowed in the selected options listbox."
|
|
1096
|
+
},
|
|
1097
|
+
"messageWhenRangeOverflow": {
|
|
1098
|
+
"type": "any",
|
|
1099
|
+
"description": "Error message to be displayed when a range overflow is detected."
|
|
1100
|
+
},
|
|
1101
|
+
"messageWhenRangeUnderflow": {
|
|
1102
|
+
"type": "any",
|
|
1103
|
+
"description": "Error message to be displayed when a range underflow is detected."
|
|
1104
|
+
},
|
|
1105
|
+
"messageWhenValueMissing": {
|
|
1106
|
+
"type": "any",
|
|
1107
|
+
"description": "Error message to be displayed when the value is missing and input is required."
|
|
1108
|
+
},
|
|
1109
|
+
"min": {
|
|
1110
|
+
"type": "number | string",
|
|
1111
|
+
"description": "Minimum number of options required in the selected options listbox."
|
|
1112
|
+
},
|
|
1113
|
+
"name": {
|
|
1114
|
+
"type": "string | number",
|
|
1115
|
+
"description": "Specifies the name of an input element."
|
|
1116
|
+
},
|
|
1117
|
+
"options": {
|
|
1118
|
+
"type": "any",
|
|
1119
|
+
"description": "A list of options that are available for selection. Each option has the following attributes: label and value."
|
|
1120
|
+
},
|
|
1121
|
+
"readOnly": {
|
|
1122
|
+
"type": "boolean",
|
|
1123
|
+
"description": "Specifies that an input field is read-only. This value defaults to false."
|
|
1124
|
+
},
|
|
1125
|
+
"removeButtonLabel": {
|
|
1126
|
+
"type": "string | number",
|
|
1127
|
+
"description": "Label for remove button."
|
|
1128
|
+
},
|
|
1129
|
+
"required": {
|
|
1130
|
+
"type": "boolean",
|
|
1131
|
+
"description": "If present, the user must add an item to the selected listbox before submitting the form."
|
|
1132
|
+
},
|
|
1133
|
+
"requiredOptions": {
|
|
1134
|
+
"type": "readonly unknown[]",
|
|
1135
|
+
"description": "A list of required options that cannot be removed from selected options listbox. This list is populated with values from the options attribute."
|
|
1136
|
+
},
|
|
1137
|
+
"selectedLabel": {
|
|
1138
|
+
"type": "string | number",
|
|
1139
|
+
"description": "Label for the selected options listbox."
|
|
1140
|
+
},
|
|
1141
|
+
"showActivityIndicator": {
|
|
1142
|
+
"type": "boolean",
|
|
1143
|
+
"description": "If present, a spinner is displayed in the first listbox to indicate loading activity."
|
|
1144
|
+
},
|
|
1145
|
+
"size": {
|
|
1146
|
+
"type": "number | string",
|
|
1147
|
+
"description": "Number of items that display in the listboxes before vertical scrollbars are displayed. Determines the vertical size of the listbox."
|
|
1148
|
+
},
|
|
1149
|
+
"sourceLabel": {
|
|
1150
|
+
"type": "string | number",
|
|
1151
|
+
"description": "Label for the source options listbox."
|
|
1152
|
+
},
|
|
1153
|
+
"tabIndex": {
|
|
1154
|
+
"type": "number | string",
|
|
1155
|
+
"description": "Specifies the tab order of an element (when the tab button is used for navigating)."
|
|
1156
|
+
},
|
|
1157
|
+
"upButtonLabel": {
|
|
1158
|
+
"type": "string | number",
|
|
1159
|
+
"description": "Label for up button."
|
|
1160
|
+
},
|
|
1161
|
+
"validity": {
|
|
1162
|
+
"type": "any",
|
|
1163
|
+
"description": "Represents the validity states that an element can be in, with respect to constraint validation."
|
|
1164
|
+
},
|
|
1165
|
+
"value": {
|
|
1166
|
+
"type": "any",
|
|
1167
|
+
"description": "A list of default options that are included in the selected options listbox. This list is populated with values from the options attribute."
|
|
1168
|
+
},
|
|
1169
|
+
"values": {
|
|
1170
|
+
"type": "readonly unknown[]",
|
|
1171
|
+
"description": "A list of default options that are included in the selected options list box. This list is populated with values from the options attribute."
|
|
1172
|
+
},
|
|
1173
|
+
"variant": {
|
|
1174
|
+
"type": "string | number",
|
|
1175
|
+
"description": "The variant changes the appearance of the dual listbox. Accepted variants include standard, label-hidden, label-inline, and label-stacked. This value defaults to standard. Use label-hidden to hide the label but make it available to assistive technology. Use label-inline to horizontally align the label and dual listbox. Use label-stacked to place the label above the dual listbox."
|
|
1176
|
+
}
|
|
1177
|
+
},
|
|
1178
|
+
"methods": {
|
|
1179
|
+
"checkValidity": {
|
|
1180
|
+
"type": "() => boolean",
|
|
1181
|
+
"description": "Returns the valid attribute value (Boolean) on the ValidityState object."
|
|
1182
|
+
},
|
|
1183
|
+
"reportValidity": {
|
|
1184
|
+
"type": "() => boolean",
|
|
1185
|
+
"description": "Displays the error messages and returns false if the input is invalid. If the input is valid, reportValidity() clears displayed error messages and returns true."
|
|
1186
|
+
},
|
|
1187
|
+
"setCustomValidity": {
|
|
1188
|
+
"type": "(message: string) => void",
|
|
1189
|
+
"description": "Sets a custom error message to be displayed when the dual listbox value is submitted."
|
|
1190
|
+
},
|
|
1191
|
+
"showHelpMessageIfInvalid": {
|
|
1192
|
+
"type": "() => void",
|
|
1193
|
+
"description": "Displays an error message if the dual listbox value is required."
|
|
1194
|
+
}
|
|
1195
|
+
},
|
|
1196
|
+
"events": {
|
|
1197
|
+
"change": {
|
|
1198
|
+
"type": "CustomEvent<{ value: string[] }>",
|
|
1199
|
+
"description": "The event fired when an item is selected in the combobox. Bubbles, and crosses the component's shadow boundary (composed)."
|
|
1200
|
+
}
|
|
1201
|
+
}
|
|
1202
|
+
},
|
|
1203
|
+
"lightning-dynamic-icon": {
|
|
1204
|
+
"description": "Represents various animated icons with different states. [View in Component Library](https://developer.salesforce.com/docs/component-library/bundle/lightning-dynamic-icon)",
|
|
1205
|
+
"properties": {
|
|
1206
|
+
"alternativeText": {
|
|
1207
|
+
"type": "string | number",
|
|
1208
|
+
"description": "The alternative text used to describe the dynamic icon. This text should describe what's happening. For example, 'Graph is refreshing', not what the icon looks like, 'Graph'."
|
|
1209
|
+
},
|
|
1210
|
+
"option": {
|
|
1211
|
+
"type": "string | number",
|
|
1212
|
+
"description": "The option attribute changes the appearance of the dynamic icon. The options available depend on the type. eq: play (default) or stop score: positive (default) or negative strength: -3, -2, -1, 0 (default), 1, 2, 3 trend: neutral (default), up, or down"
|
|
1213
|
+
},
|
|
1214
|
+
"title": {
|
|
1215
|
+
"type": "string | number",
|
|
1216
|
+
"description": "Displays tooltip text when the mouse moves over the element."
|
|
1217
|
+
},
|
|
1218
|
+
"type": {
|
|
1219
|
+
"type": "string | number",
|
|
1220
|
+
"description": "The Lightning Design System name of the dynamic icon. Valid values are: ellie, eq, score, strength, trend, and waffle."
|
|
1221
|
+
}
|
|
1222
|
+
},
|
|
1223
|
+
"methods": {},
|
|
1224
|
+
"events": {}
|
|
1225
|
+
},
|
|
1226
|
+
"lightning-empty-state": {
|
|
1227
|
+
"description": "Presents information to help users understand why a panel or other container has no content.",
|
|
1228
|
+
"properties": {
|
|
1229
|
+
"alternativeText": {
|
|
1230
|
+
"type": "string | number",
|
|
1231
|
+
"description": "Assistive text that describes the illustration. Provide this text for assistive devices if the description and title aren't meaningful enough by themselves."
|
|
1232
|
+
},
|
|
1233
|
+
"headingLevel": {
|
|
1234
|
+
"type": "string | number",
|
|
1235
|
+
"description": "Sets the aria-level value for the <h3> element in the empty state's title element. Specify headingLevel if the implicit value 3 isn't correct for your use case. Supported values are 1, 2, 3, 4, 5, 6."
|
|
1236
|
+
},
|
|
1237
|
+
"illustrationName": {
|
|
1238
|
+
"type": "string | number",
|
|
1239
|
+
"description": "The illustration identifier in \"set:symbol\" format. See the Develop tab for valid illustration names."
|
|
1240
|
+
},
|
|
1241
|
+
"size": {
|
|
1242
|
+
"type": "string | number",
|
|
1243
|
+
"description": "Overrides the automatic illustration sizing. Valid values are x-small, small, medium. The default value is null, which triggers the automatic sizing."
|
|
1244
|
+
},
|
|
1245
|
+
"title": {
|
|
1246
|
+
"type": "string | number",
|
|
1247
|
+
"description": "Text to display as the title in an <h3> element in the component."
|
|
1248
|
+
}
|
|
1249
|
+
},
|
|
1250
|
+
"methods": {},
|
|
1251
|
+
"events": {}
|
|
1252
|
+
},
|
|
1253
|
+
"lightning-file-upload": {
|
|
1254
|
+
"description": "A file uploader for uploading and attaching files to records. [View in Component Library](https://developer.salesforce.com/docs/component-library/bundle/lightning-file-upload)",
|
|
1255
|
+
"properties": {
|
|
1256
|
+
"accept": {
|
|
1257
|
+
"type": "readonly unknown[]",
|
|
1258
|
+
"description": "Comma-separated list of file extensions that can be uploaded in the format .ext, such as .pdf, .jpg, or .png."
|
|
1259
|
+
},
|
|
1260
|
+
"disabled": {
|
|
1261
|
+
"type": "boolean",
|
|
1262
|
+
"description": "Specifies whether this component should be displayed in a disabled state. Disabled components can't be clicked. The default is false."
|
|
1263
|
+
},
|
|
1264
|
+
"fileFieldName": {
|
|
1265
|
+
"type": "any"
|
|
1266
|
+
},
|
|
1267
|
+
"fileFieldValue": {
|
|
1268
|
+
"type": "any"
|
|
1269
|
+
},
|
|
1270
|
+
"label": {
|
|
1271
|
+
"type": "string | number",
|
|
1272
|
+
"description": "The text label for the file uploader."
|
|
1273
|
+
},
|
|
1274
|
+
"multiple": {
|
|
1275
|
+
"type": "boolean",
|
|
1276
|
+
"description": "Specifies whether a user can upload more than one file simultaneously. The default is false."
|
|
1277
|
+
},
|
|
1278
|
+
"name": {
|
|
1279
|
+
"type": "string | number",
|
|
1280
|
+
"description": "Specifies the name of the input element."
|
|
1281
|
+
},
|
|
1282
|
+
"recordId": {
|
|
1283
|
+
"type": "string | number",
|
|
1284
|
+
"description": "The record Id of the record that the uploaded file is associated to."
|
|
1285
|
+
},
|
|
1286
|
+
"required": {
|
|
1287
|
+
"type": "any"
|
|
1288
|
+
},
|
|
1289
|
+
"title": {
|
|
1290
|
+
"type": "string | number",
|
|
1291
|
+
"description": "Displays tooltip text when the mouse moves over the element."
|
|
1292
|
+
}
|
|
1293
|
+
},
|
|
1294
|
+
"methods": {
|
|
1295
|
+
"reportValidity": {
|
|
1296
|
+
"type": "() => boolean",
|
|
1297
|
+
"description": "Displays the error messages and returns false if the input is invalid. If the input is valid, reportValidity() clears displayed error messages and returns true."
|
|
1298
|
+
},
|
|
1299
|
+
"setCustomValidity": {
|
|
1300
|
+
"type": "(message: string) => void",
|
|
1301
|
+
"description": "Sets a custom error message to be displayed when a form is submitted."
|
|
1302
|
+
}
|
|
1303
|
+
},
|
|
1304
|
+
"events": {
|
|
1305
|
+
"uploadfinished": {
|
|
1306
|
+
"type": "CustomEvent<{ files: any[] }>",
|
|
1307
|
+
"description": "The event fired when files are uploaded successfully. Doesn't bubble."
|
|
1308
|
+
}
|
|
1309
|
+
}
|
|
1310
|
+
},
|
|
1311
|
+
"lightning-flow": {
|
|
1312
|
+
"properties": {
|
|
1313
|
+
"flowApiName": {
|
|
1314
|
+
"type": "any"
|
|
1315
|
+
},
|
|
1316
|
+
"flowFinishBehavior": {
|
|
1317
|
+
"type": "any"
|
|
1318
|
+
},
|
|
1319
|
+
"flowInputVariables": {
|
|
1320
|
+
"type": "any"
|
|
1321
|
+
},
|
|
1322
|
+
"flowInterviewId": {
|
|
1323
|
+
"type": "any"
|
|
1324
|
+
}
|
|
1325
|
+
},
|
|
1326
|
+
"methods": {
|
|
1327
|
+
"resumeFlow": {
|
|
1328
|
+
"type": "(flowInterviewId: string) => void",
|
|
1329
|
+
"description": "Call this method with a `flowInterviewId` to resume an existing paused interview"
|
|
1330
|
+
},
|
|
1331
|
+
"startFlow": {
|
|
1332
|
+
"type": "(flowApiName: string, flowInputVariables?: any[]) => void",
|
|
1333
|
+
"description": "Starts a flow interview."
|
|
1334
|
+
}
|
|
1335
|
+
},
|
|
1336
|
+
"events": {}
|
|
1337
|
+
},
|
|
1338
|
+
"lightning-form-element": {
|
|
1339
|
+
"properties": {},
|
|
1340
|
+
"methods": {},
|
|
1341
|
+
"events": {}
|
|
1342
|
+
},
|
|
1343
|
+
"lightning-formatted-address": {
|
|
1344
|
+
"description": "Displays a formatted address with a link to the given location on Google Maps. The link is opened in a new tab. A static map can be displayed with the address for better context. [View in Component Library](https://developer.salesforce.com/docs/component-library/bundle/lightning-formatted-address)",
|
|
1345
|
+
"properties": {
|
|
1346
|
+
"city": {
|
|
1347
|
+
"type": "string | number",
|
|
1348
|
+
"description": "The city detail for the address."
|
|
1349
|
+
},
|
|
1350
|
+
"country": {
|
|
1351
|
+
"type": "string | number",
|
|
1352
|
+
"description": "The country detail for the address."
|
|
1353
|
+
},
|
|
1354
|
+
"disabled": {
|
|
1355
|
+
"type": "boolean",
|
|
1356
|
+
"description": "If present, the address is displayed as plain text and is not clickable."
|
|
1357
|
+
},
|
|
1358
|
+
"latitude": {
|
|
1359
|
+
"type": "number | string",
|
|
1360
|
+
"description": "The latitude of the location if known. Latitude values must be within -90 and 90."
|
|
1361
|
+
},
|
|
1362
|
+
"locale": {
|
|
1363
|
+
"type": "any"
|
|
1364
|
+
},
|
|
1365
|
+
"longitude": {
|
|
1366
|
+
"type": "number | string",
|
|
1367
|
+
"description": "The longitude of the location if known. Longitude values must be within -180 and 180."
|
|
1368
|
+
},
|
|
1369
|
+
"postalCode": {
|
|
1370
|
+
"type": "string | number",
|
|
1371
|
+
"description": "The postal code detail for the address."
|
|
1372
|
+
},
|
|
1373
|
+
"province": {
|
|
1374
|
+
"type": "string | number",
|
|
1375
|
+
"description": "The province detail for the address."
|
|
1376
|
+
},
|
|
1377
|
+
"showStaticMap": {
|
|
1378
|
+
"type": "any",
|
|
1379
|
+
"description": "Displays a static map of the location using Google Maps. This value defaults to false."
|
|
1380
|
+
},
|
|
1381
|
+
"street": {
|
|
1382
|
+
"type": "string | number",
|
|
1383
|
+
"description": "The street detail for the address."
|
|
1384
|
+
},
|
|
1385
|
+
"title": {
|
|
1386
|
+
"type": "string | number",
|
|
1387
|
+
"description": "Displays tooltip text when the mouse moves over the element."
|
|
1388
|
+
},
|
|
1389
|
+
"variant": {
|
|
1390
|
+
"type": "any"
|
|
1391
|
+
}
|
|
1392
|
+
},
|
|
1393
|
+
"methods": {},
|
|
1394
|
+
"events": {}
|
|
1395
|
+
},
|
|
1396
|
+
"lightning-formatted-date-time": {
|
|
1397
|
+
"description": "Displays formatted date and time. [View in Component Library](https://developer.salesforce.com/docs/component-library/bundle/lightning-formatted-date-time)",
|
|
1398
|
+
"properties": {
|
|
1399
|
+
"dateStyle": {
|
|
1400
|
+
"type": "any"
|
|
1401
|
+
},
|
|
1402
|
+
"day": {
|
|
1403
|
+
"type": "string | number",
|
|
1404
|
+
"description": "Allowed values are numeric or 2-digit."
|
|
1405
|
+
},
|
|
1406
|
+
"era": {
|
|
1407
|
+
"type": "string | number",
|
|
1408
|
+
"description": "Allowed values are narrow, short, or long."
|
|
1409
|
+
},
|
|
1410
|
+
"hour": {
|
|
1411
|
+
"type": "string | number",
|
|
1412
|
+
"description": "Allowed values are numeric or 2-digit."
|
|
1413
|
+
},
|
|
1414
|
+
"hour12": {
|
|
1415
|
+
"type": "boolean",
|
|
1416
|
+
"description": "Determines whether time is displayed as 12-hour. If false, time displays as 24-hour. The default setting is determined by the user's locale."
|
|
1417
|
+
},
|
|
1418
|
+
"minute": {
|
|
1419
|
+
"type": "string | number",
|
|
1420
|
+
"description": "Allowed values are numeric or 2-digit."
|
|
1421
|
+
},
|
|
1422
|
+
"month": {
|
|
1423
|
+
"type": "string | number",
|
|
1424
|
+
"description": "Allowed values are 2-digit, narrow, short, or long."
|
|
1425
|
+
},
|
|
1426
|
+
"second": {
|
|
1427
|
+
"type": "string | number",
|
|
1428
|
+
"description": "Allowed values are numeric or 2-digit."
|
|
1429
|
+
},
|
|
1430
|
+
"timeZone": {
|
|
1431
|
+
"type": "string | number",
|
|
1432
|
+
"description": "The time zone to display. Use this attribute only if you want to override the default, which is the runtime's time zone. Specify a time zone listed in the IANA time zone database (https://www.iana.org/time-zones). For example, set the value to 'Pacific/Honolulu' to display Hawaii time. The short code UTC is also accepted."
|
|
1433
|
+
},
|
|
1434
|
+
"timeZoneName": {
|
|
1435
|
+
"type": "string | number",
|
|
1436
|
+
"description": "Allowed values are short or long. For example, the Pacific time zone would display as 'PST' if you specify 'short', or 'Pacific Standard Time' if you specify 'long.'"
|
|
1437
|
+
},
|
|
1438
|
+
"title": {
|
|
1439
|
+
"type": "string | number",
|
|
1440
|
+
"description": "Displays tooltip text when the mouse moves over the element."
|
|
1441
|
+
},
|
|
1442
|
+
"value": {
|
|
1443
|
+
"type": "any",
|
|
1444
|
+
"description": "The value to be formatted, which can be a Date object, timestamp, or an ISO8601 formatted string."
|
|
1445
|
+
},
|
|
1446
|
+
"weekday": {
|
|
1447
|
+
"type": "string | number",
|
|
1448
|
+
"description": "Specifies how to display the day of the week. Allowed values are narrow, short, or long."
|
|
1449
|
+
},
|
|
1450
|
+
"year": {
|
|
1451
|
+
"type": "string | number",
|
|
1452
|
+
"description": "Allowed values are numeric or 2-digit."
|
|
1453
|
+
}
|
|
1454
|
+
},
|
|
1455
|
+
"methods": {},
|
|
1456
|
+
"events": {}
|
|
1457
|
+
},
|
|
1458
|
+
"lightning-formatted-email": {
|
|
1459
|
+
"description": "Displays an email as a hyperlink with the mailto: URL scheme. [View in Component Library](https://developer.salesforce.com/docs/component-library/bundle/lightning-formatted-email)",
|
|
1460
|
+
"properties": {
|
|
1461
|
+
"hideIcon": {
|
|
1462
|
+
"type": "any",
|
|
1463
|
+
"description": "If present, the email icon is hidden and only the email address is displayed."
|
|
1464
|
+
},
|
|
1465
|
+
"label": {
|
|
1466
|
+
"type": "string | number",
|
|
1467
|
+
"description": "The text label for the email address."
|
|
1468
|
+
},
|
|
1469
|
+
"tabIndex": {
|
|
1470
|
+
"type": "any",
|
|
1471
|
+
"description": "Reserved for internal use. Use tabindex instead to indicate if an element should be focusable. A value of 0 means that the element is focusable and participates in sequential keyboard navigation. A value of -1 means that the element is focusable but does not participate in keyboard navigation."
|
|
1472
|
+
},
|
|
1473
|
+
"value": {
|
|
1474
|
+
"type": "any",
|
|
1475
|
+
"description": "The email address that's displayed if a label is not provided."
|
|
1476
|
+
}
|
|
1477
|
+
},
|
|
1478
|
+
"methods": {},
|
|
1479
|
+
"events": {}
|
|
1480
|
+
},
|
|
1481
|
+
"lightning-formatted-location": {
|
|
1482
|
+
"description": "Displays a geolocation in decimal degrees using the format [latitude, longitude]. [View in Component Library](https://developer.salesforce.com/docs/component-library/bundle/lightning-formatted-location)",
|
|
1483
|
+
"properties": {
|
|
1484
|
+
"latitude": {
|
|
1485
|
+
"type": "number | string",
|
|
1486
|
+
"description": "The latitude of the geolocation. Latitude values must be within -90 and 90."
|
|
1487
|
+
},
|
|
1488
|
+
"longitude": {
|
|
1489
|
+
"type": "number | string",
|
|
1490
|
+
"description": "The longitude of the geolocation. Longitude values must be within -180 and 180."
|
|
1491
|
+
},
|
|
1492
|
+
"title": {
|
|
1493
|
+
"type": "string | number",
|
|
1494
|
+
"description": "Displays tooltip text when the mouse moves over the element."
|
|
1495
|
+
}
|
|
1496
|
+
},
|
|
1497
|
+
"methods": {},
|
|
1498
|
+
"events": {}
|
|
1499
|
+
},
|
|
1500
|
+
"lightning-formatted-name": {
|
|
1501
|
+
"description": "Displays a formatted name that can include a salutation and suffix. [View in Component Library](https://developer.salesforce.com/docs/component-library/bundle/lightning-formatted-name)",
|
|
1502
|
+
"properties": {
|
|
1503
|
+
"firstName": {
|
|
1504
|
+
"type": "string | number",
|
|
1505
|
+
"description": "The value for the first name."
|
|
1506
|
+
},
|
|
1507
|
+
"format": {
|
|
1508
|
+
"type": "string | number",
|
|
1509
|
+
"description": "The format to use to display the name. Valid values include short, medium, and long. This value defaults to long."
|
|
1510
|
+
},
|
|
1511
|
+
"informalName": {
|
|
1512
|
+
"type": "string | number",
|
|
1513
|
+
"description": "The value for the informal name."
|
|
1514
|
+
},
|
|
1515
|
+
"lastName": {
|
|
1516
|
+
"type": "string | number",
|
|
1517
|
+
"description": "The value for the last name."
|
|
1518
|
+
},
|
|
1519
|
+
"locale": {
|
|
1520
|
+
"type": "any"
|
|
1521
|
+
},
|
|
1522
|
+
"middleName": {
|
|
1523
|
+
"type": "string | number",
|
|
1524
|
+
"description": "The value for the middle name."
|
|
1525
|
+
},
|
|
1526
|
+
"salutation": {
|
|
1527
|
+
"type": "string | number",
|
|
1528
|
+
"description": "The value for the salutation, such as Dr. or Mrs."
|
|
1529
|
+
},
|
|
1530
|
+
"suffix": {
|
|
1531
|
+
"type": "string | number",
|
|
1532
|
+
"description": "The value for the suffix, such as Jr. or Esq."
|
|
1533
|
+
},
|
|
1534
|
+
"title": {
|
|
1535
|
+
"type": "string | number",
|
|
1536
|
+
"description": "Displays tooltip text when the mouse moves over the element."
|
|
1537
|
+
}
|
|
1538
|
+
},
|
|
1539
|
+
"methods": {},
|
|
1540
|
+
"events": {}
|
|
1541
|
+
},
|
|
1542
|
+
"lightning-formatted-number": {
|
|
1543
|
+
"description": "Displays formatted numbers for decimals, currency, and percentages. [View in Component Library](https://developer.salesforce.com/docs/component-library/bundle/lightning-formatted-number)",
|
|
1544
|
+
"properties": {
|
|
1545
|
+
"currencyCode": {
|
|
1546
|
+
"type": "string | number",
|
|
1547
|
+
"description": "Only used if format-style='currency', this attribute determines which currency is displayed. Possible values are the ISO 4217 currency codes, such as 'USD' for the US dollar."
|
|
1548
|
+
},
|
|
1549
|
+
"currencyDisplayAs": {
|
|
1550
|
+
"type": "string | number",
|
|
1551
|
+
"description": "Determines how currency is displayed. Possible values are symbol, code, and name. This value defaults to symbol."
|
|
1552
|
+
},
|
|
1553
|
+
"formatStyle": {
|
|
1554
|
+
"type": "any",
|
|
1555
|
+
"description": "The number formatting style to use. Possible values are decimal, currency, and percent. This value defaults to decimal."
|
|
1556
|
+
},
|
|
1557
|
+
"maximumFractionDigits": {
|
|
1558
|
+
"type": "number | string",
|
|
1559
|
+
"description": "The maximum number of fraction digits that are allowed."
|
|
1560
|
+
},
|
|
1561
|
+
"maximumSignificantDigits": {
|
|
1562
|
+
"type": "number | string",
|
|
1563
|
+
"description": "The maximum number of significant digits that are allowed. Possible values are from 1 to 21."
|
|
1564
|
+
},
|
|
1565
|
+
"minimumFractionDigits": {
|
|
1566
|
+
"type": "number | string",
|
|
1567
|
+
"description": "The minimum number of fraction digits that are required."
|
|
1568
|
+
},
|
|
1569
|
+
"minimumIntegerDigits": {
|
|
1570
|
+
"type": "number | string",
|
|
1571
|
+
"description": "The minimum number of integer digits that are required. Possible values are from 1 to 21."
|
|
1572
|
+
},
|
|
1573
|
+
"minimumSignificantDigits": {
|
|
1574
|
+
"type": "number | string",
|
|
1575
|
+
"description": "The minimum number of significant digits that are required. Possible values are from 1 to 21."
|
|
1576
|
+
},
|
|
1577
|
+
"title": {
|
|
1578
|
+
"type": "string | number",
|
|
1579
|
+
"description": "Displays tooltip text when the mouse moves over the element."
|
|
1580
|
+
},
|
|
1581
|
+
"value": {
|
|
1582
|
+
"type": "any",
|
|
1583
|
+
"description": "The value to be formatted."
|
|
1584
|
+
}
|
|
1585
|
+
},
|
|
1586
|
+
"methods": {},
|
|
1587
|
+
"events": {}
|
|
1588
|
+
},
|
|
1589
|
+
"lightning-formatted-phone": {
|
|
1590
|
+
"description": "Displays a phone number as a hyperlink with the tel: URL scheme. [View in Component Library](https://developer.salesforce.com/docs/component-library/bundle/lightning-formatted-phone)",
|
|
1591
|
+
"properties": {
|
|
1592
|
+
"disabled": {
|
|
1593
|
+
"type": "any"
|
|
1594
|
+
},
|
|
1595
|
+
"tabIndex": {
|
|
1596
|
+
"type": "any",
|
|
1597
|
+
"description": "Reserved for internal use. Use tabindex instead to indicate if an element should be focusable. A value of 0 means that the element is focusable and participates in sequential keyboard navigation. A value of -1 means that the element is focusable but does not participate in keyboard navigation."
|
|
1598
|
+
},
|
|
1599
|
+
"title": {
|
|
1600
|
+
"type": "string | number",
|
|
1601
|
+
"description": "Displays tooltip text when the mouse moves over the element."
|
|
1602
|
+
},
|
|
1603
|
+
"value": {
|
|
1604
|
+
"type": "any",
|
|
1605
|
+
"description": "Sets the phone number to display."
|
|
1606
|
+
}
|
|
1607
|
+
},
|
|
1608
|
+
"methods": {},
|
|
1609
|
+
"events": {}
|
|
1610
|
+
},
|
|
1611
|
+
"lightning-formatted-rich-text": {
|
|
1612
|
+
"description": "Displays rich text that's formatted with allowlisted tags and attributes. Other tags and attributes are removed and only their text content is displayed. [View in Component Library](https://developer.salesforce.com/docs/component-library/bundle/lightning-formatted-rich-text)",
|
|
1613
|
+
"properties": {
|
|
1614
|
+
"disableLinkify": {
|
|
1615
|
+
"type": "boolean",
|
|
1616
|
+
"description": "If present, the component does not create links in the rich text."
|
|
1617
|
+
},
|
|
1618
|
+
"title": {
|
|
1619
|
+
"type": "string | number",
|
|
1620
|
+
"description": "Displays tooltip text when the mouse moves over the element."
|
|
1621
|
+
},
|
|
1622
|
+
"value": {
|
|
1623
|
+
"type": "any",
|
|
1624
|
+
"description": "Sets the rich text to display."
|
|
1625
|
+
}
|
|
1626
|
+
},
|
|
1627
|
+
"methods": {},
|
|
1628
|
+
"events": {}
|
|
1629
|
+
},
|
|
1630
|
+
"lightning-formatted-text": {
|
|
1631
|
+
"description": "Displays text, replaces newlines with line breaks, and linkifies if requested. [View in Component Library](https://developer.salesforce.com/docs/component-library/bundle/lightning-formatted-text)",
|
|
1632
|
+
"properties": {
|
|
1633
|
+
"linkify": {
|
|
1634
|
+
"type": "boolean",
|
|
1635
|
+
"description": "If present, URLs and email addresses are displayed in anchor tags. They are displayed in plain text by default."
|
|
1636
|
+
},
|
|
1637
|
+
"title": {
|
|
1638
|
+
"type": "string | number",
|
|
1639
|
+
"description": "Displays tooltip text when the mouse moves over the element."
|
|
1640
|
+
},
|
|
1641
|
+
"value": {
|
|
1642
|
+
"type": "any",
|
|
1643
|
+
"description": "Sets the text to display."
|
|
1644
|
+
}
|
|
1645
|
+
},
|
|
1646
|
+
"methods": {},
|
|
1647
|
+
"events": {}
|
|
1648
|
+
},
|
|
1649
|
+
"lightning-formatted-time": {
|
|
1650
|
+
"description": "Displays a formatted time in user's locale format. [View in Component Library](https://developer.salesforce.com/docs/component-library/bundle/lightning-formatted-time)",
|
|
1651
|
+
"properties": {
|
|
1652
|
+
"title": {
|
|
1653
|
+
"type": "string | number",
|
|
1654
|
+
"description": "Displays tooltip text when the mouse moves over the element."
|
|
1655
|
+
},
|
|
1656
|
+
"value": {
|
|
1657
|
+
"type": "any",
|
|
1658
|
+
"description": "Time value to format."
|
|
1659
|
+
}
|
|
1660
|
+
},
|
|
1661
|
+
"methods": {},
|
|
1662
|
+
"events": {}
|
|
1663
|
+
},
|
|
1664
|
+
"lightning-formatted-url": {
|
|
1665
|
+
"description": "Displays a URL as a hyperlink. [View in Component Library](https://developer.salesforce.com/docs/component-library/bundle/lightning-formatted-url)",
|
|
1666
|
+
"properties": {
|
|
1667
|
+
"label": {
|
|
1668
|
+
"type": "string | number",
|
|
1669
|
+
"description": "The text to display in the link."
|
|
1670
|
+
},
|
|
1671
|
+
"tabIndex": {
|
|
1672
|
+
"type": "any",
|
|
1673
|
+
"description": "Reserved for internal use. Use tabindex instead to indicate if an element should be focusable. A value of 0 means that the element is focusable and participates in sequential keyboard navigation. A value of -1 means that the element is focusable but does not participate in keyboard navigation."
|
|
1674
|
+
},
|
|
1675
|
+
"target": {
|
|
1676
|
+
"type": "string | number",
|
|
1677
|
+
"description": "Specifies where to open the link. Options include _blank, _parent, _self, and _top. This value defaults to _self."
|
|
1678
|
+
},
|
|
1679
|
+
"title": {
|
|
1680
|
+
"type": "string | number",
|
|
1681
|
+
"description": "Displays tooltip text when the mouse moves over the element."
|
|
1682
|
+
},
|
|
1683
|
+
"tooltip": {
|
|
1684
|
+
"type": "string | number",
|
|
1685
|
+
"description": "The text to display when the mouse hovers over the link. A link doesn't display a tooltip unless a text value is provided."
|
|
1686
|
+
},
|
|
1687
|
+
"value": {
|
|
1688
|
+
"type": "any",
|
|
1689
|
+
"description": "The URL to format."
|
|
1690
|
+
}
|
|
1691
|
+
},
|
|
1692
|
+
"methods": {},
|
|
1693
|
+
"events": {}
|
|
1694
|
+
},
|
|
1695
|
+
"lightning-helptext": {
|
|
1696
|
+
"description": "An icon with a text popover used for tooltips. [View in Component Library](https://developer.salesforce.com/docs/component-library/bundle/lightning-helptext)",
|
|
1697
|
+
"properties": {
|
|
1698
|
+
"alternativeText": {
|
|
1699
|
+
"type": "any"
|
|
1700
|
+
},
|
|
1701
|
+
"content": {
|
|
1702
|
+
"type": "string | number",
|
|
1703
|
+
"description": "Text to be shown in the popover."
|
|
1704
|
+
},
|
|
1705
|
+
"iconName": {
|
|
1706
|
+
"type": "string | number",
|
|
1707
|
+
"description": "The Lightning Design System name of the icon used as the visible element. Names are written in the format 'utility:info' where 'utility' is the category, and 'info' is the specific icon to be displayed. The default is 'utility:info'."
|
|
1708
|
+
},
|
|
1709
|
+
"iconVariant": {
|
|
1710
|
+
"type": "string | number",
|
|
1711
|
+
"description": "Changes the appearance of the icon. Accepted variants include inverse, warning, error."
|
|
1712
|
+
},
|
|
1713
|
+
"title": {
|
|
1714
|
+
"type": "string | number",
|
|
1715
|
+
"description": "Displays tooltip text when the mouse moves over the element."
|
|
1716
|
+
}
|
|
1717
|
+
},
|
|
1718
|
+
"methods": {},
|
|
1719
|
+
"events": {}
|
|
1720
|
+
},
|
|
1721
|
+
"lightning-icon": {
|
|
1722
|
+
"description": "Represents a visual element that provides context and enhances usability. [View in Component Library](https://developer.salesforce.com/docs/component-library/bundle/lightning-icon)",
|
|
1723
|
+
"properties": {
|
|
1724
|
+
"alternativeText": {
|
|
1725
|
+
"type": "string | number",
|
|
1726
|
+
"description": "The alternative text used to describe the icon. This text should describe what happens when you click the button, for example 'Upload File', not what the icon looks like, 'Paperclip'."
|
|
1727
|
+
},
|
|
1728
|
+
"iconName": {
|
|
1729
|
+
"type": "string | number",
|
|
1730
|
+
"description": "The Lightning Design System name of the icon. Names are written in the format 'utility:down' where 'utility' is the category, and 'down' is the specific icon to be displayed."
|
|
1731
|
+
},
|
|
1732
|
+
"size": {
|
|
1733
|
+
"type": "string | number",
|
|
1734
|
+
"description": "The size of the icon. Options include xx-small, x-small, small, medium, or large. The default is medium."
|
|
1735
|
+
},
|
|
1736
|
+
"src": {
|
|
1737
|
+
"type": "string | number",
|
|
1738
|
+
"description": "A uri path to a custom svg sprite, including the name of the resouce, for example: /assets/icons/standard-sprite/svg/test.svg#icon-heart"
|
|
1739
|
+
},
|
|
1740
|
+
"title": {
|
|
1741
|
+
"type": "string | number",
|
|
1742
|
+
"description": "Displays tooltip text when the mouse moves over the element."
|
|
1743
|
+
},
|
|
1744
|
+
"variant": {
|
|
1745
|
+
"type": "string | number",
|
|
1746
|
+
"description": "The variant changes the appearance of a utility icon. Accepted variants include inverse, success, warning, and error. Use the inverse variant to implement a white fill in utility icons on dark backgrounds."
|
|
1747
|
+
}
|
|
1748
|
+
},
|
|
1749
|
+
"methods": {},
|
|
1750
|
+
"events": {}
|
|
1751
|
+
},
|
|
1752
|
+
"lightning-illustration": {
|
|
1753
|
+
"description": "Displays a Salesforce Lightning Design System illustration.",
|
|
1754
|
+
"properties": {
|
|
1755
|
+
"alternativeText": {
|
|
1756
|
+
"type": "string | number",
|
|
1757
|
+
"description": "Assistive text that describes the illustration. Provide this text for assistive devices if the meaning of the surrounding content isn't sufficient."
|
|
1758
|
+
},
|
|
1759
|
+
"illustrationName": {
|
|
1760
|
+
"type": "string | number",
|
|
1761
|
+
"description": "The illustration identifier in \"set:symbol\" format. See the Develop tab for valid illustration names."
|
|
1762
|
+
}
|
|
1763
|
+
},
|
|
1764
|
+
"methods": {},
|
|
1765
|
+
"events": {}
|
|
1766
|
+
},
|
|
1767
|
+
"lightning-input": {
|
|
1768
|
+
"description": "Represents interactive controls that accept user input depending on the type attribute. [View in Component Library](https://developer.salesforce.com/docs/component-library/bundle/lightning-input)",
|
|
1769
|
+
"properties": {
|
|
1770
|
+
"accept": {
|
|
1771
|
+
"type": "string | number",
|
|
1772
|
+
"description": "Specifies the types of files that the server accepts. Use this attribute with file input type only."
|
|
1773
|
+
},
|
|
1774
|
+
"accessKey": {
|
|
1775
|
+
"type": "string | number",
|
|
1776
|
+
"description": "Specifies a shortcut key to activate or focus an element."
|
|
1777
|
+
},
|
|
1778
|
+
"ariaControls": {
|
|
1779
|
+
"type": "string | number",
|
|
1780
|
+
"description": "A space-separated list of element IDs whose presence or content is controlled by the input."
|
|
1781
|
+
},
|
|
1782
|
+
"ariaDescribedBy": {
|
|
1783
|
+
"type": "string | number",
|
|
1784
|
+
"description": "A space-separated list of element IDs that provide descriptive labels for the input."
|
|
1785
|
+
},
|
|
1786
|
+
"ariaLabel": {
|
|
1787
|
+
"type": "string | number",
|
|
1788
|
+
"description": "Describes the input to assistive technologies."
|
|
1789
|
+
},
|
|
1790
|
+
"ariaLabelledBy": {
|
|
1791
|
+
"type": "string | number",
|
|
1792
|
+
"description": "A space-separated list of element IDs that provide labels for the input."
|
|
1793
|
+
},
|
|
1794
|
+
"autocomplete": {
|
|
1795
|
+
"type": "any",
|
|
1796
|
+
"description": "Controls auto-filling of the field. Use this attribute with email, search, tel, text, and url input types only. Set the attribute to pass through autocomplete values to be interpreted by the browser."
|
|
1797
|
+
},
|
|
1798
|
+
"checked": {
|
|
1799
|
+
"type": "boolean",
|
|
1800
|
+
"description": "If present, the checkbox is selected."
|
|
1801
|
+
},
|
|
1802
|
+
"dateAriaControls": {
|
|
1803
|
+
"type": "string | number",
|
|
1804
|
+
"description": "A space-separated list of element IDs whose presence or content is controlled by the date input when type='datetime'. On mobile devices, this is merged with aria-controls and time-aria-controls to describe the native date time input."
|
|
1805
|
+
},
|
|
1806
|
+
"dateAriaDescribedBy": {
|
|
1807
|
+
"type": "string | number",
|
|
1808
|
+
"description": "A space-separated list of element IDs that provide descriptive labels for the date input when type='datetime'. On mobile devices, this is merged with aria-described-by and time-aria-described-by to describe the native date time input."
|
|
1809
|
+
},
|
|
1810
|
+
"dateAriaLabel": {
|
|
1811
|
+
"type": "string | number",
|
|
1812
|
+
"description": "Describes the date input to assistive technologies when type='datetime'. On mobile devices, this label is merged with aria-label and time-aria-label to describe the native date time input."
|
|
1813
|
+
},
|
|
1814
|
+
"dateAriaLabelledBy": {
|
|
1815
|
+
"type": "string | number",
|
|
1816
|
+
"description": "A space-separated list of element IDs that provide labels for the date input when type='datetime'. On mobile devices, this is merged with aria-labelled-by and time-aria-labelled-by to describe the native date time input."
|
|
1817
|
+
},
|
|
1818
|
+
"dateStyle": {
|
|
1819
|
+
"type": "any",
|
|
1820
|
+
"description": "The display style of the date when type='date' or type='datetime'. Valid values are short, medium (default), and long. The format of each style is specific to the locale. On mobile devices this attribute has no effect."
|
|
1821
|
+
},
|
|
1822
|
+
"disabled": {
|
|
1823
|
+
"type": "boolean",
|
|
1824
|
+
"description": "If present, the input field is disabled and users cannot interact with it."
|
|
1825
|
+
},
|
|
1826
|
+
"fieldLevelHelp": {
|
|
1827
|
+
"type": "any",
|
|
1828
|
+
"description": "Help text detailing the purpose and function of the input. This attribute isn't supported for file, radio, toggle, and checkbox-button types."
|
|
1829
|
+
},
|
|
1830
|
+
"files": {
|
|
1831
|
+
"type": "any",
|
|
1832
|
+
"description": "A FileList that contains selected files. Use this attribute with the file input type only."
|
|
1833
|
+
},
|
|
1834
|
+
"formatFractionDigits": {
|
|
1835
|
+
"type": "any",
|
|
1836
|
+
"description": "Reserved for internal use."
|
|
1837
|
+
},
|
|
1838
|
+
"formatter": {
|
|
1839
|
+
"type": "string | number",
|
|
1840
|
+
"description": "String value with the formatter to be used for number input. Valid values include decimal, percent, percent-fixed, and currency."
|
|
1841
|
+
},
|
|
1842
|
+
"isLoading": {
|
|
1843
|
+
"type": "boolean",
|
|
1844
|
+
"description": "For the search type only. If present, a spinner is displayed to indicate that data is loading."
|
|
1845
|
+
},
|
|
1846
|
+
"label": {
|
|
1847
|
+
"type": "string | number",
|
|
1848
|
+
"description": "Text label for the input."
|
|
1849
|
+
},
|
|
1850
|
+
"max": {
|
|
1851
|
+
"type": "any",
|
|
1852
|
+
"description": "The maximum acceptable value for the input. Use this attribute with number, range, date, time, and datetime input types only. For number and range type, the max value is a decimal number. For the date, time, and datetime types, the max value must use a valid string for the type."
|
|
1853
|
+
},
|
|
1854
|
+
"maxLength": {
|
|
1855
|
+
"type": "number | string",
|
|
1856
|
+
"description": "The maximum number of characters allowed in the field."
|
|
1857
|
+
},
|
|
1858
|
+
"messageToggleActive": {
|
|
1859
|
+
"type": "string | number",
|
|
1860
|
+
"description": "Text shown for the active state of a toggle. The default is \"Active\"."
|
|
1861
|
+
},
|
|
1862
|
+
"messageToggleInactive": {
|
|
1863
|
+
"type": "string | number",
|
|
1864
|
+
"description": "Text shown for the inactive state of a toggle. The default is \"Inactive\"."
|
|
1865
|
+
},
|
|
1866
|
+
"messageWhenBadInput": {
|
|
1867
|
+
"type": "string | number",
|
|
1868
|
+
"description": "Error message to be displayed when a bad input is detected."
|
|
1869
|
+
},
|
|
1870
|
+
"messageWhenPatternMismatch": {
|
|
1871
|
+
"type": "string | number",
|
|
1872
|
+
"description": "Error message to be displayed when a pattern mismatch is detected."
|
|
1873
|
+
},
|
|
1874
|
+
"messageWhenRangeOverflow": {
|
|
1875
|
+
"type": "string | number",
|
|
1876
|
+
"description": "Error message to be displayed when a range overflow is detected."
|
|
1877
|
+
},
|
|
1878
|
+
"messageWhenRangeUnderflow": {
|
|
1879
|
+
"type": "string | number",
|
|
1880
|
+
"description": "Error message to be displayed when a range underflow is detected."
|
|
1881
|
+
},
|
|
1882
|
+
"messageWhenStepMismatch": {
|
|
1883
|
+
"type": "string | number",
|
|
1884
|
+
"description": "Error message to be displayed when a step mismatch is detected."
|
|
1885
|
+
},
|
|
1886
|
+
"messageWhenTooLong": {
|
|
1887
|
+
"type": "string | number",
|
|
1888
|
+
"description": "Error message to be displayed when the value is too long."
|
|
1889
|
+
},
|
|
1890
|
+
"messageWhenTooShort": {
|
|
1891
|
+
"type": "string | number",
|
|
1892
|
+
"description": "Error message to be displayed when the value is too short."
|
|
1893
|
+
},
|
|
1894
|
+
"messageWhenTypeMismatch": {
|
|
1895
|
+
"type": "string | number",
|
|
1896
|
+
"description": "Error message to be displayed when a type mismatch is detected."
|
|
1897
|
+
},
|
|
1898
|
+
"messageWhenValueMissing": {
|
|
1899
|
+
"type": "string | number",
|
|
1900
|
+
"description": "Error message to be displayed when the value is missing."
|
|
1901
|
+
},
|
|
1902
|
+
"min": {
|
|
1903
|
+
"type": "any",
|
|
1904
|
+
"description": "The minimum acceptable value for the input. Use this attribute with number, range, date, time, and datetime input types only. For number and range types, the min value is a decimal number. For the date, time, and datetime types, the min value must use a valid string for the type."
|
|
1905
|
+
},
|
|
1906
|
+
"minLength": {
|
|
1907
|
+
"type": "number | string",
|
|
1908
|
+
"description": "The minimum number of characters allowed in the field."
|
|
1909
|
+
},
|
|
1910
|
+
"multiple": {
|
|
1911
|
+
"type": "boolean",
|
|
1912
|
+
"description": "Specifies that a user can enter more than one value. Use this attribute with file and email input types only."
|
|
1913
|
+
},
|
|
1914
|
+
"name": {
|
|
1915
|
+
"type": "string | number",
|
|
1916
|
+
"description": "Specifies the name of an input element."
|
|
1917
|
+
},
|
|
1918
|
+
"pattern": {
|
|
1919
|
+
"type": "string | number",
|
|
1920
|
+
"description": "Specifies the regular expression that the input's value is checked against. This attribute is supported for email, password, search, tel, text, and url types."
|
|
1921
|
+
},
|
|
1922
|
+
"placeholder": {
|
|
1923
|
+
"type": "string | number",
|
|
1924
|
+
"description": "Text that is displayed when the field is empty, to prompt the user for a valid entry. Use this attribute with date, email, number, password, search, tel, text, time, and url input types only."
|
|
1925
|
+
},
|
|
1926
|
+
"readOnly": {
|
|
1927
|
+
"type": "boolean",
|
|
1928
|
+
"description": "Specifies that an input field is read-only. This value defaults to false."
|
|
1929
|
+
},
|
|
1930
|
+
"required": {
|
|
1931
|
+
"type": "boolean",
|
|
1932
|
+
"description": "If present, the input field must be filled out before the form is submitted."
|
|
1933
|
+
},
|
|
1934
|
+
"selectionEnd": {
|
|
1935
|
+
"type": "any"
|
|
1936
|
+
},
|
|
1937
|
+
"selectionStart": {
|
|
1938
|
+
"type": "any"
|
|
1939
|
+
},
|
|
1940
|
+
"step": {
|
|
1941
|
+
"type": "any",
|
|
1942
|
+
"description": "Granularity of the value, specified as a positive floating point number. Use this attribute with number and range input types only. Use 'any' when granularity is not a concern. This value defaults to 1."
|
|
1943
|
+
},
|
|
1944
|
+
"tabIndex": {
|
|
1945
|
+
"type": "number | string",
|
|
1946
|
+
"description": "Specifies the tab order of an element (when the tab button is used for navigating)."
|
|
1947
|
+
},
|
|
1948
|
+
"timeAriaControls": {
|
|
1949
|
+
"type": "string | number",
|
|
1950
|
+
"description": "A space-separated list of element IDs whose presence or content is controlled by the time input when type='datetime'. On mobile devices, this is merged with aria-controls and date-aria-controls to describe the native date time input."
|
|
1951
|
+
},
|
|
1952
|
+
"timeAriaDescribedBy": {
|
|
1953
|
+
"type": "string | number",
|
|
1954
|
+
"description": "A space-separated list of element IDs that provide descriptive labels for the time input when type='datetime'. On mobile devices, this is merged with aria-described-by and date-aria-described-by to describe the native date time input."
|
|
1955
|
+
},
|
|
1956
|
+
"timeAriaLabel": {
|
|
1957
|
+
"type": "string | number",
|
|
1958
|
+
"description": "Describes the time input to assistive technologies when type=datetime. On mobile devices, this label is merged with ariaLabel and dateAriaLabel to describe the native date time input."
|
|
1959
|
+
},
|
|
1960
|
+
"timeAriaLabelledBy": {
|
|
1961
|
+
"type": "string | number",
|
|
1962
|
+
"description": "A space-separated list of element IDs that provide labels for the time input when type='datetime'. On mobile devices, this is merged with aria-labelled-by and date-aria-labelled-by to describe the native date time input."
|
|
1963
|
+
},
|
|
1964
|
+
"timeStyle": {
|
|
1965
|
+
"type": "any",
|
|
1966
|
+
"description": "The display style of the time when type='time' or type='datetime'. Valid values are short (default), medium, and long. Currently, medium and long styles look the same. On mobile devices this attribute has no effect."
|
|
1967
|
+
},
|
|
1968
|
+
"timezone": {
|
|
1969
|
+
"type": "string | number",
|
|
1970
|
+
"description": "Specifies the time zone used when type='datetime' only. This value defaults to the user's Salesforce time zone setting."
|
|
1971
|
+
},
|
|
1972
|
+
"title": {
|
|
1973
|
+
"type": "string | number",
|
|
1974
|
+
"description": "Displays tooltip text when the mouse moves over the element."
|
|
1975
|
+
},
|
|
1976
|
+
"type": {
|
|
1977
|
+
"type": "string | number",
|
|
1978
|
+
"description": "The type of the input. This value defaults to text."
|
|
1979
|
+
},
|
|
1980
|
+
"validity": {
|
|
1981
|
+
"type": "any",
|
|
1982
|
+
"description": "Represents the validity states that an element can be in, with respect to constraint validation."
|
|
1983
|
+
},
|
|
1984
|
+
"value": {
|
|
1985
|
+
"type": "any",
|
|
1986
|
+
"description": "Specifies the value of an input element."
|
|
1987
|
+
},
|
|
1988
|
+
"variant": {
|
|
1989
|
+
"type": "string | number",
|
|
1990
|
+
"description": "The variant changes the appearance of an input field. Accepted variants include standard, label-inline, label-hidden, and label-stacked. This value defaults to standard, which displays the label above the field. Use label-hidden to hide the label but make it available to assistive technology. Use label-inline to horizontally align the label and input field. Use label-stacked to place the label above the input field."
|
|
1991
|
+
}
|
|
1992
|
+
},
|
|
1993
|
+
"methods": {
|
|
1994
|
+
"checkValidity": {
|
|
1995
|
+
"type": "() => boolean",
|
|
1996
|
+
"description": "Checks if the input is valid."
|
|
1997
|
+
},
|
|
1998
|
+
"reportValidity": {
|
|
1999
|
+
"type": "() => boolean",
|
|
2000
|
+
"description": "Displays the error messages and returns false if the input is invalid. If the input is valid, reportValidity() clears displayed error messages and returns true."
|
|
2001
|
+
},
|
|
2002
|
+
"setCustomValidity": {
|
|
2003
|
+
"type": "(message: string) => void",
|
|
2004
|
+
"description": "Sets a custom error message to be displayed when a form is submitted."
|
|
2005
|
+
},
|
|
2006
|
+
"showHelpMessageIfInvalid": {
|
|
2007
|
+
"type": "() => void",
|
|
2008
|
+
"description": "Displays error messages on invalid fields. An invalid field fails at least one constraint validation and returns false when checkValidity() is called."
|
|
2009
|
+
}
|
|
2010
|
+
},
|
|
2011
|
+
"events": {
|
|
2012
|
+
"change": {
|
|
2013
|
+
"type": "CustomEvent<{ value: any; checked?: boolean }>",
|
|
2014
|
+
"description": "The event fired when a value is changed in the input field. Bubbles, and crosses the component's shadow boundary (composed)."
|
|
2015
|
+
},
|
|
2016
|
+
"commit": {
|
|
2017
|
+
"type": "CustomEvent<any>",
|
|
2018
|
+
"description": "The event fired when you press Enter after interacting with the input, or move away from the input so it loses focus. For the input type search, the event is fired when focus leaves the entire component or when the user clicks the X button to clear the search. The event is also fired when you press the Enter key. For the input type `number` the event is also fired when you press Up/Down arrow keys to change the number. Doesn't bubble."
|
|
2019
|
+
}
|
|
2020
|
+
}
|
|
2021
|
+
},
|
|
2022
|
+
"lightning-input-address": {
|
|
2023
|
+
"description": "Represents an address compound field. [View in Component Library](https://developer.salesforce.com/docs/component-library/bundle/lightning-input-address)",
|
|
2024
|
+
"properties": {
|
|
2025
|
+
"addressLabel": {
|
|
2026
|
+
"type": "string | number",
|
|
2027
|
+
"description": "The label of the address compound field."
|
|
2028
|
+
},
|
|
2029
|
+
"addressLookupLabel": {
|
|
2030
|
+
"type": "any"
|
|
2031
|
+
},
|
|
2032
|
+
"addressLookupPlaceholder": {
|
|
2033
|
+
"type": "any"
|
|
2034
|
+
},
|
|
2035
|
+
"city": {
|
|
2036
|
+
"type": "string | number",
|
|
2037
|
+
"description": "The city field of the address."
|
|
2038
|
+
},
|
|
2039
|
+
"cityLabel": {
|
|
2040
|
+
"type": "string | number",
|
|
2041
|
+
"description": "The label of the city field of the address."
|
|
2042
|
+
},
|
|
2043
|
+
"cityPlaceholder": {
|
|
2044
|
+
"type": "any"
|
|
2045
|
+
},
|
|
2046
|
+
"country": {
|
|
2047
|
+
"type": "string | number",
|
|
2048
|
+
"description": "The country field of the address. If country-options is provided, this country value is selected by default."
|
|
2049
|
+
},
|
|
2050
|
+
"countryDisabled": {
|
|
2051
|
+
"type": "any"
|
|
2052
|
+
},
|
|
2053
|
+
"countryLabel": {
|
|
2054
|
+
"type": "string | number",
|
|
2055
|
+
"description": "The label of the country field of the address."
|
|
2056
|
+
},
|
|
2057
|
+
"countryLookupFilter": {
|
|
2058
|
+
"type": "any"
|
|
2059
|
+
},
|
|
2060
|
+
"countryOptions": {
|
|
2061
|
+
"type": "readonly unknown[]",
|
|
2062
|
+
"description": "The array of label-value pairs for the country. Displays a dropdown menu of options."
|
|
2063
|
+
},
|
|
2064
|
+
"countryPlaceholder": {
|
|
2065
|
+
"type": "any"
|
|
2066
|
+
},
|
|
2067
|
+
"disabled": {
|
|
2068
|
+
"type": "boolean",
|
|
2069
|
+
"description": "If present, the address fields are disabled and users cannot interact with them."
|
|
2070
|
+
},
|
|
2071
|
+
"fieldLevelHelp": {
|
|
2072
|
+
"type": "string | number",
|
|
2073
|
+
"description": "Help text detailing the purpose and function of the input."
|
|
2074
|
+
},
|
|
2075
|
+
"hideProvince": {
|
|
2076
|
+
"type": "any"
|
|
2077
|
+
},
|
|
2078
|
+
"locale": {
|
|
2079
|
+
"type": "any"
|
|
2080
|
+
},
|
|
2081
|
+
"postalCode": {
|
|
2082
|
+
"type": "string | number",
|
|
2083
|
+
"description": "The postal code field of the address."
|
|
2084
|
+
},
|
|
2085
|
+
"postalCodeLabel": {
|
|
2086
|
+
"type": "string | number",
|
|
2087
|
+
"description": "The label of the postal code field of the address."
|
|
2088
|
+
},
|
|
2089
|
+
"postalCodePlaceholder": {
|
|
2090
|
+
"type": "any"
|
|
2091
|
+
},
|
|
2092
|
+
"province": {
|
|
2093
|
+
"type": "string | number",
|
|
2094
|
+
"description": "The province field of the address. If province-options is provided, this province value is selected by default."
|
|
2095
|
+
},
|
|
2096
|
+
"provinceLabel": {
|
|
2097
|
+
"type": "string | number",
|
|
2098
|
+
"description": "The label of the province field of the address."
|
|
2099
|
+
},
|
|
2100
|
+
"provinceOptions": {
|
|
2101
|
+
"type": "readonly unknown[]",
|
|
2102
|
+
"description": "The array of label-value pairs for the province. Displays a dropdown menu of options."
|
|
2103
|
+
},
|
|
2104
|
+
"provincePlaceholder": {
|
|
2105
|
+
"type": "any"
|
|
2106
|
+
},
|
|
2107
|
+
"readOnly": {
|
|
2108
|
+
"type": "boolean",
|
|
2109
|
+
"description": "Specifies whether the address fields are read-only. This value defaults to false."
|
|
2110
|
+
},
|
|
2111
|
+
"required": {
|
|
2112
|
+
"type": "boolean",
|
|
2113
|
+
"description": "If present, the address fields must be filled before the form is submitted."
|
|
2114
|
+
},
|
|
2115
|
+
"showAddressLookup": {
|
|
2116
|
+
"type": "any",
|
|
2117
|
+
"description": "If present, address lookup using Google Maps is enabled."
|
|
2118
|
+
},
|
|
2119
|
+
"showCompactAddress": {
|
|
2120
|
+
"type": "any"
|
|
2121
|
+
},
|
|
2122
|
+
"street": {
|
|
2123
|
+
"type": "string | number",
|
|
2124
|
+
"description": "The street field of the address."
|
|
2125
|
+
},
|
|
2126
|
+
"streetLabel": {
|
|
2127
|
+
"type": "string | number",
|
|
2128
|
+
"description": "The label of the street field of the address."
|
|
2129
|
+
},
|
|
2130
|
+
"streetPlaceholder": {
|
|
2131
|
+
"type": "any"
|
|
2132
|
+
},
|
|
2133
|
+
"subpremise": {
|
|
2134
|
+
"type": "any"
|
|
2135
|
+
},
|
|
2136
|
+
"subpremiseLabel": {
|
|
2137
|
+
"type": "any"
|
|
2138
|
+
},
|
|
2139
|
+
"title": {
|
|
2140
|
+
"type": "string | number",
|
|
2141
|
+
"description": "Displays tooltip text when the mouse moves over the element."
|
|
2142
|
+
},
|
|
2143
|
+
"validity": {
|
|
2144
|
+
"type": "any",
|
|
2145
|
+
"description": "Represents the validity states that an element can be in, with respect to constraint validation."
|
|
2146
|
+
},
|
|
2147
|
+
"variant": {
|
|
2148
|
+
"type": "string | number",
|
|
2149
|
+
"description": "The variant changes the appearance of an input address field. Accepted variants include standard, label-hidden, label-inline, and label-stacked. This value defaults to standard. Use label-hidden to hide the label but make it available to assistive technology. Use label-inline to horizontally align the label and input address field. Use label-stacked to place the label above the input address field."
|
|
2150
|
+
}
|
|
2151
|
+
},
|
|
2152
|
+
"methods": {
|
|
2153
|
+
"checkValidity": {
|
|
2154
|
+
"type": "() => boolean",
|
|
2155
|
+
"description": "Returns whether the component's value is valid, without showing an error."
|
|
2156
|
+
},
|
|
2157
|
+
"reportValidity": {
|
|
2158
|
+
"type": "() => boolean",
|
|
2159
|
+
"description": "Returns whether the component's value is valid, and shows its error message when it isn't."
|
|
2160
|
+
},
|
|
2161
|
+
"setCustomValidityForField": {
|
|
2162
|
+
"type": "(...args: any[]) => any"
|
|
2163
|
+
},
|
|
2164
|
+
"showHelpMessageIfInvalid": {
|
|
2165
|
+
"type": "() => void",
|
|
2166
|
+
"description": "Shows the component's error message when its value is invalid."
|
|
2167
|
+
}
|
|
2168
|
+
},
|
|
2169
|
+
"events": {}
|
|
2170
|
+
},
|
|
2171
|
+
"lightning-input-field": {
|
|
2172
|
+
"description": "Represents an editable input for a field on a Salesforce object. [View in Component Library](https://developer.salesforce.com/docs/component-library/bundle/lightning-input-field)",
|
|
2173
|
+
"properties": {
|
|
2174
|
+
"dirty": {
|
|
2175
|
+
"type": "any",
|
|
2176
|
+
"description": "Reserved for internal use. If present, the field has been modified by the user but not saved or submitted."
|
|
2177
|
+
},
|
|
2178
|
+
"disabled": {
|
|
2179
|
+
"type": "boolean",
|
|
2180
|
+
"description": "If present, the field is grayed out and users can't interact with it. Disabled fields don't receive focus and are skipped in tabbing navigation."
|
|
2181
|
+
},
|
|
2182
|
+
"fieldName": {
|
|
2183
|
+
"type": "string | number",
|
|
2184
|
+
"description": "The API name of the field to be displayed."
|
|
2185
|
+
},
|
|
2186
|
+
"readOnly": {
|
|
2187
|
+
"type": "any",
|
|
2188
|
+
"description": "Specifies whether an input field is read-only. This value defaults to false. Not supported for the following field types: rich text, picklist, multi-select picklist, and lookup. A read-only field is not disabled by default."
|
|
2189
|
+
},
|
|
2190
|
+
"required": {
|
|
2191
|
+
"type": "any",
|
|
2192
|
+
"description": "If present, the input field must be filled out before the form is submitted."
|
|
2193
|
+
},
|
|
2194
|
+
"value": {
|
|
2195
|
+
"type": "any",
|
|
2196
|
+
"description": "The field value, which overrides the existing value."
|
|
2197
|
+
},
|
|
2198
|
+
"variant": {
|
|
2199
|
+
"type": "any",
|
|
2200
|
+
"description": "The variant changes the label position of an input field. Accepted variants include standard, label-hidden, label-inline, and label-stacked. The variant, if specified, determines the label position. Otherwise, the density setting of the parent form determines the label position."
|
|
2201
|
+
}
|
|
2202
|
+
},
|
|
2203
|
+
"methods": {
|
|
2204
|
+
"clean": {
|
|
2205
|
+
"type": "(...args: any[]) => any",
|
|
2206
|
+
"description": "Reserved for internal use. Clean up the field dirty state."
|
|
2207
|
+
},
|
|
2208
|
+
"reportValidity": {
|
|
2209
|
+
"type": "() => boolean",
|
|
2210
|
+
"description": "Reserved for internal use."
|
|
2211
|
+
},
|
|
2212
|
+
"reset": {
|
|
2213
|
+
"type": "(...args: any[]) => any",
|
|
2214
|
+
"description": "Resets the form fields to their initial values."
|
|
2215
|
+
},
|
|
2216
|
+
"setErrors": {
|
|
2217
|
+
"type": "(...args: any[]) => any",
|
|
2218
|
+
"description": "Reserved for internal use."
|
|
2219
|
+
},
|
|
2220
|
+
"updateDependentField": {
|
|
2221
|
+
"type": "(...args: any[]) => any",
|
|
2222
|
+
"description": "Reserved for internal use."
|
|
2223
|
+
},
|
|
2224
|
+
"wirePicklistValues": {
|
|
2225
|
+
"type": "(...args: any[]) => any",
|
|
2226
|
+
"description": "Reserved for internal use."
|
|
2227
|
+
},
|
|
2228
|
+
"wireRecordUi": {
|
|
2229
|
+
"type": "(...args: any[]) => any",
|
|
2230
|
+
"description": "Reserved for internal use."
|
|
2231
|
+
}
|
|
2232
|
+
},
|
|
2233
|
+
"events": {}
|
|
2234
|
+
},
|
|
2235
|
+
"lightning-input-location": {
|
|
2236
|
+
"description": "Represents a geolocation compound field that accepts a latitude and longitude value. [View in Component Library](https://developer.salesforce.com/docs/component-library/bundle/lightning-input-location)",
|
|
2237
|
+
"properties": {
|
|
2238
|
+
"disabled": {
|
|
2239
|
+
"type": "boolean",
|
|
2240
|
+
"description": "If present, the geolocation fields are disabled and users cannot interact with them."
|
|
2241
|
+
},
|
|
2242
|
+
"fieldLevelHelp": {
|
|
2243
|
+
"type": "string | number",
|
|
2244
|
+
"description": "Help text detailing the purpose and function of the input."
|
|
2245
|
+
},
|
|
2246
|
+
"label": {
|
|
2247
|
+
"type": "string | number",
|
|
2248
|
+
"description": "The label of the geolocation compound field."
|
|
2249
|
+
},
|
|
2250
|
+
"latitude": {
|
|
2251
|
+
"type": "string | number",
|
|
2252
|
+
"description": "The latitude value. Latitude values must be within -90 and 90."
|
|
2253
|
+
},
|
|
2254
|
+
"longitude": {
|
|
2255
|
+
"type": "string | number",
|
|
2256
|
+
"description": "The longitude value. Longitude values must be within -180 and 180."
|
|
2257
|
+
},
|
|
2258
|
+
"readOnly": {
|
|
2259
|
+
"type": "boolean",
|
|
2260
|
+
"description": "Specifies whether the compound field is read-only. This value defaults to false."
|
|
2261
|
+
},
|
|
2262
|
+
"required": {
|
|
2263
|
+
"type": "boolean",
|
|
2264
|
+
"description": "If present, the geolocation fields must be filled out before the form is submitted. An error message is displayed if a user interacts with the field and does not provide a value."
|
|
2265
|
+
},
|
|
2266
|
+
"title": {
|
|
2267
|
+
"type": "string | number",
|
|
2268
|
+
"description": "Displays tooltip text when the mouse moves over the element."
|
|
2269
|
+
},
|
|
2270
|
+
"validity": {
|
|
2271
|
+
"type": "any",
|
|
2272
|
+
"description": "Represents the validity states that an element can be in, with respect to constraint validation."
|
|
2273
|
+
},
|
|
2274
|
+
"variant": {
|
|
2275
|
+
"type": "string | number",
|
|
2276
|
+
"description": "The variant changes the appearance of a geolocation compound field. Accepted variants include standard, label-hidden, label-inline, and label-stacked. This value defaults to standard. Use label-hidden to hide the label but make it available to assistive technology. Use label-inline to horizontally align the label and geolocation fields. Use label-stacked to place the label above the geolocation fields."
|
|
2277
|
+
}
|
|
2278
|
+
},
|
|
2279
|
+
"methods": {
|
|
2280
|
+
"checkValidity": {
|
|
2281
|
+
"type": "() => boolean",
|
|
2282
|
+
"description": "Returns whether the component's value is valid, without showing an error."
|
|
2283
|
+
},
|
|
2284
|
+
"reportValidity": {
|
|
2285
|
+
"type": "() => boolean",
|
|
2286
|
+
"description": "Returns whether the component's value is valid, and shows its error message when it isn't."
|
|
2287
|
+
},
|
|
2288
|
+
"setCustomValidityForField": {
|
|
2289
|
+
"type": "(...args: any[]) => any"
|
|
2290
|
+
},
|
|
2291
|
+
"showHelpMessageIfInvalid": {
|
|
2292
|
+
"type": "() => void",
|
|
2293
|
+
"description": "Shows the component's error message when its value is invalid."
|
|
2294
|
+
}
|
|
2295
|
+
},
|
|
2296
|
+
"events": {}
|
|
2297
|
+
},
|
|
2298
|
+
"lightning-input-name": {
|
|
2299
|
+
"description": "Represents a name compound field. [View in Component Library](https://developer.salesforce.com/docs/component-library/bundle/lightning-input-name)",
|
|
2300
|
+
"properties": {
|
|
2301
|
+
"disabled": {
|
|
2302
|
+
"type": "boolean",
|
|
2303
|
+
"description": "If present, the input name field is disabled and users cannot interact with it."
|
|
2304
|
+
},
|
|
2305
|
+
"fieldLevelHelp": {
|
|
2306
|
+
"type": "string | number",
|
|
2307
|
+
"description": "Help text detailing the purpose and function of the input."
|
|
2308
|
+
},
|
|
2309
|
+
"fieldsToDisplay": {
|
|
2310
|
+
"type": "readonly unknown[]",
|
|
2311
|
+
"description": "List of fields to be displayed on the component. This value defaults to ['firstName', 'salutation', 'lastName']. Other field values include middleName, informalName, suffix."
|
|
2312
|
+
},
|
|
2313
|
+
"firstName": {
|
|
2314
|
+
"type": "string | number",
|
|
2315
|
+
"description": "Displays the First Name field."
|
|
2316
|
+
},
|
|
2317
|
+
"firstNameLabel": {
|
|
2318
|
+
"type": "any",
|
|
2319
|
+
"description": "Reserved for internal use."
|
|
2320
|
+
},
|
|
2321
|
+
"informalName": {
|
|
2322
|
+
"type": "string | number",
|
|
2323
|
+
"description": "Displays the Informal Name field."
|
|
2324
|
+
},
|
|
2325
|
+
"informalNameLabel": {
|
|
2326
|
+
"type": "any",
|
|
2327
|
+
"description": "Reserved for internal use."
|
|
2328
|
+
},
|
|
2329
|
+
"label": {
|
|
2330
|
+
"type": "string | number",
|
|
2331
|
+
"description": "The label of the input name field."
|
|
2332
|
+
},
|
|
2333
|
+
"lastName": {
|
|
2334
|
+
"type": "string | number",
|
|
2335
|
+
"description": "Displays the Last Name field."
|
|
2336
|
+
},
|
|
2337
|
+
"lastNameLabel": {
|
|
2338
|
+
"type": "any",
|
|
2339
|
+
"description": "Reserved for internal use."
|
|
2340
|
+
},
|
|
2341
|
+
"locale": {
|
|
2342
|
+
"type": "any"
|
|
2343
|
+
},
|
|
2344
|
+
"middleName": {
|
|
2345
|
+
"type": "string | number",
|
|
2346
|
+
"description": "Displays the Middle Name field."
|
|
2347
|
+
},
|
|
2348
|
+
"middleNameLabel": {
|
|
2349
|
+
"type": "any",
|
|
2350
|
+
"description": "Reserved for internal use."
|
|
2351
|
+
},
|
|
2352
|
+
"options": {
|
|
2353
|
+
"type": "readonly unknown[]",
|
|
2354
|
+
"description": "Displays a list of salutation options, such as Dr. or Mrs., provided as label-value pairs."
|
|
2355
|
+
},
|
|
2356
|
+
"readOnly": {
|
|
2357
|
+
"type": "boolean",
|
|
2358
|
+
"description": "Specifies whether the compound field is read-only. This value defaults to false."
|
|
2359
|
+
},
|
|
2360
|
+
"required": {
|
|
2361
|
+
"type": "boolean",
|
|
2362
|
+
"description": "If present, the input name field must be filled out before the form is submitted. A red asterisk is displayed on the Last Name field. An error message is displayed if a user interacts with the Last Name field and does not provide a value."
|
|
2363
|
+
},
|
|
2364
|
+
"salutation": {
|
|
2365
|
+
"type": "string | number",
|
|
2366
|
+
"description": "Displays the Salutation field as a dropdown menu. Use the options attribute to provide salutations in an array of label-value pairs."
|
|
2367
|
+
},
|
|
2368
|
+
"salutationLabel": {
|
|
2369
|
+
"type": "any",
|
|
2370
|
+
"description": "Reserved for internal use."
|
|
2371
|
+
},
|
|
2372
|
+
"suffix": {
|
|
2373
|
+
"type": "string | number",
|
|
2374
|
+
"description": "Displays the Suffix field."
|
|
2375
|
+
},
|
|
2376
|
+
"suffixLabel": {
|
|
2377
|
+
"type": "any",
|
|
2378
|
+
"description": "Reserved for internal use."
|
|
2379
|
+
},
|
|
2380
|
+
"title": {
|
|
2381
|
+
"type": "string | number",
|
|
2382
|
+
"description": "Displays tooltip text when the mouse moves over the element."
|
|
2383
|
+
},
|
|
2384
|
+
"validity": {
|
|
2385
|
+
"type": "any",
|
|
2386
|
+
"description": "Represents the validity states that an element can be in, with respect to constraint validation."
|
|
2387
|
+
},
|
|
2388
|
+
"variant": {
|
|
2389
|
+
"type": "string | number",
|
|
2390
|
+
"description": "The variant changes the appearance of a name compound field. Accepted variants include standard, label-hidden, label-inline, and label-stacked. This value defaults to standard. Use label-hidden to hide the label but make it available to assistive technology. Use label-inline to horizontally align the label and name fields. Use label-stacked to place the label above the name fields."
|
|
2391
|
+
}
|
|
2392
|
+
},
|
|
2393
|
+
"methods": {
|
|
2394
|
+
"checkValidity": {
|
|
2395
|
+
"type": "() => boolean",
|
|
2396
|
+
"description": "Returns whether the component's value is valid, without showing an error."
|
|
2397
|
+
},
|
|
2398
|
+
"reportValidity": {
|
|
2399
|
+
"type": "() => boolean",
|
|
2400
|
+
"description": "Returns whether the component's value is valid, and shows its error message when it isn't."
|
|
2401
|
+
},
|
|
2402
|
+
"setCustomValidityForField": {
|
|
2403
|
+
"type": "(...args: any[]) => any"
|
|
2404
|
+
},
|
|
2405
|
+
"showHelpMessageIfInvalid": {
|
|
2406
|
+
"type": "() => void",
|
|
2407
|
+
"description": "Shows the component's error message when its value is invalid."
|
|
2408
|
+
}
|
|
2409
|
+
},
|
|
2410
|
+
"events": {}
|
|
2411
|
+
},
|
|
2412
|
+
"lightning-input-rich-text": {
|
|
2413
|
+
"description": "A WYSIWYG editor with a customizable toolbar for entering rich text [View in Component Library](https://developer.salesforce.com/docs/component-library/bundle/lightning-input-rich-text)",
|
|
2414
|
+
"properties": {
|
|
2415
|
+
"accessKey": {
|
|
2416
|
+
"type": "string | number",
|
|
2417
|
+
"description": "Specifies a shortcut key to activate or focus an element."
|
|
2418
|
+
},
|
|
2419
|
+
"ariaDescribedBy": {
|
|
2420
|
+
"type": "string | number",
|
|
2421
|
+
"description": "A space-separated list of element IDs that provides descriptive labels for the rich text editor."
|
|
2422
|
+
},
|
|
2423
|
+
"ariaLabel": {
|
|
2424
|
+
"type": "string | number",
|
|
2425
|
+
"description": "Label describing the rich text editor to assistive technologies"
|
|
2426
|
+
},
|
|
2427
|
+
"ariaLabelledBy": {
|
|
2428
|
+
"type": "string | number",
|
|
2429
|
+
"description": "An element ID that provides a label for the rich text editor."
|
|
2430
|
+
},
|
|
2431
|
+
"customButtons": {
|
|
2432
|
+
"type": "any",
|
|
2433
|
+
"description": "Reserved for internal use. Custom buttons to add to the toolbar."
|
|
2434
|
+
},
|
|
2435
|
+
"disabled": {
|
|
2436
|
+
"type": "boolean",
|
|
2437
|
+
"description": "If present, the editor is disabled and users cannot interact with it."
|
|
2438
|
+
},
|
|
2439
|
+
"disabledCategories": {
|
|
2440
|
+
"type": "readonly unknown[]",
|
|
2441
|
+
"description": "A comma-separated list of button categories to remove from the toolbar."
|
|
2442
|
+
},
|
|
2443
|
+
"fieldLevelHelp": {
|
|
2444
|
+
"type": "any"
|
|
2445
|
+
},
|
|
2446
|
+
"formats": {
|
|
2447
|
+
"type": "readonly unknown[]",
|
|
2448
|
+
"description": "A allowlist of formats. By default, the list is computed based on enabled categories. The 'table' format is always enabled to support copying and pasting of tables if formats are not provided."
|
|
2449
|
+
},
|
|
2450
|
+
"label": {
|
|
2451
|
+
"type": "string | number",
|
|
2452
|
+
"description": "The label of the rich text editor."
|
|
2453
|
+
},
|
|
2454
|
+
"labelVisible": {
|
|
2455
|
+
"type": "boolean",
|
|
2456
|
+
"description": "If present, the label on the rich text editor is visible."
|
|
2457
|
+
},
|
|
2458
|
+
"manualImageUpload": {
|
|
2459
|
+
"type": "any"
|
|
2460
|
+
},
|
|
2461
|
+
"messageWhenBadInput": {
|
|
2462
|
+
"type": "string | number",
|
|
2463
|
+
"description": "Error message to be displayed when invalid input is detected."
|
|
2464
|
+
},
|
|
2465
|
+
"placeholder": {
|
|
2466
|
+
"type": "string | number",
|
|
2467
|
+
"description": "Text that is displayed when the field is empty, to prompt the user for a valid entry."
|
|
2468
|
+
},
|
|
2469
|
+
"required": {
|
|
2470
|
+
"type": "any"
|
|
2471
|
+
},
|
|
2472
|
+
"shareWithEntityId": {
|
|
2473
|
+
"type": "string | number",
|
|
2474
|
+
"description": "Entity ID to share the image with."
|
|
2475
|
+
},
|
|
2476
|
+
"tabIndex": {
|
|
2477
|
+
"type": "number | string",
|
|
2478
|
+
"description": "Specifies the tab order of an element (when the tab button is used for navigating)."
|
|
2479
|
+
},
|
|
2480
|
+
"title": {
|
|
2481
|
+
"type": "string | number",
|
|
2482
|
+
"description": "Displays tooltip text when the mouse moves over the element."
|
|
2483
|
+
},
|
|
2484
|
+
"valid": {
|
|
2485
|
+
"type": "boolean",
|
|
2486
|
+
"description": "Specifies whether the editor content is valid. If invalid, the slds-has-error class is added. This value defaults to true."
|
|
2487
|
+
},
|
|
2488
|
+
"value": {
|
|
2489
|
+
"type": "any",
|
|
2490
|
+
"description": "The HTML content in the rich text editor."
|
|
2491
|
+
},
|
|
2492
|
+
"variant": {
|
|
2493
|
+
"type": "string | number",
|
|
2494
|
+
"description": "The variant changes the appearance of the toolbar. Accepted variant is bottom-toolbar which causes the toolbar to be displayed below the text box."
|
|
2495
|
+
}
|
|
2496
|
+
},
|
|
2497
|
+
"methods": {
|
|
2498
|
+
"getFormat": {
|
|
2499
|
+
"type": "(...args: any[]) => any",
|
|
2500
|
+
"description": "Returns an object representing the formats applied to the current selection. Formats supported are align, background, bold, code, code-block, color, font, header, italic, link, size, strike, underline."
|
|
2501
|
+
},
|
|
2502
|
+
"insertTextAtCursor": {
|
|
2503
|
+
"type": "(text: string) => void",
|
|
2504
|
+
"description": "Reserved for internal use. Insert text in the rich text editor at cursor position."
|
|
2505
|
+
},
|
|
2506
|
+
"setFormat": {
|
|
2507
|
+
"type": "(formats: any) => void",
|
|
2508
|
+
"description": "Sets a format in the editor from the cursor point onwards. The format also applies to currently selected content. Valid formats are font, size, and align."
|
|
2509
|
+
},
|
|
2510
|
+
"setRangeText": {
|
|
2511
|
+
"type": "(replacement: string, start?: number, end?: number, selectMode?: string) => void",
|
|
2512
|
+
"description": "Replaces a range of text in the rich text editor with a new string"
|
|
2513
|
+
},
|
|
2514
|
+
"uploadPendingImages": {
|
|
2515
|
+
"type": "() => any",
|
|
2516
|
+
"description": "Uploads all pending images that were inserted while manualImageUpload was true. Returns a promise that resolves with an array of upload results."
|
|
2517
|
+
}
|
|
2518
|
+
},
|
|
2519
|
+
"events": {
|
|
2520
|
+
"imageupload": {
|
|
2521
|
+
"type": "CustomEvent<{ imageId: string; downloadUrl: string; file: File; contentVersionId: string }>",
|
|
2522
|
+
"description": "The event fired when each image uploads successfully. Doesn't bubble."
|
|
2523
|
+
},
|
|
2524
|
+
"imageuploaderror": {
|
|
2525
|
+
"type": "CustomEvent<{ error: string; file: File; imageId: string; maxSize: number; reason: string }>",
|
|
2526
|
+
"description": "The event fired when an image fails to be inserted into the rich text editor or uploaded. Doesn't bubble."
|
|
2527
|
+
}
|
|
2528
|
+
}
|
|
2529
|
+
},
|
|
2530
|
+
"lightning-layout": {
|
|
2531
|
+
"description": "Represents a responsive grid system for arranging containers on a page. [View in Component Library](https://developer.salesforce.com/docs/component-library/bundle/lightning-layout)",
|
|
2532
|
+
"properties": {
|
|
2533
|
+
"horizontalAlign": {
|
|
2534
|
+
"type": "string | number",
|
|
2535
|
+
"description": "Determines how to spread the layout items horizontally. The alignment options are center, space, spread, and end."
|
|
2536
|
+
},
|
|
2537
|
+
"multipleRows": {
|
|
2538
|
+
"type": "boolean",
|
|
2539
|
+
"description": "If present, layout items wrap to the following line when they exceed the layout width."
|
|
2540
|
+
},
|
|
2541
|
+
"pullToBoundary": {
|
|
2542
|
+
"type": "string | number",
|
|
2543
|
+
"description": "Pulls layout items to the layout boundaries and corresponds to the padding size on the layout item. Possible values are small, medium, or large."
|
|
2544
|
+
},
|
|
2545
|
+
"title": {
|
|
2546
|
+
"type": "string | number",
|
|
2547
|
+
"description": "Displays tooltip text when the mouse moves over the element."
|
|
2548
|
+
},
|
|
2549
|
+
"verticalAlign": {
|
|
2550
|
+
"type": "string | number",
|
|
2551
|
+
"description": "Determines how to align the layout items vertically in the container. The alignment options are start, center, end, and stretch."
|
|
2552
|
+
}
|
|
2553
|
+
},
|
|
2554
|
+
"methods": {},
|
|
2555
|
+
"events": {}
|
|
2556
|
+
},
|
|
2557
|
+
"lightning-layout-item": {
|
|
2558
|
+
"description": "The basic element in a lightning-layout component. A layout item groups information together to define visual grids, spacing, and sections. [View in Component Library](https://developer.salesforce.com/docs/component-library/bundle/lightning-layout-item)",
|
|
2559
|
+
"properties": {
|
|
2560
|
+
"alignmentBump": {
|
|
2561
|
+
"type": "string | number",
|
|
2562
|
+
"description": "Specifies a direction to bump the alignment of adjacent layout items. Allowed values are left, top, right, bottom."
|
|
2563
|
+
},
|
|
2564
|
+
"flexibility": {
|
|
2565
|
+
"type": "any",
|
|
2566
|
+
"description": "Make the item fluid so that it absorbs any extra space in its container or shrinks when there is less space. Allowed values are: auto (columns grow or shrink equally as space allows), shrink (columns shrink equally as space decreases), no-shrink (columns don't shrink as space reduces), grow (columns grow equally as space increases), no-grow (columns don't grow as space increases), no-flex (columns don't grow or shrink as space changes). Use a comma-separated value for multiple options, such as 'auto, no-shrink'."
|
|
2567
|
+
},
|
|
2568
|
+
"largeDeviceSize": {
|
|
2569
|
+
"type": "number | string",
|
|
2570
|
+
"description": "If the viewport is divided into 12 parts, this attribute indicates the relative space the container occupies on device-types larger than desktop. It is expressed as an integer from 1 through 12."
|
|
2571
|
+
},
|
|
2572
|
+
"mediumDeviceSize": {
|
|
2573
|
+
"type": "number | string",
|
|
2574
|
+
"description": "If the viewport is divided into 12 parts, this attribute indicates the relative space the container occupies on device-types larger than tablet. It is expressed as an integer from 1 through 12."
|
|
2575
|
+
},
|
|
2576
|
+
"padding": {
|
|
2577
|
+
"type": "string | number",
|
|
2578
|
+
"description": "Sets padding to either the right and left sides of a container, or all sides of a container. Allowed values are horizontal-small, horizontal-medium, horizontal-large, around-small, around-medium, around-large."
|
|
2579
|
+
},
|
|
2580
|
+
"size": {
|
|
2581
|
+
"type": "number | string",
|
|
2582
|
+
"description": "If the viewport is divided into 12 parts, size indicates the relative space the container occupies. Size is expressed as an integer from 1 through 12. This applies for all device-types."
|
|
2583
|
+
},
|
|
2584
|
+
"smallDeviceSize": {
|
|
2585
|
+
"type": "number | string",
|
|
2586
|
+
"description": "If the viewport is divided into 12 parts, this attribute indicates the relative space the container occupies on device-types larger than mobile. It is expressed as an integer from 1 through 12."
|
|
2587
|
+
},
|
|
2588
|
+
"title": {
|
|
2589
|
+
"type": "string | number",
|
|
2590
|
+
"description": "Displays tooltip text when the mouse moves over the element."
|
|
2591
|
+
}
|
|
2592
|
+
},
|
|
2593
|
+
"methods": {},
|
|
2594
|
+
"events": {}
|
|
2595
|
+
},
|
|
2596
|
+
"lightning-map": {
|
|
2597
|
+
"description": "Displays a map with markers for one or more locations. [View in Component Library](https://developer.salesforce.com/docs/component-library/bundle/lightning-map)",
|
|
2598
|
+
"properties": {
|
|
2599
|
+
"center": {
|
|
2600
|
+
"type": "any",
|
|
2601
|
+
"description": "A location to use as the map's center. If center is not specified, the map centers automatically."
|
|
2602
|
+
},
|
|
2603
|
+
"listView": {
|
|
2604
|
+
"type": "any",
|
|
2605
|
+
"description": "Displays or hides the list of locations. Valid values are visible, hidden, or auto. This value defaults to auto, which shows the list only when multiple markers are present. Passing in an invalid value hides the list view."
|
|
2606
|
+
},
|
|
2607
|
+
"mapMarkers": {
|
|
2608
|
+
"type": "any",
|
|
2609
|
+
"description": "One or more objects with the address or latitude and longitude to be displayed on the map. If latitude and longitude are provided, the address is ignored."
|
|
2610
|
+
},
|
|
2611
|
+
"markersTitle": {
|
|
2612
|
+
"type": "string | number",
|
|
2613
|
+
"description": "Provides the heading title for the markers. Required if specifying multiple markers. The title is displayed below the map as a header for the list of clickable addresses."
|
|
2614
|
+
},
|
|
2615
|
+
"options": {
|
|
2616
|
+
"type": "any"
|
|
2617
|
+
},
|
|
2618
|
+
"selectedMarkerValue": {
|
|
2619
|
+
"type": "any",
|
|
2620
|
+
"description": "Provides the value of the currently selected marker. Returns undefined if you don’t pass value to map-markers."
|
|
2621
|
+
},
|
|
2622
|
+
"showFooter": {
|
|
2623
|
+
"type": "boolean",
|
|
2624
|
+
"description": "If present, the footer element is displayed below the map. The footer shows an 'Open in Google Maps' link that opens an external window to display the selected marker location in Google Maps. Default value is false."
|
|
2625
|
+
},
|
|
2626
|
+
"title": {
|
|
2627
|
+
"type": "string | number",
|
|
2628
|
+
"description": "Displays tooltip text when the mouse moves over the element."
|
|
2629
|
+
},
|
|
2630
|
+
"zoomLevel": {
|
|
2631
|
+
"type": "number | string",
|
|
2632
|
+
"description": "The zoom levels as defined by Google Maps API. If a zoom level is not specified, a default zoom level is applied to accommodate all markers on the map."
|
|
2633
|
+
}
|
|
2634
|
+
},
|
|
2635
|
+
"methods": {},
|
|
2636
|
+
"events": {
|
|
2637
|
+
"markerselect": {
|
|
2638
|
+
"type": "CustomEvent<{ selectedMarkerValue: string }>",
|
|
2639
|
+
"description": "The event fired when a marker is selected. Select a marker by clicking it on the map or in the list of locations. The value of the selected marker is available on the `selected-marker-value` attribute on the component. Bubbles, but doesn't cross the component's shadow boundary."
|
|
2640
|
+
}
|
|
2641
|
+
}
|
|
2642
|
+
},
|
|
2643
|
+
"lightning-menu-divider": {
|
|
2644
|
+
"properties": {
|
|
2645
|
+
"variant": {
|
|
2646
|
+
"type": "any"
|
|
2647
|
+
}
|
|
2648
|
+
},
|
|
2649
|
+
"methods": {},
|
|
2650
|
+
"events": {}
|
|
2651
|
+
},
|
|
2652
|
+
"lightning-menu-item": {
|
|
2653
|
+
"description": "Represents a list item in a menu. [View in Component Library](https://developer.salesforce.com/docs/component-library/bundle/lightning-menu-item)",
|
|
2654
|
+
"properties": {
|
|
2655
|
+
"accessKey": {
|
|
2656
|
+
"type": "string | number",
|
|
2657
|
+
"description": "Specifies a shortcut key to activate or focus an element."
|
|
2658
|
+
},
|
|
2659
|
+
"checked": {
|
|
2660
|
+
"type": "boolean",
|
|
2661
|
+
"description": "If present, a check mark displays on the left of the menu item if it's selected."
|
|
2662
|
+
},
|
|
2663
|
+
"disabled": {
|
|
2664
|
+
"type": "boolean",
|
|
2665
|
+
"description": "If present, the menu item is disabled and users cannot interact with it."
|
|
2666
|
+
},
|
|
2667
|
+
"download": {
|
|
2668
|
+
"type": "any",
|
|
2669
|
+
"description": "The name of a file that's downloaded when clicking a link in the menu item. Used with the href attribute."
|
|
2670
|
+
},
|
|
2671
|
+
"draftAlternativeText": {
|
|
2672
|
+
"type": "string | number",
|
|
2673
|
+
"description": "Describes the reason for showing the draft indicator. This is required when is-draft is present on the lightning-menu-item tag."
|
|
2674
|
+
},
|
|
2675
|
+
"href": {
|
|
2676
|
+
"type": "string | number",
|
|
2677
|
+
"description": "URL for a link to use for the menu item."
|
|
2678
|
+
},
|
|
2679
|
+
"iconName": {
|
|
2680
|
+
"type": "string | number",
|
|
2681
|
+
"description": "The name of an icon to display after the text of the menu item."
|
|
2682
|
+
},
|
|
2683
|
+
"iconType": {
|
|
2684
|
+
"type": "any"
|
|
2685
|
+
},
|
|
2686
|
+
"isDraft": {
|
|
2687
|
+
"type": "boolean",
|
|
2688
|
+
"description": "If present, a draft indicator is shown on the menu item. A draft indicator is denoted by blue asterisk on the left of the menu item. When you use a draft indicator, include alternative text for accessibility using draft-alternative-text."
|
|
2689
|
+
},
|
|
2690
|
+
"label": {
|
|
2691
|
+
"type": "string | number",
|
|
2692
|
+
"description": "Text of the menu item."
|
|
2693
|
+
},
|
|
2694
|
+
"prefixIconName": {
|
|
2695
|
+
"type": "string | number",
|
|
2696
|
+
"description": "The name of an icon to display before the text of the menu item."
|
|
2697
|
+
},
|
|
2698
|
+
"tabIndex": {
|
|
2699
|
+
"type": "number | string",
|
|
2700
|
+
"description": "Specifies the tab order of an element (when the tab button is used for navigating)."
|
|
2701
|
+
},
|
|
2702
|
+
"target": {
|
|
2703
|
+
"type": "any"
|
|
2704
|
+
},
|
|
2705
|
+
"title": {
|
|
2706
|
+
"type": "string | number",
|
|
2707
|
+
"description": "Displays tooltip text when the mouse moves over the element."
|
|
2708
|
+
},
|
|
2709
|
+
"value": {
|
|
2710
|
+
"type": "any",
|
|
2711
|
+
"description": "A value associated with the menu item."
|
|
2712
|
+
}
|
|
2713
|
+
},
|
|
2714
|
+
"methods": {},
|
|
2715
|
+
"events": {}
|
|
2716
|
+
},
|
|
2717
|
+
"lightning-menu-subheader": {
|
|
2718
|
+
"properties": {
|
|
2719
|
+
"label": {
|
|
2720
|
+
"type": "any"
|
|
2721
|
+
}
|
|
2722
|
+
},
|
|
2723
|
+
"methods": {},
|
|
2724
|
+
"events": {}
|
|
2725
|
+
},
|
|
2726
|
+
"lightning-messages": {
|
|
2727
|
+
"properties": {
|
|
2728
|
+
"error": {
|
|
2729
|
+
"type": "any"
|
|
2730
|
+
}
|
|
2731
|
+
},
|
|
2732
|
+
"methods": {
|
|
2733
|
+
"setError": {
|
|
2734
|
+
"type": "(...args: any[]) => any"
|
|
2735
|
+
}
|
|
2736
|
+
},
|
|
2737
|
+
"events": {}
|
|
2738
|
+
},
|
|
2739
|
+
"lightning-modal-body": {
|
|
2740
|
+
"properties": {},
|
|
2741
|
+
"methods": {},
|
|
2742
|
+
"events": {}
|
|
2743
|
+
},
|
|
2744
|
+
"lightning-modal-footer": {
|
|
2745
|
+
"properties": {},
|
|
2746
|
+
"methods": {},
|
|
2747
|
+
"events": {}
|
|
2748
|
+
},
|
|
2749
|
+
"lightning-modal-header": {
|
|
2750
|
+
"properties": {
|
|
2751
|
+
"label": {
|
|
2752
|
+
"type": "any"
|
|
2753
|
+
}
|
|
2754
|
+
},
|
|
2755
|
+
"methods": {},
|
|
2756
|
+
"events": {}
|
|
2757
|
+
},
|
|
2758
|
+
"lightning-notifications-library": {
|
|
2759
|
+
"properties": {},
|
|
2760
|
+
"methods": {
|
|
2761
|
+
"showNotice": {
|
|
2762
|
+
"type": "(...args: any[]) => any"
|
|
2763
|
+
},
|
|
2764
|
+
"showToast": {
|
|
2765
|
+
"type": "(...args: any[]) => any"
|
|
2766
|
+
}
|
|
2767
|
+
},
|
|
2768
|
+
"events": {}
|
|
2769
|
+
},
|
|
2770
|
+
"lightning-output-field": {
|
|
2771
|
+
"description": "Represents a read-only display of a label, help text, and value for a field on a Salesforce object. [View in Component Library](https://developer.salesforce.com/docs/component-library/bundle/lightning-output-field)",
|
|
2772
|
+
"properties": {
|
|
2773
|
+
"fieldClass": {
|
|
2774
|
+
"type": "any",
|
|
2775
|
+
"description": "A CSS class for the outer element, in addition to the component's base classes."
|
|
2776
|
+
},
|
|
2777
|
+
"fieldName": {
|
|
2778
|
+
"type": "string | number",
|
|
2779
|
+
"description": "The API name of the field to be displayed."
|
|
2780
|
+
},
|
|
2781
|
+
"variant": {
|
|
2782
|
+
"type": "string | number",
|
|
2783
|
+
"description": "Changes the appearance of the output. Accepted variants include standard and label-hidden. This value defaults to standard."
|
|
2784
|
+
}
|
|
2785
|
+
},
|
|
2786
|
+
"methods": {
|
|
2787
|
+
"wirePicklistValues": {
|
|
2788
|
+
"type": "(...args: any[]) => any",
|
|
2789
|
+
"description": "Reserved for internal use."
|
|
2790
|
+
},
|
|
2791
|
+
"wireRecordUi": {
|
|
2792
|
+
"type": "(...args: any[]) => any",
|
|
2793
|
+
"description": "Reserved for internal use."
|
|
2794
|
+
}
|
|
2795
|
+
},
|
|
2796
|
+
"events": {}
|
|
2797
|
+
},
|
|
2798
|
+
"lightning-overlay-library": {
|
|
2799
|
+
"properties": {},
|
|
2800
|
+
"methods": {
|
|
2801
|
+
"close": {
|
|
2802
|
+
"type": "(...args: any[]) => any"
|
|
2803
|
+
},
|
|
2804
|
+
"hide": {
|
|
2805
|
+
"type": "(...args: any[]) => any"
|
|
2806
|
+
},
|
|
2807
|
+
"show": {
|
|
2808
|
+
"type": "(...args: any[]) => any"
|
|
2809
|
+
},
|
|
2810
|
+
"showCustomModal": {
|
|
2811
|
+
"type": "(...args: any[]) => any"
|
|
2812
|
+
},
|
|
2813
|
+
"showCustomPopover": {
|
|
2814
|
+
"type": "(...args: any[]) => any"
|
|
2815
|
+
}
|
|
2816
|
+
},
|
|
2817
|
+
"events": {}
|
|
2818
|
+
},
|
|
2819
|
+
"lightning-pill": {
|
|
2820
|
+
"description": "A pill displays a label that can contain links and can be removed from view. [View in Component Library](https://developer.salesforce.com/docs/component-library/bundle/lightning-pill)",
|
|
2821
|
+
"properties": {
|
|
2822
|
+
"ariaSelected": {
|
|
2823
|
+
"type": "any",
|
|
2824
|
+
"description": "Specifies the aria-selected of an element."
|
|
2825
|
+
},
|
|
2826
|
+
"hasError": {
|
|
2827
|
+
"type": "boolean",
|
|
2828
|
+
"description": "If present, the pill is shown with a red border and an error icon on the left of the label."
|
|
2829
|
+
},
|
|
2830
|
+
"href": {
|
|
2831
|
+
"type": "string | number",
|
|
2832
|
+
"description": "The URL of the page that the link goes to."
|
|
2833
|
+
},
|
|
2834
|
+
"isPlainLink": {
|
|
2835
|
+
"type": "any",
|
|
2836
|
+
"description": "Reserved for internal use. Specifies whether the element variant is a plain link."
|
|
2837
|
+
},
|
|
2838
|
+
"label": {
|
|
2839
|
+
"type": "string | number",
|
|
2840
|
+
"description": "The text label that displays in the pill."
|
|
2841
|
+
},
|
|
2842
|
+
"name": {
|
|
2843
|
+
"type": "string | number",
|
|
2844
|
+
"description": "The name for the pill. This value is optional and can be used to identify the pill in a callback."
|
|
2845
|
+
},
|
|
2846
|
+
"role": {
|
|
2847
|
+
"type": "any",
|
|
2848
|
+
"description": "Specifies the role of an element."
|
|
2849
|
+
},
|
|
2850
|
+
"tabIndex": {
|
|
2851
|
+
"type": "any",
|
|
2852
|
+
"description": "Reserved for internal use. Use tabindex instead to indicate if an element should be focusable. A value of 0 means that the pill is focusable and participates in sequential keyboard navigation. A value of -1 means that the pill is focusable but does not participate in keyboard navigation."
|
|
2853
|
+
},
|
|
2854
|
+
"title": {
|
|
2855
|
+
"type": "string | number",
|
|
2856
|
+
"description": "Displays tooltip text when the mouse moves over the element."
|
|
2857
|
+
},
|
|
2858
|
+
"variant": {
|
|
2859
|
+
"type": "any",
|
|
2860
|
+
"description": "The variant changes the appearance of the pill. Accepted variants include link, plain, and plainLink. The default variant is link, which creates a link in the pill when you specify the href attribute. The plain variant renders the pill without a link and ignores the href attribute. The plainLink variant is reserved for internal use."
|
|
2861
|
+
}
|
|
2862
|
+
},
|
|
2863
|
+
"methods": {
|
|
2864
|
+
"focusLink": {
|
|
2865
|
+
"type": "(...args: any[]) => any",
|
|
2866
|
+
"description": "Reserved for internal use. Sets focus on the anchor element for a plainLink pill."
|
|
2867
|
+
},
|
|
2868
|
+
"focusRemove": {
|
|
2869
|
+
"type": "() => any",
|
|
2870
|
+
"description": "Reserved for internal use. Sets focus on the remove button element for a plain pill."
|
|
2871
|
+
}
|
|
2872
|
+
},
|
|
2873
|
+
"events": {
|
|
2874
|
+
"remove": {
|
|
2875
|
+
"type": "CustomEvent<{ name: string }>",
|
|
2876
|
+
"description": "The first event fired when you click the remove button. Doesn't bubble."
|
|
2877
|
+
}
|
|
2878
|
+
}
|
|
2879
|
+
},
|
|
2880
|
+
"lightning-pill-container": {
|
|
2881
|
+
"description": "A list of pills grouped in a container. This component requires API version 42.0 and later. [View in Component Library](https://developer.salesforce.com/docs/component-library/bundle/lightning-pill-container)",
|
|
2882
|
+
"properties": {
|
|
2883
|
+
"isCollapsible": {
|
|
2884
|
+
"type": "any",
|
|
2885
|
+
"description": "Specifies whether the pill container can be collapsed."
|
|
2886
|
+
},
|
|
2887
|
+
"isExpanded": {
|
|
2888
|
+
"type": "any",
|
|
2889
|
+
"description": "Specifies whether the pill container is expanded."
|
|
2890
|
+
},
|
|
2891
|
+
"items": {
|
|
2892
|
+
"type": "readonly unknown[]",
|
|
2893
|
+
"description": "An array of items to be rendered as pills in a container."
|
|
2894
|
+
},
|
|
2895
|
+
"label": {
|
|
2896
|
+
"type": "string | number",
|
|
2897
|
+
"description": "Aria label for the pill container."
|
|
2898
|
+
},
|
|
2899
|
+
"singleLine": {
|
|
2900
|
+
"type": "boolean",
|
|
2901
|
+
"description": "Specifies whether to keep the pills in a single line."
|
|
2902
|
+
},
|
|
2903
|
+
"title": {
|
|
2904
|
+
"type": "string | number",
|
|
2905
|
+
"description": "Displays tooltip text when the mouse moves over the element."
|
|
2906
|
+
},
|
|
2907
|
+
"variant": {
|
|
2908
|
+
"type": "any",
|
|
2909
|
+
"description": "The variant changes the appearance of the pill container. Accepted variants include standard and bare. This value defaults to standard."
|
|
2910
|
+
}
|
|
2911
|
+
},
|
|
2912
|
+
"methods": {},
|
|
2913
|
+
"events": {
|
|
2914
|
+
"itemremove": {
|
|
2915
|
+
"type": "CustomEvent<{ item: any; index: number }>",
|
|
2916
|
+
"description": "The event fired when a pill is removed. Doesn't bubble."
|
|
2917
|
+
}
|
|
2918
|
+
}
|
|
2919
|
+
},
|
|
2920
|
+
"lightning-progress-bar": {
|
|
2921
|
+
"description": "Displays a horizontal progress bar from left to right to indicate the progress of an operation. [View in Component Library](https://developer.salesforce.com/docs/component-library/bundle/lightning-progress-bar)",
|
|
2922
|
+
"properties": {
|
|
2923
|
+
"size": {
|
|
2924
|
+
"type": "string | number",
|
|
2925
|
+
"description": "The size of the progress bar. Valid values are x-small, small, medium, and large. The default value is medium."
|
|
2926
|
+
},
|
|
2927
|
+
"title": {
|
|
2928
|
+
"type": "string | number",
|
|
2929
|
+
"description": "Displays tooltip text when the mouse moves over the element."
|
|
2930
|
+
},
|
|
2931
|
+
"value": {
|
|
2932
|
+
"type": "any",
|
|
2933
|
+
"description": "The percentage value of the progress bar."
|
|
2934
|
+
},
|
|
2935
|
+
"variant": {
|
|
2936
|
+
"type": "string | number",
|
|
2937
|
+
"description": "The variant changes the appearance of the progress bar. Accepted variants include base or circular. This value defaults to base."
|
|
2938
|
+
}
|
|
2939
|
+
},
|
|
2940
|
+
"methods": {},
|
|
2941
|
+
"events": {}
|
|
2942
|
+
},
|
|
2943
|
+
"lightning-progress-indicator": {
|
|
2944
|
+
"description": "Provides a visual indication on the progress of a particular process. [View in Component Library](https://developer.salesforce.com/docs/component-library/bundle/lightning-progress-indicator)",
|
|
2945
|
+
"properties": {
|
|
2946
|
+
"currentStep": {
|
|
2947
|
+
"type": "string | number",
|
|
2948
|
+
"description": "Set current-step to match the value attribute of one of progress-step components. If current-step is not provided, the value of the first progress-step component is used."
|
|
2949
|
+
},
|
|
2950
|
+
"hasError": {
|
|
2951
|
+
"type": "boolean",
|
|
2952
|
+
"description": "If present, the current step is in error state and an error icon is displayed on the step indicator. Only the base type can display errors."
|
|
2953
|
+
},
|
|
2954
|
+
"title": {
|
|
2955
|
+
"type": "string | number",
|
|
2956
|
+
"description": "Displays tooltip text when the mouse moves over the element."
|
|
2957
|
+
},
|
|
2958
|
+
"type": {
|
|
2959
|
+
"type": "string | number",
|
|
2960
|
+
"description": "Changes the visual pattern of the indicator. Valid values are base and path. The default is base."
|
|
2961
|
+
},
|
|
2962
|
+
"variant": {
|
|
2963
|
+
"type": "string | number",
|
|
2964
|
+
"description": "Changes the appearance of the progress indicator for the base type only. Valid values are base or shaded. The shaded variant adds a light gray border to the step indicators. The default is base."
|
|
2965
|
+
}
|
|
2966
|
+
},
|
|
2967
|
+
"methods": {},
|
|
2968
|
+
"events": {}
|
|
2969
|
+
},
|
|
2970
|
+
"lightning-progress-ring": {
|
|
2971
|
+
"description": "Displays a circular progress indicator to provide feedback about an action or process. This component requires API version 48.0 and later. [View in Component Library](https://developer.salesforce.com/docs/component-library/bundle/lightning-progress-ring)",
|
|
2972
|
+
"properties": {
|
|
2973
|
+
"direction": {
|
|
2974
|
+
"type": "any",
|
|
2975
|
+
"description": "Controls which way the color flows from the top of the ring, either clockwise or counterclockwise Valid values include fill and drain. The fill value corresponds to a color flow in the clockwise direction. The drain value indicates a color flow in the counterclockwise direction."
|
|
2976
|
+
},
|
|
2977
|
+
"size": {
|
|
2978
|
+
"type": "any",
|
|
2979
|
+
"description": "The size of the progress ring. Valid values include medium and large."
|
|
2980
|
+
},
|
|
2981
|
+
"value": {
|
|
2982
|
+
"type": "any",
|
|
2983
|
+
"description": "The percentage value of the progress ring. The value must be a number from 0 to 100. A value of 50 corresponds to a color fill of half the ring in a clockwise or counterclockwise direction, depending on the direction attribute."
|
|
2984
|
+
},
|
|
2985
|
+
"variant": {
|
|
2986
|
+
"type": "any",
|
|
2987
|
+
"description": "Changes the appearance of the progress ring. Accepted variants include base, active-step, warning, expired, base-autocomplete."
|
|
2988
|
+
}
|
|
2989
|
+
},
|
|
2990
|
+
"methods": {},
|
|
2991
|
+
"events": {}
|
|
2992
|
+
},
|
|
2993
|
+
"lightning-progress-step": {
|
|
2994
|
+
"properties": {
|
|
2995
|
+
"label": {
|
|
2996
|
+
"type": "any"
|
|
2997
|
+
},
|
|
2998
|
+
"value": {
|
|
2999
|
+
"type": "any"
|
|
3000
|
+
}
|
|
3001
|
+
},
|
|
3002
|
+
"methods": {},
|
|
3003
|
+
"events": {
|
|
3004
|
+
"stepblur": {
|
|
3005
|
+
"type": "CustomEvent<{ index: number | string }>",
|
|
3006
|
+
"description": "The event fired when a step releases focus. Bubbles, but doesn't cross the component's shadow boundary."
|
|
3007
|
+
},
|
|
3008
|
+
"stepfocus": {
|
|
3009
|
+
"type": "CustomEvent<{ index: number | string }>",
|
|
3010
|
+
"description": "The event fired when a step receives focus. Bubbles, but doesn't cross the component's shadow boundary."
|
|
3011
|
+
},
|
|
3012
|
+
"stepmouseenter": {
|
|
3013
|
+
"type": "CustomEvent<{ index: number | string }>",
|
|
3014
|
+
"description": "The event fired when the mouse pointer moves onto the step. Bubbles, but doesn't cross the component's shadow boundary."
|
|
3015
|
+
},
|
|
3016
|
+
"stepmouseleave": {
|
|
3017
|
+
"type": "CustomEvent<{ index: number | string }>",
|
|
3018
|
+
"description": "The event fired when the mouse pointer moves off the step. Bubbles, but doesn't cross the component's shadow boundary."
|
|
3019
|
+
}
|
|
3020
|
+
}
|
|
3021
|
+
},
|
|
3022
|
+
"lightning-prompt": {
|
|
3023
|
+
"properties": {
|
|
3024
|
+
"defaultValue": {
|
|
3025
|
+
"type": "any"
|
|
3026
|
+
},
|
|
3027
|
+
"label": {
|
|
3028
|
+
"type": "any"
|
|
3029
|
+
},
|
|
3030
|
+
"message": {
|
|
3031
|
+
"type": "any"
|
|
3032
|
+
},
|
|
3033
|
+
"theme": {
|
|
3034
|
+
"type": "any"
|
|
3035
|
+
},
|
|
3036
|
+
"variant": {
|
|
3037
|
+
"type": "any"
|
|
3038
|
+
}
|
|
3039
|
+
},
|
|
3040
|
+
"methods": {},
|
|
3041
|
+
"events": {}
|
|
3042
|
+
},
|
|
3043
|
+
"lightning-quick-action-panel": {
|
|
3044
|
+
"properties": {
|
|
3045
|
+
"header": {
|
|
3046
|
+
"type": "any"
|
|
3047
|
+
}
|
|
3048
|
+
},
|
|
3049
|
+
"methods": {},
|
|
3050
|
+
"events": {}
|
|
3051
|
+
},
|
|
3052
|
+
"lightning-radio-group": {
|
|
3053
|
+
"description": "A radio button group that can have a single option selected. [View in Component Library](https://developer.salesforce.com/docs/component-library/bundle/lightning-radio-group)",
|
|
3054
|
+
"properties": {
|
|
3055
|
+
"accessKey": {
|
|
3056
|
+
"type": "string | number",
|
|
3057
|
+
"description": "Specifies a shortcut key to activate or focus an element."
|
|
3058
|
+
},
|
|
3059
|
+
"disabled": {
|
|
3060
|
+
"type": "boolean",
|
|
3061
|
+
"description": "If present, the radio group is disabled and users cannot interact with it."
|
|
3062
|
+
},
|
|
3063
|
+
"label": {
|
|
3064
|
+
"type": "string | number",
|
|
3065
|
+
"description": "Text label for the radio group."
|
|
3066
|
+
},
|
|
3067
|
+
"messageWhenValueMissing": {
|
|
3068
|
+
"type": "string | number",
|
|
3069
|
+
"description": "Optional message displayed when no radio button is selected and the required attribute is set to true."
|
|
3070
|
+
},
|
|
3071
|
+
"name": {
|
|
3072
|
+
"type": "string | number",
|
|
3073
|
+
"description": "Specifies the name of the radio button group. Only only one button can be selected if a name is specified for the group."
|
|
3074
|
+
},
|
|
3075
|
+
"options": {
|
|
3076
|
+
"type": "readonly unknown[]",
|
|
3077
|
+
"description": "Array of label-value pairs for each radio button."
|
|
3078
|
+
},
|
|
3079
|
+
"readOnly": {
|
|
3080
|
+
"type": "boolean",
|
|
3081
|
+
"description": "Specifies that an input field is read-only. This value defaults to false."
|
|
3082
|
+
},
|
|
3083
|
+
"required": {
|
|
3084
|
+
"type": "boolean",
|
|
3085
|
+
"description": "If present, a radio button must be selected before the form can be submitted."
|
|
3086
|
+
},
|
|
3087
|
+
"tabIndex": {
|
|
3088
|
+
"type": "number | string",
|
|
3089
|
+
"description": "Specifies the tab order of an element (when the tab button is used for navigating)."
|
|
3090
|
+
},
|
|
3091
|
+
"title": {
|
|
3092
|
+
"type": "string | number",
|
|
3093
|
+
"description": "Displays tooltip text when the mouse moves over the element."
|
|
3094
|
+
},
|
|
3095
|
+
"type": {
|
|
3096
|
+
"type": "string | number",
|
|
3097
|
+
"description": "The style of the radio group. Options are radio or button. The default is radio."
|
|
3098
|
+
},
|
|
3099
|
+
"validity": {
|
|
3100
|
+
"type": "any",
|
|
3101
|
+
"description": "Represents the validity states that an element can be in, with respect to constraint validation."
|
|
3102
|
+
},
|
|
3103
|
+
"value": {
|
|
3104
|
+
"type": "any",
|
|
3105
|
+
"description": "Specifies the value of the selected radio button."
|
|
3106
|
+
},
|
|
3107
|
+
"variant": {
|
|
3108
|
+
"type": "string | number",
|
|
3109
|
+
"description": "The variant changes the appearance of the radio group. Accepted variants include standard, label-hidden, label-inline, and label-stacked. This value defaults to standard. Use label-hidden to hide the label but make it available to assistive technology. Use label-inline to horizontally align the label and radio group. Use label-stacked to place the label above the radio group."
|
|
3110
|
+
}
|
|
3111
|
+
},
|
|
3112
|
+
"methods": {
|
|
3113
|
+
"checkValidity": {
|
|
3114
|
+
"type": "() => boolean",
|
|
3115
|
+
"description": "Returns the valid attribute value (Boolean) on the ValidityState object."
|
|
3116
|
+
},
|
|
3117
|
+
"reportValidity": {
|
|
3118
|
+
"type": "() => boolean",
|
|
3119
|
+
"description": "Displays the error messages and returns false if the input is invalid. If the input is valid, reportValidity() clears displayed error messages and returns true."
|
|
3120
|
+
},
|
|
3121
|
+
"setCustomValidity": {
|
|
3122
|
+
"type": "(message: string) => void",
|
|
3123
|
+
"description": "Sets a custom error message to be displayed when the radio group value is submitted."
|
|
3124
|
+
},
|
|
3125
|
+
"showHelpMessageIfInvalid": {
|
|
3126
|
+
"type": "() => void",
|
|
3127
|
+
"description": "Shows the help message if the form control is in an invalid state."
|
|
3128
|
+
}
|
|
3129
|
+
},
|
|
3130
|
+
"events": {
|
|
3131
|
+
"change": {
|
|
3132
|
+
"type": "CustomEvent<{ value: string }>",
|
|
3133
|
+
"description": "The selected option changed."
|
|
3134
|
+
}
|
|
3135
|
+
}
|
|
3136
|
+
},
|
|
3137
|
+
"lightning-record-edit-form": {
|
|
3138
|
+
"description": "Represents a record edit layout that displays one or more fields, provided by lightning-input-field. [View in Component Library](https://developer.salesforce.com/docs/component-library/bundle/lightning-record-edit-form)",
|
|
3139
|
+
"properties": {
|
|
3140
|
+
"density": {
|
|
3141
|
+
"type": "any",
|
|
3142
|
+
"description": "Sets the arrangement style of fields and labels in the form. Accepted values are compact, comfy, and auto (default). Use compact to display fields and their labels on the same line. Use comfy to display fields below their labels. Use auto to let the component dynamically set the density according to the user's Display Density setting and the width of the form."
|
|
3143
|
+
},
|
|
3144
|
+
"fieldNames": {
|
|
3145
|
+
"type": "any",
|
|
3146
|
+
"description": "Reserved for internal use. Names of the fields to include in the form."
|
|
3147
|
+
},
|
|
3148
|
+
"formClass": {
|
|
3149
|
+
"type": "any",
|
|
3150
|
+
"description": "A CSS class for the form element."
|
|
3151
|
+
},
|
|
3152
|
+
"layoutType": {
|
|
3153
|
+
"type": "any",
|
|
3154
|
+
"description": "The type of layout to use to display the form fields. Possible values: Compact, Full."
|
|
3155
|
+
},
|
|
3156
|
+
"objectApiName": {
|
|
3157
|
+
"type": "string | number",
|
|
3158
|
+
"description": "The API name of the object."
|
|
3159
|
+
},
|
|
3160
|
+
"optionalFields": {
|
|
3161
|
+
"type": "any"
|
|
3162
|
+
},
|
|
3163
|
+
"recordId": {
|
|
3164
|
+
"type": "string | number",
|
|
3165
|
+
"description": "The ID of the record to be displayed."
|
|
3166
|
+
},
|
|
3167
|
+
"recordTypeId": {
|
|
3168
|
+
"type": "string | number",
|
|
3169
|
+
"description": "The ID of the record type, which is required if you created multiple record types but don't have a default."
|
|
3170
|
+
}
|
|
3171
|
+
},
|
|
3172
|
+
"methods": {
|
|
3173
|
+
"submit": {
|
|
3174
|
+
"type": "(fields?: Record<string, any>) => void",
|
|
3175
|
+
"description": "Submits the form using an array of record fields or field IDs. The field ID is provisioned from @salesforce/schema/. Invoke this method only after the load event."
|
|
3176
|
+
}
|
|
3177
|
+
},
|
|
3178
|
+
"events": {
|
|
3179
|
+
"error": {
|
|
3180
|
+
"type": "CustomEvent<{ message?: string; detail?: any; output?: any }>",
|
|
3181
|
+
"description": "The event fired when the record edit form returns a server-side error. Doesn't bubble."
|
|
3182
|
+
},
|
|
3183
|
+
"load": {
|
|
3184
|
+
"type": "CustomEvent<any>",
|
|
3185
|
+
"description": "The event fired when the record edit form loads record data. If you load the fields dynamically, `load` is fired before the child elements of `lightning-record-edit-form` finish loading. Consider the [`connectedCallback()` lifecycle](https://developer.salesforce.com/docs/platform/lwc/guide/create-lifecycle-hooks-dom) hook to perform initialization tasks. Alternatively, to load values or set properties dynamically, use a [getter and setter](https://developer.salesforce.com/docs/platform/lwc/guide/js-props-getters-setters) instead. Doesn't bubble."
|
|
3186
|
+
},
|
|
3187
|
+
"submit": {
|
|
3188
|
+
"type": "CustomEvent<{ fields: Record<string, any> }>",
|
|
3189
|
+
"description": "The event fired when the submit button is pressed. Client-side validation errors, if any, are displayed. The form is then submitted only when all fields in the form are valid. The form can be submitted only after it's loaded. Bubbles, and crosses the component's shadow boundary (composed)."
|
|
3190
|
+
},
|
|
3191
|
+
"success": {
|
|
3192
|
+
"type": "CustomEvent<{ id: string; [key: string]: any }>",
|
|
3193
|
+
"description": "The event fired when the record data is updated successfully. The `load` event then fires to return the updated data. Bubbles, and crosses the component's shadow boundary (composed)."
|
|
3194
|
+
}
|
|
3195
|
+
}
|
|
3196
|
+
},
|
|
3197
|
+
"lightning-record-form": {
|
|
3198
|
+
"description": "Creates an editable form or display form for a record. [View in Component Library](https://developer.salesforce.com/docs/component-library/bundle/lightning-record-form)",
|
|
3199
|
+
"properties": {
|
|
3200
|
+
"columns": {
|
|
3201
|
+
"type": "number | string",
|
|
3202
|
+
"description": "Specifies the number of columns for the form."
|
|
3203
|
+
},
|
|
3204
|
+
"density": {
|
|
3205
|
+
"type": "any",
|
|
3206
|
+
"description": "Sets the arrangement style of fields and labels in the form. Accepted values are compact, comfy, and auto (default). Use compact to display fields and their labels on the same line. Use comfy to display fields below their labels. Use auto to let the component dynamically set the density according to the user's Display Density setting and the width of the form."
|
|
3207
|
+
},
|
|
3208
|
+
"fields": {
|
|
3209
|
+
"type": "any",
|
|
3210
|
+
"description": "List of fields to be displayed. The fields display in the order you list them."
|
|
3211
|
+
},
|
|
3212
|
+
"layoutType": {
|
|
3213
|
+
"type": "string | number",
|
|
3214
|
+
"description": "The type of layout to use to display the form fields. Possible values: Compact, Full. When creating a new record, only the full layout is supported."
|
|
3215
|
+
},
|
|
3216
|
+
"mode": {
|
|
3217
|
+
"type": "string | number",
|
|
3218
|
+
"description": "Specifies the interaction and display style for the form. Possible values: view, edit, readonly. If a record ID is not provided, the default mode is edit, which displays a form to create new records. If a record ID is provided, the default mode is view, which displays field values with edit icons on updateable fields."
|
|
3219
|
+
},
|
|
3220
|
+
"objectApiName": {
|
|
3221
|
+
"type": "string | number",
|
|
3222
|
+
"description": "The API name of the object."
|
|
3223
|
+
},
|
|
3224
|
+
"recordId": {
|
|
3225
|
+
"type": "string | number",
|
|
3226
|
+
"description": "The ID of the record to be displayed."
|
|
3227
|
+
},
|
|
3228
|
+
"recordTypeId": {
|
|
3229
|
+
"type": "string | number",
|
|
3230
|
+
"description": "The ID of the record type, which is required if you created multiple record types but don't have a default."
|
|
3231
|
+
}
|
|
3232
|
+
},
|
|
3233
|
+
"methods": {
|
|
3234
|
+
"submit": {
|
|
3235
|
+
"type": "(fields?: Record<string, any>) => void",
|
|
3236
|
+
"description": "Submits the form using an array of record fields or field IDs. The field ID is provisioned from @salesforce/schema/. Invoke this method only after the load event."
|
|
3237
|
+
}
|
|
3238
|
+
},
|
|
3239
|
+
"events": {
|
|
3240
|
+
"cancel": {
|
|
3241
|
+
"type": "CustomEvent<any>",
|
|
3242
|
+
"description": "The event fired when the user clicks the Cancel button. If the form includes the `recordId` attribute, pressing the Cancel button returns the user to view mode with initial values provided by the record. If you don't provide the `recordId` attribute, pressing the Cancel button resets the fields to blank values. Doesn't bubble."
|
|
3243
|
+
}
|
|
3244
|
+
}
|
|
3245
|
+
},
|
|
3246
|
+
"lightning-record-picker": {
|
|
3247
|
+
"description": "A component that provides an input search field, that can search for Salesforce records. [View in Component Library](https://developer.salesforce.com/docs/component-library/bundle/lightning-record-picker)",
|
|
3248
|
+
"properties": {
|
|
3249
|
+
"disabled": {
|
|
3250
|
+
"type": "boolean",
|
|
3251
|
+
"description": "If present, the component is disabled and you can't interact with it."
|
|
3252
|
+
},
|
|
3253
|
+
"displayInfo": {
|
|
3254
|
+
"type": "any",
|
|
3255
|
+
"description": "The display configuration used to customize the way retrieved records are presented."
|
|
3256
|
+
},
|
|
3257
|
+
"fieldLevelHelp": {
|
|
3258
|
+
"type": "string | number",
|
|
3259
|
+
"description": "Help text detailing the purpose and function of the record picker, displayed on hover for desktop and on click for mobile"
|
|
3260
|
+
},
|
|
3261
|
+
"filter": {
|
|
3262
|
+
"type": "any",
|
|
3263
|
+
"description": "The filter applied to the retrieved records."
|
|
3264
|
+
},
|
|
3265
|
+
"label": {
|
|
3266
|
+
"type": "string | number",
|
|
3267
|
+
"description": "The text label for the component."
|
|
3268
|
+
},
|
|
3269
|
+
"matchingInfo": {
|
|
3270
|
+
"type": "any",
|
|
3271
|
+
"description": "The matching configuration to customize the fields used to match the search results to the search term entered by the user."
|
|
3272
|
+
},
|
|
3273
|
+
"messageWhenBadInput": {
|
|
3274
|
+
"type": "string | number",
|
|
3275
|
+
"description": "The error message displayed when the user enters a search term in the input but doesn't select an option."
|
|
3276
|
+
},
|
|
3277
|
+
"objectApiName": {
|
|
3278
|
+
"type": "string | number",
|
|
3279
|
+
"description": "The API name of the object for the retrieved records."
|
|
3280
|
+
},
|
|
3281
|
+
"placeholder": {
|
|
3282
|
+
"type": "string | number",
|
|
3283
|
+
"description": "The text displayed when the input is empty to prompt the user to enter a search term."
|
|
3284
|
+
},
|
|
3285
|
+
"required": {
|
|
3286
|
+
"type": "boolean",
|
|
3287
|
+
"description": "If present, specifies that a user must select a record. If no record is selected, the record picker is in an invalid state."
|
|
3288
|
+
},
|
|
3289
|
+
"value": {
|
|
3290
|
+
"type": "any",
|
|
3291
|
+
"description": "The ID of the record that is selected in the record picker."
|
|
3292
|
+
},
|
|
3293
|
+
"variant": {
|
|
3294
|
+
"type": "string | number",
|
|
3295
|
+
"description": "The variant changes the appearance of the component. The component displays the label above the combobox by default. Specify variant=\"label-hidden\" to hide the label but make it available to assistive technology. The only variant is label-hidden."
|
|
3296
|
+
}
|
|
3297
|
+
},
|
|
3298
|
+
"methods": {
|
|
3299
|
+
"checkValidity": {
|
|
3300
|
+
"type": "() => boolean",
|
|
3301
|
+
"description": "Check if the component is in a valid state."
|
|
3302
|
+
},
|
|
3303
|
+
"clearSelection": {
|
|
3304
|
+
"type": "(...args: any[]) => any",
|
|
3305
|
+
"description": "Clears the selected record. This method does not clear the search term or refresh the validity message."
|
|
3306
|
+
},
|
|
3307
|
+
"reportValidity": {
|
|
3308
|
+
"type": "() => boolean",
|
|
3309
|
+
"description": "Check if the component is in a valid state and refresh the validity message. If the component is valid, it clears the validity error message. If the component is invalid, it displays the validity error message."
|
|
3310
|
+
},
|
|
3311
|
+
"setCustomValidity": {
|
|
3312
|
+
"type": "(message: string) => void",
|
|
3313
|
+
"description": "Set a custom validity error message."
|
|
3314
|
+
}
|
|
3315
|
+
},
|
|
3316
|
+
"events": {}
|
|
3317
|
+
},
|
|
3318
|
+
"lightning-record-view-form": {
|
|
3319
|
+
"description": "Represents a record view layout that displays one or more fields, provided by lightning-output-field. [View in Component Library](https://developer.salesforce.com/docs/component-library/bundle/lightning-record-view-form)",
|
|
3320
|
+
"properties": {
|
|
3321
|
+
"density": {
|
|
3322
|
+
"type": "any",
|
|
3323
|
+
"description": "Sets the arrangement style of fields and labels in the form. Accepted values are compact, comfy, and auto (default). Use compact to display fields and their labels on the same line. Use comfy to display fields below their labels. Use auto to let the component dynamically set the density according to the user's Display Density setting and the width of the form."
|
|
3324
|
+
},
|
|
3325
|
+
"objectApiName": {
|
|
3326
|
+
"type": "string | number",
|
|
3327
|
+
"description": "The API name of the object."
|
|
3328
|
+
},
|
|
3329
|
+
"optionalFields": {
|
|
3330
|
+
"type": "any"
|
|
3331
|
+
},
|
|
3332
|
+
"recordId": {
|
|
3333
|
+
"type": "string | number",
|
|
3334
|
+
"description": "The ID of the record to be displayed."
|
|
3335
|
+
}
|
|
3336
|
+
},
|
|
3337
|
+
"methods": {},
|
|
3338
|
+
"events": {
|
|
3339
|
+
"load": {
|
|
3340
|
+
"type": "CustomEvent<any>",
|
|
3341
|
+
"description": "The event fired when the record view form loads record data. If you load the fields dynamically, `load` is fired before the child elements of `lightning-record-view-form` finish loading. Consider the [`connectedCallback()` lifecycle](https://developer.salesforce.com/docs/platform/lwc/guide/create-lifecycle-hooks-dom) hook to perform initialization tasks. Alternatively, to load values or set properties dynamically, use a [getter and setter](https://developer.salesforce.com/docs/platform/lwc/guide/js-props-getters-setters) instead. Doesn't bubble."
|
|
3342
|
+
}
|
|
3343
|
+
}
|
|
3344
|
+
},
|
|
3345
|
+
"lightning-relative-date-time": {
|
|
3346
|
+
"description": "Displays the relative time difference between the source date-time and the provided date-time. [View in Component Library](https://developer.salesforce.com/docs/component-library/bundle/lightning-relative-date-time)",
|
|
3347
|
+
"properties": {
|
|
3348
|
+
"title": {
|
|
3349
|
+
"type": "string | number",
|
|
3350
|
+
"description": "Displays tooltip text when the mouse moves over the element."
|
|
3351
|
+
},
|
|
3352
|
+
"value": {
|
|
3353
|
+
"type": "any",
|
|
3354
|
+
"description": "The timestamp or JavaScript Date object to be formatted."
|
|
3355
|
+
}
|
|
3356
|
+
},
|
|
3357
|
+
"methods": {},
|
|
3358
|
+
"events": {}
|
|
3359
|
+
},
|
|
3360
|
+
"lightning-rich-text-toolbar-button": {
|
|
3361
|
+
"properties": {
|
|
3362
|
+
"disabled": {
|
|
3363
|
+
"type": "any"
|
|
3364
|
+
},
|
|
3365
|
+
"groupOrder": {
|
|
3366
|
+
"type": "any"
|
|
3367
|
+
},
|
|
3368
|
+
"iconAlternativeText": {
|
|
3369
|
+
"type": "any"
|
|
3370
|
+
},
|
|
3371
|
+
"iconName": {
|
|
3372
|
+
"type": "any"
|
|
3373
|
+
},
|
|
3374
|
+
"selected": {
|
|
3375
|
+
"type": "any"
|
|
3376
|
+
}
|
|
3377
|
+
},
|
|
3378
|
+
"methods": {
|
|
3379
|
+
"closePopup": {
|
|
3380
|
+
"type": "(...args: any[]) => any",
|
|
3381
|
+
"description": "Closes the popup that was displayed below the button."
|
|
3382
|
+
},
|
|
3383
|
+
"showPopup": {
|
|
3384
|
+
"type": "(...args: any[]) => any",
|
|
3385
|
+
"description": "Displays a popup below the button. Items passed in to the default slot of this component are rendered as the content of the popup."
|
|
3386
|
+
}
|
|
3387
|
+
},
|
|
3388
|
+
"events": {
|
|
3389
|
+
"popupclickout": {
|
|
3390
|
+
"type": "CustomEvent<any>",
|
|
3391
|
+
"description": "The event fired when a popup is open and you click outside it. Doesn't bubble."
|
|
3392
|
+
}
|
|
3393
|
+
}
|
|
3394
|
+
},
|
|
3395
|
+
"lightning-rich-text-toolbar-button-group": {
|
|
3396
|
+
"properties": {},
|
|
3397
|
+
"methods": {},
|
|
3398
|
+
"events": {}
|
|
3399
|
+
},
|
|
3400
|
+
"lightning-select": {
|
|
3401
|
+
"description": "A menu of options for single or multiple selection.",
|
|
3402
|
+
"properties": {
|
|
3403
|
+
"accessKey": {
|
|
3404
|
+
"type": "string | number",
|
|
3405
|
+
"description": "A shortcut key that activates and focuses on the menu."
|
|
3406
|
+
},
|
|
3407
|
+
"ariaDescribedBy": {
|
|
3408
|
+
"type": "string | number",
|
|
3409
|
+
"description": "Aria Described by value on parent lighting-select"
|
|
3410
|
+
},
|
|
3411
|
+
"ariaLabelledBy": {
|
|
3412
|
+
"type": "string | number",
|
|
3413
|
+
"description": "A space-separated list of element IDs that provide labels for the aria-labelled-by value on parent lighting-select."
|
|
3414
|
+
},
|
|
3415
|
+
"autocomplete": {
|
|
3416
|
+
"type": "string | number",
|
|
3417
|
+
"description": "Reserved for internal use. Controls auto-filling of the field."
|
|
3418
|
+
},
|
|
3419
|
+
"disabled": {
|
|
3420
|
+
"type": "boolean",
|
|
3421
|
+
"description": "Specifies whether the menu is disabled and users cannot interact with it."
|
|
3422
|
+
},
|
|
3423
|
+
"fieldLevelHelp": {
|
|
3424
|
+
"type": "string | number",
|
|
3425
|
+
"description": "Help text detailing the purpose and function of the menu of options. The text is displayed in a tooltip above the menu."
|
|
3426
|
+
},
|
|
3427
|
+
"label": {
|
|
3428
|
+
"type": "string | number",
|
|
3429
|
+
"description": "The text label for the component. To hide the label but make it available to assistive technologies, use the label-hidden variant."
|
|
3430
|
+
},
|
|
3431
|
+
"messageWhenValueMissing": {
|
|
3432
|
+
"type": "string | number",
|
|
3433
|
+
"description": "The error message that's displayed below the menu when a user interacts with the menu but does not select an option."
|
|
3434
|
+
},
|
|
3435
|
+
"multiple": {
|
|
3436
|
+
"type": "boolean",
|
|
3437
|
+
"description": "Specifies whether multiple options can be selected."
|
|
3438
|
+
},
|
|
3439
|
+
"name": {
|
|
3440
|
+
"type": "string | number",
|
|
3441
|
+
"description": "The identifier for the component."
|
|
3442
|
+
},
|
|
3443
|
+
"options": {
|
|
3444
|
+
"type": "readonly { label: string; value: string }[]",
|
|
3445
|
+
"description": "An array of menu options with key-value pairs for label and value."
|
|
3446
|
+
},
|
|
3447
|
+
"required": {
|
|
3448
|
+
"type": "boolean",
|
|
3449
|
+
"description": "Specifies whether an option must be selected."
|
|
3450
|
+
},
|
|
3451
|
+
"size": {
|
|
3452
|
+
"type": "number | string | null",
|
|
3453
|
+
"description": "The number of rows in the list that should be visible at one time. Use this attribute with the multiple attribute."
|
|
3454
|
+
},
|
|
3455
|
+
"validity": {
|
|
3456
|
+
"type": "ValidityState",
|
|
3457
|
+
"description": "Represents the validity states that an element can be in, with respect to constraint validation."
|
|
3458
|
+
},
|
|
3459
|
+
"value": {
|
|
3460
|
+
"type": "any",
|
|
3461
|
+
"description": "The value of the selected option. If empty and a value is required, the component is in an invalid state."
|
|
3462
|
+
},
|
|
3463
|
+
"variant": {
|
|
3464
|
+
"type": "string | number",
|
|
3465
|
+
"description": "The variant changes the appearance of the dropdown menu. Accepted variants include standard, label-inline, label-hidden, and label-stacked. This value defaults to standard, which displays the label above the dropdown menu. label-hidden hides the label but make it available to assistive technology. label-inline horizontally aligns the label and dropdown menu. label-stacked places the label above the dropdown menu."
|
|
3466
|
+
}
|
|
3467
|
+
},
|
|
3468
|
+
"methods": {
|
|
3469
|
+
"blur": {
|
|
3470
|
+
"type": "() => void"
|
|
3471
|
+
},
|
|
3472
|
+
"checkValidity": {
|
|
3473
|
+
"type": "() => boolean",
|
|
3474
|
+
"description": "Checks if the input is valid."
|
|
3475
|
+
},
|
|
3476
|
+
"focus": {
|
|
3477
|
+
"type": "() => void"
|
|
3478
|
+
},
|
|
3479
|
+
"reportValidity": {
|
|
3480
|
+
"type": "() => boolean",
|
|
3481
|
+
"description": "Displays the error messages and returns false if the input is invalid. If the input is valid, reportValidity() clears displayed error messages and returns true."
|
|
3482
|
+
},
|
|
3483
|
+
"setCustomValidity": {
|
|
3484
|
+
"type": "(message: string) => void",
|
|
3485
|
+
"description": "Sets a custom error message to be displayed when a form is submitted."
|
|
3486
|
+
},
|
|
3487
|
+
"showHelpMessageIfInvalid": {
|
|
3488
|
+
"type": "() => void",
|
|
3489
|
+
"description": "Displays an error message on an invalid select field. An invalid field fails at least one constraint validation and returns false when checkValidity() is called."
|
|
3490
|
+
}
|
|
3491
|
+
},
|
|
3492
|
+
"events": {
|
|
3493
|
+
"change": {
|
|
3494
|
+
"type": "CustomEvent<{ value: string | string[] }>",
|
|
3495
|
+
"description": "The event fired when an option is selected. Bubbles, and crosses the component's shadow boundary (composed)."
|
|
3496
|
+
}
|
|
3497
|
+
}
|
|
3498
|
+
},
|
|
3499
|
+
"lightning-service-cloud-voice-toolkit-api": {
|
|
3500
|
+
"properties": {},
|
|
3501
|
+
"methods": {
|
|
3502
|
+
"updateNextBestActions": {
|
|
3503
|
+
"type": "(...args: any[]) => any"
|
|
3504
|
+
}
|
|
3505
|
+
},
|
|
3506
|
+
"events": {}
|
|
3507
|
+
},
|
|
3508
|
+
"lightning-slider": {
|
|
3509
|
+
"description": "An input range slider for specifying a value between two specified numbers. [View in Component Library](https://developer.salesforce.com/docs/component-library/bundle/lightning-slider)",
|
|
3510
|
+
"properties": {
|
|
3511
|
+
"disabled": {
|
|
3512
|
+
"type": "boolean",
|
|
3513
|
+
"description": "If present, the slider is disabled and users cannot interact with it."
|
|
3514
|
+
},
|
|
3515
|
+
"label": {
|
|
3516
|
+
"type": "string | number",
|
|
3517
|
+
"description": "Text label to describe the slider. Provide your own label to describe the slider."
|
|
3518
|
+
},
|
|
3519
|
+
"max": {
|
|
3520
|
+
"type": "number | string",
|
|
3521
|
+
"description": "The maximum value of the input range. The default is 100."
|
|
3522
|
+
},
|
|
3523
|
+
"messageWhenBadInput": {
|
|
3524
|
+
"type": "string | number",
|
|
3525
|
+
"description": "Error message to be displayed when a bad input is detected."
|
|
3526
|
+
},
|
|
3527
|
+
"messageWhenPatternMismatch": {
|
|
3528
|
+
"type": "string | number",
|
|
3529
|
+
"description": "Error message to be displayed when a pattern mismatch is detected."
|
|
3530
|
+
},
|
|
3531
|
+
"messageWhenRangeOverflow": {
|
|
3532
|
+
"type": "string | number",
|
|
3533
|
+
"description": "Error message to be displayed when a range overflow is detected."
|
|
3534
|
+
},
|
|
3535
|
+
"messageWhenRangeUnderflow": {
|
|
3536
|
+
"type": "string | number",
|
|
3537
|
+
"description": "Error message to be displayed when a range underflow is detected."
|
|
3538
|
+
},
|
|
3539
|
+
"messageWhenStepMismatch": {
|
|
3540
|
+
"type": "string | number",
|
|
3541
|
+
"description": "Error message to be displayed when a step mismatch is detected."
|
|
3542
|
+
},
|
|
3543
|
+
"messageWhenTooLong": {
|
|
3544
|
+
"type": "string | number",
|
|
3545
|
+
"description": "Error message to be displayed when the value is too long."
|
|
3546
|
+
},
|
|
3547
|
+
"messageWhenTypeMismatch": {
|
|
3548
|
+
"type": "string | number",
|
|
3549
|
+
"description": "Error message to be displayed when a type mismatch is detected."
|
|
3550
|
+
},
|
|
3551
|
+
"messageWhenValueMissing": {
|
|
3552
|
+
"type": "string | number",
|
|
3553
|
+
"description": "Error message to be displayed when the value is missing."
|
|
3554
|
+
},
|
|
3555
|
+
"min": {
|
|
3556
|
+
"type": "number | string",
|
|
3557
|
+
"description": "The minimum value of the input range. The default is 0."
|
|
3558
|
+
},
|
|
3559
|
+
"size": {
|
|
3560
|
+
"type": "string | number",
|
|
3561
|
+
"description": "The size of the slider. The default is an empty string, which sets the slider to the width of the viewport. Accepted values are x-small, small, medium, and large."
|
|
3562
|
+
},
|
|
3563
|
+
"step": {
|
|
3564
|
+
"type": "string | number",
|
|
3565
|
+
"description": "The step increment value of the input range. Example steps include 0.1, 1, or 10. The default is 1."
|
|
3566
|
+
},
|
|
3567
|
+
"title": {
|
|
3568
|
+
"type": "string | number",
|
|
3569
|
+
"description": "Displays tooltip text when the mouse moves over the element."
|
|
3570
|
+
},
|
|
3571
|
+
"type": {
|
|
3572
|
+
"type": "string | number",
|
|
3573
|
+
"description": "The type determines the orientation of the slider. Accepted values are vertical and horizontal. The default is horizontal."
|
|
3574
|
+
},
|
|
3575
|
+
"validity": {
|
|
3576
|
+
"type": "any",
|
|
3577
|
+
"description": "Represents the validity states of the slider input, with respect to constraint validation."
|
|
3578
|
+
},
|
|
3579
|
+
"value": {
|
|
3580
|
+
"type": "any",
|
|
3581
|
+
"description": "The numerical value of the slider. The default is 0."
|
|
3582
|
+
},
|
|
3583
|
+
"variant": {
|
|
3584
|
+
"type": "string | number",
|
|
3585
|
+
"description": "The variant changes the appearance of the slider. Accepted variants include standard and label-hidden. The default is standard."
|
|
3586
|
+
}
|
|
3587
|
+
},
|
|
3588
|
+
"methods": {
|
|
3589
|
+
"checkValidity": {
|
|
3590
|
+
"type": "() => boolean",
|
|
3591
|
+
"description": "Returns the valid attribute value (Boolean) on the ValidityState object."
|
|
3592
|
+
},
|
|
3593
|
+
"reportValidity": {
|
|
3594
|
+
"type": "() => boolean",
|
|
3595
|
+
"description": "Displays the error messages and returns false if the input is invalid. If the input is valid, reportValidity() clears displayed error messages and returns true."
|
|
3596
|
+
},
|
|
3597
|
+
"setCustomValidity": {
|
|
3598
|
+
"type": "(message: string) => void",
|
|
3599
|
+
"description": "Sets a custom error message to be displayed when the slider value is submitted."
|
|
3600
|
+
},
|
|
3601
|
+
"showHelpMessageIfInvalid": {
|
|
3602
|
+
"type": "() => void",
|
|
3603
|
+
"description": "Displays error messages on invalid fields. An invalid field fails at least one constraint validation and returns false when checkValidity() is called."
|
|
3604
|
+
}
|
|
3605
|
+
},
|
|
3606
|
+
"events": {
|
|
3607
|
+
"change": {
|
|
3608
|
+
"type": "CustomEvent<{ value: number }>",
|
|
3609
|
+
"description": "The value changed."
|
|
3610
|
+
}
|
|
3611
|
+
}
|
|
3612
|
+
},
|
|
3613
|
+
"lightning-spinner": {
|
|
3614
|
+
"description": "Displays an animated spinner. [View in Component Library](https://developer.salesforce.com/docs/component-library/bundle/lightning-spinner)",
|
|
3615
|
+
"properties": {
|
|
3616
|
+
"alternativeText": {
|
|
3617
|
+
"type": "string | number",
|
|
3618
|
+
"description": "The alternative text used to describe the reason for the wait and need for a spinner."
|
|
3619
|
+
},
|
|
3620
|
+
"size": {
|
|
3621
|
+
"type": "string | number",
|
|
3622
|
+
"description": "The size of the spinner. Accepted sizes are small, medium, and large. This value defaults to medium."
|
|
3623
|
+
},
|
|
3624
|
+
"title": {
|
|
3625
|
+
"type": "string | number",
|
|
3626
|
+
"description": "Displays tooltip text when the mouse moves over the element."
|
|
3627
|
+
},
|
|
3628
|
+
"variant": {
|
|
3629
|
+
"type": "string | number",
|
|
3630
|
+
"description": "The variant changes the appearance of the spinner. Accepted variants include base, brand, and inverse. The default is base."
|
|
3631
|
+
}
|
|
3632
|
+
},
|
|
3633
|
+
"methods": {},
|
|
3634
|
+
"events": {}
|
|
3635
|
+
},
|
|
3636
|
+
"lightning-tab": {
|
|
3637
|
+
"description": "A single tab in a tabset component. [View in Component Library](https://developer.salesforce.com/docs/component-library/bundle/lightning-tab)",
|
|
3638
|
+
"properties": {
|
|
3639
|
+
"accessKey": {
|
|
3640
|
+
"type": "string | number",
|
|
3641
|
+
"description": "Specifies a shortcut key to activate or focus an element."
|
|
3642
|
+
},
|
|
3643
|
+
"endIconAlternativeText": {
|
|
3644
|
+
"type": "any",
|
|
3645
|
+
"description": "The alternative text for the icon specified by end-icon-name."
|
|
3646
|
+
},
|
|
3647
|
+
"endIconName": {
|
|
3648
|
+
"type": "any",
|
|
3649
|
+
"description": "The Lightning Design System name of an icon to display at the end of the tab label. Specify the name in the format 'utility:check' where 'utility' is the category, and 'check' is the icon to be displayed."
|
|
3650
|
+
},
|
|
3651
|
+
"iconAssistiveText": {
|
|
3652
|
+
"type": "string | number",
|
|
3653
|
+
"description": "The alternative text for the icon specified by icon-name."
|
|
3654
|
+
},
|
|
3655
|
+
"iconName": {
|
|
3656
|
+
"type": "string | number",
|
|
3657
|
+
"description": "The Lightning Design System name of an icon to display at the beginning of the tab label. Specify the name in the format 'utility:down' where 'utility' is the category, and 'down' is the icon to be displayed. Only utility icons can be used."
|
|
3658
|
+
},
|
|
3659
|
+
"id": {
|
|
3660
|
+
"type": "string | number",
|
|
3661
|
+
"description": "The optional ID is used during tabset's onselect event to determine which tab was clicked."
|
|
3662
|
+
},
|
|
3663
|
+
"label": {
|
|
3664
|
+
"type": "any",
|
|
3665
|
+
"description": "The text displayed in the tab header."
|
|
3666
|
+
},
|
|
3667
|
+
"showErrorIndicator": {
|
|
3668
|
+
"type": "boolean",
|
|
3669
|
+
"description": "Specifies whether there's an error in the tab content. An error icon is displayed to the right of the tab label."
|
|
3670
|
+
},
|
|
3671
|
+
"tabIndex": {
|
|
3672
|
+
"type": "number | string",
|
|
3673
|
+
"description": "Specifies the tab order of an element (when the tab button is used for navigating)."
|
|
3674
|
+
},
|
|
3675
|
+
"title": {
|
|
3676
|
+
"type": "string | number",
|
|
3677
|
+
"description": "Specifies text that displays in a tooltip over the tab content."
|
|
3678
|
+
},
|
|
3679
|
+
"value": {
|
|
3680
|
+
"type": "any",
|
|
3681
|
+
"description": "The optional string to identify which tab was clicked during the tab's active event. This string is also used by active-tab-value in tabset to open a tab."
|
|
3682
|
+
}
|
|
3683
|
+
},
|
|
3684
|
+
"methods": {
|
|
3685
|
+
"loadContent": {
|
|
3686
|
+
"type": "(...args: any[]) => any",
|
|
3687
|
+
"description": "Reserved for internal use."
|
|
3688
|
+
}
|
|
3689
|
+
},
|
|
3690
|
+
"events": {
|
|
3691
|
+
"active": {
|
|
3692
|
+
"type": "CustomEvent<any>",
|
|
3693
|
+
"description": "The event fired when a tab becomes active. Bubbles, and crosses the component's shadow boundary (composed)."
|
|
3694
|
+
}
|
|
3695
|
+
}
|
|
3696
|
+
},
|
|
3697
|
+
"lightning-tabset": {
|
|
3698
|
+
"description": "Represents a list of tabs. [View in Component Library](https://developer.salesforce.com/docs/component-library/bundle/lightning-tabset)",
|
|
3699
|
+
"properties": {
|
|
3700
|
+
"activeTabValue": {
|
|
3701
|
+
"type": "any",
|
|
3702
|
+
"description": "Sets a specific tab to open by default using a string that matches a tab's value string. If not used, the first tab opens by default."
|
|
3703
|
+
},
|
|
3704
|
+
"headingLabel": {
|
|
3705
|
+
"type": "any"
|
|
3706
|
+
},
|
|
3707
|
+
"headingLevel": {
|
|
3708
|
+
"type": "any"
|
|
3709
|
+
},
|
|
3710
|
+
"headingVisible": {
|
|
3711
|
+
"type": "any"
|
|
3712
|
+
},
|
|
3713
|
+
"selectedTabId": {
|
|
3714
|
+
"type": "string | number",
|
|
3715
|
+
"description": "Allows you to set a specific tab to open by default. If this attribute is not used, the first tab opens by default."
|
|
3716
|
+
},
|
|
3717
|
+
"title": {
|
|
3718
|
+
"type": "string | number",
|
|
3719
|
+
"description": "Displays tooltip text when the mouse moves over the tabset."
|
|
3720
|
+
},
|
|
3721
|
+
"variant": {
|
|
3722
|
+
"type": "string | number",
|
|
3723
|
+
"description": "The variant changes the appearance of the tabset. Accepted variants are standard, scoped, and vertical."
|
|
3724
|
+
}
|
|
3725
|
+
},
|
|
3726
|
+
"methods": {},
|
|
3727
|
+
"events": {}
|
|
3728
|
+
},
|
|
3729
|
+
"lightning-textarea": {
|
|
3730
|
+
"description": "Represents a multiline text input field. [View in Component Library](https://developer.salesforce.com/docs/component-library/bundle/lightning-textarea)",
|
|
3731
|
+
"properties": {
|
|
3732
|
+
"accessKey": {
|
|
3733
|
+
"type": "string | number",
|
|
3734
|
+
"description": "Specifies a shortcut key to activate or focus an element."
|
|
3735
|
+
},
|
|
3736
|
+
"autocomplete": {
|
|
3737
|
+
"type": "any"
|
|
3738
|
+
},
|
|
3739
|
+
"disabled": {
|
|
3740
|
+
"type": "boolean",
|
|
3741
|
+
"description": "If present, the textarea field is disabled and users cannot interact with it."
|
|
3742
|
+
},
|
|
3743
|
+
"fieldLevelHelp": {
|
|
3744
|
+
"type": "any",
|
|
3745
|
+
"description": "The help text that appears in a popover. Set field-level help to provide an informational tooltip on the textarea input field."
|
|
3746
|
+
},
|
|
3747
|
+
"label": {
|
|
3748
|
+
"type": "string | number",
|
|
3749
|
+
"description": "Text that describes the textarea input field."
|
|
3750
|
+
},
|
|
3751
|
+
"maxLength": {
|
|
3752
|
+
"type": "number | string",
|
|
3753
|
+
"description": "The maximum number of characters allowed in the textarea."
|
|
3754
|
+
},
|
|
3755
|
+
"messageWhenBadInput": {
|
|
3756
|
+
"type": "string | number",
|
|
3757
|
+
"description": "Error message to be displayed when a bad input is detected."
|
|
3758
|
+
},
|
|
3759
|
+
"messageWhenTooLong": {
|
|
3760
|
+
"type": "string | number",
|
|
3761
|
+
"description": "Error message to be displayed when the value is too long."
|
|
3762
|
+
},
|
|
3763
|
+
"messageWhenTooShort": {
|
|
3764
|
+
"type": "string | number",
|
|
3765
|
+
"description": "Error message to be displayed when the value is too short."
|
|
3766
|
+
},
|
|
3767
|
+
"messageWhenValueMissing": {
|
|
3768
|
+
"type": "string | number",
|
|
3769
|
+
"description": "Error message to be displayed when the value is missing."
|
|
3770
|
+
},
|
|
3771
|
+
"minLength": {
|
|
3772
|
+
"type": "number | string",
|
|
3773
|
+
"description": "The minimum number of characters allowed in the textarea."
|
|
3774
|
+
},
|
|
3775
|
+
"name": {
|
|
3776
|
+
"type": "string | number",
|
|
3777
|
+
"description": "Specifies the name of an input element."
|
|
3778
|
+
},
|
|
3779
|
+
"placeholder": {
|
|
3780
|
+
"type": "string | number",
|
|
3781
|
+
"description": "Text that is displayed when the field is empty, to prompt the user for a valid entry."
|
|
3782
|
+
},
|
|
3783
|
+
"readOnly": {
|
|
3784
|
+
"type": "boolean",
|
|
3785
|
+
"description": "Specifies that an input field is read-only. This value defaults to false."
|
|
3786
|
+
},
|
|
3787
|
+
"required": {
|
|
3788
|
+
"type": "boolean",
|
|
3789
|
+
"description": "If present, the textarea field must be filled out before the form can be submitted."
|
|
3790
|
+
},
|
|
3791
|
+
"tabIndex": {
|
|
3792
|
+
"type": "number | string",
|
|
3793
|
+
"description": "Specifies the tab order of an element (when the tab button is used for navigating)."
|
|
3794
|
+
},
|
|
3795
|
+
"title": {
|
|
3796
|
+
"type": "string | number",
|
|
3797
|
+
"description": "Displays tooltip text when the mouse moves over the element."
|
|
3798
|
+
},
|
|
3799
|
+
"validity": {
|
|
3800
|
+
"type": "any",
|
|
3801
|
+
"description": "Represents the validity states of the textarea input, with respect to constraint validation."
|
|
3802
|
+
},
|
|
3803
|
+
"value": {
|
|
3804
|
+
"type": "any",
|
|
3805
|
+
"description": "The value of the textarea input, also used as the default value during init."
|
|
3806
|
+
},
|
|
3807
|
+
"variant": {
|
|
3808
|
+
"type": "string | number",
|
|
3809
|
+
"description": "The variant changes the appearance of the textarea. Accepted variants include standard, label-hidden, label-inline, and label-stacked. This value defaults to standard. Use label-hidden to hide the label but make it available to assistive technology. Use label-inline to horizontally align the label and textarea. Use label-stacked to place the label above the textarea."
|
|
3810
|
+
}
|
|
3811
|
+
},
|
|
3812
|
+
"methods": {
|
|
3813
|
+
"checkValidity": {
|
|
3814
|
+
"type": "() => boolean",
|
|
3815
|
+
"description": "Returns the valid attribute value (Boolean) on the ValidityState object."
|
|
3816
|
+
},
|
|
3817
|
+
"reportValidity": {
|
|
3818
|
+
"type": "() => boolean",
|
|
3819
|
+
"description": "Displays the error messages and returns false if the input is invalid. If the input is valid, reportValidity() clears displayed error messages and returns true."
|
|
3820
|
+
},
|
|
3821
|
+
"setCustomValidity": {
|
|
3822
|
+
"type": "(message: string) => void",
|
|
3823
|
+
"description": "Sets a custom error message to be displayed when the textarea value is submitted."
|
|
3824
|
+
},
|
|
3825
|
+
"setRangeText": {
|
|
3826
|
+
"type": "(replacement: string, start?: number, end?: number, selectMode?: string) => void",
|
|
3827
|
+
"description": "Replace a range of text in textarea with a new string."
|
|
3828
|
+
},
|
|
3829
|
+
"showHelpMessageIfInvalid": {
|
|
3830
|
+
"type": "() => void",
|
|
3831
|
+
"description": "Displays error messages on invalid fields. An invalid field fails at least one constraint validation and returns false when checkValidity() is called."
|
|
3832
|
+
}
|
|
3833
|
+
},
|
|
3834
|
+
"events": {
|
|
3835
|
+
"change": {
|
|
3836
|
+
"type": "CustomEvent<{ value: string }>",
|
|
3837
|
+
"description": "The value changed."
|
|
3838
|
+
}
|
|
3839
|
+
}
|
|
3840
|
+
},
|
|
3841
|
+
"lightning-tile": {
|
|
3842
|
+
"description": "A grouping of related information associated with a record. [View in Component Library](https://developer.salesforce.com/docs/component-library/bundle/lightning-tile)",
|
|
3843
|
+
"properties": {
|
|
3844
|
+
"actions": {
|
|
3845
|
+
"type": "any",
|
|
3846
|
+
"description": "A list of actions that's displayed in a dropdown menu."
|
|
3847
|
+
},
|
|
3848
|
+
"href": {
|
|
3849
|
+
"type": "string | number",
|
|
3850
|
+
"description": "The URL of the page that the link goes to."
|
|
3851
|
+
},
|
|
3852
|
+
"label": {
|
|
3853
|
+
"type": "string | number",
|
|
3854
|
+
"description": "The text label that displays in the tile as the heading and hover text."
|
|
3855
|
+
},
|
|
3856
|
+
"title": {
|
|
3857
|
+
"type": "string | number",
|
|
3858
|
+
"description": "Displays tooltip text when the mouse moves over the element."
|
|
3859
|
+
},
|
|
3860
|
+
"type": {
|
|
3861
|
+
"type": "any",
|
|
3862
|
+
"description": "The tile type. Valid values are 'standard' and 'media'. The default is 'standard'."
|
|
3863
|
+
}
|
|
3864
|
+
},
|
|
3865
|
+
"methods": {},
|
|
3866
|
+
"events": {
|
|
3867
|
+
"actiontriggered": {
|
|
3868
|
+
"type": "CustomEvent<{ action: any }>",
|
|
3869
|
+
"description": "The event fired when an action on the dropdown menu is triggered. Doesn't bubble."
|
|
3870
|
+
}
|
|
3871
|
+
}
|
|
3872
|
+
},
|
|
3873
|
+
"lightning-toast": {
|
|
3874
|
+
"properties": {
|
|
3875
|
+
"label": {
|
|
3876
|
+
"type": "any"
|
|
3877
|
+
},
|
|
3878
|
+
"labelLinks": {
|
|
3879
|
+
"type": "any"
|
|
3880
|
+
},
|
|
3881
|
+
"message": {
|
|
3882
|
+
"type": "any"
|
|
3883
|
+
},
|
|
3884
|
+
"messageLinks": {
|
|
3885
|
+
"type": "any"
|
|
3886
|
+
},
|
|
3887
|
+
"mode": {
|
|
3888
|
+
"type": "any"
|
|
3889
|
+
},
|
|
3890
|
+
"variant": {
|
|
3891
|
+
"type": "any"
|
|
3892
|
+
}
|
|
3893
|
+
},
|
|
3894
|
+
"methods": {
|
|
3895
|
+
"focus": {
|
|
3896
|
+
"type": "(...args: any[]) => any"
|
|
3897
|
+
}
|
|
3898
|
+
},
|
|
3899
|
+
"events": {}
|
|
3900
|
+
},
|
|
3901
|
+
"lightning-toast-container": {
|
|
3902
|
+
"properties": {
|
|
3903
|
+
"containerPosition": {
|
|
3904
|
+
"type": "any"
|
|
3905
|
+
},
|
|
3906
|
+
"maxToasts": {
|
|
3907
|
+
"type": "any"
|
|
3908
|
+
},
|
|
3909
|
+
"toastPosition": {
|
|
3910
|
+
"type": "any"
|
|
3911
|
+
}
|
|
3912
|
+
},
|
|
3913
|
+
"methods": {
|
|
3914
|
+
"close": {
|
|
3915
|
+
"type": "(...args: any[]) => any",
|
|
3916
|
+
"description": "Overrides the \"close\" function of the toast container."
|
|
3917
|
+
}
|
|
3918
|
+
},
|
|
3919
|
+
"events": {}
|
|
3920
|
+
},
|
|
3921
|
+
"lightning-tree": {
|
|
3922
|
+
"description": "Displays a nested tree. [View in Component Library](https://developer.salesforce.com/docs/component-library/bundle/lightning-tree)",
|
|
3923
|
+
"properties": {
|
|
3924
|
+
"header": {
|
|
3925
|
+
"type": "string | number",
|
|
3926
|
+
"description": "The text that's displayed as the tree heading."
|
|
3927
|
+
},
|
|
3928
|
+
"items": {
|
|
3929
|
+
"type": "any",
|
|
3930
|
+
"description": "An array of key-value pairs that describe the tree. See the Documentation tab for more information."
|
|
3931
|
+
},
|
|
3932
|
+
"selectedItem": {
|
|
3933
|
+
"type": "any",
|
|
3934
|
+
"description": "Selects and highlights the specified tree item. Tree item names are case-sensitive. If the tree item is nested, selecting this item also expands the parent branches."
|
|
3935
|
+
},
|
|
3936
|
+
"title": {
|
|
3937
|
+
"type": "string | number",
|
|
3938
|
+
"description": "Displays tooltip text when the mouse moves over the element."
|
|
3939
|
+
}
|
|
3940
|
+
},
|
|
3941
|
+
"methods": {},
|
|
3942
|
+
"events": {
|
|
3943
|
+
"select": {
|
|
3944
|
+
"type": "CustomEvent<{ name: string }>",
|
|
3945
|
+
"description": "The event fired when a tree item is selected and before navigating to a given hyperlink. Bubbles, and crosses the component's shadow boundary (composed)."
|
|
3946
|
+
}
|
|
3947
|
+
}
|
|
3948
|
+
},
|
|
3949
|
+
"lightning-tree-grid": {
|
|
3950
|
+
"description": "Displays a hierarchical view of data in a table. [View in Component Library](https://developer.salesforce.com/docs/component-library/bundle/lightning-tree-grid)",
|
|
3951
|
+
"properties": {
|
|
3952
|
+
"columns": {
|
|
3953
|
+
"type": "readonly unknown[]",
|
|
3954
|
+
"description": "Array of the columns object that's used to define the data types. Required properties include 'label', 'fieldName', and 'type'. The default type is 'text'. See the Documentation tab for more information."
|
|
3955
|
+
},
|
|
3956
|
+
"columnWidthsMode": {
|
|
3957
|
+
"type": "any"
|
|
3958
|
+
},
|
|
3959
|
+
"data": {
|
|
3960
|
+
"type": "any",
|
|
3961
|
+
"description": "The array of data to be displayed."
|
|
3962
|
+
},
|
|
3963
|
+
"disabledRows": {
|
|
3964
|
+
"type": "any"
|
|
3965
|
+
},
|
|
3966
|
+
"expandedRows": {
|
|
3967
|
+
"type": "readonly unknown[]",
|
|
3968
|
+
"description": "The array of unique row IDs for rows that are expanded."
|
|
3969
|
+
},
|
|
3970
|
+
"hideCheckboxColumn": {
|
|
3971
|
+
"type": "boolean",
|
|
3972
|
+
"description": "If present, the checkbox column for row selection is hidden."
|
|
3973
|
+
},
|
|
3974
|
+
"isLoading": {
|
|
3975
|
+
"type": "boolean",
|
|
3976
|
+
"description": "If present, a spinner is displayed to indicate that more data is being loaded."
|
|
3977
|
+
},
|
|
3978
|
+
"keyField": {
|
|
3979
|
+
"type": "string | number",
|
|
3980
|
+
"description": "Required for better performance. Associates each row with a unique ID."
|
|
3981
|
+
},
|
|
3982
|
+
"maxColumnWidth": {
|
|
3983
|
+
"type": "number | string",
|
|
3984
|
+
"description": "The maximum width for all columns. The default is 1000px."
|
|
3985
|
+
},
|
|
3986
|
+
"minColumnWidth": {
|
|
3987
|
+
"type": "number | string",
|
|
3988
|
+
"description": "The minimum width for all columns. The default is 50px."
|
|
3989
|
+
},
|
|
3990
|
+
"resizeColumnDisabled": {
|
|
3991
|
+
"type": "boolean",
|
|
3992
|
+
"description": "If present, column resizing is disabled."
|
|
3993
|
+
},
|
|
3994
|
+
"rowNumberOffset": {
|
|
3995
|
+
"type": "number | string",
|
|
3996
|
+
"description": "Determines where to start counting the row number. The default is 0."
|
|
3997
|
+
},
|
|
3998
|
+
"rowToggleIcon": {
|
|
3999
|
+
"type": "any"
|
|
4000
|
+
},
|
|
4001
|
+
"selectedRows": {
|
|
4002
|
+
"type": "readonly unknown[]",
|
|
4003
|
+
"description": "The array of unique row IDs that are selected."
|
|
4004
|
+
},
|
|
4005
|
+
"showRowNumberColumn": {
|
|
4006
|
+
"type": "boolean",
|
|
4007
|
+
"description": "If present, the row number column are shown in the first column."
|
|
4008
|
+
},
|
|
4009
|
+
"title": {
|
|
4010
|
+
"type": "string | number",
|
|
4011
|
+
"description": "Displays tooltip text when the mouse moves over the element."
|
|
4012
|
+
}
|
|
4013
|
+
},
|
|
4014
|
+
"methods": {
|
|
4015
|
+
"collapseAll": {
|
|
4016
|
+
"type": "(...args: any[]) => any",
|
|
4017
|
+
"description": "Collapse all rows"
|
|
4018
|
+
},
|
|
4019
|
+
"expandAll": {
|
|
4020
|
+
"type": "(...args: any[]) => any",
|
|
4021
|
+
"description": "Expand all rows with children content"
|
|
4022
|
+
},
|
|
4023
|
+
"getCurrentExpandedRows": {
|
|
4024
|
+
"type": "(...args: any[]) => any",
|
|
4025
|
+
"description": "Returns an array of rows that are expanded."
|
|
4026
|
+
},
|
|
4027
|
+
"getSelectedRows": {
|
|
4028
|
+
"type": "(...args: any[]) => any",
|
|
4029
|
+
"description": "Returns data in each selected row."
|
|
4030
|
+
}
|
|
4031
|
+
},
|
|
4032
|
+
"events": {
|
|
4033
|
+
"headeraction": {
|
|
4034
|
+
"type": "CustomEvent<any>",
|
|
4035
|
+
"description": "The event fired when a header-level action is run. Doesn't bubble."
|
|
4036
|
+
},
|
|
4037
|
+
"rowaction": {
|
|
4038
|
+
"type": "CustomEvent<any>",
|
|
4039
|
+
"description": "The event fired when a row-level action is run. Doesn't bubble."
|
|
4040
|
+
},
|
|
4041
|
+
"rowselection": {
|
|
4042
|
+
"type": "CustomEvent<any>",
|
|
4043
|
+
"description": "The event fired when a row is selected. Doesn't bubble."
|
|
4044
|
+
},
|
|
4045
|
+
"sort": {
|
|
4046
|
+
"type": "CustomEvent<{ fieldName: string; sortDirection: \"asc\" | \"desc\"; isMultiColumnSort?: boolean }>",
|
|
4047
|
+
"description": "The event fired when a column is sorted. Doesn't bubble."
|
|
4048
|
+
},
|
|
4049
|
+
"toggle": {
|
|
4050
|
+
"type": "CustomEvent<{ name: string; isExpanded: boolean; hasChildrenContent: boolean; row: any }>",
|
|
4051
|
+
"description": "The event fired when a row is expanded or collapsed. Doesn't bubble."
|
|
4052
|
+
},
|
|
4053
|
+
"toggleall": {
|
|
4054
|
+
"type": "CustomEvent<{ isExpanded: boolean }>",
|
|
4055
|
+
"description": "The event fired when all rows are expanded or collapsed. Doesn't bubble."
|
|
4056
|
+
}
|
|
4057
|
+
}
|
|
4058
|
+
},
|
|
4059
|
+
"lightning-vertical-navigation": {
|
|
4060
|
+
"description": "A vertical list of links that either take the user to another page or parts of the page the user is in. [View in Component Library](https://developer.salesforce.com/docs/component-library/bundle/lightning-vertical-navigation)",
|
|
4061
|
+
"properties": {
|
|
4062
|
+
"ariaLabel": {
|
|
4063
|
+
"type": "string | number",
|
|
4064
|
+
"description": "The aria label attribute for the navigation component"
|
|
4065
|
+
},
|
|
4066
|
+
"compact": {
|
|
4067
|
+
"type": "boolean",
|
|
4068
|
+
"description": "If present, spacing between navigation items is reduced."
|
|
4069
|
+
},
|
|
4070
|
+
"selectedItem": {
|
|
4071
|
+
"type": "string | number",
|
|
4072
|
+
"description": "Name of the navigation item to make active. An active item is highlighted in blue."
|
|
4073
|
+
},
|
|
4074
|
+
"shaded": {
|
|
4075
|
+
"type": "boolean",
|
|
4076
|
+
"description": "If present, the vertical navigation is displayed on top of a shaded background."
|
|
4077
|
+
},
|
|
4078
|
+
"title": {
|
|
4079
|
+
"type": "string | number",
|
|
4080
|
+
"description": "Displays tooltip text when the mouse moves over the element."
|
|
4081
|
+
}
|
|
4082
|
+
},
|
|
4083
|
+
"methods": {},
|
|
4084
|
+
"events": {
|
|
4085
|
+
"beforeselect": {
|
|
4086
|
+
"type": "CustomEvent<{ name: string }>",
|
|
4087
|
+
"description": "The event fired before a navigation item is selected. Doesn't bubble."
|
|
4088
|
+
},
|
|
4089
|
+
"select": {
|
|
4090
|
+
"type": "CustomEvent<{ name: string }>",
|
|
4091
|
+
"description": "The event fired when a navigation item is selected. Doesn't bubble."
|
|
4092
|
+
}
|
|
4093
|
+
}
|
|
4094
|
+
},
|
|
4095
|
+
"lightning-vertical-navigation-item": {
|
|
4096
|
+
"description": "A text-only link within lightning-vertical-navigation-section or lightning-vertical-navigation-overflow. [View in Component Library](https://developer.salesforce.com/docs/component-library/bundle/lightning-vertical-navigation-item)",
|
|
4097
|
+
"properties": {
|
|
4098
|
+
"href": {
|
|
4099
|
+
"type": "string | number",
|
|
4100
|
+
"description": "The URL of the page that the navigation item goes to."
|
|
4101
|
+
},
|
|
4102
|
+
"label": {
|
|
4103
|
+
"type": "string | number",
|
|
4104
|
+
"description": "The text displayed for the navigation item."
|
|
4105
|
+
},
|
|
4106
|
+
"name": {
|
|
4107
|
+
"type": "string | number",
|
|
4108
|
+
"description": "A unique identifier for the navigation item. The name is used by the `select` event on lightning-vertical-navigation to identify which item is selected."
|
|
4109
|
+
},
|
|
4110
|
+
"title": {
|
|
4111
|
+
"type": "string | number",
|
|
4112
|
+
"description": "Displays tooltip text when the mouse moves over the element."
|
|
4113
|
+
}
|
|
4114
|
+
},
|
|
4115
|
+
"methods": {},
|
|
4116
|
+
"events": {}
|
|
4117
|
+
},
|
|
4118
|
+
"lightning-vertical-navigation-item-badge": {
|
|
4119
|
+
"description": "A link and badge within lightning-vertical-navigation-section or lightning-vertical-navigation-overflow. [View in Component Library](https://developer.salesforce.com/docs/component-library/bundle/lightning-vertical-navigation-item-badge)",
|
|
4120
|
+
"properties": {
|
|
4121
|
+
"assistiveText": {
|
|
4122
|
+
"type": "string | number",
|
|
4123
|
+
"description": "Assistive text describing the number in the badge, which enhances accessibility and is not displayed to the user. The default is \"New Items\"."
|
|
4124
|
+
},
|
|
4125
|
+
"badgeCount": {
|
|
4126
|
+
"type": "number | string",
|
|
4127
|
+
"description": "The number to show inside the badge. If this value is zero, the badge is hidden. The default value is zero."
|
|
4128
|
+
},
|
|
4129
|
+
"href": {
|
|
4130
|
+
"type": "string | number",
|
|
4131
|
+
"description": "The URL of the page that the navigation item goes to."
|
|
4132
|
+
},
|
|
4133
|
+
"label": {
|
|
4134
|
+
"type": "string | number",
|
|
4135
|
+
"description": "The text displayed for this navigation item."
|
|
4136
|
+
},
|
|
4137
|
+
"name": {
|
|
4138
|
+
"type": "string | number",
|
|
4139
|
+
"description": "A unique identifier for this navigation item."
|
|
4140
|
+
},
|
|
4141
|
+
"title": {
|
|
4142
|
+
"type": "string | number",
|
|
4143
|
+
"description": "Displays tooltip text when the mouse moves over the element."
|
|
4144
|
+
}
|
|
4145
|
+
},
|
|
4146
|
+
"methods": {},
|
|
4147
|
+
"events": {}
|
|
4148
|
+
},
|
|
4149
|
+
"lightning-vertical-navigation-item-icon": {
|
|
4150
|
+
"description": "A link and icon within lightning-vertical-navigation-section or lightning-vertical-navigation-overflow. [View in Component Library](https://developer.salesforce.com/docs/component-library/bundle/lightning-vertical-navigation-item-icon)",
|
|
4151
|
+
"properties": {
|
|
4152
|
+
"href": {
|
|
4153
|
+
"type": "string | number",
|
|
4154
|
+
"description": "The URL of the page that the navigation item goes to."
|
|
4155
|
+
},
|
|
4156
|
+
"iconName": {
|
|
4157
|
+
"type": "string | number",
|
|
4158
|
+
"description": "The Lightning Design System name of the icon. Names are written in the format 'utility:down' where 'utility' is the category, and 'down' is the specific icon to be displayed."
|
|
4159
|
+
},
|
|
4160
|
+
"label": {
|
|
4161
|
+
"type": "string | number",
|
|
4162
|
+
"description": "The text displayed for this navigation item."
|
|
4163
|
+
},
|
|
4164
|
+
"name": {
|
|
4165
|
+
"type": "string | number",
|
|
4166
|
+
"description": "A unique identifier for this navigation item."
|
|
4167
|
+
},
|
|
4168
|
+
"title": {
|
|
4169
|
+
"type": "string | number",
|
|
4170
|
+
"description": "Displays tooltip text when the mouse moves over the element."
|
|
4171
|
+
}
|
|
4172
|
+
},
|
|
4173
|
+
"methods": {},
|
|
4174
|
+
"events": {}
|
|
4175
|
+
},
|
|
4176
|
+
"lightning-vertical-navigation-overflow": {
|
|
4177
|
+
"properties": {},
|
|
4178
|
+
"methods": {},
|
|
4179
|
+
"events": {}
|
|
4180
|
+
},
|
|
4181
|
+
"lightning-vertical-navigation-section": {
|
|
4182
|
+
"properties": {
|
|
4183
|
+
"label": {
|
|
4184
|
+
"type": "any"
|
|
4185
|
+
}
|
|
4186
|
+
},
|
|
4187
|
+
"methods": {},
|
|
4188
|
+
"events": {}
|
|
4189
|
+
}
|
|
4190
|
+
};
|