UI

Text Input

Field to enter and submit textual input.

Import TextInput

Tremor exports one component for text input.

import { TextInput } from '@tremor/react';

Usage example

The example below shows text input examples with an icon property, error message and a disabled state.

Wrong username

API Reference: TextInput

client component
type
text | password | email | url

Default: text

The type of the input field.
defaultValue
string
The default of TextInput when it is initially rendered. Use when you do not need to control its state.
value
string
The controlled state of TextInput. Must be used in conjunction with onChange.
onValueChange
(value: string) => void
Event handler called when the state of the input changes.
placeholder
string

Default: Type...

Sets the placehoder text
icon
React.Element

Default: -

Set an icon.
error
boolean

Default: false

If true, the text input is labeled as invalid.
errorMessage
string
Text to be displayed if the error prop is set to `true`.
disabled
boolean

Default: false

If true, the text input will be disabled.

Theming

Text Input

Roundness
borderRadiustremor-default
Shadow
boxShadowtremor-input
Font size
fontSizetremor-default
Border color
colorstremor-border-DEFAULT
Border color focus
colorstremor-brand-subtle
Ring color focus
colorstremor-brand-muted
Icon
colorstremor-content-subtle
Background color
colorstremor-background-DEFAULT
Background color disabled
colorstremor-background-subtle
Background color hover
colorstremor-background-muted
Text color placeholder
colorstremor-content-DEFAULT
Text color input
colorstremor-content-emphasis
Text color disabled
colorstremor-content-muted