@nospamproxy/core
    Preparing search index...

    Class GenericPopover

    A generic popover with custom anchor and content.

    <generic-popover component.ref="popover">
      <hyperlink-command action.call="popover.toggle()">Click me!</hyperlink-command>

      <text-block slot="content">
        Popover content...
      </text-block>
    </generic-popover>

    Implements

    • ICustomElementViewModel
    Index

    Constructors

    constructor

    Properties

    alignment allowHide anchor containerClass content displaySpike eventChannel foreignEventHandler? inline maxHeight placement stretch

    Accessors

    isVisible stateChangedEvent

    Methods

    attached binding detaching hide show toggle

    Constructors

    Properties

    alignment: Alignment = 'center'

    Set the PopoutControl alignment.

    allowHide: boolean = true

    If false, the generic popover can not be closed by the user or via the .hide method.

    anchor: HTMLElement
    containerClass: string = ''

    A class for the content container element.

    content

    content: HTMLElement[]
    displaySpike: boolean = true

    If true, the typical popover spike is displayed.

    eventChannel: string

    If bound, the popover will subscribe to this event channel and will toggle itself when the event is published.

    foreignEventHandler?: () => void

    A function that is called when a user action occurs outside of the popover's content while the popover is open.

    inline: boolean = false

    If true, this is an inline element, otherwise an inline-block.

    maxHeight: string = ''

    The maximum height of the content.

    Scrolling is enabled if this height is exceeded.

    placement: Side = 'top'

    Set the PopoutControl placement.

    stretch: boolean = false

    If true, the content has at least the size of the anchor element.

    Accessors

    • get isVisible(): boolean

      Check if the popover is visible.

      Returns boolean

    • get stateChangedEvent(): string

      Returns string

    Methods

    • Returns void

    • Parameters

      • _initiator: IHydratedController
      • _parent: IHydratedController | null

      Returns void | Promise<void>

    • Parameters

      • _initiator: IHydratedController
      • _parent: IHydratedController | null

      Returns void | Promise<void>

    • Ensure that the popover is hidden.

      Returns void

    • Ensure that the popover is shown.

      Returns void

    • Toggle the popover.

      Parameters

      • Optionalshow: boolean

        If true, the popover will be shown, otherwise hidden. Default is !isVisible.

      Returns void

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods