PlayKit JS Navigation is written in ECMAScript6, statically analysed using Typescript and transpiled in ECMAScript5 using Babel.
The plugin requires Kaltura Player to be loaded first.
First, clone and run yarn to install dependencies:
git clone https://github.com/kaltura/playkit-js-navigation.git
cd playkit-js-navigation
yarn install
Then, build the player
yarn run build
Finally, add the bundle as a script tag in your page, and initialize the player
<script type="text/javascript" src="/PATH/TO/FILE/kaltura-player.js"></script>
<!--Kaltura player-->
<script type="text/javascript" src="/PATH/TO/FILE/playkit-js-timeline.js"></script>
<!--PlayKit timeline plugin-->
<script type="text/javascript" src="/PATH/TO/FILE/playkit-kaltura-cuepoints.js"></script>
<!--PlayKit cuepoints plugin-->
<script type="text/javascript" src="/PATH/TO/FILE/playkit-ui-managers.js"></script>
<!--PlayKit ui-managers plugin-->
<script type="text/javascript" src="/PATH/TO/FILE/playkit-navigation.js"></script>
<!--PlayKit navigation plugin-->
<div id="player-placeholder" style="height:360px; width:640px">
<script type="text/javascript">
var playerContainer = document.querySelector("#player-placeholder");
var config = {
...
targetId: 'player-placeholder',
plugins: {
navigation: { ... },
uiManagers: { ... },
kalturaCuepoints: { ... },
timeline: { ... }
}
...
};
var player = KalturaPlayer.setup(config);
player.loadMedia(...);
</script>
</div>
Navigation plugin configuration can be found here:
Navigation plugin dependencies can been found here:
We use ESLint recommended set with some additions for enforcing [Flow] types and other rules.
See ESLint config for full configuration.
We also use .editorconfig to maintain consistent coding styles and settings, please make sure you comply with the styling.
Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.
We use SemVer for versioning. For the versions available, see the tags on this repository.
This project is licensed under the AGPL-3.0 License - see the LICENSE.md file for details
Run dev server: yarn dev
;
Bump version: yarn release
;
//Default configuration
"navigation" = {};
//Plugin params
"navigation" = {
expandOnFirstPlay?: boolean, // optional
position?: string, // optional
expandMode?: string, // optional
itemsOrder?: object< string, number >, // optional
visible?: boolean // optional
}
Description: expand mode of side panel (‘alongside', ‘hidden’, 'over’, default 'alongside').
Description: expand mode of side panel (‘alongside', ‘hidden’, 'over’, default 'alongside').
"playkit-navigation":"Version" (check latest version of navigation plugin)
Plugin dependencies:
Cue Points
UI Managers
Timeline
Node version: up to 14+
If nvm installed: nvm use
change version of current terminal to required.