JSPM – gitbook-plugin-glossary-tooltip@0.0.5

Package Exports

gitbook-plugin-glossary-tooltip

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (gitbook-plugin-glossary-tooltip) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

A plugin that uses tooltipjs to automatically transform glossary items into tooltips instead of seeing the default browser title attribute on hover.

Add Plugin

book.json

{
    "plugins": ["glossary-tooltip"]
}

then run

$ gitbook install

Configure (Optional Step)

book.json

"pluginsConfig": {
    "glossary-tooltip":{
        "parseGlossaryItems": false,
    }
}

Config Options:

Option	Description
`parseGlossaryItems` {Boolean} default: `true`	tells the plugin whether to apply tooltips to glossary items or not
`trigger` {string} default: `hover`	the event that triggers the tooltip. one of ['hover', 'click', 'focus']
`placement` {string} default: `top`	placement of the tooltip relative to the trigger element. one of ['top', 'bottom', 'left', 'right']"

Template

You can also place your own tooltip in your markdown

Args

tooltip takes one required named/unnamed argument:

topic (string): The text to display in the tooltip trigger element.

example:


{% tooltip "sample tooltip" %} sample tooltip test with **Emphasis** {% endtooltip %}

Sample output

output

Pull requests are welcome

gitbook-plugin-glossary-tooltip