Skip to content

Latest commit

 

History

History
193 lines (124 loc) · 6.03 KB

README.md

File metadata and controls

193 lines (124 loc) · 6.03 KB
Raw

@zestia/ember-async-tooltips

Ember Observer

Installation

ember install @zestia/ember-async-tooltips

Add the following to ~/.npmrc to pull @zestia scoped packages from Github instead of NPM.

@zestia:registry=https://npm.pkg.github.com
//npm.pkg.github.com/:_authToken=<YOUR_GH_TOKEN>

Demo

https://zestia.github.io/ember-async-tooltips

Features

  • Manual positioning ✔︎
  • Automatic positioning ✔︎
  • Customisable show/hide delays ✔︎
  • Customisable reference element ✔︎
  • Customisable destination element ✔︎
  • Pre-loads any required data ✔︎
  • Tethers to element ✔︎

Notes

  • This addon intentionally does not come with any styles.
  • Currently ships with rudimentary positioning utils. The goal being to strip out positioning as a concern once CSS anchors have better support.
  • It is configured with ember-test-waiters so awaiting in your test suite will just work.

Example

<div>
  Hover over me

  <Tooltip>
    Hello World
  </Tooltip>
</div>

Tooltip

Arguments

@element

Optional. By default, the parent of the tooltip element is what causes the tooltip to show & hide, and is also the element it will be positioned next to.

@destination

Optional. By default, tooltips are rendered in-place. Specify a destination if you want to render them in that element instead.

@attachTo

Optional. By default, tooltips will be positioned next to the element that caused them to display. Unless this argument is specified, in which case the tooltip will show when mousing over the element, but will then be positioned next to a different element.

@show

Optional. By default, tooltips will display when hovering over the reference element. But you can use this argument to force a tooltip to display.

@showDelay

Optional. The show delay will prevent the tooltip from being shown until the specified milliseconds have passed after entering the reference element.

@hideDelay

Optional. The hide delay will prevent the tooltip from being hidden until the specified milliseconds have passed after leaving the reference element.

@stickyID

Optional. You can group tooltips together with a sticky identifier. When a tooltip from a group of tooltips all with the same identifier is shown, then other tooltips in that group will show instantly - ignoring their show delay. The term sticky is used because it feels as if the tooltips are stuck open.

@stickyTimeout

Optional. When a group of tooltips is in sticky mode (and so they have no show delays), after a period of time they will revert back to their normal delays. Use this argument to tweak that behaviour.

@onLoad

Optional. When an element is hovered over, @onLoad will be fired. You can respond to this action by returning a promise. The result of that promise is available on the API. This is a good way preload any data required for the tooltip to display.

In the following example, there is a show delay of 300ms before a tooltip will appear. But, during that time it is loading some data which takes 50ms. The actual show delay is reduced to 250ms, so that the total delay remains at 300ms.

Example 
{{! application.gjs }}
<LinkTo @route='user' @model={{123}}>
  Preview user
  <UserTooltip @id={{123}} />
</LinkTo>

{{! user-tooltip.gjs }}
<Tooltip @showDelay={{300}} @onLoad={{fn this.loadUser @id}} as |tooltip|>
  {{tooltip.data.user.name}}
</Tooltip>

@onShow

Optional. Fired after a tooltip has been rendered, and any animations have been performed.

@onHide

Optional. Fired after any animations have been performed, and the tooltip has been destroyed.

@eager

Optional. If true, @onLoad is fired when the mouse enters the reference element, this is so data required for the tooltip to display will arrive sooner. When false, @onLoad is fired when the tooltip displays. Defaults to true.

@position

Optional. Tooltips will be automatically positioned around the outside edge of the element if no @position is specified.

For example: If the element is positioned in the 'bottom left' of the viewport, then the tooltip will be displayed above, so as to remain visible.

You can use the arguments @rows and @columns to tweak how the positioning algorithm decides what 'bottom left' means. See the positioning library for more information.

You can also set @position to be a function. It will receive the element's position in the viewport. You are then free to return an appropriate counter position for your tooltip.

Example 
position(referencePosition) {
  switch(referencePosition) {
    case 'top right':
      return 'left top';
    // ...
  }
}

API

hide

Hides the tooltip (waiting for any animations), then un-renders it.

data

Any data that was loaded via @onLoad

error

Any error if the data was @onLoad failed

Animating

If your tooltips need to animate in and out, you can utilise these attributes:

[data-showing='true'] {
  animation: your-show-animation;
}

[data-showing='false'] {
  animation: your-hide-animation;
}

You may want to alter animations for sticky tooltips:

[data-sticky='true'] {
  animation-name: none;
}