agent-docs 1.3.1 → 1.4.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/docs/AURACOMPONENTS.md +812 -0
- package/package.json +1 -1
|
@@ -0,0 +1,812 @@
|
|
|
1
|
+
# Aura Component Reference
|
|
2
|
+
|
|
3
|
+
> **Version**: 1.0.0
|
|
4
|
+
|
|
5
|
+
## Meta
|
|
6
|
+
|
|
7
|
+
- Prefer LWC; Aura for backward compat
|
|
8
|
+
- Use `lightning:` namespace (SLDS1, built-in a11y)
|
|
9
|
+
- A11y: `label`/`aria-label` (buttons), `alternative-text` (icons/images),
|
|
10
|
+
associated labels (inputs)
|
|
11
|
+
- ARIA: `role`, `aria-expanded`, `aria-pressed`, `aria-current`, `tabindex`
|
|
12
|
+
- Events: `aura:if` (conditional), `aura:iteration` (lists), component/app
|
|
13
|
+
events
|
|
14
|
+
- Styling: SLDS utility classes + CSS custom props; no internal overrides
|
|
15
|
+
- SLDS1 only; SLDS2 incompatible
|
|
16
|
+
|
|
17
|
+
## Notation
|
|
18
|
+
|
|
19
|
+
`→LWC:X`=Aura-only,use X in LWC | `See:X`=ref X | `SLDS:x`=implements blueprint
|
|
20
|
+
| `API X+`=requires≥X.0 | `⚠dep`=deprecated | `LX`=Lightning Experience |
|
|
21
|
+
`req`=required | `ro`=read-only
|
|
22
|
+
|
|
23
|
+
## Types
|
|
24
|
+
|
|
25
|
+
`str`=string `bool`=boolean `num`=number `obj`=object `arr`=array
|
|
26
|
+
`comp`=component
|
|
27
|
+
|
|
28
|
+
## aura:\*
|
|
29
|
+
|
|
30
|
+
**aura:component** - Root container `access`:str=public/global |
|
|
31
|
+
`controller`:str=ns.Class | `extends`:comp | `extensible`:bool(def:false) |
|
|
32
|
+
`implements`:str(comma-sep) | `isTemplate`:bool |
|
|
33
|
+
`template`:comp(def:aura:template)
|
|
34
|
+
|
|
35
|
+
**aura:expression** - Renders `{!expr}`. `value`:any(req). Providers: `v`(attr),
|
|
36
|
+
`c`(controller), `m`(model)
|
|
37
|
+
|
|
38
|
+
**aura:html** - HTML wrapper. `tag`:str(req) | `HTMLAttributes`:obj |
|
|
39
|
+
`body`:comp/arr
|
|
40
|
+
|
|
41
|
+
**aura:if** - Conditional (server-eval, lazy). `isTrue`:bool(req) |
|
|
42
|
+
`else`:comp/arr. Switching destroys/creates branches.
|
|
43
|
+
|
|
44
|
+
**aura:iteration** - Iterator. `items`:arr(req) | `var`:str(req) |
|
|
45
|
+
`indexVar`:str. Auto-rerenders.
|
|
46
|
+
|
|
47
|
+
**aura:renderIf** - ⚠dep→`aura:if`. Re-evals on change, renders both branches.
|
|
48
|
+
|
|
49
|
+
**aura:template** - Bootstrap template. Extend+`aura:set` for custom.
|
|
50
|
+
|
|
51
|
+
**aura:text** - Plain text. `value`:str(ro)
|
|
52
|
+
|
|
53
|
+
**aura:unescapedHtml** - ⚠XSS. Raw HTML. `value`:str(req). Sanitize first.
|
|
54
|
+
|
|
55
|
+
## force:\*
|
|
56
|
+
|
|
57
|
+
**force:canvasApp** →LWC:Canvas via iframe. `namespacePrefix`:str |
|
|
58
|
+
`developerName`:str | `applicationName`:str. One of
|
|
59
|
+
developerName/applicationName req.
|
|
60
|
+
|
|
61
|
+
**force:inputField** →LWC:`lightning-input-field`+`lightning-record-edit-form`.
|
|
62
|
+
`value`:obj. Events:`change`(blur). No SLDS.
|
|
63
|
+
|
|
64
|
+
**force:outputField**
|
|
65
|
+
→LWC:`lightning-output-field`+`lightning-record-view-form`. `value`:obj
|
|
66
|
+
|
|
67
|
+
**force:recordData** →LWC:`lightning/ui*Api` wire. CRUD. `recordId`:str |
|
|
68
|
+
`fields`:arr | `targetFields`:obj | `targetRecord`:obj | `targetError`:obj.
|
|
69
|
+
Events:`recordUpdated`→changeType(ERROR/LOADED/REMOVED/CHANGED),changedFields.
|
|
70
|
+
Prefer `lightning:recordForm`.
|
|
71
|
+
|
|
72
|
+
**force:recordEdit** →LWC:`lightning-record-edit-form`. `recordId`:str(req).
|
|
73
|
+
Events:`onSaveSuccess`. Fire `force:recordSave` to save. Partial SLDS. No
|
|
74
|
+
Lightning Out.
|
|
75
|
+
|
|
76
|
+
**force:recordView** →LWC:`lightning-record-view-form`. `recordId`:str(req)
|
|
77
|
+
|
|
78
|
+
## forceChatter:\* (all →LWC:LWC Chatter APIs, Beta)
|
|
79
|
+
|
|
80
|
+
**forceChatter:feed** - Chatter feed. Works with `:publisher`. LX+Experience
|
|
81
|
+
Builder(Customer Service,Account Portal,Partner Central,Build Your Own).
|
|
82
|
+
|
|
83
|
+
**forceChatter:fullFeed** - Custom feed. Lightning Out/external only. Issues in
|
|
84
|
+
LX(temp post duplication).
|
|
85
|
+
|
|
86
|
+
**forceChatter:publisher** - Create posts. `context`:RECORD/GLOBAL. Works with
|
|
87
|
+
`:feed`. No mobile in LX; available mobile in communities.
|
|
88
|
+
|
|
89
|
+
## forceCommunity:\* (all →LWC:LWC community APIs)
|
|
90
|
+
|
|
91
|
+
**forceCommunity:appLauncher** - Beta. App Launcher. Req "Show App Launcher in
|
|
92
|
+
Experiences" perm. No Mobile App/Tabs+VF sites.
|
|
93
|
+
|
|
94
|
+
**forceCommunity:navigationMenuBase** - Abstract nav base. `menuItems`:arr(auto)
|
|
95
|
+
| `navigationLinkSetId`:str. Methods:`navigate(menuItemId)`
|
|
96
|
+
|
|
97
|
+
**forceCommunity:notifications** - Beta. Notifications. Template header only.
|
|
98
|
+
|
|
99
|
+
**forceCommunity:routeLink** - SEO-friendly anchor. `routeInput`:obj={recordId}
|
|
100
|
+
|
|
101
|
+
**forceCommunity:waveDashboard** - CRM Analytics in Community.
|
|
102
|
+
|
|
103
|
+
## lightning:\*
|
|
104
|
+
|
|
105
|
+
**lightning:accordion** API41+ →LWC:`lightning-accordion` SLDS:accordion
|
|
106
|
+
`activeSectionName`:str/arr | `allowMultipleSectionsOpen`:bool(def:false)
|
|
107
|
+
Slot:`lightning:accordionSection`. Events:`onsectiontoggle`→openSections.
|
|
108
|
+
Keys:Tab→Enter→L/R arrows.
|
|
109
|
+
|
|
110
|
+
**lightning:accordionSection** API41+ →LWC:`lightning-accordion-section`
|
|
111
|
+
`label`:str | `name`:str(req) | `headingLevel`:num(1-6). Slots:default,`actions`
|
|
112
|
+
|
|
113
|
+
**lightning:alert** API54+ →LWC:`lightning/alert` `message`:str(req) |
|
|
114
|
+
`label`:str(def:"Alert") | `variant`:header/headerless |
|
|
115
|
+
`theme`:default/shade/inverse/alt-inverse/success/info/warning/error/offline
|
|
116
|
+
Call `.openAlert()`→Promise. Works cross-origin iframes.
|
|
117
|
+
|
|
118
|
+
**lightning:avatar** →LWC:`lightning-avatar` SLDS:avatars `src`:str |
|
|
119
|
+
`initials`:str | `alternativeText`:str
|
|
120
|
+
|
|
121
|
+
**lightning:badge** →LWC:`lightning-badge` SLDS:badges `label`:str(req) |
|
|
122
|
+
`iconName`:str | `iconPosition`:str(end=after). No nav/links; use
|
|
123
|
+
`lightning:pill`.
|
|
124
|
+
|
|
125
|
+
**lightning:breadcrumb** →LWC:`lightning-breadcrumb`. In
|
|
126
|
+
`lightning:breadcrumbs`. `label`:str(req) | `href`:str(def:#) | `name`:str.
|
|
127
|
+
Events:`onclick`(use preventDefault for custom nav)
|
|
128
|
+
|
|
129
|
+
**lightning:breadcrumbs** →LWC:`lightning-breadcrumbs` SLDS:breadcrumbs
|
|
130
|
+
`class`:str. Slot:`lightning:breadcrumb`. ARIA:role=navigation,
|
|
131
|
+
last=aria-current=page.
|
|
132
|
+
|
|
133
|
+
**lightning:button** →LWC:`lightning-button` SLDS:buttons `label`:str(req) |
|
|
134
|
+
`type`:button/submit/reset |
|
|
135
|
+
`variant`:base/neutral/brand/brand-outline/destructive/destructive-text/inverse/success
|
|
136
|
+
| `iconName`:str | `iconPosition`:str(end) | `stretch`:bool | `title`:str |
|
|
137
|
+
`disabled`:bool | `ariaLabel`:str | `ariaDescribedBy`:str
|
|
138
|
+
Events:`onclick`→event.getSource(). Icon-only:use `lightning:buttonIcon`.
|
|
139
|
+
Menu:use `lightning:buttonMenu`.
|
|
140
|
+
|
|
141
|
+
**lightning:buttonGroup** →LWC:`lightning-button-group` SLDS:button groups.
|
|
142
|
+
Slot:`lightning:button`/`lightning:buttonMenu`
|
|
143
|
+
|
|
144
|
+
**lightning:buttonIcon** →LWC:`lightning-button-icon` SLDS:button icons
|
|
145
|
+
`iconName`:str(req) | `alternativeText`:str(req) |
|
|
146
|
+
`variant`:bare/border-filled/border/container/brand/inverse/success/destructive
|
|
147
|
+
| `size`:xx-small/x-small/small/medium/large | `title`:str | `tooltip`:str |
|
|
148
|
+
`disabled`:bool | `iconClass`:str Events:`onclick`
|
|
149
|
+
|
|
150
|
+
**lightning:buttonIconStateful** API41+ →LWC:`lightning-button-icon-stateful`
|
|
151
|
+
`iconName`:str(req) | `alternativeText`:str(req) | `selected`:bool |
|
|
152
|
+
variant/size/disabled same as buttonIcon Events:`onclick`
|
|
153
|
+
|
|
154
|
+
**lightning:buttonMenu** →LWC:`lightning-button-menu` SLDS:menus `label`:str |
|
|
155
|
+
`alternativeText`:str |
|
|
156
|
+
`variant`:border/border-inverse/border-filled/container/bare/bare-inverse |
|
|
157
|
+
`iconName`:str | `iconSize`:str | `disabled`:bool | `isLoading`:bool |
|
|
158
|
+
`loadingStateAlternativeText`:str | `isDraft`:bool |
|
|
159
|
+
`draftAlternativeText`:str(req if isDraft) | `visible`:bool |
|
|
160
|
+
`menuAlignment`:str(auto for overflow) | `title`:str | `tooltip`:str
|
|
161
|
+
Slot:`lightning:menuItem`/`lightning:menuDivider`/`lightning:menuSubheader`.
|
|
162
|
+
Events:`onselect`→value. Items created on trigger.
|
|
163
|
+
|
|
164
|
+
**lightning:buttonStateful** →LWC:`lightning-button-stateful` `label`:str |
|
|
165
|
+
`labelWhenSelected`:str | `labelWhenHover`:str | `iconName`:str |
|
|
166
|
+
`iconNameWhenSelected`:str | `buttonstate`:bool | variant/disabled
|
|
167
|
+
Events:`onclick`(toggle buttonstate in handler)
|
|
168
|
+
|
|
169
|
+
**lightning:card** →LWC:`lightning-card` SLDS:cards `title`:str |
|
|
170
|
+
`iconName`:str. Slots:default,`title`,`actions`,`footer`
|
|
171
|
+
|
|
172
|
+
**lightning:checkboxGroup** API41+ →LWC:`lightning-checkbox-group` SLDS:checkbox
|
|
173
|
+
`label`:str(req) | `name`:str(req) | `options`:arr(req)[{label,value}] |
|
|
174
|
+
`value`:arr | `required`:bool | `messageWhenValueMissing`:str | `disabled`:bool
|
|
175
|
+
| `validity`:obj(ro) Events:`onchange`→value[].
|
|
176
|
+
Methods:`checkValidity()`,`reportValidity()`,`setCustomValidity()`
|
|
177
|
+
|
|
178
|
+
**lightning:clickToDial** API41+ →LWC:`lightning-click-to-dial` `value`:str(req)
|
|
179
|
+
| `recordId`:str | `params`:obj. Works with
|
|
180
|
+
enableClickToDial/disableClickToDial/onClickToDial. No iframe.
|
|
181
|
+
|
|
182
|
+
**lightningcommunity:backButton** Beta →LWC:navigation APIs. Back nav
|
|
183
|
+
myCommunity iOS. Visible non-homepage with nav history.
|
|
184
|
+
|
|
185
|
+
**lightning:confirm** API54+ →LWC:`lightning/confirm` `message`:str(req) |
|
|
186
|
+
`label`:str(def:"Confirm") | `variant`:header/headerless | `theme`:(same as
|
|
187
|
+
alert) Call `.openConfirm()`→Promise
|
|
188
|
+
|
|
189
|
+
**lightning:container** No LWC. Hosts third-party JS in iframe. `src`:str(req) |
|
|
190
|
+
`alternativeText`:str. Events:`onmessage`. Use `message()` for comms. SPA only.
|
|
191
|
+
No hostname in src.
|
|
192
|
+
|
|
193
|
+
**lightning:datatable** API41+ →LWC:`lightning-datatable` SLDS:data tables.
|
|
194
|
+
Desktop only.
|
|
195
|
+
`columns`:arr(req)[{label,fieldName,type,sortable,editable,wrapText,fixedWidth,initialWidth,cellAttributes,typeAttributes,actions}]
|
|
196
|
+
| `data`:arr(req) | `keyField`:str(req) | `selectedRows`:arr |
|
|
197
|
+
`disabledRows`:arr | `maxRowSelection`:num(1=radio) |
|
|
198
|
+
`singleRowSelectionMode`:str(checkbox) | `hideCheckboxColumn`:bool |
|
|
199
|
+
`showRowNumberColumn`:bool | `rowNumberOffset`:num(def:0) |
|
|
200
|
+
`enableInfiniteLoading`:bool | `loadMoreOffset`:num(def:20) | `isLoading`:bool |
|
|
201
|
+
`totalNumberOfRows`:num | `resizeColumnDisabled`:bool |
|
|
202
|
+
`minColumnWidth`:num(def:50) | `maxColumnWidth`:num(def:1000) |
|
|
203
|
+
`columnWidthsMode`:fixed/auto | `hideTableHeader`:bool | `hideTableBorder`:bool
|
|
204
|
+
| `errors`:arr | `ariaLabel`:str
|
|
205
|
+
Events:`onrowselection`,`onloadmore`,`onsort`→fieldName/sortDirection,`oncellchange`→draftValues,`oncancel`,`onsave`,`onrowaction`,`onheaderaction`,`resize`
|
|
206
|
+
Methods:`getSelectedRows()`,`scrollToTop()`,`openInlineEdit()`,`focus()`
|
|
207
|
+
Types:text(def),action,boolean,button,button-icon,currency,date,date-local,email,location,number,percent,phone,url
|
|
208
|
+
|
|
209
|
+
**lightning:dualListbox** API41+ →LWC:`lightning-dual-listbox` SLDS:Dueling
|
|
210
|
+
Picklist `label`:str(req) | `sourceLabel`:str(def:Source) |
|
|
211
|
+
`selectedLabel`:str(def:Selected) | `options`:arr(req)[{label,value,disabled?}]
|
|
212
|
+
| `value`:arr | `min`:num | `max`:num | `required`:bool |
|
|
213
|
+
`messageWhenRange*/ValueMissing`:str | `disabled`:bool | `validity`:obj(ro)
|
|
214
|
+
Events:`onchange`→value[]. Limit≤50 options/list.
|
|
215
|
+
Methods:`checkValidity()`,`reportValidity()`,`setCustomValidity()`
|
|
216
|
+
|
|
217
|
+
**lightning:dynamicIcon** API41+ →LWC:`lightning-dynamic-icon` SLDS:dynamic
|
|
218
|
+
icons `type`:str(req)=ellie/eq/score/strength/trend/waffle |
|
|
219
|
+
`alternativeText`:str
|
|
220
|
+
|
|
221
|
+
**lightning:fileUpload** →LWC:`lightning-file-upload` SLDS:file selector
|
|
222
|
+
`recordId`:str | `accept`:str | `multiple`:bool |
|
|
223
|
+
`fileFieldName`:str(\***c+fileupload**c) | `fileFieldValue`:str
|
|
224
|
+
Events:`onuploadfinished`→files[{name,documentId}]. Max 10 files(admin:1-25),
|
|
225
|
+
2GB each. Guest:enable in Setup+sharing rules. No Lightning Out.
|
|
226
|
+
|
|
227
|
+
**lightning:flexipageRegionInfo** →LWC:Flexipage context APIs.
|
|
228
|
+
`regionWidth`:num(ro). Methods:`get()`→{width}. Events:`onload`
|
|
229
|
+
|
|
230
|
+
**lightning:flow** API41+ →LWC:`lightning-flow` `name`:str(req)=active flow API
|
|
231
|
+
name | `inputVariables`:arr[{name,value}]
|
|
232
|
+
Events:`onstatuschange`→status(STARTED/PAUSED/FINISHED/FINISHED_SCREEN/ERROR),flowTitle,outputVariables,activeStages,currentStage,helpText,guid
|
|
233
|
+
|
|
234
|
+
**lightning:formattedAddress** API42+ →LWC:`lightning-formatted-address`
|
|
235
|
+
`street`/`city`/`province`/`postalCode`/`country`:str |
|
|
236
|
+
`latitude`/`longitude`:num(faster) | `showStaticMap`:bool |
|
|
237
|
+
`disabled`:bool(plain text)
|
|
238
|
+
|
|
239
|
+
**lightning:formattedDateTime** →LWC:`lightning-formatted-date-time`. Uses
|
|
240
|
+
Intl.DateTimeFormat. `value`:str/Date/ts(req)=ISO8601/timestamp |
|
|
241
|
+
`timeZone`:str=IANA(def:user SF tz) | `timeZoneName`:short/long Date-only:use
|
|
242
|
+
timeZone="UTC". ISO:YYYY-MM-DDThh:mm:ssTZD
|
|
243
|
+
|
|
244
|
+
**lightning:formattedLocation** API41+ →LWC:`lightning-formatted-location`
|
|
245
|
+
`latitude`:num(req,-90-90) | `longitude`:num(req,-180-180)
|
|
246
|
+
|
|
247
|
+
**lightning:formattedName** API42+ →LWC:`lightning-formatted-name`
|
|
248
|
+
`salutation`/`firstName`/`middleName`/`lastName`/`suffix`/`informalName`:str |
|
|
249
|
+
`format`:short/medium/long | `locale`:str
|
|
250
|
+
|
|
251
|
+
**lightning:formattedNumber** →LWC:`lightning-formatted-number`. Uses
|
|
252
|
+
Intl.NumberFormat. `value`:num/str(req,str for precision) |
|
|
253
|
+
`style`:decimal/currency/percent/percent-fixed | `currency`:str(ISO4217) |
|
|
254
|
+
`currencyDisplayAs`:symbol/code/name | `minimum/maximumSignificantDigits`:num |
|
|
255
|
+
`minimum/maximumFractionDigits`:num
|
|
256
|
+
|
|
257
|
+
**lightning:formattedPhone** API41+ →LWC:`lightning-formatted-phone`
|
|
258
|
+
`value`:str(req) | `disabled`:bool(plain text). en-US/en-CA 10-11 digit starting
|
|
259
|
+
1→(999)999-9999
|
|
260
|
+
|
|
261
|
+
**lightning:formattedRichText** API41+ →LWC:`lightning-formatted-rich-text`.
|
|
262
|
+
Sanitized HTML. `value`:str(req) | `disableLinkify`:bool
|
|
263
|
+
Tags:a,abbr,acronym,address,br,big,blockquote,caption,cite,code,col,colgroup,del,div,dl,dd,dt,em,font,h1-h6,hr,img,ins,kbd,li,ol,mark,p,param,pre,q,s,samp,small,span,strong,sub,sup,table,tbody,td,tfoot,th,thead,tr,tt,u,ul,var,strike.
|
|
264
|
+
b→strong,i→em
|
|
265
|
+
|
|
266
|
+
**lightning:formattedText** API41+ →LWC:`lightning-formatted-text`
|
|
267
|
+
`value`:str(req,\n→<br/>) | `linkify`:bool(auto-link URLs/emails)
|
|
268
|
+
|
|
269
|
+
**lightning:formattedTime** API42+ →LWC:`lightning-formatted-time`. UTC.
|
|
270
|
+
`value`:str(req)=ISO8601 time(HH:mm:ss.SSS)
|
|
271
|
+
|
|
272
|
+
**lightning:helptext** →LWC:`lightning-helptext` SLDS:tooltips
|
|
273
|
+
`content`:str(req,no HTML) | `iconName`:str(def:utility:info) |
|
|
274
|
+
`alternativeText`:str(def:Help) | `iconVariant`:bare/error/inverse/warning
|
|
275
|
+
|
|
276
|
+
**lightning:icon** →LWC:`lightning-icon` `iconName`:str | `src`:str(custom
|
|
277
|
+
SVG:{!$Resource.x}#id) | `variant`:str |
|
|
278
|
+
`size`:xx-small/x-small/small/medium/large | `alternativeText`:str Custom SVG
|
|
279
|
+
needs `<g id="x">`. Fill via SVG fill attr.
|
|
280
|
+
|
|
281
|
+
**lightning:input** →LWC:`lightning-input` SLDS:input
|
|
282
|
+
`type`:checkbox/checkbox-button/date/datetime/time/email/file/password/search/tel/url/number/text
|
|
283
|
+
| `label`:str(req,variant=label-hidden to hide) | `value`:str/num/bool/Date |
|
|
284
|
+
`name`:str | `placeholder`:str | `required`:bool | `disabled`:bool |
|
|
285
|
+
`readonly`:bool | `variant`:standard/label-stacked/label-inline/label-hidden |
|
|
286
|
+
`min`/`max`:num/str | `step`:num/str(def:1) | `maxlength`/`minlength`:num |
|
|
287
|
+
`pattern`:str(regex) | `formatter`:percent/percent-fixed/currency(number only) |
|
|
288
|
+
`dateStyle`:short/medium/long | `timeStyle`:short/medium/long |
|
|
289
|
+
`timezone`:str(IANA) | `checked`:bool | `multiple`:bool(multi-email) |
|
|
290
|
+
`autocomplete`:str | `fieldLevelHelp`:str | `messageWhen*`:str |
|
|
291
|
+
`validity`:obj(ro) | `isLoading`:bool(search spinner) |
|
|
292
|
+
`messageToggleActive/Inactive`:str
|
|
293
|
+
Events:`onchange`(typing+finish),`oncommit`(finish
|
|
294
|
+
only),`onblur`,`onfocus`,`onkeydown`
|
|
295
|
+
Methods:`checkValidity()`,`reportValidity()`,`setCustomValidity()`. File:max
|
|
296
|
+
3.5MB, event.getSource().get("v.files")
|
|
297
|
+
|
|
298
|
+
**lightning:inputAddress** →LWC:`lightning-input-address`
|
|
299
|
+
`street`/`city`/`province`/`country`/`postalCode`/`subpremise`:str |
|
|
300
|
+
`countryOptions`/`provinceOptions`:arr[{label,value}] | `locale`:str |
|
|
301
|
+
`hideProvince`:bool | `showAddressLookup`:bool(Google Places,LX only) |
|
|
302
|
+
`countryLookupFilter`:arr(ISO,max 5) | `showCompactAddress`:bool |
|
|
303
|
+
`*Label`/`*Placeholder`:str | `required`:bool | `variant`:label-hidden
|
|
304
|
+
Events:`onchange`.
|
|
305
|
+
Methods:`checkValidity()`,`reportValidity()`,`setCustomValidityForField(field,msg)`
|
|
306
|
+
|
|
307
|
+
**lightning:inputField** →LWC:`lightning-input-field`. Direct child of
|
|
308
|
+
`lightning:recordEditForm` only. `fieldName`:str(req) | `value`:obj |
|
|
309
|
+
`required`:bool(client-side) | `variant`:str | `readonly`:bool(not:rich
|
|
310
|
+
text,picklists,lookup) Events:`onchange`→value. Methods:`reset()`
|
|
311
|
+
Supports:Address,Checkbox,Currency,Date,DateTime,Email,Geolocation,Lookup(not
|
|
312
|
+
OwnerId/CreatedBy/LastModifiedBy),Name,Number,Percent,Phone,Picklist(dependent
|
|
313
|
+
ok),Text,Text Encrypted,TextArea,TextArea Long,TextArea Rich,Time,URL
|
|
314
|
+
|
|
315
|
+
**lightning:inputLocation** →LWC:`lightning-input-location`
|
|
316
|
+
`latitude`:num(-90-90) | `longitude`:num(-180-180) | `*Label`/`*Placeholder`:str
|
|
317
|
+
| `required`:bool | `validity`:obj(ro) | `messageWhenValueMissing`:str |
|
|
318
|
+
`variant`:label-hidden Events:`onchange`→{latitude,longitude}.
|
|
319
|
+
Methods:`checkValidity()`,`reportValidity()`,`setCustomValidityForField(field,msg)`
|
|
320
|
+
|
|
321
|
+
**lightning:inputName** API42+ →LWC:`lightning-input-name`
|
|
322
|
+
`fieldsToDisplay`:str/arr=firstName/lastName/middleName/informalName/suffix/salutation
|
|
323
|
+
| field values:str | `options`:arr(salutation) | `required`:bool |
|
|
324
|
+
`validity`:obj(ro) | `messageWhenValueMissing`:str | `variant`:label-hidden
|
|
325
|
+
Events:`onchange`→{fieldNames:values}.
|
|
326
|
+
Methods:`checkValidity()`,`reportValidity()`,`setCustomValidityForField(field,msg)`
|
|
327
|
+
|
|
328
|
+
**lightning:inputRichText** →LWC:`lightning-input-rich-text` SLDS:rich text
|
|
329
|
+
editor. Quill WYSIWYG. `value`:str | `label`:str | `labelVisible`:bool |
|
|
330
|
+
`placeholder`:str | `required`:bool(needs labelVisible) | `valid`:bool |
|
|
331
|
+
`disabled`:bool | `formats`:arr(replaces default) |
|
|
332
|
+
`disabledCategories`:arr=FORMAT_FONT/FORMAT_TEXT/FORMAT_BODY/ALIGN_TEXT/INSERT_CONTENT/REMOVE_FORMATTING
|
|
333
|
+
| `shareWithEntityId`:str(image scope) Slot:`lightning:insertImageButton`.
|
|
334
|
+
Events:`onchange`→value. Methods:`getFormat()`,`setFormat({...})` Default
|
|
335
|
+
formats:font,size,bold,italic,underline,strike,list,indent,align,link,clean,table,header.
|
|
336
|
+
Additional:image,color,background,code,code-block,script,blockquote,direction.
|
|
337
|
+
Images:png/jpg/gif,max 1MB.
|
|
338
|
+
|
|
339
|
+
**lightning:insertImageButton** No LWC(built-in). Image button for
|
|
340
|
+
`lightning:inputRichText`. Child slot only. png/jpg/gif,max 1MB.
|
|
341
|
+
|
|
342
|
+
**lightning:layout** →LWC:`lightning-layout` SLDS:grid
|
|
343
|
+
`horizontalAlign`:center/space/spread/end |
|
|
344
|
+
`verticalAlign`:start/center/end/stretch | `pullToBoundary`:small/medium/large |
|
|
345
|
+
`multipleRows`:bool Slot:`lightning:layoutItem`
|
|
346
|
+
|
|
347
|
+
**lightning:layoutItem** →LWC:`lightning-layout-item` `size`:num(1-12) |
|
|
348
|
+
`smallDeviceSize`:num | `mediumDeviceSize`:num | `largeDeviceSize`:num |
|
|
349
|
+
`flexibility`:auto/grow/shrink/no-grow/no-shrink/no-flex |
|
|
350
|
+
`padding`:around-_/horizontal-_/vertical-\* small/medium/large
|
|
351
|
+
|
|
352
|
+
**lightning:listView** →LWC:`lightning/uiListsApi` `objectApiName`:str(req) |
|
|
353
|
+
`listName`:str(req) | `rowsToLoad`:num Supports inline/mass editing,column
|
|
354
|
+
resize/sort,search,Load More. Get
|
|
355
|
+
listName:`SELECT DeveloperName FROM ListView WHERE SObjectType='Account'`
|
|
356
|
+
|
|
357
|
+
**lightning:map** API44+ →LWC:`lightning-map` SLDS:map. Google Maps.
|
|
358
|
+
`mapMarkers`:arr(req)[{location,title,description,icon,value,type,mapIcon,...}]
|
|
359
|
+
| `center`:obj | `zoomLevel`:num(1-22 desktop,1-20 mobile) |
|
|
360
|
+
`selectedMarkerValue`:str | `listView`:hidden/visible | `markersTitle`:str |
|
|
361
|
+
`showFooter`:bool |
|
|
362
|
+
`options`:obj{draggable,zoomControl,scrollwheel,disableDefaultUI,disableDoubleClickZoom}
|
|
363
|
+
Events:`onmarkerselect`→selectedMarkerValue. Max 10 geocoded;use lat/long for
|
|
364
|
+
more. Recommend≤100. Shapes:Circle(radius),Rectangle(bounds),Polygon(paths).
|
|
365
|
+
Custom icons via mapIcon SVG.
|
|
366
|
+
|
|
367
|
+
**lightning:menuDivider** →LWC:`lightning-menu-divider`. In
|
|
368
|
+
`lightning:buttonMenu`. `variant`:compact
|
|
369
|
+
|
|
370
|
+
**lightning:menuItem** →LWC:`lightning-menu-item` SLDS:menus. In
|
|
371
|
+
`lightning:buttonMenu`. `label`:str(req) | `value`:str | `checked`:bool |
|
|
372
|
+
`iconName`:str(after) | `prefixIconName`:str(before) | `href`:str |
|
|
373
|
+
`target`:\_blank/\_self | `isDraft`:bool | `draftAlternativeText`:str(req if
|
|
374
|
+
isDraft) | `disabled`:bool
|
|
375
|
+
|
|
376
|
+
**lightning:menuSubheader** →LWC:`lightning-menu-subheader`. In
|
|
377
|
+
`lightning:buttonMenu`. `label`:str(req)
|
|
378
|
+
|
|
379
|
+
**lightning:messageChannel** →LWC:`lightning/messageService`. Pub/sub.
|
|
380
|
+
`type`:str(req,custom:\_\_c suffix). Methods:`publish(payload)`(req
|
|
381
|
+
aura:id),`subscribe(onMessage,scope)`→subscription.
|
|
382
|
+
Events:`onMessage`→event.getParam("message") Immediate child of aura:component.
|
|
383
|
+
Cross-DOM:Aura↔VF↔LWC. Wrap $A.enqueueAction in $A.getCallback if callback
|
|
384
|
+
triggers re-render.
|
|
385
|
+
|
|
386
|
+
**lightning:navigation** API43+ →LWC:`lightning/navigation`
|
|
387
|
+
`pageReference`:obj(req){type,attributes,state}.
|
|
388
|
+
Methods:`generateUrl()`→Promise(URL),`navigate()`(direct from onclick)
|
|
389
|
+
PageReference:type=PageDefinition API name,attributes per
|
|
390
|
+
PageDefinition,state=query params.
|
|
391
|
+
Ex:`/lightning/o/Account/list?filterName=MyAccounts`→{type:"standard\_\_objectPage",attributes:{objectApiName:"Account",actionName:"list"},state:{filterName:"MyAccounts"}}
|
|
392
|
+
|
|
393
|
+
**lightning:outputField** API41+ →LWC:`lightning-output-field`. In
|
|
394
|
+
`lightning:recordViewForm`. `fieldName`:str(req) | `variant`:compact |
|
|
395
|
+
`class`:str Auto FLS/locale/translations. No Apex. No spanning relationships.
|
|
396
|
+
Types:Address,Auto
|
|
397
|
+
Number,Checkbox,Currency,Date,DateTime,Email(mailto:),Encrypted,Formula,Geolocation,Lookup(not
|
|
398
|
+
OwnerId/CreatedBy/LastModifiedBy),Name,Number,Percent,Phone(tel:),Picklist/Multi-select,Text/TextArea/Long/Rich,Time,URL.
|
|
399
|
+
Invalid field=no output.
|
|
400
|
+
|
|
401
|
+
**lightning:path** →LWC:`lightning-path`. Path from picklist+Path Settings.
|
|
402
|
+
`recordId`:str | `variant`:str. Slot:key fields/guidance. Includes Mark
|
|
403
|
+
Complete. Configure:Setup>Path Settings. Implement
|
|
404
|
+
`flexipage:availableForAllPageTypes`.
|
|
405
|
+
|
|
406
|
+
**lightning:picklistPath** →LWC:`lightning-picklist-path` `recordId`:str |
|
|
407
|
+
`picklistFieldApiName`:str(req) | `variant`:str. No key fields/guidance/Mark
|
|
408
|
+
Complete. Mobile:truncated labels.
|
|
409
|
+
|
|
410
|
+
**lightning:pill** →LWC:`lightning-pill` SLDS:pills `label`:str(req) |
|
|
411
|
+
`href`:str(same tab) | `hasError`:bool(red+error icon) | `class`:str
|
|
412
|
+
Slot:`media`. Events:`onclick`,`onremove`(must hide/remove in handler).
|
|
413
|
+
preventDefault stops nav. Multiple:use `lightning:pillContainer`.
|
|
414
|
+
|
|
415
|
+
**lightning:pillContainer** API42+ →LWC:`lightning-pill-container` SLDS:pills
|
|
416
|
+
with container
|
|
417
|
+
`items`:arr(req)[{label,name?,href?,type?,src?,fallbackIconName?,variant?,alternativeText?,iconName?}]
|
|
418
|
+
| `variant`:bare/standard(better a11y) | `isCollapsible`:bool |
|
|
419
|
+
`isExpanded`:bool | `singleLine`:bool
|
|
420
|
+
Events:`onitemremove`→event.getParam("item").name,`onfocus`.
|
|
421
|
+
Types:text-only,link(href),avatar(type:"avatar",src
|
|
422
|
+
req),icon(type:"icon",iconName req utility only)
|
|
423
|
+
|
|
424
|
+
**lightning:progressBar** API41+ →LWC:`lightning-progress-bar` SLDS:progress
|
|
425
|
+
bars `value`:num(req,0-100) | `size`:x-small/small/medium/large
|
|
426
|
+
|
|
427
|
+
**lightning:progressIndicator** API41+ Beta →LWC:`lightning-progress-indicator`
|
|
428
|
+
SLDS:progress indicators `currentStep`:str | `type`:base/path |
|
|
429
|
+
`hasError`:bool(base only). Slot:`lightning:progressStep`.
|
|
430
|
+
ARIA:base→aria-valuenow/min/max,path→aria-selected.
|
|
431
|
+
Keys:Tab/Shift+Tab(base),arrows(path).
|
|
432
|
+
|
|
433
|
+
**lightning:progressRing** API48+ →LWC:`lightning-progress-ring` SLDS:progress
|
|
434
|
+
ring `value`:num(req,0-100) |
|
|
435
|
+
`variant`:base(green)/active-step(blue)/warning(yellow+icon)/expired(red+icon)/base-autocomplete(green+icon@100)
|
|
436
|
+
|
|
437
|
+
**lightning:progressStep** API41+ Beta →LWC:via `lightning-progress-indicator`
|
|
438
|
+
`label`:str(req) | `value`:str(req). Events:`onstepblur`,`onstepfocus`(base
|
|
439
|
+
only,returns index). No click event;add clickable element to update parent
|
|
440
|
+
currentStep.
|
|
441
|
+
|
|
442
|
+
**lightning:prompt** API54+ →LWC:`lightning-prompt` `message`:str(req) |
|
|
443
|
+
`defaultValue`:str | `label`:str(def:"Prompt") | `variant`:header/headerless |
|
|
444
|
+
`theme`:(same as alert) Call `.openPrompt()`→Promise→string(OK)/null(Cancel).
|
|
445
|
+
Works cross-origin iframes.
|
|
446
|
+
|
|
447
|
+
**lightning:quipCard** →LWC:Quip APIs. `parentRecordId`:str(req,15-char).
|
|
448
|
+
Actions:search,create doc/spreadsheet. Requires Quip enabled.
|
|
449
|
+
|
|
450
|
+
**lightning:radioGroup** API41+ →LWC:`lightning-radio-group` SLDS:radio button
|
|
451
|
+
`options`:arr(req)[{label,value}] | `value`:str | `name`:str(auto if omitted) |
|
|
452
|
+
`label`:str(req,legend) | `required`:bool | `disabled`:bool(always valid) |
|
|
453
|
+
`messageWhenValueMissing`:str | `type`:str(button=button group style) |
|
|
454
|
+
`validity`:obj(ro) Events:`onchange`→event.getParam("value").
|
|
455
|
+
Methods:`checkValidity()`,`reportValidity()`,`setCustomValidity()`. Reuse:omit
|
|
456
|
+
name or wrap in form.
|
|
457
|
+
|
|
458
|
+
**lightning:recordEditForm** API41+ →LWC:`lightning-record-edit-form`
|
|
459
|
+
`recordId`:str(req for edit,omit for create) | `objectApiName`:str(req) |
|
|
460
|
+
`recordTypeId`:str(req if multiple w/o default) | `density`:auto/comfy/compact
|
|
461
|
+
Slot:`lightning:inputField`(edit),`lightning:outputField`(read).
|
|
462
|
+
Events:`onload`→recordUi,`onsubmit`→fields(preventDefault for
|
|
463
|
+
custom),`onsuccess`→response,`onerror`→error Include
|
|
464
|
+
`lightning:button type="submit"` and `lightning:messages`. Auto FLS/sharing. UI
|
|
465
|
+
API objects only. No spanning relationships. Person
|
|
466
|
+
accounts:objectApiName="Account",contact fields use Person<FieldName>,custom
|
|
467
|
+
contact **pc,custom account **c. No multiple currencies. No nesting in other
|
|
468
|
+
record forms. Custom actions:implement force:lightningQuickAction,fire
|
|
469
|
+
force:refreshView after.
|
|
470
|
+
|
|
471
|
+
**lightning:recordForm** →LWC:`lightning-record-form` `recordId`:str(omit for
|
|
472
|
+
create) | `objectApiName`:str(req) | `mode`:edit/view/readonly |
|
|
473
|
+
`fields`:arr(alt to layoutType) | `layoutType`:Full/Compact(no Compact for
|
|
474
|
+
create) | `recordTypeId`:str | `density`:auto/comfy/compact
|
|
475
|
+
Events:`onload`,`onsubmit`,`onsuccess`(includes ID for
|
|
476
|
+
new),`onerror`,`oncancel`. Auto Cancel/Save in edit. Auto inline edit in view.
|
|
477
|
+
No prepopulating(use recordEditForm). Same limitations.
|
|
478
|
+
|
|
479
|
+
**lightning:recordViewForm** →LWC:`lightning-record-view-form`
|
|
480
|
+
`recordId`:str(req) | `objectApiName`:str(req) | `density`:auto/comfy/compact.
|
|
481
|
+
Slot:`lightning:outputField`. No Apex. Auto FLS/sharing. Use SLDS Grid for
|
|
482
|
+
columns.
|
|
483
|
+
|
|
484
|
+
**lightning:relativeDateTime** →LWC:`lightning-relative-date-time`
|
|
485
|
+
`value`:str/Date/ts(req). Output:"a few seconds ago","in 5 minutes","2 months
|
|
486
|
+
ago",etc. Unicode CLDR. Units:seconds→years. Language from org setting.
|
|
487
|
+
|
|
488
|
+
**lightning:select** →LWC:`lightning-combobox` `label`:str(req) | `value`:str |
|
|
489
|
+
`name`:str | `required`:bool | `disabled`:bool(always valid) |
|
|
490
|
+
`messageWhenValueMissing`:str(def:"Complete this field") | `validity`:obj(ro) |
|
|
491
|
+
`variant`:standard/label-stacked/label-inline/label-hidden
|
|
492
|
+
Events:`onchange`(user click only).
|
|
493
|
+
Methods:`checkValidity()`,`showHelpMessageIfInvalid()`. Use HTML `<option>`. No
|
|
494
|
+
multiple(use dualListbox). Use aura:iteration for dynamic.
|
|
495
|
+
|
|
496
|
+
**lightning:slider** API41+ →LWC:`lightning-slider` SLDS:slider `label`:str(req)
|
|
497
|
+
| `value`:num(clamped) | `min`:num(def:0) | `max`:num(def:100) | `step`:num |
|
|
498
|
+
`type`:horizontal/vertical | `disabled`:bool(always valid) |
|
|
499
|
+
`messageWhenRange*`:str | `messageWhenStepMismatch`:str | `validity`:obj(ro) |
|
|
500
|
+
`variant`:standard/label-stacked/label-inline/label-hidden Events:`onchange`(use
|
|
501
|
+
instead of onblur-Safari issues).
|
|
502
|
+
Methods:`checkValidity()`,`reportValidity()`,`setCustomValidity()`
|
|
503
|
+
|
|
504
|
+
**lightning:spinner** →LWC:`lightning-spinner` SLDS:spinners
|
|
505
|
+
`variant`:brand/inverse/default(dark blue) | `size`:str | `alternativeText`:str.
|
|
506
|
+
Use aura:if or slds-hide to toggle.
|
|
507
|
+
|
|
508
|
+
**lightning:tab** →LWC:`lightning-tab`. In `lightning:tabset`. `label`:str(req)
|
|
509
|
+
| `id`:str | `iconName`:str | `iconAssistiveText`:str(req if iconName) |
|
|
510
|
+
`endIconName`:str | `endIconAlternativeText`:str(req if endIconName) |
|
|
511
|
+
`showErrorIndicator`:bool Events:`onactive`. Can nest in aura:if/iteration.
|
|
512
|
+
Lazy:can only query active/previously-active.
|
|
513
|
+
|
|
514
|
+
**lightning:tabset** →LWC:`lightning-tabset` SLDS:tabs `selectedTabId`:str |
|
|
515
|
+
`variant`:default(global)/scoped(bordered)/vertical(side)
|
|
516
|
+
Slots:default(`lightning:tab`),`moretabs`(dynamic via $A.createComponent).
|
|
517
|
+
Events:`onactive`→event.getParam("id"). First tab default. Can nest scoped in
|
|
518
|
+
global. Overflow:nav buttons.
|
|
519
|
+
|
|
520
|
+
**lightning:textarea** →LWC:`lightning-textarea` SLDS:textarea `label`:str(req)
|
|
521
|
+
| `value`:str(clear:""not null) | `name`:str | `required`:bool |
|
|
522
|
+
`disabled`:bool(grayed,valid,not submitted) |
|
|
523
|
+
`readonly`:bool(focusable,submitted,no resize) | `maxlength`/`minlength`:num |
|
|
524
|
+
`variant`:standard/label-stacked/label-inline/label-hidden | `messageWhen*`:str
|
|
525
|
+
| `validity`:obj(ro) | `autocomplete`:str Events:`onchange`,`onblur`,`onfocus`.
|
|
526
|
+
Methods:`checkValidity()`,`reportValidity()`,`setCustomValidity()`,`setRangeText(replacement,start,end,selectMode)`.
|
|
527
|
+
No rows/cols. Don't use both disabled+readonly. Width from container.
|
|
528
|
+
|
|
529
|
+
**lightning:tile** →LWC:`lightning-tile` SLDS:tiles `label`:str(req) |
|
|
530
|
+
`media`:comp | `href`:str. For constrained space. Short lists(<10). Icons not in
|
|
531
|
+
Lightning Out.
|
|
532
|
+
|
|
533
|
+
**lightning:tree** API41+ →LWC:`lightning-tree` SLDS:trees
|
|
534
|
+
`items`:arr(req)[{label,name?,href?,metatext?,items?,expanded?,disabled?}] |
|
|
535
|
+
`selectedItem`:str Events:`onselect`→event.getParam("name")(also fires with href
|
|
536
|
+
before nav). Unlimited nesting(recommend flat). Keys:arrows,Enter/Space. Use
|
|
537
|
+
with breadcrumbs.
|
|
538
|
+
|
|
539
|
+
**lightning:treeGrid** API42+ →LWC:`lightning-tree-grid` SLDS:trees
|
|
540
|
+
`columns`:arr(req)[{fieldName,label,type,sortable?,cellAttributes?,typeAttributes?,actions?,iconName?,initialWidth?,wrapText?}]
|
|
541
|
+
| `data`:arr(req,\_children for nested) | `keyField`:str(req) |
|
|
542
|
+
`expandedRows`:arr | `selectedRows`:arr | `disabledRows`:arr |
|
|
543
|
+
`hideCheckboxColumn`:bool | `hideHeader`/`hideBorders`:bool |
|
|
544
|
+
`minColumnWidth`:num(def:50) | `maxColumnWidth`:num(def:1000) |
|
|
545
|
+
`columnWidthsMode`:fixed/auto | `resizeColumnDisabled`:bool |
|
|
546
|
+
`rowNumberOffset`:num(def:1) | `rowToggleIcon`:str/obj | `ariaLabel`:str
|
|
547
|
+
Events:`onsort`→fieldName/sortDirection,`ontoggle`→name/isExpanded/hasChildrenContent/row,`onrowselection`→selectedRows
|
|
548
|
+
Methods:`getCurrentExpandedRows()`,`expandAll()`,`collapseAll()`. Max 20 nested.
|
|
549
|
+
Types:first
|
|
550
|
+
col-button/button-icon/currency/date/number/percent/text/url;other-action/boolean/button/button-icon/currency/date/date-local/email/location/number/percent/phone/text/url.
|
|
551
|
+
No infinite scroll/inline edit.
|
|
552
|
+
|
|
553
|
+
**lightning:unsavedChanges** →LWC:notification mechanisms. `unsavedChanges`:obj.
|
|
554
|
+
Methods:`setUnsavedChanges(bool)`,`clearUnsavedChanges()`. Prompts save/discard
|
|
555
|
+
on close.
|
|
556
|
+
|
|
557
|
+
**lightning:verticalNavigation** →LWC:`lightning-vertical-navigation`
|
|
558
|
+
SLDS:vertical navigation `selectedItem`:str.
|
|
559
|
+
Slot:`lightning:verticalNavigationSection`,`lightning:verticalNavigationOverflow`.
|
|
560
|
+
One level. Width:full(specify CSS). More levels:use tree.
|
|
561
|
+
|
|
562
|
+
**lightning:verticalNavigationItem** →LWC:`lightning-vertical-navigation-item`.
|
|
563
|
+
`name`:str | `label`:str | `href`:str
|
|
564
|
+
|
|
565
|
+
**lightning:verticalNavigationItemBadge**
|
|
566
|
+
→LWC:`lightning-vertical-navigation-item-badge`. `name`:str | `label`:str |
|
|
567
|
+
`href`:str | `badgeCount`:num
|
|
568
|
+
|
|
569
|
+
**lightning:verticalNavigationItemIcon**
|
|
570
|
+
→LWC:`lightning-vertical-navigation-item-icon`. `name`:str | `label`:str |
|
|
571
|
+
`href`:str | `iconName`:str
|
|
572
|
+
|
|
573
|
+
**lightning:verticalNavigationOverflow**
|
|
574
|
+
→LWC:`lightning-vertical-navigation-overflow`. Slot:verticalNavigationItem\*.
|
|
575
|
+
Toggle shows/hides. No auto viewport adjust.
|
|
576
|
+
|
|
577
|
+
**lightning:verticalNavigationSection**
|
|
578
|
+
→LWC:`lightning-vertical-navigation-section`. `label`:str.
|
|
579
|
+
Slot:verticalNavigationItem\*
|
|
580
|
+
|
|
581
|
+
**ltng:require** →LWC:`lightning/platformResourceLoader`
|
|
582
|
+
`scripts`:str(comma-sep,use join) | `styles`:str | `afterScriptsLoaded`:action.
|
|
583
|
+
Events:`ltng:afterScriptsLoaded`,`ltng:beforeLoadingResources` Add to every
|
|
584
|
+
.cmp/.app using library. Resources load once(deduped same URL).
|
|
585
|
+
Multiple:`scripts="{!join(',', $Resource.lib1 + '/lib1.js', $Resource.lib2 + '/lib2.js')}"`.
|
|
586
|
+
Order preserved. No dedup between Aura ltng:require and LWC loadScript(script
|
|
587
|
+
must self-protect).
|
|
588
|
+
|
|
589
|
+
## ui:\* (⚠dep API47)
|
|
590
|
+
|
|
591
|
+
All deprecated. See "Aura Components in the ui Namespace Are Deprecated".
|
|
592
|
+
|
|
593
|
+
**ui:actionMenuItem** →`lightning-button-menu` | **ui:button**
|
|
594
|
+
→`lightning-button`. Events:press | **ui:checkboxMenuItem**
|
|
595
|
+
→`lightning-button-menu` | **ui:inputCheckbox** →`lightning-input`.
|
|
596
|
+
Events:change,click | **ui:inputCurrency** →`lightning-input` | **ui:inputDate**
|
|
597
|
+
→`lightning-input type="date"`. Mobile:native,format unsupported,iOS change
|
|
598
|
+
fires but value on blur | **ui:inputDateTime** →`lightning-input` |
|
|
599
|
+
**ui:inputDefaultError** →`lightning-input`(built-in) | **ui:inputEmail**
|
|
600
|
+
→`lightning-input` | **ui:inputNumber** →`lightning-input type="number"` |
|
|
601
|
+
**ui:inputPhone** →`lightning-input` | **ui:inputRadio**
|
|
602
|
+
→`lightning-radio-group` | **ui:inputRichText** →`lightning-input-rich-text` |
|
|
603
|
+
**ui:inputSecret** →`lightning-input` | **ui:inputSelect**
|
|
604
|
+
→`lightning-select`/`lightning-combobox`. Slot:ui:inputSelectOption |
|
|
605
|
+
**ui:inputSelectOption** →`lightning-select`/`lightning-combobox` |
|
|
606
|
+
**ui:inputText** →`lightning-input` | **ui:inputTextArea** →`lightning-textarea`
|
|
607
|
+
| **ui:inputURL** →`lightning-input` | **ui:menu** →`lightning-button-menu`.
|
|
608
|
+
Slot:ui:menuTriggerLink+ui:menuList | **ui:menuItem** →`lightning-button-menu` |
|
|
609
|
+
**ui:menuItemSeparator** →`lightning-button-menu` | **ui:menuList**
|
|
610
|
+
→`lightning-button-menu`. Events:ui:collapse,expand,menuFocusChange,menuSelect |
|
|
611
|
+
**ui:menuTrigger** →`lightning-button-menu` | **ui:menuTriggerLink**
|
|
612
|
+
→`lightning-button-menu` | **ui:message**
|
|
613
|
+
→`lightning/platformShowToastEvent`/`lightning/toast` | **ui:outputCheckbox**
|
|
614
|
+
→`lightning-formatted-text`/`lightning-checkbox` | **ui:outputCurrency**
|
|
615
|
+
→`lightning-formatted-number` | **ui:outputDate**
|
|
616
|
+
→`lightning-formatted-date-time` | **ui:outputDateTime**
|
|
617
|
+
→`lightning-formatted-date-time` | **ui:outputEmail**
|
|
618
|
+
→`lightning-formatted-email` | **ui:outputNumber** →`lightning-formatted-number`
|
|
619
|
+
| **ui:outputPhone** →`lightning-formatted-phone` | **ui:outputRichText**
|
|
620
|
+
→`lightning-formatted-rich-text` | **ui:outputText** →`lightning-formatted-text`
|
|
621
|
+
| **ui:outputTextArea** →`lightning-formatted-text` | **ui:outputURL**
|
|
622
|
+
→`lightning-formatted-url` | **ui:radioMenuItem** →`lightning-button-menu` |
|
|
623
|
+
**ui:scrollerWrapper** →CSS scrolling | **ui:spinner** →`lightning-spinner`.
|
|
624
|
+
Toggle:$A.get("e.toggle"),set isVisible,fire
|
|
625
|
+
|
|
626
|
+
## wave:\*
|
|
627
|
+
|
|
628
|
+
**wave:sdk** Aura-only. Tableau CRM SDK. Ref:`<wave:sdk aura:id="sdk"/>`.
|
|
629
|
+
Access:`component.find("sdk")`.
|
|
630
|
+
Methods:`invokeMethod(context,methodName,methodParameters,callback)`
|
|
631
|
+
|
|
632
|
+
**wave:waveDashboard** Aura-only. Embeds Tableau CRM dashboard. Available in App
|
|
633
|
+
Builder.
|
|
634
|
+
|
|
635
|
+
## Events
|
|
636
|
+
|
|
637
|
+
### aura:\*
|
|
638
|
+
|
|
639
|
+
**aura:applicationEvent** - Root type="APPLICATION". Loose coupling.
|
|
640
|
+
Handle:aura:handler w/event+action. Propagation:bubble then broadcast. Control
|
|
641
|
+
via phase(BUBBLE/CAPTURE).
|
|
642
|
+
|
|
643
|
+
**aura:componentEvent** - Root type="COMPONENT". Parent-child. Faster than app
|
|
644
|
+
events. Prefer when possible.
|
|
645
|
+
|
|
646
|
+
**aura:doneRendering** ⚠dep. Use render event. Fires initial render complete.
|
|
647
|
+
One handler/component.
|
|
648
|
+
|
|
649
|
+
**aura:doneWaiting** ⚠dep. Use action callback response status.
|
|
650
|
+
|
|
651
|
+
**aura:locationChange** - URL hash changes. Not useful in LX/mobile(use
|
|
652
|
+
navigation service). Params:`querystring`:str,`token`:str
|
|
653
|
+
|
|
654
|
+
**aura:methodCall** - Public method called. Params:`arguments`:list,`name`:str
|
|
655
|
+
|
|
656
|
+
**aura:noAccess** - Resource inaccessible. Params:`redirectURL`:str
|
|
657
|
+
|
|
658
|
+
**aura:systemError** - Server action error. Params:`error`:str,`message`:str
|
|
659
|
+
|
|
660
|
+
**aura:valueChange** - Attr value changes. Multiple handlers.
|
|
661
|
+
Params:`expression`:str,`index`:str,`oldvalue`:obj,`value`:obj
|
|
662
|
+
|
|
663
|
+
**aura:valueDestroy** - Component destroyed. Cleanup.
|
|
664
|
+
Register:`value="{!this}"`. Params:`value`:obj(req)
|
|
665
|
+
|
|
666
|
+
**aura:valueEvent** - Root type="VALUE". Sub:valueChange,valueInit,valueDestroy.
|
|
667
|
+
|
|
668
|
+
**aura:valueInit** - App/component init(before render).
|
|
669
|
+
Register:`value="{!this}"`. Params:`value`:obj(req)
|
|
670
|
+
|
|
671
|
+
**aura:waiting** ⚠dep. Execute after queueing action. One handler/component.
|
|
672
|
+
|
|
673
|
+
### force:\*
|
|
674
|
+
|
|
675
|
+
**force:closeQuickAction** →LWC:Navigation/Quick Action Panel API. Closes quick
|
|
676
|
+
action. Fire last. LX/mobile only.
|
|
677
|
+
|
|
678
|
+
**force:createRecord** →LWC:Navigation. Full Record Create panel.
|
|
679
|
+
Params:`entityApiName`:str(req),`recordTypeId`:str,`defaultFieldValues`:obj,`navigationLocation`:LOOKUP/RELATED_LIST/RECENT.
|
|
680
|
+
Unsupported:ContractLineItem,EventRelation,OpportunityLineItem,OrderItem,QuoteLineItem,TaskRelation.
|
|
681
|
+
No action overrides. **Prefer:**`lightning:navigation` w/standard\_\_object.
|
|
682
|
+
|
|
683
|
+
**force:navigateHome** ⚠dep→standard\_\_objectPage
|
|
684
|
+
|
|
685
|
+
**force:navigateToComponent** ⚠dep API43→lightning:isUrlAddressable.
|
|
686
|
+
Params:`componentDef`:str(req),`componentAttributes`:obj(base64),`isredirect`:bool.
|
|
687
|
+
Target:access="global" or same namespace.
|
|
688
|
+
|
|
689
|
+
**force:navigateToList** ⚠dep→standard\_\_objectPage.
|
|
690
|
+
Params:`listViewId`:str(req),`listViewName`:str,`scope`:str(req)
|
|
691
|
+
|
|
692
|
+
**force:navigateToObjectHome** ⚠dep→standard\_\_objectPage.
|
|
693
|
+
Params:`scope`:str(req),`resetHistory`:bool
|
|
694
|
+
|
|
695
|
+
**force:navigateToRelatedList** →LWC:standard**recordRelationshipPage.
|
|
696
|
+
Params:`parentRecordId`:str(req),`relatedListId`:str(req,std:plural like
|
|
697
|
+
Contacts,custom:{Label}**r),`entityApiName`:str. Get relatedListId from URL
|
|
698
|
+
/rlName/<relatedListId>/view.
|
|
699
|
+
|
|
700
|
+
**force:navigateToSObject** Beta→LWC:Navigation.
|
|
701
|
+
Params:`recordId`:str(req),`slideDevName`:str(LX only)
|
|
702
|
+
|
|
703
|
+
**force:navigateToURL** →LWC:Navigation.
|
|
704
|
+
Params:`url`:str(req),`isredirect`:bool. Absolute+isredirect:false→new window.
|
|
705
|
+
Relative+isredirect:true→redirect.
|
|
706
|
+
|
|
707
|
+
**force:recordSave** →LWC:LDS/recordEditForm. Request save. Use
|
|
708
|
+
w/force:recordEdit. **Prefer:**inputField+recordEditForm.
|
|
709
|
+
|
|
710
|
+
**force:recordSaveSuccess** →LWC:LDS/recordEditForm events. On success. Handle
|
|
711
|
+
via onSaveSuccess on force:recordEdit.
|
|
712
|
+
|
|
713
|
+
**force:refreshView** →LWC:`getRecordNotifyChange()`. Reloads view.
|
|
714
|
+
**Performance impact.** Only refreshes std components. Doesn't impact storable
|
|
715
|
+
Actions. **Best:**Use LDS first. Supported:LX,mobile,Experience Builder.
|
|
716
|
+
|
|
717
|
+
**force:showToast** →LWC:`lightning/platformShowToastEvent`.
|
|
718
|
+
Params:`message`:str(req),`messageTemplate`:str({0},{1}),`messageTemplateData`:arr,`mode`:dismissible/pester/sticky,`type`:success/warning/error/info/other,`duration`:int(def:5000),`key`:str.
|
|
719
|
+
Not on login pages.
|
|
720
|
+
|
|
721
|
+
### forceChatter:\*
|
|
722
|
+
|
|
723
|
+
**forceChatter:customOpenFile** - File open behavior in Communities
|
|
724
|
+
mobile/tablet. Set recordId,call fire().
|
|
725
|
+
|
|
726
|
+
**forceChatter:postCreated** - Chatter post created. LX,mobile,Experience
|
|
727
|
+
Builder. Use w/publisher/feed.
|
|
728
|
+
|
|
729
|
+
### forceCommunity:\*
|
|
730
|
+
|
|
731
|
+
**forceCommunity:analyticsInteraction** - GA data. Experience Builder only.
|
|
732
|
+
Enable:add GA tracking ID in Settings>Advanced.
|
|
733
|
+
hitTypes:event(eventAction,eventCategory),social(socialAction,socialNetwork,socialTarget),exception(exDescription),timing(timingCategory,timingVar,timingValue)
|
|
734
|
+
|
|
735
|
+
**forceCommunity:analyticsInteractionGtag** - GA via gtag. Experience Builder
|
|
736
|
+
only.
|
|
737
|
+
|
|
738
|
+
**forceCommunity:routeChange** - System event page URL changes(auto-fired,cannot
|
|
739
|
+
fire manually). Experience Builder only.
|
|
740
|
+
|
|
741
|
+
### lightning:\*
|
|
742
|
+
|
|
743
|
+
**lightning:conversationAgentSend** - Agent sends message console/Enhanced
|
|
744
|
+
Messaging. Params:`content`,`name`,`recordId`,`timestamp`,`type`
|
|
745
|
+
|
|
746
|
+
**lightning:conversationChatEnded** - Chat ends. Param:`recordId`
|
|
747
|
+
|
|
748
|
+
**lightning:conversationCustomEvent** - Custom chat event.
|
|
749
|
+
Params:`data`,`recordId`,`type`
|
|
750
|
+
|
|
751
|
+
**lightning:conversationNewMessage** - New message.
|
|
752
|
+
Params:`content`,`name`,`recordId`,`timestamp`,`type`
|
|
753
|
+
|
|
754
|
+
**lightning:omniChannelStatusChanged** - Agent changes status.
|
|
755
|
+
Params:`channels`:JSON,`statusApiName`,`statusId`,`statusName`
|
|
756
|
+
|
|
757
|
+
**lightning:omniChannelWorkAccepted/Assigned/Closed** - Work item
|
|
758
|
+
accepted/assigned/closed. Param:`workId`
|
|
759
|
+
|
|
760
|
+
**lightning:openFiles** ⚠dep→Navigation. Opens
|
|
761
|
+
preview(desktop)/download(mobile).
|
|
762
|
+
Params:`recordIds`:str/arr(req)=ContentDocument/ContentHubItem
|
|
763
|
+
IDs,`selectedRecordId`:str
|
|
764
|
+
|
|
765
|
+
**lightning:sendChatterExtensionPayload** - Component event Chatter publisher.
|
|
766
|
+
Experience Builder.
|
|
767
|
+
Params:`extensionDescription`,`extensionThumbnailUrl`,`extensionTitle`,`payload`:obj
|
|
768
|
+
|
|
769
|
+
**lightning:tabClosed/Created/Focused/Refreshed/Replaced/Updated** - Console tab
|
|
770
|
+
events. Param:`tabId`
|
|
771
|
+
|
|
772
|
+
### ltng:\*
|
|
773
|
+
|
|
774
|
+
**ltng:afterScriptsLoaded** - ltng:require loads all scripts. Handle via
|
|
775
|
+
afterScriptsLoaded attr.
|
|
776
|
+
|
|
777
|
+
**ltng:beforeLoadingResources** - Before ltng:require loads.
|
|
778
|
+
|
|
779
|
+
**ltng:selectSObject** - Object selected. Params:`recordId`,`channel`(optional)
|
|
780
|
+
|
|
781
|
+
**ltng:sendMessage** - Data between components.
|
|
782
|
+
Params:`message`:str/JSON,`channel`(optional)
|
|
783
|
+
|
|
784
|
+
### ui:\* (⚠dep API47)
|
|
785
|
+
|
|
786
|
+
**ui:clearErrors** - Validation errors cleared. Handler:onClearErrors |
|
|
787
|
+
**ui:collapse** - menuList collapsed. Handler:menuCollapse | **ui:expand** -
|
|
788
|
+
Component expanded. Handler:menuExpand | **ui:menuFocusChange** - Menu focus
|
|
789
|
+
changed. Handler:menuFocusChange | **ui:menuSelect** - Item selected.
|
|
790
|
+
Handler:menuSelect. Click fires before.
|
|
791
|
+
|
|
792
|
+
### wave:\*
|
|
793
|
+
|
|
794
|
+
**wave:assetLoaded** - Analytics asset loaded | **wave:discover** - Request
|
|
795
|
+
dashboard discovery. Set UID. Dashboards respond w/discoverResponse |
|
|
796
|
+
**wave:discoverResponse** - Response to discover | **wave:pageChange** - Nav to
|
|
797
|
+
dashboard page. Params:`devName`,`pageid` | **wave:selectionChanged** -
|
|
798
|
+
Dashboard selection. payload=row data | **wave:update** - Apply
|
|
799
|
+
filter/selection. Params:`devName`,`id`,`type`,`value`:JSON
|
|
800
|
+
|
|
801
|
+
### lightningcommunity:\*
|
|
802
|
+
|
|
803
|
+
**lightningcommunity:deflectionSignal** - User interacts w/deflection item.
|
|
804
|
+
Experience Builder. sourceType:caseCreateDeflectionModal. payload varies by
|
|
805
|
+
signal type.
|
|
806
|
+
|
|
807
|
+
## Interfaces
|
|
808
|
+
|
|
809
|
+
**aura:hasPageReference** - Adds `pageReference`:obj(ro). Current
|
|
810
|
+
page:type,attributes,state. →LWC:CurrentPageReference wire/NavigationMixin
|
|
811
|
+
|
|
812
|
+
**clients:availableForMailAppAppPage** - Lightning for Gmail/Outlook Flexipages
|