Coral.Popover

Current Version: 3.3.5
Note:Any Coral CSS classes and attributes not explicitly mentioned in the public documentation are private and subject to change. Their direct use is not recommended and at high risk of breaking after subsequent updates of CoralUI library. For technical details of how to use Coral safely, please refer to the CoralUI Architecture.
Github: @coralui/coralui-component-popover
Notice: When using the Coral.Popover in a scrollable content, make sure the set 'position: relative' on the container to enable the repositioning of Coral.Popover.

Markup Examples

Content Padding

Use the u-coral-margin class to give margin to content zones.

This is especially useful when adding multiple paragraphs to a Popover.

Show Markup 
<button is="coral-button" id="marginPopover_target">Content Margin</button>
<coral-popover target="#marginPopover_target">
  <coral-popover-content>
    <p class="u-coral-margin">Lorem ipsum dolor sit amet, consectetur adipiscing elit. Vivamus imperdiet interdum convallis.</p>
    <p class="u-coral-margin">Vestibulum convallis lectus ut nulla commodo gravida. Suspendisse porta arcu sit amet purus sollicitudin id gravida mi gravida.</p>
  </coral-popover-content>
</coral-popover>

You can also use u-coral-padding class to give padding to the entire content container.

Note that this won't pay well with inner elements that use u-coral-margin, as you'll get double the spacing you intended.

Show Markup 
<button is="coral-button" id="paddingPopover_target">Content Padding</button>
<coral-popover target="#paddingPopover_target">
  <coral-popover-content class="u-coral-padding">Lorem ipsum dolor sit amet, consectetur adipiscing elit. Vivamus imperdiet interdum convallis.</coral-popover-content>
</coral-popover>

Content Separators

Use the coral-popover-separator component to create content separators.

Show Markup 
<button is="coral-button" id="separatorsPopover_target">Separators</button>
<coral-popover target="#separatorsPopover_target">
  <coral-popover-content>
    <p class="u-coral-margin">Lorem ipsum dolor sit amet, consectetur adipiscing elit. Vivamus imperdiet interdum convallis.</p>
    <p class="u-coral-margin">Vestibulum convallis lectus ut nulla commodo gravida. Suspendisse porta arcu sit amet purus sollicitudin id gravida mi gravida.</p>
    <coral-popover-separator></coral-popover-separator>
    <p class="u-coral-margin">Lorem ipsum dolor sit amet, consectetur adipiscing elit. Vivamus imperdiet interdum convallis.</p>
    <p class="u-coral-margin">Vestibulum convallis lectus ut nulla commodo gravida. Suspendisse porta arcu sit amet purus sollicitudin id gravida mi gravida.</p>
  </coral-popover-content>
</coral-popover>

Behavior

Keyboard Controls

When the popover is visible, pressing the escape key will dismiss the top most popover.

Focus Behavior

When shown, the popover will focus on itself, showing no border. Pressing tab will move to the first focusable element, usually the close button.

When hidden, the popover will return focus to the element that was previously focused on the page.

Coral.Popover API

Constructor

JavaScript:

new Coral.Popover() or document.createElement('coral-popover')

HTML Tag:

<coral-popover>

Extends

Sub-components

Static Properties

Coral.Popover.closable {String}

Boolean enumeration for popover closable state.

Properties:

Name Type Value Description
ON String on Show a close button on the popover and close the popover when clicked.
OFF String off Do not show a close button. Elements with the coral-close attributes will still close the popover.

Coral.Popover.interaction {String}

Popover interaction values.

Properties:

Name Type Value Description
ON String on Show when the target is clicked and hide when clicked outside of the target and popover.
OFF String off Do not show or hide automatically.

Coral.Popover.variant {String}

Popover variants.

Properties:

Name Type Value Description
DEFAULT String default A popover with the default, gray header and no icon.
ERROR String error A popover with a red header and warning icon, indicating that an error has occurred.
WARNING String warning A popover with an orange header and warning icon, notifying the user of something important.
SUCCESS String success A popover with a green header and checkmark icon, indicates to the user that an operation was successful.
HELP String help A popover with a blue header and question mark icon, provides the user with help.
INFO String info A popover with a blue header and info icon, informs the user of non-critical information.

