/taggd

A tool to show and add tags to images

Primary LanguageJavaScriptMIT LicenseMIT

Taggd Build Status Coverage Status Library Size

Taggd is a tool that allows you to tag pictures with additional information.

Installation

Usage

You need to include the stylesheet in the <head>-tag, and the script in the <body>-tag. Both files are in the dist directory.

<link rel="stylesheet" href="/path/to/taggd/dist/taggd.css">

The stylesheet has no default theme, so they will be dull default buttons ready for you to style!

<script src="/path/to/taggd/dist/taggd.js"></script>

Finally, you can initialise taggd:

const image = document.getElementById('my-image');
const options = {};
const tags = [];

const taggd = new Taggd(image, options, tags);

The options parameter is a list of options. The tags parameter is a list of Taggd.Tags. These are the buttons and popup that will render over your image. You can generate these using the Taggd tags generator.

Documentation

For more information, check out the documentation.

License

The code is released under the MIT license.