pax_global_header 0000666 0000000 0000000 00000000064 13250442175 0014515 g ustar 00root root 0000000 0000000 52 comment=e8394d0899a887a1f02f34ea4dee3dcbea4f648f
impress.js-1.0.0/ 0000775 0000000 0000000 00000000000 13250442175 0013610 5 ustar 00root root 0000000 0000000 impress.js-1.0.0/.gitattributes 0000664 0000000 0000000 00000000014 13250442175 0016476 0 ustar 00root root 0000000 0000000 * text=auto
impress.js-1.0.0/.gitignore 0000664 0000000 0000000 00000000060 13250442175 0015574 0 ustar 00root root 0000000 0000000 /js/impress.min.js
/node_modules
/npm-debug.log
impress.js-1.0.0/.gitmodules 0000664 0000000 0000000 00000000125 13250442175 0015763 0 ustar 00root root 0000000 0000000 [submodule "extras"]
path = extras
url = https://github.com/impress/impress-extras
impress.js-1.0.0/.jscsrc 0000664 0000000 0000000 00000000214 13250442175 0015075 0 ustar 00root root 0000000 0000000 {
"preset": "jquery",
// Since we check quotemarks already in jshint, this can be turned off
"validateQuoteMarks": false
}
impress.js-1.0.0/.jshintrc 0000664 0000000 0000000 00000000370 13250442175 0015435 0 ustar 00root root 0000000 0000000 {
"globals": {
"module": true
},
"boss": true,
"browser": true,
"curly": true,
"esversion": 6,
"eqeqeq": true,
"eqnull": true,
"expr": true,
"immed": true,
"noarg": true,
"quotmark": "double",
"undef": true,
"unused": true
}
impress.js-1.0.0/.npmignore 0000664 0000000 0000000 00000000067 13250442175 0015612 0 ustar 00root root 0000000 0000000 /.*/
/.*
/test/
/bower.json
/circle.yml
/karma.conf.js
impress.js-1.0.0/DOCUMENTATION.md 0000664 0000000 0000000 00000026415 13250442175 0016153 0 ustar 00root root 0000000 0000000 # Reference API
## HTML
### Root Element
impress.js requires a Root Element. All the content of the presentation will be created inside that element. It is not recommended to manipulate any of the styles, attributes or classes that are created by impress.js inside the Root Element after initialization.
**Example:**
```html
```
### Step Element
A Step Element is an element that contains metadata that defines how it is going to be presented in the screen.
A Step Element should contain a `.step` class and an optional `id` attribute.
The content represents an html fragment that will be positioned at the center of the camera.
In the Step Element, you can define a specific set of default attributes and positioning, that are documented below.
**Example:**
```html
Aren’t you just bored with all those slides-based presentations?
```
#### 2D Coordinates Positioning (data-x, data-y)
Define the pixel based position in which the **center** of the [Step Element](#step-element) will be positioned inside the infinite canvas.
**Example:**
```html
Aren’t you just bored with all those slides-based presentations?
```
#### 2D Scaling (data-scale)
Defines the scaling multiplier of the [Step Element](#step-element) relative to other Step Elements. For example, `data-scale="4"` means that the element will appear to be 4 times larger than the others. From the presentation and transitions point of view, it means that it will have to be scaled down (4 times) to make it back to its correct size.
**Example:**
```html
then you should try
impress.js*
```
#### 2D Rotation (data-rotate)
Represents the amount of clockwise rotation of the element relative to 360 degrees.
**Example:**
```html
It’s a presentation tool
inspired by the idea behind prezi.com
and based on the power of CSS3 transforms and transitions in modern browsers.
```
#### 3D Coordinates Positioning (data-z)
Define the pixel based position in which the **center** of the [Step Element](#step-element) will be positioned inside the infinite canvas on the third dimension (Z) axis. For example, if we use `data-z="-3000"`, it means that the [Step Element](#step-element) will be positioned far away from the camera (by 3000px).
**Example:**
```html
```
**Note:** The introduction of the [rel](src/plugins/rel/README.md) plugin includes a slight backward incompatible change.
Previously the default value for `data-x`, `data-y` and `data-z` was zero. The `rel` plugin changes the default to inherit
the value of the previous slide. This means, you need to explicitly set these values to zero, if they ever were non-zero.
#### 3D Rotation (data-rotate-x, data-rotate-y, data-rotate-z)
You can not only position a [Step Element](#step-element) in 3D, but also rotate it around any axis.
**Example:**
The example below will get rotated by -40 degrees (40 degrees anticlockwise) around X axis and 10 degrees (clockwise) around Y axis.
You can of course rotate it around Z axis with `data-rotate-z` - it has exactly the same effect as `data-rotate` (these two are basically aliases).
```HTML
have
you
noticed
it’s
in
3D*?
```
#### 3D Rotation Order (data-rotate-order)
The order in which the CSS `rotateX(), rotateY(), rotateZ()` transforms are applied matters. This is because each rotation is relative to the then current position of the element.
By default the rotation order is `data-rotate-order="xyz"`. For some advanced uses you may need to change it. The demo presentation [3D rotations](examples/3D-rotations/index.html) sets this attribute to rotate some steps into positions that are impossible to reach with the default order.
## CSS
### 4D States (.past, .present and .future classes)
The `.future` class is added to all [Step Elements](#step-element) that haven't been visited yet.
**Example:**
```CSS
.future {
display: none;
}
```
The `.present` class is added to the [Step Element](#step-element) that is currently at the center of the camera. This is useful to create animations inside the step once the camera navigates to it.
**Example:**
```CSS
.present .rotating {
transform: rotate(-10deg);
transition-delay: 0.25s;
}
```
The `.past` class is added to all [Step Elements](#step-element) that have been visited at least once.
**Example:**
```CSS
.past {
display: none;
}
```
### Current Active Step (.active class)
The `.active` class is added to the [Step Element](#step-element) that is currently visible at the center of the camera.
**Example:**
```CSS
.step {
opacity: 0.3;
transition: opacity 1s;
}
.step.active {
opacity: 1
}
```
At the same time, the `impress-on-*` class is added to the body element, the class name represents the active [Step Element](#step-element) id. This allows for custom global styling, since you can't match a CSS class backwards from the active [Step Element](#step-element) to the `body`.
**Example:**
```CSS
.impress-on-overview .step {
opacity: 1;
cursor: pointer;
}
.impress-on-step-1,
.impress-on-step-2,
.impress-on-step-3 {
background: LightBlue;
}
```
### Progressive Enhancement (.impress-not-supported class)
The `.impress-not-supported` class is added to the `body` element if the browser doesn't support the features required by impress.js to work, it is useful to apply some fallback styles in the CSS.
It's not necessary to add it manually on the `body` element. If the script detects that the browser lacks important features it will add this class.
It is recommended to add the class manually to the `body` element though, because that means that users without JavaScript will also get fallback styles. When impress.js script detects that the browser supports all required features, the `.impress-not-support` class will be removed from the `body` element.
**Example:**
```CSS
.impress-not-supported .step {
display: inline-block;
}
```
## Plugins
Many new features are implemented as plugins. The [Plugins documentation](src/plugins/README.md) is the starting place to learn about those, as well as the README.md of [each plugin](src/plugins/).
## JavaScript
### impress( [ id ] )
A factory function that creates the [ImpressAPI](#impressapi).
Accepts a [`String`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String) that represents the id of the root element in the page. If omitted, impress.js will lookup for the element with the id "impress" by default.
**Example:**
```JavaScript
var impressAPI = impress( "root" );
```
### ImpressAPI
The main impress.js API that handles common operations of impress.js, listed below.
#### .init()
Initializes impress.js globally in the page. Only one instance of impress.js is supported per document.
**Example:**
```JavaScript
impress().init();
```
Triggers the `impress:init` event in the [Root Element](#root-element) after the presentation is initialized.
**Example:**
```JavaScript
var rootElement = document.getElementById( "impress" );
rootElement.addEventListener( "impress:init", function() {
console.log( "Impress init" );
});
impress().init();
```
#### .tear()
Resets the DOM to its original state, as it was before `init()` was called.
This can be used to "unload" impress.js. A particular use case for this is, if you want to do
dynamic changes to the presentation, you can do a teardown, apply changes, then call `init()`
again. (In most cases, this will not cause flickering or other visible effects to the user,
beyond the intended dynamic changes.)
**Example:**
```JavaScript
impress().tear();
```
#### .next()
Navigates to the next step of the presentation using the [`goto()` function](#impressgotostepindexstepelementidstepelement-duration).
**Example:**
```JavaScript
var api = impress();
api.init();
api.next();
```
#### impress().prev()
Navigates to the previous step of the presentation using the [`goto()` function](#impressgotostepindexstepelementidstepelement-duration).
**Example:**
```JavaScript
var api = impress();
api.init();
api.prev();
```
#### impress().goto( stepIndex | stepElementId | stepElement, [ duration ] )
Accepts a [`Number`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number) that represents the step index.
Navigates to the step given the provided step index.
**Example:**
```JavaScript
var api = impress();
api.init();
api.goto(7);
```
Accepts a [`String`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String) that represents the [Step Element](#step-element) id.
Navigates to the step given the provided [Step Element](#step-element) id.
**Example:**
```JavaScript
var api = impress();
api.init();
api.goto( "overview" );
```
Accepts an [`HTMLElement`](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement) that represents the [Step Element](#step-element).
Navigates to the step given the provided [Step Element](#step-element).
**Example:**
```JavaScript
var overview = document.getElementById( "overview" );
var api = impress();
api.init();
api.goto( overview );
```
Accepts an optional [Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number) in the last argument that represents the duration of the transition in milliseconds. If not provided, the default transition duration for the presentation will be used.
Triggers the `impress:stepenter` event in the [Root Element](#root-element) when the presentation navigates to the target [Step Element](#step-element).
**Example:**
```JavaScript
var rootElement = document.getElementById( "impress" );
rootElement.addEventListener( "impress:stepenter", function(event) {
var currentStep = event.target;
console.log( "Entered the Step Element '" + currentStep.id + "'" );
});
```
Triggers the `impress:stepleave` event in the [Root Element](#root-element) when the presentation navigates away from the current [Step Element](#step-element).
**Example:**
```JavaScript
var rootElement = document.getElementById( "impress" );
rootElement.addEventListener( "impress:stepleave", function(event) {
var currentStep = event.target;
var nextStep = event.detail.next;
console.log( "Left the Step Element '" + currentStep.id + "' and about to enter '" + nextStep.id );
});
```
# Improve The Docs
Did you find something that can be improved? Then [create an issue](https://github.com/impress/impress.js/issues/new) so that we can discuss it!
impress.js-1.0.0/LICENSE 0000664 0000000 0000000 00000002075 13250442175 0014621 0 ustar 00root root 0000000 0000000 The MIT License (MIT)
Copyright (c) 2011-2016 Bartek Szopka
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
impress.js-1.0.0/README.md 0000664 0000000 0000000 00000016324 13250442175 0015075 0 ustar 00root root 0000000 0000000 impress.js
============
[](https://circleci.com/gh/impress/impress.js)
It's a presentation framework based on the power of CSS3 transforms and
transitions in modern browsers and inspired by the idea behind prezi.com.
**WARNING**
impress.js may not help you if you have nothing interesting to say ;)
HOW TO USE IT
---------------
### Checking out and initializing the git repository
git clone --recursive https://github.com/impress/impress.js.git
cd impress.js
Note: For a minimal checkout, omit the `--recursive` option. This will leave out extra plugins.
**Stable releases**
New features and fixes are continuously merged into the master branch, which is what the above command will check out. For the latest stable release, see the [Github Releases page](https://github.com/impress/impress.js/releases).
### Documentation
Reference documentation of core impress.js features and API you can find it in [DOCUMENTATION.md](DOCUMENTATION.md).
The [HTML source code](index.html) of the official [impress.js demo](http://impress.github.io/impress.js/) serves as a good example usage and contains comments explaning various features of impress.js. For more information about styling you can look into [CSS code](css/impress-demo.css) which shows how classes provided by impress.js can be used. Last but not least [JavaScript code of impress.js](js/impress.js) has some useful comments if you are interested in how everything works. Feel free to explore!
### Official demo
[impress.js demo](http://impress.github.io/impress.js/) by [@bartaz](http://twitter.com/bartaz)
### Examples and demos
The [Classic Slides](http://impress.github.io/impress.js/examples/classic-slides/) demo is targeted towards beginners, or can be used as a template for presentations that look like the traditional PowerPoint slide deck. Over time, it also grew into the example presentation that uses most of the features and addons available.
More examples and demos can be found on [Examples and demos wiki page](http://github.com/impress/impress.js/wiki/Examples-and-demos).
Feel free to add your own example presentations (or websites) there.
### Other tutorials and learning resources
If you want to learn even more there is a [list of tutorials and other learning resources](https://github.com/impress/impress.js/wiki/impress.js-tutorials-and-other-learning-resources)
on the wiki, too.
There is also a book available about [Building impressive presentations with impress.js](http://www.packtpub.com/building-impressive-presentations-with-impressjs/book) by Rakhitha Nimesh Ratnayake.
You may want to check out the sibling project [Impressionist](https://github.com/henrikingo/impressionist): a 3D GUI editor that can help you in creating impress.js presentations.
### Mailing list
You're welcome to ask impress.js related questions on the [impressionist-presentations](https://groups.google.com/forum/#!forum/impressionist-presentations) mailing list.
REPOSITORY STRUCTURE
--------------------
* [index.html](index.html): This is the official impress.js demo, showcasing all of the features of the original impress.js, as well as some new plugins as we add them.
* As already mentioned, this file is well commented and acts as the official tutorial.
* [examples/](examples/): Contains several demos showcasing additional features available.
* [Classic Slides](examples/classic-slides/index.html) is a simple demo that that you can use as template if you want to create very simple, rectangular, PowerPoint-like presentations.
* [src/](src/): The main file is [src/impress.js](src/impress.js). Additional functionality is implemented as plugins in [src/plugins/](src/plugins/).
* See [src/plugins/README.md](src/plugins/README.md) for information about the plugin API and how to write plugins.
* [test/](test/): Contains QUnit and Syn libraries that we use for writing tests, as well as some test coverage for core functionality. (Yes, more tests are much welcome.) Tests for plugins are in the directory of each plugin.
* [js/](js/): Contains [js/impress.js](js/impress.js), which contains a concatenation of the core `src/impress.js` and all the plugins. Traditionally this is the file that you'll link to in a browser. In fact both the demo and test files do exactly that.
* [css/](css/): Contains a CSS file used by the demo. This file is **not required for using impress.js** in your own presentations. Impress.js creates the CSS it needs dynamically.
* [extras/](extras/) contains plugins that for various reasons aren't enabled by default. You have to explicitly add them with their own `script` element to use them.
* [build.js](build.js): Simple build file that creates `js/impress.js`. It also creates a minified version `impress.min.js`, but that one is not included in the github repository.
* [package.json](build.js): An NPM package specification. This was mainly added so you can easily install [buildify](https://www.npmjs.com/package/buildify) and run `node build.js`. Other than the build process, which is really just doing roughly `cat src/impress.js src/plugins/*/*.js > js/impress.js`, and testing, `impress.js` itself doesn't depend on Node or any NPM modules.
* [bower.json](bower.json): A Bower package file. We also don't depend on Bower, but provide this file if you want to use it.
WANT TO CONTRIBUTE?
---------------------
For developers, once you've made changes to the code, you should run these commands for testing:
npm run build
npm run test
npm run lint
Note that running `firefox qunit_test_runner.html` is usually more informative than running `karma` with `npm run test`. They both run the same tests.
More info about the [src/](src/) directory can be found in [src/plugins/README.md](src/plugins/README.md).
ABOUT THE NAME
----------------
impress.js name is [courtesy of @skuzniak](http://twitter.com/skuzniak/status/143627215165333504).
It's an (un)fortunate coincidence that a Open/LibreOffice presentation tool is called Impress ;)
Reference API
--------------
See the [Reference API](DOCUMENTATION.md)
BROWSER SUPPORT
-----------------
The design goal for impress.js has been to showcase awesome CSS3 features as found in modern browser versions. We also use some new DOM functionality, and specifically do not use jQuery or any other JavaScript libraries, nor our own functions, to support older browsers. In general, recent versions of Firefox and Chrome are known to work well. Reportedly IE now works too.
The typical use case for impress.js is to create presentations that you present from your own laptop, with a browser version you know works well. Some people also use impress.js successfully to embed animations or presentations in a web page, however, be aware that in this some of your visitors may not see the presentation correctly, or at all.
In particular, impress.js makes use of the following JS and CSS features:
* [DataSet API](http://caniuse.com/#search=dataset)
* [ClassList API](http://caniuse.com/#search=classlist)
* [CSS 3D Transforms](http://caniuse.com/#search=css%203d)
* [CSS Transitions](http://caniuse.com/#search=css%20transition)
COPYRIGHT AND LICENSE
---------------------
Copyright 2011-2016 Bartek Szopka
Copyright 2015-2017 Henrik Ingo
Released under the MIT [License](LICENSE)
impress.js-1.0.0/apple-touch-icon.png 0000664 0000000 0000000 00000007554 13250442175 0017500 0 ustar 00root root 0000000 0000000 PNG
IHDR J J U&