---
schema_version: "1"
id: 8c0760904d7c45b82b6710189635878e6f68c17703908bd548c720e8cdca226d
title: HomePageComponent
collection: legacydeveloper
version: current
locale: en-us
portal_url: https://docs.salesforce.com/legacydeveloper/current/en-us/api_meta/meta_homepagecomponent.md
canonical_url: https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_homepagecomponent.htm
source_site: developer.salesforce.com
content_type: documentation
content_hash: 8914d188af96f2062adce79ca7e0c0ddd2bb42a2835e9e29c0a1079e22914f60
description: 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.
---
# HomePageComponent

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.

For more information, see “[Salesforce Classic Home Tab Page Layouts](https://help.salesforce.com/s/articleView?id=platform.customize_homepage.htm&type=5&language=en_US "HTML (New Window)")” in the Salesforce Help.

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.

## Declarative Metadata File Suffix and Directory Location

The file suffix for home page components is .homePageComponent and components are stored in the homepagecomponents directory of the corresponding package directory.

## Version

Home page components are available in API version 12.0 and later.

## HomePageComponent

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

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



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

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

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

            </tr>

          </thead>

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

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

              <td class="entry" headers="d564856e114" data-title="Description">The text body inside the HTML page component.</td>

            </tr>

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

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

              <td class="entry" headers="d564856e114" 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="d564856e108" data-title="Field Name"><span class="keyword parmname">height</span></td>

              <td class="entry" headers="d564856e111" data-title="Field Type">int</td>

              <td class="entry" headers="d564856e114" data-title="Description">Required for Visualforce Area components. Indicates the height (in pixels) of
                the component.<p class="p">This field is available in API version 31.0 and later.</p>
              </td>

            </tr>

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

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

              <td class="entry" headers="d564856e114" data-title="Description">If the <span class="keyword parmname">pageComponentType</span> is <samp class="codeph nolang">links</samp>, then zero or more names of custom page links can be specified.<ul class="ul bulletList">
                  <li class="li"><samp class="codeph nolang">ObjectWebLink</samp></li>

                  <li class="li"><samp class="codeph nolang">CustomPageWebLink</samp></li>

                </ul>
              </td>

            </tr>

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

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

              <td class="entry" headers="d564856e114" data-title="Description">This field is only available for Visualforce Area components and indicates the
                API name of the Visualforce page that is associated with the component. <p class="p">This
                  field is available in API version 31.0 and later.</p>
              </td>

            </tr>

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

              <td class="entry" headers="d564856e111" data-title="Field Type">PageComponentType (<a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_objects_intro.htm#enumeration_title">enumeration</a> of type string)</td>

              <td class="entry" headers="d564856e114" data-title="Description">Required. Valid values are:<ul class="ul bulletList">
                  <li class="li"><samp class="codeph nolang">links</samp></li>

                  <li class="li"><samp class="codeph nolang">htmlArea</samp></li>

                  <li class="li"><samp class="codeph nolang">imageOrNote</samp></li>

                  <li class="li">
                    <samp class="codeph nolang">visualforcePage</samp> (This value is available
                    in API version 31.0 and later.)
                  </li>

                </ul>
              </td>

            </tr>

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

              <td class="entry" headers="d564856e111" data-title="Field Type">boolean</td>

              <td class="entry" headers="d564856e114" data-title="Description">This field is only available for Visualforce Area components and specifies
                whether the component displays with a label (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>).<p class="p">This field
                  is available in API version 31.0 and later.</p>
              </td>

            </tr>

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

              <td class="entry" headers="d564856e111" data-title="Field Type">boolean</td>

              <td class="entry" headers="d564856e114" data-title="Description">This field is only available for Visualforce Area components and specifies
                whether the component displays with scrollbars (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>).<p class="p">This field
                  is available in API version 31.0 and later.</p>
              </td>

            </tr>

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

              <td class="entry" headers="d564856e111" data-title="Field Type">PageComponentWidth (<a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_objects_intro.htm#enumeration_title">enumeration</a> of type string)</td>

              <td class="entry" headers="d564856e114" data-title="Description">This field is only available for HTML and Visualforce Area components, and
                indicates whether it’s a narrow or wide home page component. Valid values are:<ul class="ul bulletList">
                  <li class="li"><samp class="codeph nolang">narrowComponents</samp></li>

                  <li class="li"><samp class="codeph nolang">wideComponents</samp></li>

                </ul>
              </td>

            </tr>

          </tbody>

        </table>

## Declarative Metadata Sample Definition

The following is the definition of a home page component. See [Declarative Metadata Sample Definition](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_homepagelayouts.htm#HomePageLayout_meta_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"?>
<HomePageComponent xmlns="http://soap.sforce.com/2006/04/metadata">
  <height\>200</height\>
  <page\>MyVisualforcePage</page\>
  <pageComponentType\>visualforcePage</pageComponentType\>
  <showLabel\>true</showLabel\>
  <showScrollbars\>true</showScrollbars\>
  <width\>wideComponents</width\>
</HomePageComponent\>

## 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

- [HomePageLayout](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_homepagelayouts.htm "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.")
- [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.")