Giter Club home page Giter Club logo

walkthrough.js's Introduction

walkthrough.js

walkthrough.js allows you to create interactive walkthroughs for your website.

var wt = new WT.Walkthrough('walkthrough-name', {})

wt.addStep({
    el: 'body', // jQuery selector for the element that the message is positioned relative to
    position: 'center', // Where to position relative to el
    html: "<h3>Walkthrough</h3><p>Use HTML to set the content of the message</p>", // The HTML content of the message
    first: true, // Indicate that this is the first of a batch, page reloads will wind back to the previous 'first' step
    page: "^http(s)?://example.com/pageone.html$", // RegEx to limit step to appear on a particular URL
    width: 300, // Override default width
    height: 200, // Override default height
    highlight: false // Disable element hightlighting
});

wt.addStep({
    el: 'input[type='submit'], // jQuery selector for the element that the message is positioned relative to
    position: 'bottom', // Where to position relative to el
    html: "<h3>Walkthrough</h3><p>Use HTML to set the content of the message</p>", // The HTML content of the message
    offsetX: 10, // offset relative to the default positioning
    offsetY: 20, // offset relative to the default positioning
    trigger: 'click' // Type of event that triggers the next message
    disable: '#selector' // Disable element using jQuery selector
});

wt.addStep({
    el: 'body', // The element to that the message is positioned relative to
    position: 'bottom', // Where to position relative to el
    html: "<h3>Walkthrough</h3><p>Use HTML to set the content of the message</p>", // The HTML content of the message
    enable: '#selector' // Enable element using jQuery selector
    last: true
});

See the examples folder for working demos.

walkthrough.js's People

Contributors

daredevildave avatar

Watchers

James Cloos avatar Bernard Ojengwa avatar

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.