README.md

NativeScript-Gif

NativeScript plugin to use .gifs

Android Library	iOS CocoaPod
Koral-- / android-gif-drawable	FLAnimatedImage by Flipboard

Installation

npm install nativescript-gif or tns plugin add nativescript-gif

Android Screen	iOS Screen

Usage

XML

IMPORTANT: Make sure you include xmlns:Gif="nativescript-gif" on the Page element.

<Page xmlns="http://schemas.nativescript.org/tns.xsd"
      xmlns:Gif="nativescript-gif" loaded="pageLoaded">
  <StackLayout>
    <Gif:Gif src="~/gifs/bill.gif" height="100" />
    <Gif:Gif src="https://media4.giphy.com/media/3uyIgVxP1qAjS/200.gif" height="200" />
  </StackLayout> 
</Page>  

Angular 2

TypeScript

import { registerElement } from "nativescript-angular/element-registry";

registerElement("Gif", () => require("nativescript-gif").Gif);

HTML

<StackLayout>
    <Gif src="~/gifs/bill.gif" height="100" ></Gif>
    <Gif src="https://media4.giphy.com/media/3uyIgVxP1qAjS/200.gif" height="200" ></Gif>
</StackLayout>

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

Contributors

• NathanaelA - @CongoCart
• NathanWalker - @wwwalkerrun