Interface TextControlProps

Properties of the TextControl React component.

interface TextControlProps {
    disabled?: boolean;
    endAdornment?: string;
    error?: boolean;
    fullWidth?: boolean;
    helperText?: string;
    id?: string;
    inputMode?:
        | "search"
        | "text"
        | "none"
        | "tel"
        | "url"
        | "email"
        | "numeric"
        | "decimal";
    label?: string;
    margin?: "none"
    | "normal"
    | "dense";
    onBlur?: () => void;
    onChange?: (value: string) => void;
    pattern?: string;
    required?: boolean;
    size?: "small" | "medium";
    startAdornment?: string;
    sx?: SxProps<Theme>;
    sxEndAdornment?: SxProps<Theme>;
    sxStartAdornment?: SxProps<Theme>;
    value: string;
}

Properties

disabled? endAdornment? error? fullWidth? helperText? id? inputMode? label? margin? onBlur? onChange? pattern? required? size? startAdornment? sx? sxEndAdornment? sxStartAdornment? value

Properties

Optionaldisabled

disabled?: boolean

Set to true to disable this control.

OptionalendAdornment

endAdornment?: string

A text to be displayed after the value.

Optionalerror

error?: boolean

The current error state.

OptionalfullWidth

fullWidth?: boolean

Set to true to expand this control to use the full widht of its parent.

OptionalhelperText

helperText?: string

Any helper text that should be displayed.

Optionalid

id?: string

The component id.

OptionalinputMode

inputMode?:
    | "search"
    | "text"
    | "none"
    | "tel"
    | "url"
    | "email"
    | "numeric"
    | "decimal"

Input mode.

Optionallabel

label?: string

The label of this input control.

Optionalmargin

margin?: "none" | "normal" | "dense"

Margins between controls inside this control.

OptionalonBlur

onBlur?: () => void

Callback that will be called when the control has lost focus.

OptionalonChange

onChange?: (value: string) => void

Callback that will be called when the value has been changed.

Type declaration

    • (value: string): void

    • Parameters

      • value: string

        The new value.

      Returns void

Optionalpattern

pattern?: string

Regex pattern of the value in this control.

Optionalrequired

required?: boolean

Set to true if this control's value is required.

Optionalsize

size?: "small" | "medium"

The component size.

OptionalstartAdornment

startAdornment?: string

A text to be displayed in front of the value.

Optionalsx

sx?: SxProps<Theme>

Optional sx properties.

OptionalsxEndAdornment

sxEndAdornment?: SxProps<Theme>

Optional sx properties for the end adornment.

OptionalsxStartAdornment

sxStartAdornment?: SxProps<Theme>

Optional sx properties for the start adornment.

value

value: string

The current value.

Settings

Member Visibility

On This Page

Properties