Kvaser CanKing GUI Extensions SDK - v7.3.0
    Preparing search index...

    Interface TextControlProps

    Properties of the TextControl React component.

    interface TextControlProps {
        disabled?: boolean;
        endAdornment?: ReactNode;
        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?: ReactNode;
        sx?: SxProps<Theme>;
        sxEndAdornment?: SxProps<Theme>;
        sxStartAdornment?: SxProps<Theme>;
        value: string;
    }
    Index

    Properties

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

    Properties

    disabled?: boolean

    Set to true to disable this control.

    endAdornment?: ReactNode

    A text or component to be displayed after the value.

    error?: boolean

    The current error state.

    fullWidth?: boolean

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

    helperText?: string

    Any helper text that should be displayed.

    id?: string

    The component id.

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

    Input mode.

    label?: string

    The label of this input control.

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

    Margins between controls inside this control.

    onBlur?: () => void

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

    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

    pattern?: string

    Regex pattern of the value in this control.

    required?: boolean

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

    size?: "small" | "medium"

    The component size.

    startAdornment?: ReactNode

    A text or component to be displayed in front of the value.

    sx?: SxProps<Theme>

    Optional sx properties.

    sxEndAdornment?: SxProps<Theme>

    Optional sx properties for the end adornment.

    sxStartAdornment?: SxProps<Theme>

    Optional sx properties for the start adornment.

    value: string

    The current value.

    Settings

    Member Visibility

    On This Page

    Properties