@theredhead — Frontend Library - v1.0.0
    Preparing search index...

    Interface OpenPopoverConfig<T>

    Configuration object passed to PopoverService.openPopover.

    interface OpenPopoverConfig<T> {
        anchor: Element;
        ariaLabel?: string;
        arrowGap?: number;
        closeOnOutsideClick?: boolean;
        component: Type<T>;
        horizontalAxisAlignment?: PopoverHorizontalAlignment;
        horizontalOffset?: number;
        inputs?: Record<string, unknown>;
        outputs?: Record<string, (event: any) => void>;
        showArrow?: boolean;
        verticalAxisAlignment?: PopoverVerticalAlignment;
        verticalOffset?: number;
    }

    Type Parameters

    • T
    Index

    Properties

    anchor: Element

    The DOM element the popover is anchored to.

    ariaLabel?: string

    Accessible label applied to the popover element.

    arrowGap?: number

    Minimum pixel gap between the anchor and popover when showArrow is true. If the configured verticalOffset / horizontalOffset is smaller than this value, the gap is raised automatically.

    Ignored when showArrow is false.

    16
    
    closeOnOutsideClick?: boolean

    Whether clicking outside the popover closes it (light-dismiss).

    When true, uses popover="auto" (native light-dismiss). When false, uses popover="manual" and the content component must call popoverRef.close() explicitly.

    true
    
    component: Type<T>

    The standalone component class to render inside the popover.

    horizontalAxisAlignment?: PopoverHorizontalAlignment

    Horizontal alignment of the popover relative to the anchor.

    'auto'
    
    horizontalOffset?: number

    Pixel offset on the horizontal axis (positive = right).

    When showArrow is true and this is not set, the offset defaults to arrowGap (16 px) instead of 0 px.

    0  (or arrowGap when showArrow is true)
    
    inputs?: Record<string, unknown>

    Input values set on the component via ComponentRef.setInput().

    outputs?: Record<string, (event: any) => void>

    Map of output property names to handler callbacks.

    showArrow?: boolean

    Whether to show a triangular arrow (caret) pointing from the popover towards its anchor element.

    The arrow side is determined automatically from the resolved vertical/horizontal alignment.

    When enabled, verticalOffset and horizontalOffset are automatically raised to at least arrowGap so the arrow has room to render between the anchor and the popover.

    true
    
    verticalAxisAlignment?: PopoverVerticalAlignment

    Vertical alignment of the popover relative to the anchor.

    'auto'
    
    verticalOffset?: number

    Pixel offset on the vertical axis (positive = down). Applied after alignment — e.g. a small gap between anchor and popover.

    When showArrow is true and this is not set, the offset defaults to arrowGap (16 px) instead of 4 px.

    4  (or arrowGap when showArrow is true)