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

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

Getting Started

Prerequisites

The plugin requires Kaltura Player and playkit-ui-managers to be loaded first.

Installing

First, clone and run yarn to install dependencies:

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

Building

Then, build the plugin

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/kaltura-player.js"></script>
<!--Playkit ui managers plugin -->
<script type="text/javascript" src="/PATH/TO/FILE/playkit-related.js"></script>
<!--PlayKit related 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: {
       uiManagers: {},
       related: {
         playlistId: "", // Fetch related entries by this playlist id.
         entryList: [], // Fetch related entries by list of entry metadata.
         sourcesList: [], // Manually set related entries data, without fetching them from another source.
         useContext: true, // fetch entries by context API, unless other options are not set.
         autoContinue: true, // Indicates whether to continue to to next related entry after playback end.
         autoContinueTime: 5, // If autoContinue is true, indicates the time in seconds to wait after playback end and before continuing to the next entry.
         showOnPlaybackPaused: false, // Indicates whether the related grid should be visible on playback paused.
         entriesByContextLimit: 12, // Max number of entries which can be fetched when fetching related entries by context.
         position: "right", // Position of the related list (top, down, left, right).
         expandMode: "alongside" // The relation between the position of the player and of the related list (over, alongside).
       }
     },
     ui: {
      translations: { // for local development
        en: {
          related: {
            upNextIn: 'Up Next In',
            playNow: 'Play Now'
          }
        }
      }
    }
     ...
    };
    var player = KalturaPlayer.setup(config);
    player.loadMedia(...);
  </script>
</div>

Documentation

• Configuration & API

Running the tests

Tests can be run locally via Karma, which will run on Chrome, Firefox and Safari

yarn run test

You can test individual browsers:

yarn run test:chrome
yarn run test:firefox
yarn run test:safari

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.

Compatibility

TBD

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