<bs-timeline>

Element providing a responsive timeline Based on http://www.bootsnipp.com/snippets/featured/timeline-responsive

Demo

Install

Install the component using Bower:

$ bower install oce-timeline --save

Or download as ZIP.

Usage

Import Web Components' polyfill:

<script src="bower_components/platform/platform.js"></script>

Import Custom Element:

<link rel="import" href="bower_components/bs-timeline/bs-timeline.html">

Start using it!

    <bs-timeline>
	<bs-timeline-entry title="Geez!" time="11 hours ago until now" badge="plus">
		<p>Mussum ipsum cacilds, vidis litro abertis. Consetis adipiscings elitis. Pra lá , depois divoltis porris, paradis. Paisis, filhis, espiritis santis. Mé faiz elementum girarzis, nisi eros vermeio, in elementis mé pra quem é amistosis quis leo. Manduma pindureta quium dia nois paga. Sapien in monti palavris qui num significa nadis i pareci latim. Interessantiss quisso pudia ce receita de bolis, mais bolis eu num gostis.</p>
	</bs-timeline-entry>
</bs-timeline>

Options

Attribute	Options	Default	Description
`title`	string	``	The title
`time`	string	``	The time of the event
`badge`	string	`plus`	Glyphicon to use for the entry
`opened`	boolean	`true`	Display collapsed or opened
`inverse`	boolean	`false`	Display inverted (right side)

Methods

Method	Parameters	Returns	Description
`toggle()`	None.	Nothing.	Open/close the entry

Events

Event	Description
`onsomething`	Triggers when something happens.

Development

In order to run it locally you'll need to fetch some dependencies and a basic server setup.

Install Bower & Grunt:
```
$ [sudo] npm install -g bower grunt-cli
```
Install local dependencies:
```
$ bower install && npm install
```
To test your project, start the development server and open http://localhost:8000.
```
$ grunt server
```
To build the distribution files before releasing a new version.
```
$ grunt build
```
To provide a live demo, send everything to gh-pages branch.
```
$ grunt deploy
```

Contributing

Fork it!
Create your feature branch: git checkout -b my-new-feature
Commit your changes: git commit -m 'Add some feature'
Push to the branch: git push origin my-new-feature
Submit a pull request :D

History

For detailed changelog, check Releases.

License

MIT License

h0ru5/bs-timeline