@playkit-js/qna/README.md

[](https://github.com/kaltura/playkit-js-qna/actions/workflows/run_canary_full_flow.yaml) [![code style: prettier](https://img.shields.io/badge

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

[![Build Status](https://github.com/kaltura/playkit-js-qna/actions/workflows/run_canary_full_flow.yaml/badge.svg)](https://github.com/kaltura/playkit-js-qna/actions/workflows/run_canary_full_flow.yaml)
[![code style: prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg?style=flat-square)](https://github.com/prettier/prettier)
[![](https://img.shields.io/npm/v/@playkit-js/qna/latest.svg)](https://www.npmjs.com/package/@playkit-js/qna)
[![](https://img.shields.io/npm/v/@playkit-js/qna/canary.svg)](https://www.npmjs.com/package/@playkit-js/qna/v/canary)

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

### Prerequisites

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

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

### Installing

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

### 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
<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](#configuration)**

QnA plugin dependencies can been found here:

- **[Dependencies](#dependencies)**

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


## 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-qna/tags).

## License

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

## Commands

Run dev server: `yarn dev`;<br/>
Bump version: `yarn release`;<br/>


<a name="dependencies"></a>
## Dependencies

#### Configuration Structure

```js
//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:<br/>
<a href="https://github.com/kaltura/playkit-js-kaltura-cuepoints">Cue Points</a><br/>
<a href="https://github.com/kaltura/playkit-js-ui-managers">UI Managers</a>