playkit-js-google-tag-manager

playkit-js-google-tag-manager is a [kaltura player] plugin that adds built-in support for [Google Tag Manager] in the [kaltura player]

The plugin enables your website or app to communicate with the the Google Tag Manager servers,
and manage your tags from your [Google Tag Manager] dashbored.

playkit-js-google-tag-manager is written in [ECMAScript6] (.js) and [TypeScript] (.ts) (strongly typed superset of ES6),
and transpiled in ECMAScript5 using Babel and the [TypeScript compiler].

[Webpack] is used to build the distro bundle and serve the local development environment.

[kaltura player]: https://github.com/kaltura/kaltura-player-js
[Google Tag Manager]: https://developers.google.com/tag-platform/tag-manager
[ecmascript6]: https://github.com/ericdouglas/ES6-Learning#articles--tutorials
[typescript]: https://www.typescriptlang.org/
[typescript compiler]: https://www.typescriptlang.org/docs/handbook/compiler-options.html
[webpack]: https://webpack.js.org/

For more information about Google Tag Manager, see Google Tag Manager overview

Getting started with development

``sh


First, checkout the repository and install the required dependencies

git clone https://github.com/kaltura/playkit-js-google-tag-manager.git

Navigate to the repo dir

cd playkit-js-google-tag-manager

Install dependencies

npm install

Run dev-server for demo page (recompiles on file-watch, and write to actual dist fs artifacts)

npm run dev

Before submitting a PR - Run the pre commit command

npm run pre:commit

this command will run type and lint checks

`

The dev server will host files on port 8080. Once started, the demo can be found running at http://localhost:8000/.

Before submitting a PR, please see our contribution guidelines.

$3

Run linter:

`
npm run lint:check
`

Run linter with auto-fix mode:

`
npm run lint:fix
`

$3

Run prettier to format code

`
npm run prettier:fix
`

$3

Run type-check to verify TypeScript types

`
npm run types:check
`

$3

Run all tests at once:

`
npm test
`

Run unit tests in watch mode:

`
npm run test:watch
``

Usage guide

usage guide

Compatibility

playkit-js-google-tag-manager is only compatible with browsers supporting MediaSource extensions (MSE) API with 'video/MP4' mime-type inputs.

playkit-js-google-tag-manager is supported on:

- Chrome 39+ for Android
- Chrome 39+ for Desktop
- Firefox 41+ for Android
- Firefox 42+ for Desktop
- IE11 for Windows 8.1+
- Edge for Windows 10+
- Safari 8+ for MacOS 10.10+
- Safari for ipadOS 13+

License

playkit-js-google-tag-manager is released under Apache 2.0 License