# Changelog

All notable changes to this project will be documented in this file.

The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).

## [Unreleased]

## [2.1.1] - 2021-03-02

### Fixed

- `findMediaElement` children checking

## [2.1.0] - 2021-02-27

### Added

- `setAlignment()` function
- `setViewMode()` function

### Fixed

- Highlight current lyrics line immediately after re-rendering or clicking

## [2.0.0] - 2021-02-25

### Added

- ESM module
- Karaoke feature
- `setLyrics()` function to change lyrics dynamically

### Changed

- **BREAKING CHANGE**: rename UMD module

### Removed

- **BREAKING CHANGE**: height option. You can set height through CSS.

## [1.3.0] - 2019-08-19

### Changed

- Change license from GPLv3 to AGPLv3

### Fixed

- Support hour timestamp [#12](https://github.com/guoyunhe/rabbit-lyrics/issues/12)

## [1.2.0] - 2019-06-06

### Added

- Support multiple lyrics [#10](https://github.com/guoyunhe/rabbit-lyrics/issues/10)

## [1.1.2] - 2019-05-08

### Fixed

- Webpack library export issues [#9](https://github.com/guoyunhe/rabbit-lyrics/issues/9)

## [1.1.1] - 2019-02-28

### Fixed

- Cannot specify media element [#6](https://github.com/guoyunhe/rabbit-lyrics/issues/6)
- `data-audio` should be changed to `data-media` in documentation

## [1.1.0] - 2018-10-25

### Added

- Support timestamp with hours `[hh:mm:ss.xx]`, like `[2:17:53.92]`.
- Add alignment option.
- Add height option.
- Add changelog.
- CSS class of playing status.

### Changed

- Go back to CSS from SCSS, since the style is too simple.
- Build with latest webpack (v4.17.0) and css loader (v1.0.0).
- Update document and examples.
- Use BEM naming.

### Removed

- Don't extract CSS file anymore. Style will be loaded by JavaScript. A single
  entry point makes it easier to import.

## [1.0.0] - 2017-07-31

### Added

- Published as Node module.
- Support three view mode.

### Changed

- Rewrite in ES5 class. Build with webpack.
- Auto-scroll is more accurate and smooth.
- Better documentation and examples.

### Removed

- Remove jQuery dependency and support. Now it doesn't have any run-time dependency.
- Remove `size` option. Use `viewMode` instead.

## [0.1.2] - 2015-10-08

### Changed

- Skip empty lines when playing.

## [0.1.1] - 2015-10-08

### Fixed

- Fixed timestamp parsing bug.

## [0.1.0] - 2015-10-08

### Added

- Lyrics parser.
- Lyrics synchronizer
- Three sizes: tiny, medium, full.

[unreleased]: https://github.com/guoyunhe/rabbit-lyrics/compare/v2.1.1...HEAD
[2.1.1]: https://github.com/guoyunhe/rabbit-lyrics/compare/v2.1.0...v2.1.1
[2.1.0]: https://github.com/guoyunhe/rabbit-lyrics/compare/v2.0.0...v2.1.0
[2.0.0]: https://github.com/guoyunhe/rabbit-lyrics/compare/v1.3.0...v2.0.0
[1.3.0]: https://github.com/guoyunhe/rabbit-lyrics/compare/v1.2.0...v1.3.0
[1.2.0]: https://github.com/guoyunhe/rabbit-lyrics/compare/v1.1.2...v1.2.0
[1.1.2]: https://github.com/guoyunhe/rabbit-lyrics/compare/v1.1.1...v1.1.2
[1.1.1]: https://github.com/guoyunhe/rabbit-lyrics/compare/v1.1.0...v1.1.1
[1.1.0]: https://github.com/guoyunhe/rabbit-lyrics/compare/v1.0.0...v1.1.0
[1.0.0]: https://github.com/guoyunhe/rabbit-lyrics/compare/v0.1.2...v1.0.0
[0.1.2]: https://github.com/guoyunhe/rabbit-lyrics/compare/v0.1.1...v0.1.2
[0.1.1]: https://github.com/guoyunhe/rabbit-lyrics/compare/v0.1.0...v0.1.1
[0.1.0]: https://github.com/guoyunhe/rabbit-lyrics/releases/tag/v0.1.0