docx
    Preparing search index...

    Type Alias MathBracketsOptions

    MathBracketsOptions: {
        close?: string;
        grow?: boolean;
        open?: string;
        separator?: string;
    } & (
        | { children: readonly MathComponent[]; items?: never }
        | { children?: never; items: readonly (readonly MathComponent[])[] }
    )

    Options for MathBrackets: the brackets, and what goes between them.

    Type Declaration

    • Optional Readonlyclose?: string

      The closing bracket: one character, or "" for none (m:endChr).

      ")"
      
    • Optional Readonlygrow?: boolean

      Whether the brackets grow to the height of what they hold (m:grow). LibreOffice and Pages always grow them.

      true
      
    • Optional Readonlyopen?: string

      The opening bracket: one character, such as "|" or "⟨", or "" for none (m:begChr).

      "("
      
    • Optional Readonlyseparator?: string

      The character between items, such as "," (m:sepChr).

      "|"
      
    • { children: readonly MathComponent[]; items?: never }
      • Readonlychildren: readonly MathComponent[]

        What goes between the brackets

      • Optional Readonlyitems?: never
    • { children?: never; items: readonly (readonly MathComponent[])[] }
      • Optional Readonlychildren?: never
      • Readonlyitems: readonly (readonly MathComponent[])[]

        Several things between the brackets, with separator between them, such as ⟨a|b⟩