0.1.0 • Published 6 years ago

archer-callouts v0.1.0

Weekly downloads
-
License
MIT
Repository
-
Last release
6 years ago

archer-callouts

The archer-callouts.js is a small javascript library for easily creating fancy callout elements. Basically, designed for the use in archer graphics it is completely independent from the archer-graphics.js library and can be used by its own in any html website.

Even if the implementation is not perfect yet, it is already good enough for the most usual use cases.

The following issues have to be done for the first major release:

  • Improve render performance
  • Remove unused legacy code
  • Refactor code for better readability
  • Optimize programming interface
  • Add source code documentation

Watch it

See the little-planes example on codepen.io

little-planes

Build it

> npm install
> npm run-script build

Use it

//Get the container element for the callout
var container = document.getElementById('container');

//Get the source element for the callout
var sourceElement = document.getElementById('source-element');

//Create a callout and add it to a container.
var callout = calloutManager.create(container);

//Bind the callout to the source element
callout.bind(sourceElement);

//Set the content of the callout. Currently there are two sections that can //be set separately. Use html to format your content to your needs.
callout.sections[0].content = '<h1>Title</h1>';
callout.sections[1].content = '<p>This is a callout</p>';

//Show the callout
callout.show();

//Call updatePosition() eache time the position of the source element changes
callout.updatePosition();

//Hide the callout
callout.hide();
0.1.0

6 years ago