Coral.Tooltip

Current Version: 3.1.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-tooltip

A tooltip that can be attached to any other element and may be displayed immediately, on mouse over or only on API call.

Notice: When using the Coral.Tooltip in a scrollable content, make sure the set 'position: relative' on the container to enable the repositioning of Coral.Tooltip.

Tooltip Target Examples

_prev

Achieved using target="_prev".

Point at previous
Show Markup 
<div class="coralDocs-TooltipTarget">Point at previous</div>
  <coral-tooltip target="_prev">I'm a tooltip</coral-tooltip>

_next

Achieved using target="_next".

Point at next
Show Markup 
<coral-tooltip target="_next">I'm a tooltip</coral-tooltip>
<div class="coralDocs-TooltipTarget">Point at next</div>

CSS Selector

Achieved using target="<CSS_SELECTOR>".

Point at CSS selector
Show Markup 
<coral-tooltip target=".coralDocs-TooltipTarget--cssTarget">I'm a tooltip</coral-tooltip>
<div class="coralDocs-TooltipTarget coralDocs-TooltipTarget--cssTarget" id="abc">Point at CSS selector</div>

DOM Element

DOM Target
Show Markup 
var target = document.querySelector('#tooltipDOMTarget');
var tooltip = new Coral.Tooltip().set({
  target: target,
  content: {
    innerHTML: 'I am a tooltip'
  }
});
document.body.appendChild(tooltip);

JavaScript Examples

Show a Coral.Tooltip with a different trigger

Target
<div class="coralDocs-TooltipTarget" id="anotherTooltipTarget">Target</div>
<button is="coral-button" class="coralDocs-TooltipButton" id="tooltipTrigger">Toggle Tooltip</button>
<script>
  var tooltip = new Coral.Tooltip().set({
    content: {
      innerHTML: 'Tooltip'
    },
    variant: 'success',
    target: '#anotherTooltipTarget',
    placement: 'left',
      // Don't show or hide automatically
    interaction: 'off'
  });
  document.body.appendChild(tooltip);
  document.querySelector('#tooltipTrigger').addEventListener('click', function() {
    // Toggle the open property
    tooltip.open = !tooltip.open;
  });
</script>

Coral.Tooltip API

Constructor

JavaScript:

new Coral.Tooltip() or document.createElement('coral-tooltip')

HTML Tag:

<coral-tooltip>

Extends

Sub-components

Static Properties

Coral.Tooltip.interaction {String}

Tooltip interaction values.

Properties:

Name Type Value Description
ON String on Show when the target is hovered or focused and hide when the mouse is moved out or focus is lost.
OFF String off Do not show or hide automatically.

Coral.Tooltip.variant {String}

Tooltip variants.

Properties:

Name Type Value Description
INFO String info A blue tooltip that informs the user of non-critical information.
ERROR String error A red tooltip that indicates an error has occurred.
WARNING String warning An orange tooltip that notifies the user of something important.
SUCCESS String success A green tooltip that indicates an operation was successful.
INSPECT String inspect A dark gray tooltip that provides additional information for a chart item.

Instance Properties

instance.alignAt {Coral.Overlay.align}

The point on the target we should anchor to when positioning.
Default Value:
  • Coral.Overlay.align.RIGHT_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.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 Tooltip content element.

instance.delay {Number}

The amount of time in miliseconds to wait before showing the tooltip when the target is interacted with.
Default Value:
  • 500
HTML Attribute:
  • delay

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

Whether to focus the tooltip when opened or not. By default Tooltips do not require the focus to be changed, but in case some content needs to be focused, setting focusOnShow="on" would handle this. 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:
  • Coral.mixin.overlay.focusOnShow.ON
HTML Attribute:
  • focusonshow

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.hidden {Boolean}

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

instance.interaction {Coral.Tooltip.interaction}

Whether the tooltip should show itself when the target is interacted with.
Default Value:
  • Coral.Tooltip.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.Tooltip#alignMy and Coral.Tooltip#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.OFF
HTML Attribute:
  • returnfocus

instance.returnFocus {String}

Return focus options.

Properties:

Name Type Value Description
ON String on When the overlay is closed, the element that was focused before the it was shown will be focused again.
OFF String off Nothing will be focused when the overlay is closed.
Inherited From:

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.OFF
HTML Attribute:
  • trapfocus

instance.trapFocus {String}

Focus trap options.

Properties:

Name Type Value Description
ON String on Focus is trapped such that the use cannot focus outside of the overlay.
OFF String off The user can focus outside the overlay as normal.
Inherited From:

instance.variant {Coral.Tooltip.variant}

Reflected
The variant of tooltip.
Default Value:
  • Coral.Tooltip.variant.INFO
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

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

instance.hide

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

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.