platform-bible-react
    Preparing search index...

    Type Alias DestructiveKeyConfirmationProps

    Props for DestructiveKeyConfirmation.

    type DestructiveKeyConfirmationProps = {
        align?: "start" | "center" | "end";
        anchorRect: { height: number; left: number; top: number; width: number };
        confirmingKeyLabel: string;
        message: string;
        open: boolean;
        showArrow?: boolean;
        side?: "top" | "bottom";
    }
    Index

    Properties

    align? anchorRect confirmingKeyLabel message open showArrow? side?

    Properties

    align?: "start" | "center" | "end"

    Tooltip placement alignment. Defaults to 'start'.

    anchorRect: { height: number; left: number; top: number; width: number }

    Position and size of the invisible anchor, in the coordinates of the nearest position: relative ancestor. Typically the bounding rect of the element the hint should point at (e.g. a verse marker), recomputed by the caller as it moves/scrolls.

    confirmingKeyLabel: string

    Localized/display label for the key that confirms the action on a second press (e.g. "Backspace").

    message: string

    Localized message to display. Include a {key} placeholder where the confirming key belongs.

    open: boolean

    Whether the confirmation hint is currently showing.

    showArrow?: boolean

    Whether to render the pointer arrow. Defaults to true.

    side?: "top" | "bottom"

    Tooltip placement side. Defaults to 'bottom'.

    Only 'top'/'bottom' are supported — the bordered arrow this component renders relies on clip-path/translate math in tooltip.tsx that has only been worked out for those two sides; the equivalent math for 'left'/'right' was tried and found visibly broken (see tooltip.tsx), so those two values are omitted from this component's public API rather than silently degrading to a borderless arrow.

    Settings

    Member Visibility

    On This Page

    Properties