Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Update README.md #1

Merged
merged 1 commit into from Nov 25, 2015
Merged

Update README.md #1

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
6 changes: 3 additions & 3 deletions README.md
View file
Open in desktop
Expand Up @@ -31,14 +31,14 @@ A version with a global object is also available.
```html
<script src="teleporter-global.js"></script>
```
If you have to support all browsers, you need to install the [Promise](https://github.com/jakearchibald/es6-promise) and [Web Animations](https://github.com/web-animations/web-animations-js) polyfills. A version of teleporter bundles everything in one file.
If you have to support all browsers, you need to install the [Promise](https://github.com/jakearchibald/es6-promise), [Web Animations](https://github.com/web-animations/web-animations-js) and [Object.assign()](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object/assign) polyfills. A version of teleporter bundles everything in one file.
```html
<script src="teleporter-global-polyfilled.js"></script>
```

## API
### Basic
```
```javascript
var myElement = new Teleporter('#myid');
myElement.teleport('myclass');
```
Expand All @@ -47,7 +47,7 @@ This will teleport your element from its current state to the state correspondin
### Constructor

**'animation'**
```
```javascript
var myElement = new Teleporter({
selector: '#myid',
animation: {
Expand Down