Text Input

Text inputs are box-shaped input fields that helps the user enter data to communicate to the machine, a system or a product.

Sizes

Control the size of an text input to set size attribute to small, medium or large value. By default, the text input has size medium.

<QtmTextInput size="small" leftIcon="account_circle" placeholder="Small" />
<QtmTextInput size="medium" leftIcon="account_circle" placeholder="Medium" />
<QtmTextInput size="large" leftIcon="account_circle" placeholder="Large" />

Disabled

Add disabled in text input to disable this element.

<QtmTextInput
  leftIcon="account_circle"
  placeholder="Text Input"
  disabled
  classes="w-23xl"
/>

Icons

You can combine a input with icon(s), using leftIcon and rightIcon attribute with a name of icon in the material icon website

<QtmTextInput size="small" leftIcon="account_circle" placeholder="Text Input" />
<QtmTextInput size="medium" rightIcon="check_circle" placeholder="Text Input" />
<QtmTextInput
  size="large"
  leftIcon="account_circle"
  rightIcon="check_circle"
  placeholder="Text Input"
/>

Custom icon

To select an appropriate icon, please consult the Icon component documentation.

Both the left icon and right icon can be either a string or having the following interface:

interface IconProps = {
  icon: string,
  classes?: string,
  lib?: IconLibType,
  size?: IconSizeType,
  variant?: IconVariantType,
};

<QtmTextInput
  placeholder="Text Input"
  classes="w-23xl"
  leftIcon={{ icon: 'applied_settings', lib: 'business' }}
/>

Severity validation

Error

Set severity property to error to change container border color and right-icon color in error severity.

<QtmTextInput
  leftIcon="email"
  rightIcon="check_circle"
  placeholder="Text Input"
  severity="error"
  classes="w-23xl"
/>

Warning

Set severity property to warning to change container border color and right-icon color in warning severity.

<QtmTextInput
  leftIcon="vpn_key"
  rightIcon="warning"
  placeholder="Text Input"
  severity="warning"
  classes="w-23xl"
/>

Success

Set severity property to success to change right-icon color in success severity.

<QtmTextInput
  leftIcon="vpn_key"
  rightIcon="check_circle"
  placeholder="Text Input"
  severity="success"
  classes="w-23xl"
/>

<input> attributes

You can apply any standard <input> attributes (e.g., maxlength, type, etc.) to the Text Input component through the props property.

<QtmTextInput
  placeholder="Text Input"
  classes="w-23xl"
  props={{ maxlength: '5', type: 'password' }}
/>

Value

You can control value of the input by using value attribute.

<QtmTextInput
  placeholder="Text Input"
  name="text-input"
  value="Hello world!"
  classes="w-23xl"
/>

API

Loading API documentation...