Git Product home page Git Product logo

tour.js's Introduction

📸 Tour.js

Tour is like bootstrap carousel with additional powerfull features. No need for JQuery library.

Demo

See live Demo

Version

  • Version 2.5

New Features

  • V(2.5) The last code was not compatible with any internal update on the elements if you use this plugin with (Asynchronous request) like example so the new version solve this matter. In wrods you can use this plugin with Angular framework like any other plugin with no problem.
  • V(2.0) Solving some issues and adding few effects that can you change them using "slideEffect" property.

🔨 Getting Started

  1. Take a copy from the project.
  2. take a copy of both files tour.js and tour.css then paste them inside your project.
  3. append your project with the following tags which are:
	<link href="https://maxcdn.bootstrapcdn.com/font-awesome/4.7.0/css/font-awesome.min.css" rel="stylesheet">
	<link rel="stylesheet" href="yourPath/tour.css">
	<script src="yourPath/tour.js" type="text/javascript"></script>
  1. I used fontawesome library to bring the shape of arrows so if you want to do the same or ignore the first tag and use your own shape.
  2. Don't forget to execute Tour function by writing those codes:
	document.addEventListener('DOMContentLoaded', function (){
	document.removeEventListener('DOMContentLoaded', arguments.calee);
		tour('.tour').apply();
	});

If you are running JQuery library then you need just to write this code below inside the ready function.

tour('.tour').apply();

🔬 Features and why Tour.js

I was searching for a slider or carousel as they call it today for making my own specefic slider according to my properties. I did not find some thing special so i decided to build my own slider that can accept any developer requirement.

Tour.js also work with asynchronous request using observer event if you use like example Angular http API but be in mind that features will still work for a period time to prevent any huge memory size utilization.

Lets go with Tour.js features: When you run Tour function you can pass an object to do some controlls, the whole object is like this.

tour('.tour').apply({
	"delay": 6000,
	"startCycle": true,
	"showArrows": true,
	"slideEffect": 'sliding',
	"returnAPI": false
});
"delay": 6000

It is the time that slider will holds in ms = 6 seconds.

"startCycle": true

Starting Tour automatice sliding.

"showArrows": true

To show the two aside arrows as you wish.

"SlideEffect": 'sliding'

There are 3 slide transition effects which are 'sliding', 'fading', 'rolling'

"returnAPI": true

It will return API methods that can controll Tour in another places in your code. This is a very important feature should assigne to "true" if you want to controll your own slider with your own programm methods.

The return API will be the following methods:

{
	"element": will return the current element,
	"next": function can be execut to go to the next slide,
	"prev": the previous of next function,
	"indeicators": will return the current element indeicator's elements
	"transition": Here you can see or change your slide transition in respect of 3 slide transition effects explained above.
};

Browser Compatibilities

I develop the project from time to time so for the moment i thing that IE is not supported but working on it. Any other intiligent browser will just work fine.

Built With

License

This project is licensed under the MIT License. In words it is free to use and develope.

Contact

Acknowledgments

  • HTML/CSS
  • Javascript/JQuery
  • SASS
  • Bootstrap
  • PHP
  • MySQL
  • Angular 2

Want to support me!

Please make a feedback if any issue happen to you. Thank you... Enjoy.

tour.js's People

Contributors

ahmedbhameed avatar

Stargazers

Andrea Alba avatar Divine avatar Jan Pražák avatar  avatar

Watchers

James Cloos avatar

tour.js's Issues

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.