@nativescript/rive/index.d.ts

Rive for NativeScript

import { View } from '@nativescript/core';
import { TypeRiveAlignment, TypeRiveDirection, TypeRiveFit, TypeRiveLoop } from './common';
export { TypeRiveAlignment, TypeRiveDirection, TypeRiveFit, TypeRiveLoop } from './common';

export declare class RiveView extends View {
  /**
   * app.rive.runtime.kotlin.RiveAnimationView
   */
  readonly android: any;

  /**
   * NSCRiveController
   */
  readonly ios: any;

  constructor();

  public src: string;
  public autoPlay: boolean;
  public alignment?: RiveAlignment;
  public fit?: RiveFit;
  public artboardName?: string;
  public animationName?: string;
  public stateMachineName?: string;

  /*
   * loop: default AUTO
   * direction: default AUTO
   * */
  public play(loop?: TypeRiveLoop, direction?: TypeRiveDirection, settleInitialState?: true): void;

  /*
   * loop: default AUTO
   * direction: default AUTO
   * */
  public playWithAnimations(animationNames: string[], loop?: TypeRiveLoop, direction?: TypeRiveDirection, areStateMachines?: false, settleInitialState?: true): void;

  /*
   * loop: default AUTO
   * direction: default AUTO
   * */
  public playWithAnimation(animationName: string, loop?: TypeRiveLoop, direction?: TypeRiveDirection, areStateMachines?: false, settleInitialState?: true): void;

  public stop(): void;

  public stopWithAnimations(animationNames: string[], areStateMachines?: false): void;

  public stopWithAnimation(animationName: String, isStateMachine?: false): void;

  public pause(): void;

  public pauseWithAnimation(animationName: string, areStateMachines?: false): void;

  public pauseWithAnimations(animationNames: string[], areStateMachines?: false): void;

  public reset(): void;

  public fireState(stateMachineName: string, inputName: string): void;

  public isPlaying(): boolean;

  public getStateMachines();

  public getAnimations();

  triggerInput(name: string): void;
  triggerInputValue(name: string, value: string | boolean | number | null): void;
}