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].

[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-qna.git
cd playkit-js-qna
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

QnA plugin configuration can been found here:

- Configuration

QnA 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.

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

`js
//Default configuration
"qna" = {};
//Plugin params
"qna" = {
bannerDuration?: number;

toastDuration?: number;

dateFormat?: string;

expandMode?: string;

expandOnFirstPlay?: boolean;

userRole?: string;

}
`

##

> ### 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