bitmovin-player-ui
Version:
Bitmovin Player UI Framework
51 lines (31 loc) • 2.97 kB
Markdown
# Bitmovin Player UI [](https://badge.fury.io/js/bitmovin-player-ui) [](https://app.travis-ci.com/bitmovin/bitmovin-player-ui)
This repository contains the Bitmovin Player UI framework.
It is designed as a flexible and modularized layer on the player API, enabling customers and users of the player to easily customize the UI to their needs in design, structure, and functionality. It makes it extremely easy and straightforward to add additional control components and we encourage our users to proactively contribute to our codebase.
Read more about the Framework, its usage and customization possibilities in our [developer documentation](https://developer.bitmovin.com/playback/docs/bitmovin-player-ui) and the [API documentation](https://cdn.bitmovin.com/player/ui/4/docs/index.html).
## Installation
The UI framework is also available through the following distribution channels:
### CDN
The UI framework and default skin bundled with the latest player release are always available via CDN. This is the recommended way if you just want to work with the predefined UI components. All components will be available in the `bitmovin.playerui` namespace.
- JavaScript library: `https://cdn.jsdelivr.net/npm/bitmovin-player-ui@4/dist/js/bitmovinplayer-ui.js`
- CSS file: `https://cdn.jsdelivr.net/npm/bitmovin-player-ui@4/dist/css/bitmovinplayer-ui.css`
### NPM
The UI framework is also available in the NPM repository and comes with all source and distributable files, JavaScript modules and TypeScript type definitions.
- `npm install bitmovin-player-ui`
## Getting Started with Development
0. Clone Git repository
1. Install node.js
2. Install required npm packages: `npm ci`
3. Run `npm run` to see available scripts
- `npm start` to open test page in browser, build and reload changed files automatically
- `npm run build` to build project into `dist` directory without minification
- `npm run build:prod` to build project with minified files into `dist` directory
- `npm run lint` to lint TypeScript and SASS files
- `npm test` to run the test suite
- `npm run format` to format all files with prettier
- `npm run docs` to generate the HTML documentation
To take a look at the project, run `npm run start`. For changes, check our [CHANGELOG](CHANGELOG.md). This UI framework version is for player v8.
## UI Playground
The UI playground can be launched with `npm start` and opens a page in a local browser window. On this page, you can switch between different sources and UI styles, trigger API actions and observe events.
This page recompiles and reloads files automatically when any `.scss` or `.ts` files are modified. It makes a helpful tool for developing and testing the UI.
## Contributing
Pull requests are welcome! Please check the [contribution guidelines](CONTRIBUTING.md).