pahans:inline-help

simple inline help package for Meteor


License
MIT
Install
meteor add pahans:inline-help@=1.0.2

Documentation

meteor-inline-help

This is a simple inline help package for Meteor.

Meteor inline help demo

How to Use

install it from atmosphere

for Meteor 0.9+

meteor add pahans:inline-help

for Meteor 0.8

mrt add inline-help

for versions before Meteor 0.8

mrt add inline-help --pkg-version 0.1.5

Fetch your help information

property message, supports markdown

var helpData = {
  'help-name': {
    title: "Help document title ",
    message: "Help document message", //supports Markdown
    url: "http://YOUR_URL_TO_ADDITIONAL_HELP",
    options: {
      placement: 'right'
    }
  },
  'another-help-name': {
    title: "another help document title ", //supports Markdown
    message: "another help document message",
    url: "http://YOUR_URL_TO_ADDITIONAL_HELP"
  },
}
InlineHelp.initHelp(helpData); 

Markup

use showHelp handlebars helper

for versions before Meteor 0.8

{{showHelp 'help-name'}}

for Meteor 0.8+

{{>showHelp 'help-name'}}

Styling

  • .show-help-icon - if you need to set a custom icon
  • .inline-help-popover - wrapped element in bootstrap popover