NativeScript-Gif
NativeScript plugin to use GIFs in your application.
---
## Installation
NativeScript Version 7+:
`tns plugin add nativescript-gif`
NativeScript Version prior to 7:
`tns plugin add nativescript-gif@4.0.6`
The native libraries used to handle rendering GIFs for Android & iOS.
| Android Library | iOS CocoaPod |
| --------------------------------------------------------------------------------- | ---------------------------------------------------------------------------- |
| [Koral-- / android-gif-drawable](https://github.com/koral--/android-gif-drawable) | [FLAnimatedImage by Flipboard](https://github.com/Flipboard/FLAnimatedImage) |
| Android Screen | iOS Screen |
| ---------------------------------------- | ----------------------------------- |
|  |  |
## Usage
#### Plain NativeScript
IMPORTANT: _Make sure you include
`xmlns:Gif="nativescript-gif"` on the Page element._
```XML
```
### NativeScript Angular
```typescript
import { registerElement } from 'nativescript-angular/element-registry';
import { Gif } from 'nativescript-gif';
registerElement('Gif', () => Gif);
```
##### HTML
```HTML
```
### Bundling Note:
Demo app sample: https://github.com/bradmartin/nativescript-gif/blob/master/demo/webpack.config.js#L218
Be sure that you have your `.gifs` added to the globs of the CopyWebpackPlugin as part of your webpack.config.
```javascript
{
from: {
glob: '**/*.gif';
}
}
```
## Properties
- **src** - _required_
Set the gif file to play.
- **headers - (JSON Object)** - _optional_
Set headers to add when loading a gif from URL
## API
##### start()
- starts playing the .gif
##### stop()
- stops playing the .gif
##### getFrameCount()
- returns the number of frames in the current .gif
##### isPlaying()
- returns boolean value indicating if the gif is playing.
---
###### _Android Only_
##### getDuration()
- returns the .gif duration
##### reset()
- resets the .gif to its initial frame
##### setSpeed(speedFactor: _Number_)
- sets the .gif play speed
##### recycle()
- provided to speed up freeing memory _advanced usage - you shouldn't need this often_