https://github.com/mchalapuk/hyper-text-slider

Declarative, CSS3-Powered Slideshow component.
https://github.com/mchalapuk/hyper-text-slider

Last synced: 25 days ago
JSON representation

Declarative, CSS3-Powered Slideshow component.

• Host: GitHub
• URL: https://github.com/mchalapuk/hyper-text-slider
• Owner: mchalapuk
• License: apache-2.0
• Created: 2015-09-05T06:12:47.000Z (about 9 years ago)
• Default Branch: master
• Last Pushed: 2019-04-14T01:11:59.000Z (over 5 years ago)
• Last Synced: 2024-10-10T06:49:45.089Z (27 days ago)
• Language: JavaScript
• Homepage:
• Size: 821 KB
• Stars: 0
• Watchers: 1
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# HyperText Slider

[![Build Status][travis-image]][travis-url]

[![Dependency Status][david-image]][david-url]

[![devDependency Status][david-image-dev]][david-url-dev]

[![Documentation Status][inch-image]][inch-url]

[travis-url]: https://travis-ci.org/mchalapuk/hyper-text-slider

[travis-image]: https://travis-ci.org/mchalapuk/hyper-text-slider.svg?branch=master

[david-url]: https://david-dm.org/mchalapuk/hyper-text-slider

[david-image]: https://david-dm.org/mchalapuk/hyper-text-slider.svg

[david-url-dev]: https://david-dm.org/mchalapuk/hyper-text-slider?type=dev

[david-image-dev]: https://david-dm.org/mchalapuk/hyper-text-slider/dev-status.svg

[inch-url]: https://inch-ci.org/github/mchalapuk/hyper-text-slider

[inch-image]: https://inch-ci.org/github/mchalapuk/hyper-text-slider.svg?branch=master

Web slideshow component which comes with:

 * separately configurable background and content [CSS3 Transitions][transitions],

 * responsiveness (automatically adjusts it's layout to screen resolution),

 * extendability (adding new transtitions is very simple),

 * component-based approach (each feature can be enabled separately),

 * declarative (HTML/CSS) programming interface (no JavaScript coding required).

[transitions]: http://www.w3.org/TR/css3-transitions/

## Getting the Code

Preferred way to get HyperText Slider is to use [bower](http://bower.io/).

```shell

bower install hyper-text-slider --save-dev

```

You can also use [npm](https://www.npmjs.com/) (especially if using

[browserify](https://github.com/substack/node-browserify)).

```shell

npm install --save hyper-text-slider

```

## Hello, HyperText Slider!

```html

  Hello, HyperText Slider!

  

  

  

  


    


      
Hello, HyperText Slider!

    



    


      
How's the waether?

    

  


  

  

  

```

## Documentation

API Reference:

 * [Declarative API](doc/class-names.md)

 * [JavaScript API](doc/javascript-api.md)

User Guides:

 * [Adding Custom Themes](doc/custom-themes.md)

 * [Screen Responsiveness](doc/responsiveness.md)

 * [Slider's DOM Upgrade](doc/dom-upgrade.md)

Tutorials:

 * [HyperText Slider via Node and Browserify][node-tutorial]

See Also:

 * [Animatable CSS Properties][animatable]

Project Info:

 * [TODO](doc/TODO.md)

 * [CHANGELOG](doc/CHANGELOG.md)

[node-tutorial]: https://github.com/mchalapuk/hyper-text-slider-node-tutorial

[animatable]: https://drafts.csswg.org/css-transitions/#animatable-properties

## Contributing

Please read [build.config.js](build.config.js) file before contributing.

Pull requests are very welcome!

## License

Copyright © 2016 Maciej Chałapuk.

Released under [Apache License Version 2.0](LICENSE).