Generate a FlexiPage, also known as a Lightning page.
note: This feature is a Beta Service. Customers may opt to try such Beta Service in its sole discretion. Any use of the Beta Service is subject to the applicable Beta Services Terms provided at Agreements and Terms.
Description for template generate flexipage
FlexiPages are the metadata types associated with a Lightning page. A Lightning page represents a customizable screen made up of regions containing Lightning components.
You can use this command to generate these types of FlexiPages; specify the type with the --template flag:
<ul><li>AppPage: A Lightning page used as the home page for a custom app or a standalone application page.</li><li>HomePage: A Lightning page used to override the Home page in Lightning Experience.</li><li>RecordPage: A Lightning page used to override an object record page in Lightning Experience. Requires that you specify the object name with the --sobject flag.</li></ul>Flags
| Flag Name (Long) | Flag Name (Short) | Description |
|---|---|---|
| <code>‑‑api‑version</code> | N/A | Type: Value<br><br>Override the api version used for api requests made by this command |
| <code>‑‑description</code> | N/A | Type: Value<br><br>Description for the FlexiPage, which provides context about its purpose. |
| <code>‑‑detail‑fields</code> | N/A | Type: Value<br><br>Fields to display in the Details tab. Specify multiple fields separated by commas. Fields are split into two columns. Used only with RecordPage. |
| <code>‑‑flags‑dir</code> | N/A | Type: Value<br><br>Import flag values from a directory. |
| <code>‑‑json</code> | N/A | Type: Boolean<br><br>Format output as json. |
| <code>‑‑label</code> | N/A | Type: Value<br><br>Label of this FlexiPage; if not specified, uses the FlexiPage name as the label. |
| <code>‑‑name</code> | <code>‑n</code> | Type: Value<br>Required<br><br>Name of the FlexiPage.<br><br>The name can contain only alphanumeric characters, must start with a letter, and can't end with an underscore or contain two consecutive underscores. |
| <code>‑‑output‑dir</code> | <code>‑d</code> | Type: Value<br>Default value: .<br><br>Directory for saving the created files.<br><br>The location can be an absolute path or relative to the current working directory. The default is the current directory. |
| <code>‑‑primary‑field</code> | N/A | Type: Value<br><br>Primary field for the dynamic highlights header; typically 'Name'. Used only with RecordPage. |
| <code>‑‑secondary‑fields</code> | N/A | Type: Value<br><br>Secondary fields shown in the dynamic highlights header. Specify multiple fields separated by commas. Maximum of 11 fields. Used only with RecordPage. |
| <code>‑‑sobject</code> | <code>‑s</code> | Type: Value<br><br>API name of the Salesforce object; required when creating a RecordPage.<br><br>For RecordPage FlexiPages, you must specify the associated object API name, such as 'Account', 'Opportunity', or 'Custom_Object__c'. This sets the sobjectType field in the FlexiPage metadata. |
| <code>‑‑template</code> | <code>‑t</code> | Type: Value<br>Required<br>Valid Values: RecordPage, AppPage, HomePage<br><br>Template type for the FlexiPage. |
Examples for template generate flexipage
Generate a RecordPage FlexiPage for the Account object in the current directory:
sf template generate flexipage --name Account_Record_Page --template RecordPage --sobject Account
Generate an AppPage FlexiPage in the "force-app/main/default/flexipages" directory:
sf template generate flexipage --name Sales_Dashboard --template AppPage --output-dir force-app/main/default/flexipages
Generate a HomePage FlexiPage with a custom label:
sf template generate flexipage --name Custom_Home --template HomePage --label "Sales Home Page"
Generate a RecordPage with dynamic highlights and detail fields:
sf template generate flexipage --name Property_Page --template RecordPage --sobject Rental_Property__c --primary-field Name --secondary-fields Property_Address__c,City__c --detail-fields Name,Property_Address__c,City__c,Monthly_Rent__c,Bedrooms__c