Getting Started

A icon dance style cpmponent deved with react.

📦 Install

yarn add react-icon-dance

or you can:

npm install react-icon-dance

🚀 Usage

import Icon from 'react-icon-dance';
import icon from '../assets/icon.png';

function App() {
  return (
    <Icon size={64} interval={10} src={icon} />
  )
}

📔 API

| Params | Description | Type | Default | |------------|:----------------------------------------------|:----------|:---------| | async | The async properties of extarnal resources <script> | boolean | true | | media | The media properties of extarnal resources <link>, support all/screen/print/handheld | string | all | | target | The DOM or Refs of container which need to load the <img> | HTMLElement | (() => HTMLElement) | MutableRefObject | - |

🔨 Contribute

Install dependencies,

$ npm i

Start the dev server,

$ npm start

Build documentation,

$ npm run docs:build

Build library via father-build,

$ npm run build

License

MIT