react-apng

A React component make apng to canvas for controling apng

Downloads in past

Stats

StarsIssuesVersionUpdatedCreatedSize
react-apng
501.4.05 years ago5 years agoMinified + gzip package size for react-apng in KB

Readme

react-apng
APNG implementation on canvas as a React.js component, provides functions for control it (base on apng-js).

Demo & Examples

Live demo: https://sl2782087.github.io/react-apng/ To run the examples locally: ``` npm install or yarn npm start or yarn start ``` Then open localhost:8080/docs/ in a browser.

Installation

react-apng is available through npm or yarn: ``` npm install react-apng --save ``` ``` yarn add react-apng --save ```

Usage

Require the react-apng component and render it with JSX: ```javascript import React from 'react'; import ApngComponent from 'react-apng'; //const ApngComponent = require('react-apng'); or this way import apic1 from './apic1.png'; class ApngComponent extends React.Component {
render() {
return <ApngComponent src={apic1} />;
}
} React.render(, document.getElementById('app')); ```

Methods && State

methods

  • play play the apng
  • pause pause the apng
  • stop stop the apng
  • one play the apng once

state

  • isPlay apng play status
```javascript class ApngComponent extends React.Component {
playAndPause =()=>{
const apngcom = this.refs.apngcom;
const isPlay = apngcom.isPlay;
if(isPlay){
apngcom.pause();
}else {
apngcom.play();
}
}
render() {
return (
<ApngComponent
ref="apngcom"
onClick={this.playAndPause}
src={apic1}
/>;
)
}
} ``` You can interact with the component instance using a ref after the componentDidMount lifecycle event has fired (including inside the componentDidMount event in a parent Component).

Properties

  • className string canvas className
  • style string canvas style
  • src string local image path
  • autoPlay bool auto play apng (default false)
  • rate floot apng play rate (default 1.0)
  • onClick,onMouseOver... function bind events like a real dom
Copyright (c) 2018 wangzy MIT Licensed.