GithubHelp home page GithubHelp logo

gdseller / fastuts Goto Github PK

View Code? Open in Web Editor NEW

This project forked from yashilanka/fastuts

0.0 2.0 0.0 239 KB

A faster way to display quick tutorials for your application or website

HTML 19.00% CSS 8.70% JavaScript 72.31%

fastuts's Introduction

#fastuts.js

What is it?

A faster way to display quick tutorials for your application or website

  • It's tiny! Just 5KB;
  • Easy to customize;
  • Allows callback functions;
  • jQuery required.

View the demo


Installation

  • Install via Bower bower install --save fastuts
  • Download via GitHub

How to use?

Fast way

Don't have time? Do it.

  • First off, add the class fastuts to all the elements you want to introduce to people, as the example below. Also, it's required to add the attribute data-fastuts-tip. Optionally, you can add a sequence number to your presentation using the attribute data-fastuts-order.
<div class="fastuts" data-fastuts-tip="Put a short tip right here" data-fastuts-order="2">
	<h4>Some random content one</h4>
	<p>Donec id elit non mi porta gravida at eget metus. Maecenas faucibus mollis interdum.</p>
</div>
<div class="fastuts" data-fastuts-tip="Another tip" data-fastuts-order="1">
	<h4>Some random content two</h4>
	<p>Donec id elit non mi porta gravida at eget metus. Maecenas faucibus mollis interdum.</p>
</div>
  • Now, add this script below to any event or function you wish:
$('.fastuts').fastuts();

And that's all! Enjoy your content in your table.


Complete mode

Would you like to fully customize fastuts.js? Here's all the options:

$('.fastuts').fastuts
({
	settings:
	{
		spacing: '40px',
		time: 0.2,
		autoScroll: true,
		allowKeys: true
	},
	buttons:
	{
		close:
		{
			text: 'Close',
			callback: function ()
			{
				console.log('Clicked close button');
			}
		},
		prev:
		{
			text: '&#10094;',
			callback: function (index, element)
			{
				console.log('Clicked back button and moving to element ' + index);
			}
		},
		next:
		{
			text: '&#10095;',
			callback: function (index, element)
			{
				console.log('Clicked next button and moving to element ' + index);
			}
		}
	},
	overlay:
	{
		color: 'rgba(0,0,0,0.8)',
		allowEscapeKey: true,
		onClose: function ()
		{
			console.log('Clicked on overlay to close');
		}
	},
	onReady: function ()
	{
		console.log('Fastuts ready!');
	},
});

Help?

Tweet me: @guimadaleno


License

GNU GPL

Peace!

fastuts's People

Contributors

guimadaleno avatar

Watchers

James Cloos avatar Eric Ting 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.