Skip to content

Latest commit

 

History

History
41 lines (24 loc) · 1.39 KB

README.md

File metadata and controls

41 lines (24 loc) · 1.39 KB

ember-popper-modifier

An Ember modifier for working with Popper.js.

Compatibility

  • Ember.js v3.28 or above
  • Ember CLI v3.28 or above
  • Node.js v14 or above

Installation

ember install ember-popper-modifier

Usage

This addon provides Ember modifiers that interfaces with the Popper.js library. It handles creating Popper instances as well as configuring them as options are updated.

Popper.js operates on two elements at the same time:

  1. The "reference" element, which is the one the tooltip is positioned relative to
  2. The "popper" element, which is the one that floats.

Two modifiers are provided, depending on which element you want to apply the modifier to and which you want to pass as a reference:

  • {{popper}} is applied on the reference element and given the tooltip as an argument
  • {{popper-tooltip}} is applied on the tooltip element and passed the reference as an argument

Aside from that difference, the modifiers are identical. Thus, the examples below will only show the usage of {{popper}}; know that all of the same principles and options work for {{popper-tooltip}} as well.

More information WIP.

Contributing

See the Contributing guide for details.

License

This project is licensed under the MIT License.