---
title: "au-widget-input-text/IInputTextConfig | Customer's Canvas On-Premises"
canonical: "https://customerscanvas.com/docs/on-premises/ui-framework/widgets/reference/au-widget-input-text.IInputTextConfig/"
---

# au-widget-input-text/IInputTextConfig

> Provides properties for an input field.

## Interfaces

### IInputTextConfig

You can use these properties in **params** of the `AuWidgetInputText` class.
```json
{
  "widgets": [
    {
      "name": "quantity",
      "title": "Quantity",
      "type": "input-text",
      "params": {
        "defaultValue": "{{ order.quantity }}",
        "placeholder": "Quantity",
        "type": "number",
        "min": "1"
      }
    }
  ]
}
```

#### Properties

##### defaultValue?

```ts
optional defaultValue?: string | number;
```

The default value of the widget, either a string or number. By default, this is an empty string.

##### isNumber?

```ts
optional isNumber?: boolean;
```

##### isTextArea?

```ts
optional isTextArea?: boolean;
```

If `true`, enables a text area instead of single-line text. The default value is `false`.

##### label?

```ts
optional label?: string;
```

A label of the widget. By default, this is an empty string.

##### max?

```ts
optional max?: number;
```

The max value for the `number` type. The default value is `999999`.

##### maxLength?

```ts
optional maxLength?: number;
```

The max text length.

##### min?

```ts
optional min?: number;
```

The min value for the `number` type. The default value is `-999999`.

##### onChange?

```ts
optional onChange?: Function | Function[];
```

A function (`"{{#function <expression>}}"`) or an array of functions. This event triggers when the user changes the text in the widget.

##### pattern?

```ts
optional pattern?: string;
```

A regular expression to limit input.

##### patternFlags?

```ts
optional patternFlags?: string;
```

##### placeholder?

```ts
optional placeholder?: string;
```

A string that is displayed as a hint. By default, this is an empty string.

##### prompt?

```ts
optional prompt?: string;
```

_Deprecated, use `placeholder` instead. By default, this is an empty string.

##### rows?

```ts
optional rows?: number;
```

The widget height in rows if the text area mode is on. The default value is `2`.

##### supportText?

```ts
optional supportText?: string;
```

An optional string. By default, this is an empty string.

##### supportTextPosition

```ts
supportTextPosition: SupportTextPosition;
```

##### type?

```ts
optional type?: string;
```

The widget type, either `"number"` or `"text"`. The default value is `"text"`.

##### value?

```ts
optional value?: string | number;
```

The current value of the widget if it's used for entering text.