Skip to content

Latest commit

 

History

History
40 lines (29 loc) · 1.56 KB

File metadata and controls

40 lines (29 loc) · 1.56 KB

react-partyparrot

Installation

Install the package react-partyparrot with your favorite package manager.

Configuration

You need to make the parrot gifs publicly accessible. There are the following options to do that:

  • symlink or copy the folder node_modules/react-partyparrot/parrots manually to your public directory
  • or better: Use copy-webpack-plugin to copy the files at build time

The component expects the gif to be accessible in /parrots, but you can change that.

import { setPublicParrotPath } from 'react-partyparrot'

setPublicParrotPath('/your/custom/parrot/path')

Usage

Import the parrot component

import Parrot from 'react-partyparrot'

And use it in your app

<Parrot />

Props

Name Type Required Default Description
name string no '' Name of the parrot. Omit to get the default parrot.
hd bool no false Get HD version of the parrot.

License

View the license file