rn-sprite-sheet-18/index.d.ts

A sprite sheet animation library for React Native

import { MutableRefObject, PureComponent } from 'react';
import { StyleProp, ViewStyle, ImageStyle } from 'react-native';

type AnimationConfig = {
  [name: string]: number[];
};

export interface ISpriteSheetProps {
  source: number | { uri: string; width: number; height: number };
  columns: number;
  rows: number;
  ref: MutableRefObject<SpriteSheet | null>;
  animations: AnimationConfig; // see example
  viewStyle?: StyleProp<ViewStyle>; // styles for the sprite sheet container
  imageStyle?: StyleProp<ImageStyle>; // styles for the sprite sheet
  width?: number;
  height?: number;
  onLoad?: () => void;
}

export class SpriteSheet extends PureComponent<ISpriteSheetProps, {}> {
  play: (config: {
    type: string;
    fps?: number;
    loop?: boolean;
    resetAfterFinish?: boolean;
    onFinish?: () => void;
  }) => void;
  stop: (cb?: (value: number) => void) => void;
  reset: (cb?: (value: number) => void) => void;
}

export default SpriteSheet;