SheetXL - v0.8.0-beta.9+sites.210.e2d420901
    Preparing search index...

    Interface UseFormulaInputPartsOptions

    interface UseFormulaInputPartsOptions {
        api: FormulaInputApi;
        argument?: FormulaArgument | null;
        disabled?: boolean;
        grammar: FormulaInputGrammar;
        home?: Partial<CellCoords>;
        workbook?: IWorkbook | null;
    }
    Index

    The headless field API driving this chrome (useFormulaInput).

    argument?: FormulaArgument | null

    The call argument the field's whole text is — see UseFormulaHintsOptions.getArgument. An empty field then offers the values its parameter is limited to.

    disabled?: boolean

    Disabled fields render plain glyphs — no overlay, no tip.

    The two grammars a formula-backed field can enforce.

    • 'formula' — any formula expression (=SUM(A1:A5)*2). The field text is one expression; the picker projects the expression's REFERENCES (per token) and a pick re-scopes the caret's reference or splices a new one at the caret — the formula editor's point model.
    • 'reference' — a pure reference list (Sheet1!A1:B2, Sheet2!C1). The field text is comma-joined reference segments; the picker projects the SEGMENTS (segment index = picker range index) and a pick re-scopes/appends a segment. Function calls and computed expressions are invalid — the field accepts only what ICalculation.IFormula.isReferenceOnly holds for (Excel's RefEdit contract: OFFSET/INDIRECT-style computed references are not accepted; those belong in a 'formula' field, e.g. a name's refers-to).
    home?: Partial<CellCoords>

    The formula's HOME anchor ('formula' grammar) — bare references evaluate against it.

    workbook?: IWorkbook | null

    Resolution context for the 'formula'-grammar eval tip. Defaults to the enclosing WorkbookContext (the same resolution the headless core applies).