platform-bible-react
    Preparing search index...

    Type Alias ToolbarCompoundLabelProps

    type ToolbarCompoundLabelProps = {
        className?: string;
        fullText: string;
        isPartial?: boolean;
        primary: ReactNode;
        secondary?: ReactNode;
        secondaryFirst?: boolean;
        separator?: string;
        showSecondary?: boolean;
    }
    Index

    Properties

    className?: string

    Additional classes for the label row.

    fullText: string

    The complete label. Shown in the tooltip whenever the rendered form is not the whole thing.

    isPartial?: boolean

    Whether what is rendered is only part of ToolbarCompoundLabelProps.fullText, so the tooltip should open on hover even though nothing is visibly clipped. Set this when the primary field is an abbreviation — GEN for Genesis — which CSS cannot detect.

    Defaults to true whenever the secondary field has been dropped.

    primary: ReactNode

    The field that identifies the item — a book abbreviation, project short name, marker code.

    secondary?: ReactNode

    The field that gives way first: clipped with an ellipsis, then dropped entirely.

    secondaryFirst?: boolean

    Render secondary before primary, for labels that read that way round — a project selector shows Translation Project 1 (TP1), full name first, short name last.

    separator?: string

    Text placed between the two fields. Rendered as a real text node, so it survives into textContent where a CSS gap would not — assertions and screen readers both read it.

    showSecondary?: boolean

    Whether the secondary field is rendered at all. Defaults to true.