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

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

Getting Started

Prerequisites

The plugin requires Kaltura Player to be loaded first.

Installing

First, clone and run yarn to install dependencies:

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

Building

Then, build the player

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

<script type="text/javascript" src="/PATH/TO/FILE/kaltura-player.js"></script>
<!--Kaltura player-->
<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-qna.js"></script>
<!--PlayKit qna 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: {
      qna: { ... },
      uiManagers: { ... },
      kalturaCuepoints: { ... },
     }
     ...
    };
    var player = KalturaPlayer.setup(config);
    player.loadMedia(...);
  </script>
</div>

Documentation

QnA plugin configuration can been found here:

• Configuration

QnA plugin dependencies can been found here:

• Dependencies

And coding style tests

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.

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;

Dependencies

Configuration Structure

//Default configuration
"qna" = {};
//Plugin params
"qna" = {
  bannerDuration?: number;<br/>
  toastDuration?: number;<br/>
  dateFormat?: string;<br/>
  expandMode?: string;<br/>
  expandOnFirstPlay?: boolean;<br/>
  userRole?: string;<br/>
}

config.bannerDuration

Type: number

Default: 60000

config.toastDuration

Type: number

Default: 5000

config.expandMode

Type: string;

Default: over; (‘alongside', ‘hidden’, 'over’)

config.dateFormat

Type: string;

Default: over; (dd/mm/yyyy)

config.userRole

Type: string

Default: anonymousRole (anonymousRole|unmoderatedAdminRole)

Plugin dependencies: Cue Points UI Managers