Skip to content
Popper is designed to make it quick and easy to create customisable popups in Javascript that can contain anything
JavaScript
Find file
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Failed to load latest commit information.
demo
src
vendor
LICENSE
README.md

README.md

Popper

Popper is designed to make it quick and easy to create customisable popups in Javascript that can contain anything.

It only takes care of positioning and when to display or hide the popup. Everything else is taken care of using customisable callbacks

Usage

In order to avoid any namespace conflicts Popper uses the public namespace com.jivatechnology (reverse DNS scheme). You can import this into your local scope with something like:

var Popper = com.jivatechnology.Popper;

Configuring

We can configure what we need from the constructor:

var popper = new Popper({
  target:    $(".js-popper"), // Element you want the popup on
  trigger:   "hover",         // When to automatically trigger the popper
  placement: "north",         // Where to place the popper
  baseClass: "my-popper",     // Class name used to build all other classes
  onOpen:    function(p){ $(p.container).html('Hello!'); },
  onClose:   function(p){ console.info("Popper closed") },
})

It's possible to customise it once the object has been instantiated:

var popper = new Popper({placement: "north"});
popper.placement();
=> "north"
popper.placement("south");
=> "south"

Requirements

Both included in the vendor folder:

  • Tests
  • Automatically place depending on the size of the viewport
Something went wrong with that request. Please try again.