TextInput

Source@react-form-builder/components-mantine

Introduction

The TextInput component is a versatile single-line text input field that allows users to enter and edit text. It provides a customizable alternative to native HTML input controls and can be used to collect various types of user input such as names, email addresses, or search queries.

The TextInput component is based on Mantine TextInput. It is included within the following NPM package: @react-form-builder/components-mantine.

The TextInput component can be styled and configured to fit specific design and functionality requirements by using various properties that are presented and described below.

Main properties

The following general properties are available within the Main tab:

Name	Type	Description
Label	string	Text displayed as the label for the input
Value	string	The current value of the input (data-bound)
Placeholder	string	Placeholder text when the input is empty
Description	string	Helper text displayed below the input
Error	string	Error message; when set, applies error styling
Type	'text' | 'password' | 'email' | 'number' | 'search' | 'tel' | 'url' | 'time'	The input type
Size	'xs' | 'sm' | 'md' | 'lg' | 'xl'	The size of the input
Variant	'filled' | 'default' | 'unstyled'	The visual variant
Disabled	boolean	Disables the input, making it non-interactive
Read only	boolean	Makes the input read-only
With asterisk	boolean	Shows a required indicator next to the label
On change	event	Fired when the value changes
On focus	event	Fired when the input receives focus
On blur	event	Fired when the input loses focus

At the bottom of the Main properties menu, you can find additional options:

• Render When: Provides conditional rendering for your component as described in the corresponding chapter.
• HTML attributes: Allows you to provide custom HTML attributes for your form.

Style properties

These are properties that allow to customize the size, color and other style properties of your component:

• For Device: You can provide component's style customization for all devices or specific devices by using this dropdown list. Refer to Adaptive Layout for more details.

• Component > Class Name: Add a class name for your component for the subsequent styling if necessary.

• Wrapper: The options below enable you to tailor the appearance of your component and customize it for a specific device type, as selected in the For Device property:

  Name	Type	Description
  Width	number	Specifies the width for your component
  Height	number	Specifies the height for your component
  Margin top/right/bottom/left	number	Margin values for you component
  Color	string	Allows customizing the text color
  Background color	string	Enables customizing the background color