mrt:pageguide

v1.0.4Published 10 years ago

This package has not had recent updates. Please investigate it's current state before committing to using it in your project.

An interactive guide for web page element using jQuery and CSS3

Requires Meteorite : https://github.com/oortcloud/meteorite

Pageguide Official Documentation : https://github.com/tracelytics/pageguide/blob/master/README.md

Installing pageguide using Meteorite

$ cd app/directory
$ mrt add pageguide

Meteor Packages

  • jQuery ( included )

Usage

See pageguide Official Documentation : https://github.com/tracelytics/pageguide/blob/master/README.md

Example

meteor-pageguide live example

if (Meteor.isClient) {

  Template.pageguide.created =  function () {
    var currentPageguide = {
      id: "jQuery.PageGuide",
      title: "Take a quick tour of all the possibilities",
      steps: [
        {
          target: ".code",
          content: "This is the actualy Meteor code used on this page",
          direction: "top"
        },
        {
          target: ".github",
          content: "Click here view this project on github",
          direction: "top"
        },
        {
          target: ".atmosphere",
          content: "This project is also available on the Atmosphere Meteorite package repository",
          direction: "top"
        },
        {
          target: ".profile",
          content: "Here is a link to my github profile for all you stalkers",
          direction: "top"
        },
        {
          target: ".readme",
          content: "This should point you towards all the docs you need",
          direction: "top"
        }
    ]};
    Session.set("currentPageguide",currentPageguide);
};

  Template.pageguide.events = {
    "click .open-pageguide" : function () {
      var guide = Session.get('currentPageguide');
      $.pageguide(guide, {events: {close: function () {$.pageguide("unload")}}}).open();
    }
  }
}

To run example locally

$ git clone git://github.com/austinrivas/meteor-pageguide.git
$ cd meteor-pageguide/example
$ mrt

TODOS