Skip to content

prestigos/vainilla-tour

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

55 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

vainilla-tour

Is a pure JS web-component for tour like Bootstrap Tour but is made with web-components

Check it Demo

Live Demo

How it works

bower install --save vainilla-tour

<vainilla-tour with-labels='true' name='tourname' id='uniqueID'>
  <step-tour for='elementId' background='colorHEX' color='colorHEX'>
  ...Custom tags for HTML
  </step-tour>
</vainilla-tour>

<vainilla-tour> properties

property default require description
with-labels false no show or hidde labels
name yes name for unique when use multiple tours

<step-tour> properties

property default require description
for "" no element id reference
color black no the custom font-color HEX or byName
background white no custom background color for element

Run

In your attachedCallback element uses init() function to vainilla-tour to start

...
//If you use a polymer
element.attached: function () {
  document.querySelector('#uniqueID').init();
}

...
//If you use pure JS

element.attachedCallback = function () {
  document.querySelector('#uniqueID').init();
}

Fork and enjoy

After you clone Run these steps:

npm install bower install

Change the Line 2 from src/demo.jade

link(rel='import', href='../dist/vainilla-tour.html') to link(rel='import', href='../src/vainilla-tour.html')

Is very important if you view local changes

run server

npm start

Visit browser

localhost:3000/src/demo.html

Packages

No packages published

Languages

  • JavaScript 75.4%
  • HTML 24.6%