---
schema_version: "1"
id: eba519739be96a5619501245ec711718e773aaf07ae2312a24e11da286cefd5f
title: Custom Link Layout Component
collection: legacydeveloper
version: current
locale: en-us
portal_url: https://docs.salesforce.com/legacydeveloper/current/en-us/uiapi/ui_api_responses_custom_link_layout_component.md
canonical_url: https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_custom_link_layout_component.htm
source_site: developer.salesforce.com
content_type: documentation
content_hash: cad95d4495b7a6e1bce7ea5afc9c2dc269cfe5ec0c8f597f78edbbe4a45ef2d9
description: A custom link component on a record page layout.
---
# Custom Link Layout Component

A custom link component on a record page layout.

<table class="featureTable sort_table" summary="">
          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader vertical-align-top " id="d101951e28">Property Name</th>
              <th class="featureTableHeader vertical-align-top " id="d101951e30">Type</th>
              <th class="featureTableHeader vertical-align-top " id="d101951e32">Description</th>
              <th class="featureTableHeader vertical-align-top " id="d101951e34">Filter Group and Version</th>
              <th class="featureTableHeader vertical-align-top " id="d101951e36">Available Version</th>
            </tr>
          </thead>
          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d101951e28" data-title="Property Name"><samp class="codeph nolang">apiName</samp></td>

              <td class="entry" headers="d101951e30" data-title="Type">String</td>

              <td class="entry" headers="d101951e32" data-title="Description">If a field powers this component, this property contains the API name of the field.</td>

              <td class="entry" headers="d101951e34" data-title="Filter Group and Version">Small, 41.0</td>

              <td class="entry" headers="d101951e36" data-title="Available Version">41.0</td>

            </tr>

            <tr>
              <td class="entry" headers="d101951e28" data-title="Property Name"><samp class="codeph nolang">behavior</samp></td>
              <td class="entry" headers="d101951e30" data-title="Type">String</td>
              <td class="entry" headers="d101951e32" data-title="Description">Indicates how a link behaves on open. One of these values: <ul class="ul bulletList">
                  <li class="li">
                    <samp class="codeph nolang">NewWindow</samp>—Open a new window.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">NoSidebar</samp>—No sidebar
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">OnClickJavaScript</samp>—When the link is
                    clicked, run JavaScript.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">Replace</samp>—Replace the current page.
                  </li>

                  <li class="li">
                    <samp class="codeph nolang">Sidebar</samp>—Sidebar
                  </li>

                </ul>
              </td>
              <td class="entry" headers="d101951e34" data-title="Filter Group and Version">Small, 41.0</td>
              <td class="entry" headers="d101951e36" data-title="Available Version">41.0</td>
            </tr>


            <tr>
              <td class="entry" headers="d101951e28" data-title="Property Name"><samp class="codeph nolang">componentType</samp></td>

              <td class="entry" headers="d101951e30" data-title="Type">String</td>

              <td class="entry" headers="d101951e32" data-title="Description">The component type. The value is <samp class="codeph nolang">CustomLink</samp>.</td>

              <td class="entry" headers="d101951e34" data-title="Filter Group and Version">Small, 41.0</td>

              <td class="entry" headers="d101951e36" data-title="Available Version">41.0</td>

            </tr>
            <tr>
              <td class="entry" headers="d101951e28" data-title="Property Name"><samp class="codeph nolang">customLinkUrl</samp></td>
              <td class="entry" headers="d101951e30" data-title="Type">String</td>
              <td class="entry" headers="d101951e32" data-title="Description">The custom link URL.</td>
              <td class="entry" headers="d101951e34" data-title="Filter Group and Version">Small, 41.0</td>
              <td class="entry" headers="d101951e36" data-title="Available Version">41.0</td>
            </tr>
            <tr>
              <td class="entry" headers="d101951e28" data-title="Property Name"><samp class="codeph nolang">label</samp></td>
              <td class="entry" headers="d101951e30" data-title="Type">String</td>
              <td class="entry" headers="d101951e32" data-title="Description">The custom link label.</td>
              <td class="entry" headers="d101951e34" data-title="Filter Group and Version">Small, 41.0</td>
              <td class="entry" headers="d101951e36" data-title="Available Version">41.0</td>
            </tr>
          </tbody>
        </table>

#### See Also

- [Record Layout Item](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_record_layout_item.htm "An item in a record layout.")