# Input (string)

## **Look\&Feel Settings:**

**Label** (not mandatory) - label for input.

**Default value** (not mandatory) - input default value.

**Placeholder** (not mandatory) - placeholder for input.

**Name** (mandatory) - name of the input.

**Tooltip** (not mandatory) - hint for input.

**Required** (mandatory) - makes the field mandatory. Disabled by default.

**Allow clear** (mandatory) - icon to clear the input. Disabled by default.

**Validate icon** (mandatory) - validate icon for input. Disabled by default.

**Disabled** (mandatory) - makes the component disabled if turned on. Is turned off by default.

**Visible** (mandatory) - makes the component visible if turned on. Enabled by default.

![](https://3563768697-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MapxHzVskQ_27pNUTT4-1972196547%2Fuploads%2FOoCwz1hPjrhcBJRxFMCo%2Fimage.png?alt=media\&token=5383e2d6-88c2-4bf0-814e-352a6d7a70fe)

## **Workflow triggers:**

* **onCreate** – fires when the element is created on the page; 
* **onShow** – fires when the component changes its state to visible (displayed on the page); 
* **onHide** – fires when the component changes its state to hidden (stops being displayed); 
* **onDestroy** – fires before the component is destroyed;
* **onChange** - fires when the value is changed;
* **onFocus** - fires when component is being focused;
* **onBlur** - fires when component is blurred;
* **onEnterKey** - fires when Enter is pressed.

## Component Actions

### InputString Get Properties

Gets the component's properties.

**Input** parameters:

* **Component Id** \[string] *-* input component's identifier.

**Output** parameters:

* **Label** \[*string*] - input label;
* **Placeholder** \[*string*] - input placeholder;
* **Allow clear** \[*boolean*] - state of allow clear;
* **Disable** \[*boolean*] - disables component if *true*;
* **Visible** \[*boolean*] - component visibility state;
* **Tooltip** \[*string*] - input field hint;
* **Required** \[*boolean*] - shows required mark if *true*;
* **Debounce** (ms) \[*integer*] - delay to validate the value; 
* **Value** \[*string*] - value from input;
* **Validate Icon** \[*boolean*] - icon to be shown on validate the value;
* **Validate Status** \[*Status type*] - status to be shown on validate the value; 
* **Validate Message** \[*string*] - message to be shown on validate the value.

![](https://3563768697-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MapxHzVskQ_27pNUTT4-1972196547%2Fuploads%2FZuwIBcVF3j0x5pRWDEGp%2Fimage.png?alt=media\&token=62897160-ce3f-4365-b98e-b91b4975bf9d)

### InputString Set Properties

Sets the component's properties.

**Input** parameters:

* **Component Id** \[string] *-* input component's identifier;
* **Label** \[*string*] - input label;
* **Placeholder** \[*string*] - input placeholder;
* **Allow clear** \[*boolean*] - state of allow clear;
* **Disable** \[*boolean*] - disables component if *true*;
* **Visible** \[*boolean*] - component visibility state;
* **Tooltip** \[*string*] - input field hint;
* **Required** \[*boolean*] - shows required mark if *true*;
* **Debounce** (ms) \[*integer*] - delay to validate the value; 
* **Value** \[*string*] - value from input;
* **Validate Icon** \[*boolean*] - icon to be shown on validate the value;
* **Validate Status** \[*Status type*] - status to be shown on validate the value; 
* **Validate Message** \[*string*] - message to be shown on validate the value.

![](https://3563768697-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MapxHzVskQ_27pNUTT4-1972196547%2Fuploads%2F3wop7062tQouwvHXXtCo%2Fimage.png?alt=media\&token=adb83723-158f-4cce-9bd2-4647e13234da)

### InputString Update Properties

Update the component's properties.

**Input** parameters:

* **Component Id** \[string] *-* input component's identifier;
* **Label** \[*string*] - input label;
* **Placeholder** \[*string*] - input placeholder;
* **Allow clear** \[*boolean*] - state of allow clear;
* **Disable** \[*boolean*] - disables component if *true*;
* **Visible** \[*boolean*] - component visibility state;
* **Tooltip** \[*string*] - input field hint;
* **Required** \[*boolean*] - shows required mark if *true*;
* **Debounce** (ms) \[*integer*] - delay to validate the value; 
* **Value** \[*string*] - value from input;
* **Validate Icon** \[*boolean*] - icon to be shown on validate the value;
* **Validate Status** \[*Status type*] - status to be shown on validate the value; 
* **Validate Message** \[*string*] - message to be shown on validate the value.

![](https://3563768697-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MapxHzVskQ_27pNUTT4-1972196547%2Fuploads%2F2Ean0hq2ZM8MoxEIhLnR%2Fimage.png?alt=media\&token=0afb28f4-72c2-4cf6-8a66-5e6b1db27ebe)

## Usage example

Most often, the inputstring is used in forms for working with records in the database.

![](https://3563768697-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MapxHzVskQ_27pNUTT4-1972196547%2Fuploads%2FEieXqOFkcgoWIu8pssJj%2Fimage.png?alt=media\&token=82d45f75-308e-4fa2-b5a5-074f1f73b2d7)