dungang / jquery.timeline Goto Github PK

jQuery.Timeline V2

You are able to easily create two types of horizontal timeline with this jQuery plugin.

Report bug · Request feature · Blog

Table of Contents

• Quick start
• Status
• What's included
• Usage
• Supported browsers
• Documentation
• Example as demonstration
• Creators
• Copyright and license

Quick start

Several quick start options are available:

• Download the latest release.
• Clone the repository: git clone https://github.com/ka215/jquery.timeline.git

Status

What's included

Within the download you'll find the following directories and files, logically grouping common assets and providing compiled and minified variations. You'll see something like this:

jquery.timeline/
└── dist/
    ├── jquery.timeline.min.css
    ├── jquery.timeline.min.css.map
    ├── jquery.timeline.min.js
    └── jquery.timeline.min.js.map

We provide compiled and minified CSS and JS (jquery.timeline.min.*). source maps (jquery.timeline.*.map) are available for use with certain browsers' developer tools.

Usage

Include the installed files into your html:

<link rel="stylesheet" src="./jquery.timeline/dist/jquery.timeline.min.css">

<script src="./jquery.timeline/dist/jquery.timeline.min.js"></script>

Bind this plugin in the scope had imported the jQuery:

$('#myTimeline').Timeline()

Supported browsers

jQuery.Timeline version 2.x supports the following browsers:

PC						Mobile
Ok	Ok	?	NG	Ok	?	?	?

Unfortunately as for the Internet Explorer etc., several methods of this plugin does not work because JavaScript implementation of browser is too immature. Please note that we are not go to support for these legacy browsers in the future.

Documentation

jQuery.Timeline's documentation, included in this repository in the root directory, is built with ESDoc and publicly hosted on GitHub Pages at https://ka2.org/. The docs may also be run locally.

Documentation for previous releases

• For v2.0.x: (WIP)
• For v1.0.x: https://raw.githubusercontent.com/ka215/jquery.timeline/v1/README.md
• For v1.0.x (Japanese): https://ka2.org/released-jquery-timeline-for-easily-generating-two-type-horizontal-timeline/

Example as demonstration

(WIP)

Creators

ka2 (Katsuhiko Maeno)

• https://ka2.org/

Copyright and license

Code and documentation copyright 2011-2018 the ka2. Code released under the MIT License.