Skip to content
This repository has been archived by the owner on Jan 13, 2019. It is now read-only.
/ ShowcaseView.js Public archive

ShowcaseView.js brings the awesome feature of Android in HTML

License

Notifications You must be signed in to change notification settings

krmax44/ShowcaseView.js

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

15 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

ShowcaseView.js

ShowcaseView.js brings the awesome feature of Android in HTML. It's current state is not completely bug-free and does not always bring the perfect position of the showcase, so feel free to make the code better!

Installation and requirements

CDN

<link rel="stylesheet" type="text/css" href="https://cdn.rawgit.com/krmax44/ShowcaseView.js/master/css/showcaseview.min.css">
<script type="text/javascript" src="https://cdn.rawgit.com/krmax44/ShowcaseView.js/master/js/showcaseview.min.js"></script>

Self-hosted

Just include showcaseview.min.js and showcaseview.min.css and you're done! (But make sure that the CSS file and the showcaseview.png file are in the same directory!)

Dependencies

For now, you need jQuery and Materialize.

Basic usage

It's very simple. Want to play around with the demo?

<a href="#" class="btn">Cool feature!</a>
<script>
  $(".btn").showcaseview({
    text: "Click this awesome button", //required
    buttonOnly: true, //only a click of a button closes the ShowcaseView (default: false)
    btntext: "Hide", //text of the button (default: "OK")
    circle: true, //defines if the shape is a circle instead of an ellipse (default: false)
    scroll: false //scroll to the element 
  }, function(){
    alert("ShowcaseView closed!");
  });
</script>

Changelog

Check out the Changelog over here.

License

The MIT License