Create a Lightning Web Component Action
Creating a Lightning web component (LWC) action is similar to creating a regular quick action, and you do it in the same place in Setup for most supported objects. All you need is an LWC in your org for the quick action to trigger.
Required Editions
| Available in: Lightning Experience |
| Available in: Group, Professional, Enterprise, Performance, Unlimited, Contact Manager, Database.com, and Developer Editions |
| User Permissions Needed | |
|---|---|
| To create actions: | Customize Application |
You can create a Lightning web component action for custom objects and for Salesforce record home objects that are enabled for LWC. If you can’t create actions with the Lightning Web Component action type, they’re not currently supported for that object. For more information, see LWC Migration for Record Home Pages in the Lightning Web Components Developer Guide.
- From Setup, click Object Manager, click the object that you want to create the action for, and then click Buttons, Links, and Actions.
- Click New Action.
- For Action Type, select Lightning Web Component.
- Select the component that you want the action to call.
-
Enter a label for the action. Users see this label as the name of the action.
Tip You can choose an option from the Standard Label Type list to have Salesforce generate the label. For the labels in this list that include Record and Record Type, Salesforce fills in the type of object or the record type the action creates. For example, if you choose the Create New Record standard label on a create contact action, the generated label is Create New Contact. -
If necessary, change the name of the action. If you selected a standard label type in the
previous step, you must enter the name.
This name is used in the API and managed packages. It must begin with a letter and use only alphanumeric characters and underscores, and it can’t end with an underscore or have two consecutive underscores. Unless you’re familiar with working with the API, we suggest not editing this field.
-
Type a description for the action.
The description appears on the detail page for the action and in the list on the Buttons, Links, and Actions page. The description isn’t visible to your users. If you’re creating several actions on the same object, we recommend using a detailed description, such as “Create Contact on Account using New Client record type.”
- Optionally, to select a different icon for the action, click Change Icon.
When you finish creating your action, add it to the Lightning Experience Actions section of the desired page layout, such as the opportunity page layout, and your users can start using it.
