CompactLayout

Represents the metadata associated with a compact layout. This type extends the Metadata metadata type and inherits its fullName field.

A compact layout displays a record’s key fields at a glance in both the Salesforce mobile app and Lightning Experience.

Compact layouts support all field types except:

text area
long text area
rich text area
multi-select picklist

For more information on compact layouts, see “Compact Layouts” in the Salesforce Help.

File Suffix and Directory Location

Compact layouts are defined as part of the custom object, standard object, or external object definition. See CustomObject for more information.

Version

CompactLayout components are available in API version 29.0 and later. CompactLayout components are available for external objects in API version 42.0 and later.

Fields

Field Name	Field Type	Description
fields	string	The fields assigned to the compact layout. Their order represents the prioritization given to them when defining the compact layout.
label	string	Label that represents the object throughout the Salesforce user interface.

Declarative Metadata Sample Definition

The following is an example of a CompactLayout component:

Wildcard Support in the Manifest File

This metadata type supports the wildcard character * (asterisk) in the package.xml manifest file. For information about using the manifest file, see Deploying and Retrieving Metadata with the Zip File.

Metadata API Developer Guide