Skip to content

WhatsNew.js is a lightweight plugin that helps you easily create a step-by-step tutorial in a modal format.

License

Notifications You must be signed in to change notification settings

bennyluk/WhatsNew.js

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

4 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

WhatsNew.js is a lightweight plugin that helps you easily create a step-by-step tutorial in a modal format. It was designed for applications that need to explain new features to the client.

Visit the WhatNew.js Project Site for demos and documentations.

Table of Contents

Quick Start

  1. Add WhatNew.js to your site document's head
<link href="whatsNew.min.css" rel="stylesheet">
<script src="whatsNew.min.js"></script>
  1. Once the page loads, initialize a new WhatsNew. The first argument is the data and the (optional) second is extra options. Examine the API or Examples for a detailed usage of the plugin. Once initialize, it will return a WhatsNew object.
  var whatsNewSteps = new WhatsNew([
    {
      title: "First Slide",
      img: "https://upload.wikimedia.org/wikipedia/commons/thumb/d/d9/Big_Bear_Valley%2C_California.jpg/1200px-Big_Bear_Valley%2C_California.jpg",
      content: "Hello World !"
    },
    {
      title: "Second Slide",
      img: "https://upload.wikimedia.org/wikipedia/commons/thumb/d/d9/Big_Bear_Valley%2C_California.jpg/1200px-Big_Bear_Valley%2C_California.jpg",
      content: "This is the second slide !",
    }
  ]);
  1. Last but not last, start the WhatsNew once ready.
  whatsNewSteps.start();

Dependencies

jQuery

Not Needed ~ Vanilla JS :P

Browser Support

WhatsNew.js has been tested and works on IE 9+, Chrome 32+, Firefox 32+ and Safari 9+

License

WhatNew.js is licensed under the MIT license.

About

WhatsNew.js is a lightweight plugin that helps you easily create a step-by-step tutorial in a modal format.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published