Skip to content

arunoda/meteor-inline-help

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

30 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

meteor-inline-help

This is a simple inline help package for Meteor.

Meteor inline help demo

How to Use

###install it from atmosphere

for versions before Meteor 0.8

mrt add inline-help --pkg-version 0.1.5

for Meteor 0.8+

mrt add inline-help

###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

About

simple inline help package for Meteor.

Resources

License

Stars

Watchers

Forks

Packages

No packages published