0.0.2 • Published 9 years ago

paper-audio-player v0.0.2

Weekly downloads
22
License
MIT
Repository
github
Last release
9 years ago

paper-audio-player

A custom audio player with material paper style and clean design.

Paper-audio-player example

Live demo

Check the Player live here.

Element usage example

Here is an example of code to add a Paper-Audio-Player element to your page:

<paper-audio-player src="track.mp3" title="STING - Desert Rose" color="#F05C38"></paper-audio-player>

Title and color attributes are optional.

Install

Install the component using NPM:

npm install paper-audio-player --save

Install the component using Bower:

bower install paper-audio-player --save

Or download as ZIP.

Dependencies

  • Polymer 1.0
  • Paper-progress
  • Iron-Icons

These dependencies are managed via Bower. You can install that via:

npm install -g bower

Then, go ahead and download the player's dependencies:

bower install

Usage

  1. Import Web Components' polyfill:

    <script src="bower_components/webcomponentsjs/webcomponents.js"></script>
  2. Import Player element:

    <link rel="import" href="bower_components/paper-audio-player/paper-audio-player.html">
  3. Start using it!

    <paper-audio-player src="track.mp3"></paper-audio-player>
    <paper-audio-player src="podcast-2.mp3" title="My Podcast #2"></paper-audio-player>
    <paper-audio-player src="song.mp3" title="PANG! - Cry Me A River" color="#F05C38"></paper-audio-player>

Customization

AttributeOptionsDescription
srcstringThe URL path to the audio file
titlestringCustomize the track name
colorstringCustomize the accent color that will be used

Development

If you wish to work on your element in isolation, we recommend that you use Polyserve to keep your element's bower dependencies in line. You can install it via:

npm install -g polyserve

And you can run it via:

polyserve

Once running, you can preview your element at http://localhost:8080/components/paper-audio-player/

To work with Demo page styling with Sass, install grunt and its plugins:

npm install

After you made any changes, create new CSS file:

gulp

This will convert Sass into CSS and run Autoprefixer.

Contributing

  1. Fork it!
  2. Create your feature branch: git checkout -b new-feature
  3. Commit your changes: git commit -m 'Add some awesomeness'
  4. Push to the branch: git push origin new-feature
  5. Submit a pull request!

License

MIT License © Nadi Dikun