v6.0.35

TextInput

Capture string input from user
Import
Source
View source code
Docs
Edit this page
Package
@asuikit/core

Usage

Radius
xs
sm
md
lg
xl
Size
xs
sm
md
lg
xl
import { TextInput } from '@asuikit/core';


function Demo() {
  return (
    <TextInput
      placeholder="Your name"
      label="Full name"
      withAsterisk
    />
  );
}

Controlled

import { useState } from 'react';
import { TextInput } from '@asuikit/core';


function Demo() {
  const [value, setValue] = useState('');
  return <TextInput value={value} onChange={(event) => setValue(event.currentTarget.value)} />;
}

Invalid state and error

Invalid email
// Error as boolean – red border color
<TextInput error />


// Error as React node – red border color and message below input
<TextInput error="Invalid email" />

Disabled state

import { TextInput } from '@asuikit/core';


function Demo() {
  return <TextInput disabled />;
}

With icon

import { TextInput } from '@asuikit/core';
import { IconAt } from '@tabler/icons-react';


function Demo() {
  return <TextInput label="Your email" placeholder="Your email" icon={<IconAt size="0.8rem" />} />;
}

With right section

import { TextInput, Loader } from '@asuikit/core';


function Demo() {
  return <TextInput label="Your email" placeholder="Your email" rightSection={<Loader size="xs" />} />;
}

Get input ref

import { useRef } from 'react';
import { TextInput } from '@asuikit/core';


function Demo() {
  const ref = useRef<HTMLInputElement>(null);
  return <TextInput ref={ref} />;
}

Accessibility

Provide aria-label in case you use component without label for screen reader support:

<TextInput /> // -> not ok, input is not labeled
<TextInput label="My input" /> // -> ok, input and label is connected
<TextInput aria-label="My input" /> // -> ok, label is not visible but will be announced by screen reader
Go back
Textarea – @asuikit/core
Up next
TransferList – @asuikit/core

TextInput component props

NameTypeDescription
description
ReactNode
Input description, displayed after label
descriptionProps
Record<string, any>
Props spread to description element
disabled
boolean
Disabled input state
error
ReactNode
Displays error message after input
errorProps
Record<string, any>
Props spread to error element
icon
ReactNode
Adds icon on the left side of input
iconWidth
Width<string | number>
Width of icon section
inputContainer
(children: ReactNode) => ReactNode
Input container component, defaults to React.Fragment
inputWrapperOrder
("input" | "label" | "error" | "description")[]
Controls order of the Input.Wrapper elements
label
ReactNode
Input label, displayed before input
labelProps
Record<string, any>
Props spread to label element
placeholder
string
radius
number | "xs" | "sm" | "md" | "lg" | "xl"
Key of theme.radius or any valid CSS value to set border-radius, theme.defaultRadius by default
required
boolean
Sets required on input element
rightSection
ReactNode
Right section of input, similar to icon but on the right
rightSectionProps
Record<string, any>
Props spread to rightSection div element
rightSectionWidth
Width<string | number>
Width of right section, is used to calculate input padding-right
size
"xs" | "sm" | "md" | "lg" | "xl"
Input size
type
HTMLInputTypeAttribute
Input element type
variant
Variants<"unstyled" | "default" | "filled">
Defines input appearance, defaults to default in light color scheme and filled in dark
withAsterisk
boolean
Determines whether required asterisk should be rendered, overrides required prop, does not add required attribute to the input
wrapperProps
Record<string, any>
Props passed to root element (InputWrapper component)

TextInput component Styles API

NameStatic selectorDescription
wrapper.asuikit-TextInput-wrapperRoot Input element
icon.asuikit-TextInput-iconInput icon wrapper on the left side of the input, controlled by icon prop
input.asuikit-TextInput-inputMain input element
rightSection.asuikit-TextInput-rightSectionInput right section, controlled by rightSection prop
root.asuikit-TextInput-rootRoot element
label.asuikit-TextInput-labelLabel element styles, defined by label prop
error.asuikit-TextInput-errorError element styles, defined by error prop
description.asuikit-TextInput-descriptionDescription element styles, defined by description prop
required.asuikit-TextInput-requiredRequired asterisk element styles, defined by required prop
Learn more about Styles API
Build fully functional accessible web applications faster than ever
About
ContributeAbout MantineChangelogReleases
Community
Chat on DiscordFollow on TwitterFollow on GitHubGitHub discussions
Project
Mantine UIDocumentationGitHub organizationnpm organization
Built by Vitaly Rtishchev and these awesome people
Join Discord community
Follow Mantine on Twitter