Instance Properties

instance.alignAt {Coral.Overlay.align}

The point on the target we should anchor to when positioning.
Inherited From:
Default Value:
  • Coral.Overlay.align.CENTER_CENTER
HTML Attribute:
  • alignat

instance.alignMy {Coral.Overlay.align}

The point on the overlay we should anchor from when positioning.
Default Value:
  • Coral.Overlay.align.LEFT_CENTER
HTML Attribute:
  • alignmy

instance.closable {Coral.Popover.closable}

Reflected
Whether the popover should have a close button.
Default Value:
  • Coral.Popover.closable.OFF
HTML Attribute:
  • closable

instance.collision {Coral.Overlay.collision}

The collision handling strategy when positioning the overlay relative to a target.
Inherited From:
Default Value:
  • Coral.Overlay.collision.FLIP_FIT
HTML Attribute:
  • collision

instance.content {HTMLElement}

The popover's content element.

instance.focusOnShow {String}

Focus behavior options.

Properties:

Name Type Value Description
ON String on When the overlay is opened, it will be focused.
OFF String off The overlay will not focus itself when opened.
Inherited From:

instance.focusOnShow {Coral.mixin.overlay.focusOnShow | HTMLElement | String}

Whether to focus the overlay, when opened or not. By default the overlay itself will get the focus. It also accepts an instance of HTMLElement or a selector like ':first-child' or 'button:last-of-type'. If the selector returns multiple elements, it will focus the first element inside the overlay that matches the selector.
Default Value:
HTML Attribute:
  • focusonshow

instance.header {HTMLElement}

The popover's header element.

instance.hidden {Boolean}

Reflected
Whether this component is hidden or not.
Inherited From:
Default Value:
  • false
HTML Attribute:
  • hidden

instance.icon {String}

The popover's icon.
Default Value:
  • ""
HTML Attribute:
  • icon

instance.interaction {Coral.Popover.interaction}

Whether the popover should show itself when the target is interacted with.
Default Value:
  • Coral.Popover.interaction.ON
HTML Attribute:
  • interaction

instance.offset {Number}

The distance the overlay should be from its target.
Default Value:
  • 5
HTML Attribute:
  • offset

instance.open {Boolean}

Reflected
Whether this overlay is open or not.
Default Value:
  • false
HTML Attribute:
  • open

instance.placement {Coral.Overlay.placement}

The placement of the overlay. This property sets Coral.Overlay#alignMy and Coral.Overlay#alignAt.
Default Value:
  • Coral.Overlay.placement.RIGHT
HTML Attribute:
  • placement

instance.returnFocus {Coral.mixin.overlay.returnFocus}

Whether to return focus to the previously focused element when closed.
Default Value:
  • Coral.mixin.overlay.returnFocus.ON
HTML Attribute:
  • returnfocus

instance.target {Coral.Overlay.target | HTMLElement | String}

The element the overlay should position relative to. It accepts values from Coral.Overlay.target, as well as a DOM element or a CSS selector. If a CSS selector is provided, the first matching element will be used. If a target is not specified, the overlay will not respect Coral.Overlay#alignMy, Coral.Overlay#alignAt, or Coral.Overlay#collision.
Inherited From:
Default Value:
  • null
HTML Attribute:
  • target

instance.trapFocus {Coral.mixin.overlay.trapFocus}

Whether to trap tabs and keep them within the overlay.
Default Value:
  • Coral.mixin.overlay.trapFocus.ON
HTML Attribute:
  • trapfocus

instance.variant {Coral.Dialog.variant}

The popover's variant.
Default Value:
  • Coral.Dialog.variant.DEFAULT
HTML Attribute:
  • variant

instance.within {HTMLElement | String}

