https://github.com/kaltura/playkit-js-visibility
Visibility Plugin for the Kaltura Player JS
https://github.com/kaltura/playkit-js-visibility
Last synced: 3 months ago
JSON representation
Visibility Plugin for the Kaltura Player JS
- Host: GitHub
- URL: https://github.com/kaltura/playkit-js-visibility
- Owner: kaltura
- License: agpl-3.0
- Created: 2020-05-31T08:38:23.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2025-03-06T14:38:18.000Z (7 months ago)
- Last Synced: 2025-06-08T15:07:27.834Z (4 months ago)
- Language: JavaScript
- Homepage:
- Size: 522 KB
- Stars: 3
- Watchers: 10
- Forks: 1
- Open Issues: 31
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# PlayKit JS Visibility - Visibility plugin for the [PlayKit JS Player]
[](https://github.com/kaltura/playkit-js-visibility/actions/workflows/run_canary_full_flow.yaml)
PlayKit JS Visibility is written in [ECMAScript6], statically analysed using [Flow] and transpiled in ECMAScript5 using [Babel].
[Flow]: https://flow.org/
[ECMAScript6]: https://github.com/ericdouglas/ES6-Learning#articles--tutorials
[Babel]: https://babeljs.io
## Getting Started
### Prerequisites
The plugin requires [PlayKit JS Player] to be loaded first.
[playkit js player]: https://github.com/kaltura/playkit-js-visibility
### Installing
First, clone and run [yarn] to install dependencies:
[yarn]: https://yarnpkg.com/lang/en/
```
git clone https://github.com/kaltura/playkit-js-visibility.git
cd playkit-js-visibility
yarn install
```
### Building
Then, build the player
```javascript
yarn run build
```
### Embed the library in your test page
Finally, add the bundle as a script tag in your page, and initialize the player
```html
var playerContainer = document.querySelector("#player-placeholder");
var config = {
...
plugins: {
floating: {
}
}
...
};
var player = playkit.core.loadPlayer(config);
playerContainer.appendChild(player.getView());
player.play();
```
## Documentation
- **[Configuration](docs/configuration.md)**
## Running the tests
Tests can be run locally via [Karma], which will run on Chrome, Firefox and Safari
[karma]: https://karma-runner.github.io/1.0/index.html
```
yarn run test
```
You can test individual browsers:
```
yarn run test:chrome
yarn run test:firefox
yarn run test:safari
```
### And coding style tests
We use ESLint [recommended set](http://eslint.org/docs/rules/) with some additions for enforcing [Flow] types and other rules.
See [ESLint config](.eslintrc.json) for full configuration.
We also use [.editorconfig](.editorconfig) to maintain consistent coding styles and settings, please make sure you comply with the styling.
## Compatibility
TBD
## Contributing
Please read [CONTRIBUTING.md](https://gist.github.com/PurpleBooth/b24679402957c63ec426) for details on our code of conduct, and the process for submitting pull requests to us.
## Versioning
We use [SemVer](http://semver.org/) for versioning. For the versions available, see the [tags on this repository](https://github.com/kaltura/playkit-js-visibility/tags).
## License
This project is licensed under the AGPL-3.0 License - see the [LICENSE.md](LICENSE.md) file for details
.