npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@playkit-js/moderation

v3.2.24

Published

[![Build Status](https://github.com/kaltura/playkit-js-moderation/actions/workflows/run_canary_full_flow.yaml/badge.svg)](https://github.com/kaltura/playkit-js-moderation/actions/workflows/run_canary_full_flow.yaml) [![code style: prettier](https://img.sh

Downloads

714

Readme

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

Build Status code style: prettier

About

Moderation plugin provides applications ability to add reporting mechanisem for the content that being played in case users find it not appropriate.

PlayKit JS Moderation 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-moderation.git
cd playkit-js-moderation
yarn install

Building

Then, build the plugin

yarn run build

Testing

The plugin uses cypress tool for e2e tests

yarn run test

UI conf file (cypress/public/ui-conf.js) contains Kaltura player and plugin dependencies. Keep Kaltura player and dependency versions aligned to currently released versions.

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-moderation.js"></script>
<!--PlayKit moderation 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: {
       'playkit-js-moderation': { ... }
     }
     ...
    };
    var player = KalturaPlayer.setup(config);
    player.loadMedia(...);
  </script>
</div>

Documentation

Moderation plugin configuration can been found here:

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

Configuration

Configuration Structure


//Plugin params
"playkit-js-moderation": {
  reportLength?: number, // optional
  subtitle?: string, // optional extra information to be displayed
  notificatonDuration?: number, // miliseconds, optional
  moderateOptions?: Array< {id: number, label: string} > // optional
}

Plugin Default configuration

"playkit-js-moderation" = {};

"playkit-js-moderation": {
    "reportLength": 500,
    "subtitle": "",
    "notificatonDuration": 5000,
    "moderateOptions": [
      {
      		"id": 1,
      		"label": "Sexual Content"
      },
      {
      		"id": 2,
      		"label": "Violent Or Repulsive"
      },
      {
      		"id": 3,
      		"label": 'Harmful Or Dangerous Act"
      },
      {
      		"id": 4,
      		"label": "Spam / Commercials"
      },
      {
	       "id": 5,
	       "label": "Copyright Violation"
      },
      {
      		"id": 6,
      		"label": "Terms of Use Violation"
      }
    ]
  }

Example:

Moderation1

Moderation2

Moderation2

Docs:

config.reportLength

Type: number
Default: 500

config.subtitle

Type: string
Default: -

config.notificatonDuration

Type: number
Default: 5000

config.moderateOptions

Type: Array< {id: number, label: string} >
Default:
moderateOptions = [
  {id: 1, label: 'Sexual Content'},      
  {id: 2, label: 'Violent Or Repulsive'},      
  {id: 3, label: 'Harmful Or Dangerous Act'},      
  {id: 4, label: 'Spam / Commercials'}
]