# Masked Input

The live `masked` field uses the jQuery Masked Input plugin.

## Common Configuration Properties

| Property                   | Type      | Description                                           |
| -------------------------- | --------- | ----------------------------------------------------- |
| `type`                     | `String`  | Must be `"masked"`                                    |
| `label`                    | `String`  | Field label                                           |
| `model`                    | `String`  | Model key that stores the input value                 |
| `placeholder`              | `String`  | Placeholder text                                      |
| `disabled`                 | `Boolean` | Disables the input                                    |
| `readonly`                 | `Boolean` | Makes the input read-only                             |
| `fieldOptions.mask`        | `String`  | Mask pattern passed to `$(el).mask(...)`              |
| `fieldOptions.maskOptions` | `Object`  | Optional plugin options passed as the second argument |

## Example Schema Snippet

```json
{
  "type": "masked",
  "label": "Phone Number",
  "model": "userPhoneNumber",
  "placeholder": "(999) 999-9999",
  "fieldOptions": {
    "mask": "(999) 999-9999"
  }
}
```

## Runtime Notes

* The component requires the jQuery Masked Input library to be loaded globally.
* On mount, the component runs `unmask().mask(fieldOptions.mask, fieldOptions.maskOptions)`.
* On destroy, it removes the mask with `unmask()`.

## Full Property Reference

This element is implemented in the sibling `vue-form-generator` source as `fieldMasked.vue` and uses the jQuery Masked Input plugin.


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.klai.studio/reference/components-overview/betterforms-elements/masked.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.