The bounding element for the overlay. The overlay will be sized and positioned such that it is contained within this element. It accepts both a DOM Element or a CSS selector. If a CSS selector is provided, the first matching element will be used.
Inherited From:
Default Value:
  • window

Methods

instance.get

Get the value of a property.
Parameters:
Name Type Description
property String The name of the property to fetch the value of.
Returns:
Property value. {*}
Inherited From:

instance.hide

Close the overlay.
Returns:
this, chainable {Coral.Component}

instance.hide

Hide this component.
Returns:
this, chainable {Coral.Component}
Inherited From:

instance.off

Remove an event listener.
Parameters:
Name Type Optional Description
eventName String No
 The event name to stop listening for.
selector String Yes
 The selector that was used for event delegation.
func function No
 The function that was passed to on().
useCapture Boolean Yes
 Only remove listeners with useCapture set to the value passed in.
Returns:
this, chainable. {Coral.Component}
Inherited From:

instance.on

Add an event listener.
Parameters:
Name Type Optional Default Description
eventName String No
 The event name to listen for.
selector String Yes
 The selector to use for event delegation.
func function No
 The function that will be called when the event is triggered.
useCapture Boolean Yes
 Whether or not to listen during the capturing or bubbling phase.
Returns:
this, chainable. {Coral.Component}
Inherited From:

instance.remove

Non-destructively remove this element. It can be re-added by simply appending it to the document again. It will be garbage collected if there are no more references to it.
Inherited From:

instance.reposition

Re-position the overlay if it's currently open.
Inherited From:

instance.returnFocusTo

Set the element that focus should be returned to when the overlay is hidden.
Parameters:
Name Type Description
element HTMLElement The element to return focus to. This must be a DOM element, not a jQuery object or selector.
Returns:
this, chainable {Coral.Component}

instance.set

Set a single property.
Parameters:
Name Type Description
property String The name of the property to set.
value * The value to set the property to.
silent Boolean If true, events should not be triggered as a result of this set.
Returns:
this, chainable. {Coral.Component}
Inherited From:

instance.show

Show this component.
Returns:
this, chainable {Coral.Component}
Inherited From:

instance.show

Open the overlay and set the z-index accordingly.
Returns:
this, chainable {Coral.Component}

instance.trigger

Trigger an event.
Parameters:
Name Type Optional Default Description
eventName String No
 The event name to trigger.
props Object Yes
 Additional properties to make available to handlers as event.detail.
bubbles Boolean Yes
 Set to false to prevent the event from bubbling.
cancelable Boolean Yes
 Set to false to prevent the event from being cancelable.
Returns:
CustomEvent object {CustomEvent}
Inherited From:

Events

coral-overlay:beforeclose

Triggerred before the component is closed with hide() or instance.open = false.
Callback Parameters:
Name Type Description
event Object

Event object.

Name Type Description
event.preventDefault function Call to stop the overlay from closing.

coral-overlay:beforeopen

Triggerred before the component is opened with show() or instance.open = true.
Callback Parameters:
Name Type Description
event Object

Event object.

Name Type Description
event.preventDefault function Call to stop the overlay from opening.

coral-overlay:close

Triggerred after the component is closed with hide() or instance.open = false
Callback Parameters:
Name Type Description
event Object Event object.

coral-overlay:open

Triggerred after the overlay is opened with show() or instance.open = true
Callback Parameters:
Name Type Description
event Object Event object.

coral-component:attached

Triggered when the component is attached to the DOM.
Callback Parameters:
Name Type Description
event Object Event object.
Inherited From:
Deprecated:
  • since 1.14.0, use MutationObserver instead.

    coral-component:detached

    Triggered when the component is detached to the DOM.
    Callback Parameters:
    Name Type Description
    event Object Event object.
    Inherited From:
    Deprecated:
    • since 1.14.0, use MutationObserver instead.

      coral-component:ready

      Triggerred when the component has been upgraded and is ready for use.
      Callback Parameters:
      Name Type Description
      event Object Event object.
      Inherited From:
      Deprecated:
      • since 1.9.0, use Coral.commons.ready() instead.