Installation

Using NPM

npm install jquery-tourer

Using Yarn

yarn add jquery-tourer

Using CDN

<!-- Import jQuery first -->
<script type="text/javascript" src="https://code.jquery.com/jquery-3.4.1.min.js"></script>
<script type="text/javascript" src="https://unpkg.com/jquery-tourer@latest/dist/jquery-tourer.min.js"></script>
<link rel="stylesheet" href="https://unpkg.com/jquery-tourer@latest/dist/jquery-tourer.min.css">

Usage

Add the .tour-wrapper template anywhere inside the body tag. The .tour-overlay prevents interaction when the tour is activated.

<ul class="tour-wrapper">
    <li class="tour-step" target="#logo">
        <span>Step 1</span>
        <div class="tour-content bottom">
            <h2>Step Number 1</h2>
            <p>
                This is a normal step. In larger displays, this is shown as a tooltip
                and the image is hidden. On devices with smaller screens, this will
                be shown as a modal.
            </p>
            <img src="assets/images/step-1.png" alt="step 1">
        </div>
    </li>
</ul>
<div class="tour-overlay"></div>

Adding Steps

<!-- Add 'unbound' class to always show modal instead of a tooltip -->
<!-- Use the target attribute to denote which element the step will be bound on -->
<li class="tour-step" target="#logo">
    <!-- Short Title (For Large Displays) -->
    <span>Step 1</span>

    <!-- Use classes [top, bottom, right, left] for Tooltip Placement -->
    <div class="tour-content bottom">
        <!-- Full Title (On Mobile Devices) -->
        <h2>Step Number 1</h2>
        <!-- Body -->
        <p>
            This is a normal step. In larger displays, this is shown as a tooltip
            and the image is hidden. On devices with smaller screens, this will
            be shown as a modal.
        </p>
        <!-- Image (Hidden on Large Displays) -->
        <img src="assets/images/step-1.png" alt="step 1">
    </div>
</li>

Initialization

// Initializate Tour Wrapper
// This is done automatically on page load
$('.tour-wrapper').tour();

// This creates two event listeners
$('.tour-wrapper').trigger('start-tour'); // Starts Tour
$('.tour-wrapper').trigger('stop-tour'); // Ends Tour

// These event listeners are automatically
// bound to the following buttons, respectively

$('.start-tour').click() // Triggers 'star-tour'
$('.stop-tour').click() // Triggers 'stop-tour'

License

Copyright © 2020 Gerard Balaoro

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Credits

• CodyHouse/product-tour - This project was forked from the orginal work of CodyHouse, which is published under the MIT License.