Git Product home page Git Product logo

meteor-inline-help's Introduction

meteor-inline-help

This is a simple inline help package for Meteor.

Meteor inline help demo

Not actively maintained

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

meteor-inline-help's People

Contributors

pahans avatar mikowals avatar heimdallrj avatar arunoda avatar

Stargazers

Gopalakrishna Palem avatar Richard Smith avatar M Narayanan avatar Claire Zuliani avatar avatar avatar Maximilian Stroh avatar Pinder Johal avatar Charles avatar Roy Barber avatar i.m. ruzz avatar Jeff Rogers avatar Gabriel H Pugliese avatar Patrick Lee Scott avatar Ryan Yeske avatar Jo Meenen avatar avatar Lauricio Su avatar Jarriett K Robinson avatar Jidé avatar

Watchers

James Cloos avatar

Forkers

sergii-savchenko mikowals arunoda sclausen alex-meteor heimdallrj

meteor-inline-help's Issues

can't get example to work

I have

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

and then in my provileView template, I do

{{>showHelp 'help-name'}}

but nothing shows, and in console.log I get

unknown inline help document help-name

I'm on Meteor Release 0.8.1.2 if that helps.

Readme missing ,

Hi,
Thanks, great package.

There is a missing comma after the url line within var helpData. Should be.

var helpData = {
  'help-name': {
    title: "Help document title ",
    message: "Help document message", //supports Markdown
    url: "http://YOUR_URL_TO_ADDITIONAL_HELP",
    options: {
      placement: 'right'
    }
  },

only shows help in first instance

I tried using it in the 'microscope' demo app - adding help to post_item.html

It worked for the first item, but not the subsequent ones?

Exception: object is not a function

When using this package with the provided example in a minimal meteor app, the following ecxeption occurs in the browser console:

Uncaught TypeError: object is not a function           inline-help.js:9
(anonymous function)                                   inline-help.js:9
_extend.lookup                                            fields.js:111
Spacebars.call                                 spacebars-runtime.js:137
Spacebars.mustacheImpl                          spacebars-runtime.js:74
Spacebars.mustache                              spacebars-runtime.js:78
...

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.