Text

A text field is used to input textual data.

text('My text field', {
  help: 'This is an example field',
  multiline: true
})

/**

Optional settings to configure a text field */

export type TextOptions

{

/**

Focus this input automatically */

autoFocus: boolean

/**

Add instructional text to a field */

help: Label

/**

An icon (React component) to display on the left side of the input */

iconLeft: ComponentType

/**

An icon (React component) to display on the right side of the input */

iconRight: ComponentType

/**

A default value */

initialValue: string

/**

Display a minimal version */

inline: boolean

/**

Allow line breaks */

multiline: boolean

/**

Field is optional */

optional: boolean

/**

Width of the field in the dashboard UI (0-1) */

width: number

}