Home

Awesome

react-karaoke-lyric

npm version Build Status Coverage Status

Display karaoke lyric progress via React

lyric1

lyric2

Installation

$ npm install react-karaoke-lyric

Usage

const KaraokeLyric = require('react-karaoke-lyric');

// Blue
<KaraokeLyric text="Hello world" percentage="80" />

// Red
<KaraokeLyric text="Hello World" percentage={35} activeStyle={{
  color: '#e50906',
}} />

API

props

text

Required Type: string

Text be displayed.

percentage

Required Type: number

Progress.

wrapperStyle

Type: object

Custom wrapper style.

fontStyle

Type: object

Custom font style.

activeStyle

Type: object

Custom active style.

License

MIT © C.T. Lin