https://github.com/rkrupinski/prez

Simple presentation engine
https://github.com/rkrupinski/prez

Last synced: about 1 month ago
JSON representation

Simple presentation engine

• Host: GitHub
• URL: https://github.com/rkrupinski/prez
• Owner: rkrupinski
• Created: 2013-03-18T18:30:43.000Z (almost 12 years ago)
• Default Branch: master
• Last Pushed: 2014-05-21T20:02:39.000Z (over 10 years ago)
• Last Synced: 2024-04-13T18:24:19.126Z (8 months ago)
• Language: JavaScript
• Homepage:
• Size: 301 KB
• Stars: 0
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
prez

====

A simple slide-based animation tool originally designed to work with screen capture software.

###few things to know

* it does not come with wide browser support out of the box; no fallbacks included

* it does not come with any controls, it just runs and notifies when it's done

* it's public API is limited to the `start` method

###usage

Slides behaviour is controlled via `data-*` attributes:

* `data-pos-x`, `data-pos-y`, `data-pos-z` - positions slide in three-dimensional space (default: `0`)

* `data-rotate-x`, `data-rotate-y`, `data-rotate-z` - rotates slide around x / y / z axis (default: `0`)

* `data-scale` - scales slide up / down (default: `1`)

* `data-duration` - sets slide's life time (default: `2000`)

* `data-transition` - sets slide's transition duration (default: `750`)

* `data-easing` - sets slide's transition timing function (default: `ease`)

Each slide has 4 states which can be addressed using Sass mixins:

* `prez-before` - addresses all unseen slides

* `prez-next` - addresses slide being shown

* `prez-current` - addresses currently viewed slide

* `prez-after` - addresses all seen slides

Two callbacks can be passed to the `Prez` constructor:

* `onComplete(timeElapsed)` invoked when last slide ends it's life

* `onProgress(index, slide)` invoked when a slide is shown

###configuration

For "variety" of available configuration options check [here](https://github.com/rkrupinski/prez/blob/master/js/config/default.js).

###example

http://rkrupinski.github.io/prez/

###changelog

* "0.0.5" - vendor prefix sniffing (which is obviously a bad practice)

* "0.0.4" - `onComplete` & `onProgress` added

* "0.0.3" - default attribute values

* stuff...