Pilates
    Preparing search index...

    Interface TextInputProps

    interface TextInputProps {
        autoFocus?: boolean;
        focus?: boolean;
        focusId?: string;
        mask?: string;
        onChange: (value: string) => void;
        onSubmit?: (value: string) => void;
        placeholder?: string;
        value: string;
    }
    Index

    Properties

    autoFocus? focus? focusId? mask? onChange onSubmit? placeholder? value

    Properties

    autoFocus?: boolean

    When focusId is set, take focus on mount if no other focusable currently holds it. Ignored when focusId is undefined.

    focus?: boolean

    Default true. When false, does not consume keystrokes and does not render a cursor. Ignored when focusId is set — focus state then comes from the useFocus registration instead.

    focusId?: string

    Register this input with useFocus(id) so the surrounding <FocusProvider> (auto-installed by render()) can route Tab / Shift+Tab cycling through it. When set, focus is ignored and the keystroke gate comes from the manager's focused id.

    mask?: string

    If set, renders this character in place of every visible grapheme. Single grapheme only.

    onChange: (value: string) => void

    Called on every value change. Required.

    onSubmit?: (value: string) => void

    Called on Enter.

    placeholder?: string

    Rendered with <Text dim> when value === ''.

    value: string

    Controlled value. Required.

    Settings

    Member Visibility

    On This Page

    Properties