Skip to main content

TextFieldProps

Home > @backstage/canon > TextFieldProps

Signature:

export interface TextFieldProps extends Omit<React.ComponentPropsWithoutRef<'input'>, 'size'> 

Extends: Omit<React.ComponentPropsWithoutRef<'input'>, 'size'>

Properties

Property

Modifiers

Type

Description

className?

string

(Optional) The class name of the text field

description?

string

(Optional) The description of the text field

error?

string | null

(Optional) The error message of the text field

icon?

ReactNode

(Optional) An icon to render before the input

label?

string

(Optional) The label of the text field

name

string

The name of the text field

onClear?

MouseEventHandler<HTMLButtonElement>

(Optional) Handler to call when the clear button is pressed

size?

'small' | 'medium' | Partial<Record<Breakpoint, 'small' | 'medium'>>

(Optional) The size of the text field