# AFrame GIF Component
**A gif controller for [A-Frame](https://aframe.io) VR. Requires [`aframe-gif-shader`](https://github.com/mayognaise/aframe-gif-shader).
Inspired by [@gtk2k](https://github.com/gtk2k)'s [awesome sample](https://github.com/gtk2k/gtk2k.github.io/tree/master/animation_gif).**
**[DEMO](https://mayognaise.github.io/aframe-gif-component/basic/index.html)**
## Method
### Global method
#### `play()`
Play gif animation
```js
entity.play()
```
#### `pause()`
Pause gif animation
```js
entity.pause()
```
### Custom method
#### `togglePlayback()`
Toggle playback. if the gif is paused, play and pause if it's playing.
```js
entity.components.gif.togglePlayback()
```
#### `nextFrame()`
Go to next frame. Useful if it's paused.
```js
entity.components.gif.nextFrame()
```
#### `paused()`
Returns if it is paused.
```js
const paused = entity.components.gif.paused() // true or false
```
## Usage
### Browser Installation
Install and use by directly including the [browser files](dist):
```html
My A-Frame Scene
```
### NPM Installation
Install via NPM:
```bash
npm i -D aframe-gif-shader aframe-gif-component
```
Then register and use.
```js
import 'aframe'
import 'aframe-gif-shader'
import 'aframe-gif-component'
```