Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/tomhazledine/picobel
A lightweight wrapper for HTML audio. Bring your own CSS.
https://github.com/tomhazledine/picobel
audio-player css html-audio
Last synced: 18 days ago
JSON representation
A lightweight wrapper for HTML audio. Bring your own CSS.
- Host: GitHub
- URL: https://github.com/tomhazledine/picobel
- Owner: tomhazledine
- License: mit
- Created: 2015-06-14T15:53:20.000Z (over 9 years ago)
- Default Branch: main
- Last Pushed: 2024-02-16T17:33:09.000Z (9 months ago)
- Last Synced: 2024-10-12T23:43:45.210Z (about 1 month ago)
- Topics: audio-player, css, html-audio
- Language: CSS
- Homepage:
- Size: 75.6 MB
- Stars: 61
- Watchers: 3
- Forks: 9
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: license.txt
Awesome Lists containing this project
README
Picobel.js
v3.0.2
Picobel.js (pronounced _peek-o-bell_, as in _decibel_) is a lightweight dependency-free JavaScript tool that converts html audio tags into styleable markup.
Documentation can be found at [picobel.tomhazledine.com](https://picobel.tomhazledine.com/).
## Quick Start
### JavaScript
Picobel is a JavaScript utility, so you'll need to include the script somehow. The recommended method is to [install from npm](#install-js-from-npm) but you can also download the script bundle and [include it directly](#install-js-manually).
#### Install JS from [npm](https://www.npmjs.com/package/picobel)
`yarn add picobel` (or `npm install picobel`) will install Picobel in your project and add Picobel into the `dependencies` section of your `package.json` file.
```js
// Include Picobel in your project:
import picobel from 'picobel';
// Initialise picobel:
picobel();
// ...or initialise picobel with your chosen options:
picobel({ theme: 'default' });
```
#### Install JS manually
If you prefer not to use npm, you can include the Picobel build file directly.
```html
picobel();
```
### CSS (optional)
Picobel's primary aim is to provide structured markup for styling audio players. If you're commited to writing all your own CSS then you do not need to include any of the Picobel stylesheets (although feel free to [use the pre-made themes as inspiration](/themes) or as a jumping-off point for [writing your own styles](/styling)).
But you don't **have** to write your own CSS. Picobel comes with several "pre made" themes that you can include.
Adding a theme is a two-step process:
1. Declare the `theme` option when initialising Picobel.
2. Be sure to inclde the relevant stylesheet in your project.
```js
picobel({ theme: 'default' });
```
You can find the CSS files for each theme in the [`/src/css` directory of the GitHub repo](https://github.com/tomhazledine/picobel/tree/main/src/css), along with minified production-ready versions [here](https://github.com/tomhazledine/picobel/tree/main/build). The filename convention is `picobel.THEME_NAME.css`.