---
schema_version: "1"
id: eb6560c70d4d07d97bb4567c81cd49725b29723d6e46a083f0e3a85fee361fd4
title: MaskedInput Lightning Web Component ReadMe (Managed Package)
collection: admin
version: current
locale: en-us
portal_url: https://docs.salesforce.com/admin/current/en-us/xcloud/264-0-0/os_maskedinput_lightning_web_component_readme.md
canonical_url: https://help.salesforce.com/s/articleView?id=xcloud.os_maskedinput_lightning_web_component_readme.htm&release=264.0.0&type=5
source_site: help.salesforce.com
content_type: documentation
content_hash: f46d680d730e1faccb6d3c395038746f3c72ef8ccbc48b65e2d1d5b760dda719
description: For the managed package runtime, this page contains a MaskedInput LWC ReadMe for each Vlocity release.
products:
  - Omnistudio
release: "264"
---
# MaskedInput Lightning Web Component ReadMe (Managed Package)

For the managed package runtime, this page contains a MaskedInput LWC ReadMe for each Vlocity release.

![Managed Package app icon](https://sf-zdocs-cdn-prod.zoominsoftware.com/tdta-xcloud-omnistudio_for_managed_packages-264-0-0-production-enus/aa2554ec-624a-4ee6-8da4-6435670e6e62/resources-global/_corporate/images/managedpackageicon.png) This information is for Omnistudio for Managed Packages. For Omnistudio on standard runtime, see [Omnistudio Help](https://help.salesforce.com/s/articleView?id=xcloud.os_omnistudio_standard.htm&language=en_US).

## Vlocity Insurance and Health Summer '20

The _MaskedInput Lightning Web Component_ controls what and how a user can enter data in form input fields. The _MaskedInput Lightning Web Component_extends the _Input Lightning Web Component_.

For possible use cases for the masked-input component, see [imask documentation](https://unmanner.github.io/imaskjs/guide.html).

## Available c-masked-input Attributes

<table class="slds-table slds-table_bordered slds-max-medium-table_stacked slds-m-bottom_small ">
        <colgroup>
          <col>
          <col>
          <col>
          <col>
          <col>
        </colgroup>
        <thead class="slds-text-title_caps ">
          <tr class="">
            <th scope="col" class="slds-cell-wrap" style="vertical-align:top;" id="d75847e78">
              <p style="margin-bottom:0;">Attribute</p>
            </th>
            <th scope="col" class="slds-cell-wrap" style="vertical-align:top;" id="d75847e84">
              <p style="margin-bottom:0;">Value</p>
            </th>
            <th scope="col" class="slds-cell-wrap" style="vertical-align:top;" id="d75847e90">
              <p style="margin-bottom:0;">Type</p>
            </th>
            <th scope="col" class="slds-cell-wrap" style="vertical-align:top;" id="d75847e96">
              <p style="margin-bottom:0;">Required</p>
            </th>
            <th scope="col" class="slds-cell-wrap" style="vertical-align:top;" id="d75847e102">
              <p style="margin-bottom:0;">Description</p>
            </th>
          </tr>
        </thead>
        <tbody>
          <tr class="">
            <td data-label="Attribute" class="slds-cell-wrap" style="vertical-align:top;" headers="d75847e78 ">
              <p style="margin-bottom:0;">currency</p>
            </td>

            <td data-label="Value" class="slds-cell-wrap" style="vertical-align:top;" headers="d75847e84 ">&nbsp;</td>

            <td data-label="Type" class="slds-cell-wrap" style="vertical-align:top;" headers="d75847e90 ">
              <p style="margin-bottom:0;">string</p>
            </td>

            <td data-label="Required" class="slds-cell-wrap" style="vertical-align:top;" headers="d75847e96 ">
              <p style="margin-bottom:0;">&nbsp;</p>
            </td>

            <td data-label="Description" class="slds-cell-wrap" style="vertical-align:top;" headers="d75847e102 ">
              <p style="margin-bottom:0;">Enables user to set currency code.</p>
            </td>

          </tr>
          <tr class="">
            <td data-label="Attribute" class="slds-cell-wrap" style="vertical-align:top;" headers="d75847e78 ">
              <p style="margin-bottom:0;">imask</p>
            </td>

            <td data-label="Value" class="slds-cell-wrap" style="vertical-align:top;" headers="d75847e84 ">
              <p style="margin-bottom:0;">JSON</p>
            </td>

            <td data-label="Type" class="slds-cell-wrap" style="vertical-align:top;" headers="d75847e90 ">
              <p style="margin-bottom:0;">object</p>
            </td>

            <td data-label="Required" class="slds-cell-wrap" style="vertical-align:top;" headers="d75847e96 ">
              <p style="margin-bottom:0;">yes</p>
            </td>

            <td data-label="Description" class="slds-cell-wrap" style="vertical-align:top;" headers="d75847e102 ">
              <p style="margin-bottom:0;">Contains the valid imask attribute JSON.</p>
            </td>

          </tr>
          <tr class="">
            <td data-label="Attribute" class="slds-cell-wrap" style="vertical-align:top;" headers="d75847e78 ">
              <p style="margin-bottom:0;">inputmode</p>
            </td>

            <td data-label="Value" class="slds-cell-wrap" style="vertical-align:top;" headers="d75847e84 ">&nbsp;</td>

            <td data-label="Type" class="slds-cell-wrap" style="vertical-align:top;" headers="d75847e90 ">
              <p style="margin-bottom:0;">string</p>
            </td>

            <td data-label="Required" class="slds-cell-wrap" style="vertical-align:top;" headers="d75847e96 ">
              <p style="margin-bottom:0;">&nbsp;</p>
            </td>

            <td data-label="Description" class="slds-cell-wrap" style="vertical-align:top;" headers="d75847e102 ">
              <p style="margin-bottom:0;">Enables user to set inputmode which corresponds to different keypads on mobile.</p>
            </td>

          </tr>
          <tr class="">
            <td data-label="Attribute" class="slds-cell-wrap" style="vertical-align:top;" headers="d75847e78 ">
              <p style="margin-bottom:0;">locale</p>
            </td>

            <td data-label="Value" class="slds-cell-wrap" style="vertical-align:top;" headers="d75847e84 ">&nbsp;</td>

            <td data-label="Type" class="slds-cell-wrap" style="vertical-align:top;" headers="d75847e90 ">
              <p style="margin-bottom:0;">string</p>
            </td>

            <td data-label="Required" class="slds-cell-wrap" style="vertical-align:top;" headers="d75847e96 ">
              <p style="margin-bottom:0;">&nbsp;</p>
            </td>

            <td data-label="Description" class="slds-cell-wrap" style="vertical-align:top;" headers="d75847e102 ">
              <p style="margin-bottom:0;">Enables user to set locale for the currency type.</p>
            </td>

          </tr>
        </tbody>
      </table>

## Public Variables to Access Value

<table class="slds-table slds-table_bordered slds-max-medium-table_stacked slds-m-bottom_small ">
        <colgroup>
          <col>
          <col>
        </colgroup>
        <thead class="slds-text-title_caps ">
          <tr class="">
            <th scope="col" class="slds-cell-wrap" style="vertical-align:top;" id="d75847e251">
              <p style="margin-bottom:0;">Name</p>
            </th>
            <th scope="col" class="slds-cell-wrap" style="vertical-align:top;" id="d75847e257">
              <p style="margin-bottom:0;">Description</p>
            </th>
          </tr>
        </thead>
        <tbody>
          <tr class="">
            <td data-label="Name" class="slds-cell-wrap" style="vertical-align:top;" headers="d75847e251 ">
              <p style="margin-bottom:0;">maskedValue</p>
            </td>

            <td data-label="Description" class="slds-cell-wrap" style="vertical-align:top;" headers="d75847e257 ">
              <p style="margin-bottom:0;">Returns value with masking.</p>
            </td>

          </tr>
          <tr class="">
            <td data-label="Name" class="slds-cell-wrap" style="vertical-align:top;" headers="d75847e251 ">
              <p style="margin-bottom:0;">typedValue</p>
            </td>

            <td data-label="Description" class="slds-cell-wrap" style="vertical-align:top;" headers="d75847e257 ">
              <p style="margin-bottom:0;">Returns the valid value based on type.</p>
            </td>

          </tr>
          <tr class="">
            <td data-label="Name" class="slds-cell-wrap" style="vertical-align:top;" headers="d75847e251 ">
              <p style="margin-bottom:0;">unmaskedValue</p>
            </td>

            <td data-label="Description" class="slds-cell-wrap" style="vertical-align:top;" headers="d75847e257 ">
              <p style="margin-bottom:0;">Returns value without masking.</p>
            </td>

          </tr>
        </tbody>
      </table>

## To Note

- For the 'currency' and 'number' masks, the value of the _mask_ parameter must be `new Number()`, not `Number`. See Example _masked-input_Component on this page.
- For date, use `c-input` element where _type_ is set to 'date'.

## Example c-masked-input Component

```
<c-masked-input
  imask={maskAttrib}
  class="slds-p-top_small"
  theme={theme}
  label="InputMask"
  value="123456"
  type="text"
>
</c-masked-input>
```

```
maskAttrib ={
    mask: new Number(),
    thousandsSeparator: ',',
    radix: '.'
  }
```

## Label Slot Usage

A named slot (name = label) is available in the event a user would like to dynamically insert markup next to the input's label. This feature is not available for formula input.

```
<c-masked-input
  imask={maskAttrib}
  class="slds-p-top_small"
  theme={theme}
  label="InputMask"
  value="123456"
  type="text"
>
  <span slot="label">Additional markup is inserted here</span>
</c-masked-input>
```

## Vlocity Insurance and Health Winter '20 and Vlocity CME Spring '20

The _MaskedInput Lightning Web Component_ controls what you can enter in form input fields. The _MaskedInput Lightning Web Component_ extends the _Input Lightning Web Component_.

## Available c-masked-input Attributes

<table class="slds-table slds-table_bordered slds-max-medium-table_stacked slds-m-bottom_small ">
        <colgroup>
          <col>
          <col>
          <col>
          <col>
          <col>
        </colgroup>
        <thead class="slds-text-title_caps ">
          <tr class="">
            <th scope="col" class="slds-cell-wrap" style="vertical-align:top;" id="d75847e416">
              <p style="margin-bottom:0;">Attribute</p>
            </th>
            <th scope="col" class="slds-cell-wrap" style="vertical-align:top;" id="d75847e422">
              <p style="margin-bottom:0;">Value</p>
            </th>
            <th scope="col" class="slds-cell-wrap" style="vertical-align:top;" id="d75847e428">
              <p style="margin-bottom:0;">Type</p>
            </th>
            <th scope="col" class="slds-cell-wrap" style="vertical-align:top;" id="d75847e434">
              <p style="margin-bottom:0;">Required</p>
            </th>
            <th scope="col" class="slds-cell-wrap" style="vertical-align:top;" id="d75847e440">
              <p style="margin-bottom:0;">Description</p>
            </th>
          </tr>
        </thead>
        <tbody>
          <tr class="">
            <td data-label="Attribute" class="slds-cell-wrap" style="vertical-align:top;" headers="d75847e416 ">
              <p style="margin-bottom:0;">imask</p>
            </td>

            <td data-label="Value" class="slds-cell-wrap" style="vertical-align:top;" headers="d75847e422 ">
              <p style="margin-bottom:0;">JSON</p>
            </td>

            <td data-label="Type" class="slds-cell-wrap" style="vertical-align:top;" headers="d75847e428 ">
              <p style="margin-bottom:0;">object</p>
            </td>

            <td data-label="Required" class="slds-cell-wrap" style="vertical-align:top;" headers="d75847e434 ">
              <p style="margin-bottom:0;">yes</p>
            </td>

            <td data-label="Description" class="slds-cell-wrap" style="vertical-align:top;" headers="d75847e440 ">
              <p style="margin-bottom:0;">Contains the valid imask attribute JSON.</p>
            </td>

          </tr>
        </tbody>
      </table>

## Public Variables to Access Value

For possible use cases for the masked-input component, see [imask documentation](https://unmanner.github.io/imaskjs/guide.html).

<table class="slds-table slds-table_bordered slds-max-medium-table_stacked slds-m-bottom_small ">
        <colgroup>
          <col>
          <col>
        </colgroup>
        <thead class="slds-text-title_caps ">
          <tr class="">
            <th scope="col" class="slds-cell-wrap" style="vertical-align:top;" id="d75847e509">
              <p style="margin-bottom:0;">Name</p>
            </th>
            <th scope="col" class="slds-cell-wrap" style="vertical-align:top;" id="d75847e515">
              <p style="margin-bottom:0;">Description</p>
            </th>
          </tr>
        </thead>
        <tbody>
          <tr class="">
            <td data-label="Name" class="slds-cell-wrap" style="vertical-align:top;" headers="d75847e509 ">
              <p style="margin-bottom:0;">typedValue</p>
            </td>

            <td data-label="Description" class="slds-cell-wrap" style="vertical-align:top;" headers="d75847e515 ">
              <p style="margin-bottom:0;">Returns the valid value based on type.</p>
            </td>

          </tr>
          <tr class="">
            <td data-label="Name" class="slds-cell-wrap" style="vertical-align:top;" headers="d75847e509 ">
              <p style="margin-bottom:0;">unmaskedValue</p>
            </td>

            <td data-label="Description" class="slds-cell-wrap" style="vertical-align:top;" headers="d75847e515 ">
              <p style="margin-bottom:0;">Returns value without masking.</p>
            </td>

          </tr>
          <tr class="">
            <td data-label="Name" class="slds-cell-wrap" style="vertical-align:top;" headers="d75847e509 ">
              <p style="margin-bottom:0;">maskedValue</p>
            </td>

            <td data-label="Description" class="slds-cell-wrap" style="vertical-align:top;" headers="d75847e515 ">
              <p style="margin-bottom:0;">Returns value with masking.</p>
            </td>

          </tr>
        </tbody>
      </table>

- For the 'currency' and 'number' masks, the value of the _mask_ parameter must be `new Number()`, not `Number`. See Example _masked-input_ Component on this page.
- For date, use `c-input` element where _type_ is set to 'date'.

## Example c-masked-input Component

```
<c-masked-input
  imask="{maskAttrib}"
  class="slds-p-top_small"
  theme="{theme}"
  label="InputMask"
  value="123456"
  type="text"
>
</c-masked-input>
```

```
  maskAttrib ={
    mask: new Number(),
    thousandsSeparator: ',',
    radix: '.'
  }
```

## Vlocity Insurance and Health Summer '19 and Vlocity CME Fall '19

The _MaskedInput Lightning Web Component_ controls what you can enter in form input fields. The _MaskedInput Lightning Web Component_ extends the_Input Lightning Web Component_.

## Available c-masked-input Attributes

<table class="slds-table slds-table_bordered slds-max-medium-table_stacked slds-m-bottom_small ">
        <colgroup>
          <col>
          <col>
          <col>
          <col>
          <col>
        </colgroup>
        <thead class="slds-text-title_caps ">
          <tr class="">
            <th scope="col" class="slds-cell-wrap" style="text-align:left;vertical-align:top;" id="d75847e656">
              <p style="margin-bottom:0;">Attribute</p>
            </th>
            <th scope="col" class="slds-cell-wrap" style="text-align:left;vertical-align:top;" id="d75847e662">
              <p style="margin-bottom:0;">Value</p>
            </th>
            <th scope="col" class="slds-cell-wrap" style="text-align:left;vertical-align:top;" id="d75847e668">
              <p style="margin-bottom:0;">Type</p>
            </th>
            <th scope="col" class="slds-cell-wrap" style="text-align:left;vertical-align:top;" id="d75847e674">
              <p style="margin-bottom:0;">Required</p>
            </th>
            <th scope="col" class="slds-cell-wrap" style="text-align:left;vertical-align:top;" id="d75847e680">
              <p style="margin-bottom:0;">Description</p>
            </th>
          </tr>
        </thead>
        <tbody>
          <tr class="">
            <td data-label="Attribute" class="slds-cell-wrap" style="text-align:left;vertical-align:top;" headers="d75847e656 ">
              <p style="margin-bottom:0;">imask</p>
            </td>

            <td data-label="Value" class="slds-cell-wrap" style="text-align:left;vertical-align:top;" headers="d75847e662 ">
              <p style="margin-bottom:0;">JSON</p>
            </td>

            <td data-label="Type" class="slds-cell-wrap" style="text-align:left;vertical-align:top;" headers="d75847e668 ">
              <p style="margin-bottom:0;">object</p>
            </td>

            <td data-label="Required" class="slds-cell-wrap" style="text-align:left;vertical-align:top;" headers="d75847e674 ">
              <p style="margin-bottom:0;">yes</p>
            </td>

            <td data-label="Description" class="slds-cell-wrap" style="text-align:left;vertical-align:top;" headers="d75847e680 ">
              <p style="margin-bottom:0;">Contains the valid imask attribute JSON.</p>
            </td>

          </tr>
        </tbody>
      </table>

## Public Variables to Access Value

For possible use cases for the masked-input component, see [imask documentation](https://unmanner.github.io/imaskjs/guide.html).

<table class="slds-table slds-table_bordered slds-max-medium-table_stacked slds-m-bottom_small ">
        <colgroup>
          <col>
          <col>
        </colgroup>
        <thead class="slds-text-title_caps ">
          <tr class="">
            <th scope="col" class="slds-cell-wrap" style="text-align:left;vertical-align:top;" id="d75847e749">
              <p style="margin-bottom:0;">Name</p>
            </th>
            <th scope="col" class="slds-cell-wrap" style="text-align:left;vertical-align:top;" id="d75847e755">
              <p style="margin-bottom:0;">Description</p>
            </th>
          </tr>
        </thead>
        <tbody>
          <tr class="">
            <td data-label="Name" class="slds-cell-wrap" style="text-align:left;vertical-align:top;" headers="d75847e749 ">
              <p style="margin-bottom:0;">typedValue</p>
            </td>

            <td data-label="Description" class="slds-cell-wrap" style="text-align:left;vertical-align:top;" headers="d75847e755 ">
              <p style="margin-bottom:0;">Returns the valid value based on type.</p>
            </td>

          </tr>
          <tr class="">
            <td data-label="Name" class="slds-cell-wrap" style="text-align:left;vertical-align:top;" headers="d75847e749 ">
              <p style="margin-bottom:0;">unmaskedValue</p>
            </td>

            <td data-label="Description" class="slds-cell-wrap" style="text-align:left;vertical-align:top;" headers="d75847e755 ">
              <p style="margin-bottom:0;">Returns value without masking.</p>
            </td>

          </tr>
          <tr class="">
            <td data-label="Name" class="slds-cell-wrap" style="text-align:left;vertical-align:top;" headers="d75847e749 ">
              <p style="margin-bottom:0;">maskedValue</p>
            </td>

            <td data-label="Description" class="slds-cell-wrap" style="text-align:left;vertical-align:top;" headers="d75847e755 ">
              <p style="margin-bottom:0;">Returns value with masking.</p>
            </td>

          </tr>
        </tbody>
      </table>

## To Note

- For the ``currency' and `number' masks, the value of the _mask_ parameter must be `new Number()``, not `Number`. See Example _masked-input_ Component on this page.
- For date, use `c-input` element where _type_ is set to \`date'.

## Example c-masked-input Component

```
<c-masked-input
  imask="{maskAttrib}"
  class="slds-p-top_small"
  theme="{theme}"
  label="InputMask"
  value="123456"
  type="text"
>
</c-masked-input>
```

```
  maskAttrib ={
    mask: new Number(),
    thousandsSeparator: ',',
    radix: '.'
  }
```