PlayKit JS Navigation - plugin for the [PlayKit JS Player]


PlayKit JS Navigation is written in [ECMAScript6], statically analysed using [Typescript] and transpiled in ECMAScript5 using [Babel].

[typescript]: https://www.typescriptlang.org/
[ecmascript6]: https://github.com/ericdouglas/ES6-Learning#articles--tutorials
[babel]: https://babeljs.io

Getting Started

$3

The plugin requires [Kaltura Player] to be loaded first.

[kaltura player]: https://github.com/kaltura/kaltura-player-js

$3

First, clone and run [yarn] to install dependencies:

[yarn]: https://yarnpkg.com/lang/en/

``
git clone https://github.com/kaltura/playkit-js-navigation.git
cd playkit-js-navigation
yarn install
`

$3

Then, build the player

`javascript
yarn run build
`

$3

Finally, add the bundle as a script tag in your page, and initialize the player

`html













`

Documentation

Navigation plugin configuration can be found here:

- Configuration

Navigation plugin dependencies can been found here:

- Dependencies

$3

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.

Contributing

Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.

Versioning

We use SemVer for versioning. For the versions available, see the tags on this repository.

License

This project is licensed under the AGPL-3.0 License - see the LICENSE.md file for details

Commands

Run dev server: yarn dev;

Bump version: yarn release;





Configuration

#### Configuration Structure

`js
//Default configuration
"navigation" = {};
//Plugin params
"navigation" = {
expandOnFirstPlay?: boolean, // optional
position?: string, // optional
expandMode?: string, // optional
itemsOrder?: object< string, number >, // optional
visible?: boolean // optional
}
`

##

> ### config.expandOnFirstPlay
>
> ##### Type: boolean
>
> ##### Default: right
>
> ##### Description: if plugin should automatically open on first play.
>

##

> ### config.position
>
> ##### Type: 'right' | 'left' | 'top' | 'bottom'
>
> ##### Default: right
>
> ##### Description: expand mode of side panel (‘alongside', ‘hidden’, 'over’, default 'alongside').
>

##

> ### config.expandMode
>
> ##### Type: string
>
> ##### Default: alongside
>
> ##### Description: expand mode of side panel (‘alongside', ‘hidden’, 'over’, default 'alongside').
>

##

> ### config.itemsOrder
>
> ##### Type: object< string, number >
>
> ##### Default: { "All": 0, "Chapter": 1, "Slide": 2, "Hotspot": 3, "AnswerOnAir": 4, }
>
> ##### Change tab order: navigation = {...itemsOrder: { "Slide": 1, "All": 4, "AnswerOnAir": 3, "Chapter": 5, "Hotspot": 2, }, ...}
>
> ##### Description: define order of Tabs (min value at the left) and Items inside group (min value at the top). itemsOrder also uses as tabs filter (all items that not included in "itemsOrder" object will be filtered out) (default: { "All": 0, "Chapter": 1, "Slide": 2, "Hotspot": 3, "AnswerOnAir": 4, }).

##

> ### config.visible
>
> ##### Type: boolean
>
> ##### Default: true
>
> ##### Description: if plugin's side panel should be displayed or not.
>

Additional flashvars

"playkit-navigation":"Version" (check latest version of navigation plugin)

Dependencies

Plugin dependencies:

Cue Points

UI Managers

Timeline

$3

Node version: up to 14+

If nvm installed: nvm use` change version of current terminal to required.