Interface SingleLineTextProps

Hierarchy

Properties

autoComplete? autoFocus? className? defaultValue? disabled? error? id? inlineMode? innerRef? inputProps? isSet? label? name onBlur? onChange? onFocus? placeholder? tooltipContent? type? value?

Properties

Optional autoComplete

autoComplete?: "on" | "off"

Whether or not the control supports auto complete

Optional autoFocus

autoFocus?: boolean

Whether or not the control should start focused (default: false)

Optional className

className?: string

CSS Class name for additional styles

Optional defaultValue

defaultValue?: string | number | readonly string[]

Default value for the form control

Optional disabled

disabled?: boolean

Whether or not the control is disabled (default: false)

Optional error

error?: string

If set, indicates the control has an error and will display this prop as the error message

Optional id

id?: string

Form control id

Optional inlineMode

inlineMode?: boolean

Hide options not needed in the “inline” scenario

Optional innerRef

innerRef?: RefObject<HTMLInputElement>

Optional inputProps

inputProps?: InputHTMLAttributes<HTMLInputElement>

Additional props to be passed to the input element.

Optional isSet

isSet?: boolean

This property is only used in combination with type='password'.

Use this to signalize the textbox whether it should act like a value is already set, eventhough the actual value is empty. This is useful if the backend just indicates that a password is set, but doesn't give out the actual value.

Optional label

label?: string

Form control label

name

name: string

Name of form control, required and must be unique from other form control names. This name should match the the name of the object corresponding to this control.

Optional onBlur

onBlur?: ((event) => void)

Type declaration

    • (event): void

    • Raised when the element has been selected

      Parameters

      • event: ChangeEvent<HTMLInputElement>

      Returns void

Optional onChange

onChange?: ((event) => void)

Type declaration

    • (event): void

    • Raised when the value has changed

      Parameters

      • event: ChangeEvent<HTMLInputElement>

      Returns void

Optional onFocus

onFocus?: ((event) => void)

Type declaration

    • (event): void

    • Raised when the element has been de-selected

      Parameters

      • event: ChangeEvent<HTMLInputElement>

      Returns void

Optional placeholder

placeholder?: string

Input placeholder

Optional tooltipContent

tooltipContent?: ReactNode

A tooltip of additional information

Optional type

type?: "number" | "text" | "password"

Input element type

Optional value

value?: string | number | readonly string[]

Current value the form control has

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc