---
schema_version: "1"
id: 352408c28f8ee2e5686acc99cfb43f606a5d9eab6c5e0f189aafa44a1e301cfe
title: HomePageLayout
collection: legacydeveloper
version: current
locale: en-us
portal_url: https://docs.salesforce.com/legacydeveloper/current/en-us/api_meta/meta_homepagelayouts.md
canonical_url: https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_homepagelayouts.htm
source_site: developer.salesforce.com
content_type: documentation
content_hash: c93fecde77ff8728c403b320e69b9b79a135f12dc1c6e9143a8e293b19080e4f
description: Represents the metadata associated with a home page layout. You can customize home page layouts and assign the layouts to users based on their user profile.
---
# HomePageLayout

Represents the metadata associated with a home page layout. You can customize home page layouts and assign the layouts to users based on their user profile.

## File Suffix and Directory Location

Home page layouts are stored in the homePageLayouts directory of the corresponding package directory. The extension is .homePageLayout.

## Version

Home page components are available in API version 12.0 and later. This type extends the [Metadata](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/metadata.htm "The base class for all metadata types. You can’t edit this object. A component is an instance of a metadata type.") metadata type and inherits its fullName field.

## Fields

This metadata type represents the valid values that define a home page layout:

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d565908e95">Field Name</th>

              <th class="featureTableHeader  " id="d565908e98">Field Type</th>

              <th class="featureTableHeader  " id="d565908e101">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d565908e95" data-title="Field Name"><span class="keyword parmname">fullName</span></td>

              <td class="entry" headers="d565908e98" data-title="Field Type">string</td>

              <td class="entry" headers="d565908e101" data-title="Description">The name can only contain characters, letters, and the underscore
                (_) character. The name must start with a letter, and can’t end with
                an underscore or contain two consecutive underscore
                characters.<p class="p">Inherited from the <a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/metadata.htm" title="The base class for all metadata types. You can’t edit this object. A component is an instance of a metadata type.">Metadata</a> component, this field isn’t defined in
                  the WSDL for this component. It must be specified when creating,
                  updating, or deleting. See <a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_create.htm" title="Deprecated. Adds one or more new metadata components to your organization asynchronously. This call is removed as of API version 31.0 and is available in earlier versions only. Use createMetadata() instead.">create()</a> to see an example of this field
                  specified for a call.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d565908e95" data-title="Field Name"><span class="keyword parmname">narrowComponents</span></td>

              <td class="entry" headers="d565908e98" data-title="Field Type">string[]</td>

              <td class="entry" headers="d565908e101" data-title="Description">The list of elements in the narrow column on the left side of the
                home page.</td>

            </tr>

            <tr>
              <td class="entry" headers="d565908e95" data-title="Field Name"><span class="keyword parmname">wideComponents</span></td>

              <td class="entry" headers="d565908e98" data-title="Field Type">string[]</td>

              <td class="entry" headers="d565908e101" data-title="Description">The list of elements in the wide column on the right side of the
                home page.</td>

            </tr>

          </tbody>

        </table>

## Declarative Metadata Sample Definition

The following is the definition of a home page layout. See [Declarative Metadata Sample Definition](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_homepagecomponent.htm#HomePageCompenent_example) and [Declarative Metadata Sample Definition](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_weblink.htm#weblink_example) for related samples.

<?xml version="1.0" encoding="UTF-8"?>
<HomePageLayout xmlns="http://soap.sforce.com/2006/04/metadata">
    <narrowComponents\>google</narrowComponents\>
</HomePageLayout\>

## 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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm).

#### See Also

- [HomePageComponent](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_homepagecomponent.htm "Represents the metadata associated with a home page component. You can customize the Home tab in Salesforce Classic to include components such as sidebar links, a company logo, a dashboard snapshot, or custom components that you create. Use to create, update, or delete home page component definitions.")
- [WebLink](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_weblink.htm "Represents a custom button or link defined in a custom object.")