featherbit UI
    Preparing search index...

    Interface TemplateTokenArgs

    Args accepted by useTemplateToken.

    interface TemplateTokenArgs {
        elRef: RefObject<HTMLInputElement | HTMLTextAreaElement | null>;
        legacyDollar: boolean;
        onChange: (v: string) => void;
        suggestions: Suggestion[];
        templateMode: "full" | "env-only";
        value: string;
    }
    Index
    elRef legacyDollar onChange suggestions templateMode value
    elRef: RefObject<HTMLInputElement | HTMLTextAreaElement | null>

    Ref to the underlying <input>/<textarea> — used to read/restore the caret.

    legacyDollar: boolean

    Whether this field also accepts legacy $name/${name} completions.

    onChange: (v: string) => void

    Called with the full replacement value on insert.

    suggestions: Suggestion[]

    Candidate rows; filtered here by the in-progress token, templateMode, and trigger.

    templateMode: "full" | "env-only"

    See VarInput's templateMode prop doc comment.

    value: string

    Current field value (controlled).

    Settings
    Member Visibility

    On This Page
    Properties