---
schema_version: "1"
id: a783c4ef39d7217e0666024543cb4512a3bd21510a18f42c66c49d5ae27a4370
title: UiPreviewMessageTabDef
collection: legacydeveloper
version: current
locale: en-us
portal_url: https://docs.salesforce.com/legacydeveloper/current/en-us/api_meta/meta_uipreviewmessagetabdef.md
canonical_url: https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_uipreviewmessagetabdef.htm
source_site: developer.salesforce.com
content_type: documentation
content_hash: 0e011e803daf7995e648c57bd8fa40b54700b64e51982365b098be927374260c
description: Represents the registration of a custom Marketing Cloud Preview and Test modal tab, created using custom Lightning web components. You can register and show multiple tabs in the Preview and Test experience.
---
# UiPreviewMessageTabDef

Represents the registration of a custom Marketing Cloud Preview and Test modal tab, created using custom Lightning web components. You can register and show multiple tabs in the Preview and Test experience.

![Important](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note_important.png)

#### Important

Where possible, we changed noninclusive terms to align with our company value of Equality. We maintained certain terms to avoid any effect on customer implementations.

## Parent Type

This type extends the [Metadata](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/metadata.htm "HTML (New Window)") metadata type and inherits its fullName field.

## File Suffix and Directory Location

UiPreviewMessageTabDef components have the suffix .uiPreviewMessageTabDef and are stored in the uiPreviewMessageTabDef folder.

## Version

UiPreviewMessageTabDef components are available in API version 63.0 and later.

## Special Access Rules

There are no additional access requirements that are specific to this type.

## Fields

| Field Name | Description |
| --- | --- |
| isActive | 
Field Type

boolean

Description

Required.

Indicates whether the tab is enabled and is customer controlled (true) or not (false).



 |
| isProtected | 

Field Type

boolean

Description

Indicates whether the configuration is protected (true) or not (false).



 |
| label | 

Field Type

string

Description

Required.

Label for the tab.



 |
| lightningComponentDef | 

Field Type

string

Description

Required.

The customer-created Lightning web component that displays in the Preview and Test tabs.



 |
| supportedChannel | 

Field Type

SupportedChannel (enumeration of type string)

Description

Required.

A string indicating the type of channel.

Values are:

- Email
- Sms
- WhatsApp





 |
| tabName | 

Field Type

string

Description

Required.

The case-sensitive, user-defined label displayed as the name of the tab. Maximum length is 255 characters.





 |

## Declarative Metadata Sample Definition

This example is a custom Lightning web component’s HTML file.

<template\>
    <div\>A custom tab</div\>
    <div\>Preview data</div\>
    <div\>{previewData}</div\>
</template\>

Here’s the component’s JavaScript file.

import { LightningElement, api } from "lwc";

export default class CustomTab extends LightningElement {
    @api previewData;
}

Here’s the component’s configuration file.

<?xml version="1.0" encoding="UTF-8"?>
<LightningComponentBundle xmlns="http://soap.sforce.com/2006/04/metadata">
    <apiVersion\>63.0</apiVersion\>
    <isExposed\>true</isExposed\>
    <capabilities\>
        <capability\>lightning\_\_dynamicComponent</capability\>
    </capabilities\>
</LightningComponentBundle\>

This example package.xml references the component’s definition.

<?xml version="1.0" encoding="UTF-8"?>

<UiPreviewMessageTabDef xmlns="http://soap.sforce.com/2006/04/metadata">
    <isActive\>true</isActive\>
    <label\>TestUiPreviewMessageTab</label\>
    <lightningComponentDef\>customTab</lightningComponentDef\>
    <supportedChannel\>Email</supportedChannel\>
    <tabName\>My Tab</tabName\>
    <isProtected\>false</isProtected\>
</UiPreviewMessageTabDef\>