@playkit-js/hotspots 2.1.5-canary.2-32c5fbe → 2.2.0-canary.11-63dbdd2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/CHANGELOG.md CHANGED
@@ -2,7 +2,19 @@
2
2
 
3
3
  All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
4
4
 
5
- ### [2.1.5-canary.2-32c5fbe](https://github.com/kaltura/playkit-js-hotspots/compare/v2.1.4...v2.1.5-canary.2-32c5fbe) (2022-08-30)
5
+ ## [2.2.0-canary.11-63dbdd2](https://github.com/kaltura/playkit-js-hotspots/compare/v2.1.4...v2.2.0-canary.11-63dbdd2) (2022-10-03)
6
+
7
+
8
+ ### Features
9
+
10
+ * **FEV-1317:** Hotspot plugin - Move contrib kitchen sink to core side panels ([#278](https://github.com/kaltura/playkit-js-hotspots/issues/278)) ([b616a8b](https://github.com/kaltura/playkit-js-hotspots/commit/b616a8ba96f94cc0b83c313e89bad65871e486c3))
11
+
12
+
13
+ ### Bug Fixes
14
+
15
+ * **FEV-1416:** init floating manager ([#279](https://github.com/kaltura/playkit-js-hotspots/issues/279)) ([8b73169](https://github.com/kaltura/playkit-js-hotspots/commit/8b731690023450743c78c38ce923bd6db03f86b6))
16
+ * **FEV-1506:** clean hotspots data on reset; ([#282](https://github.com/kaltura/playkit-js-hotspots/issues/282)) ([d7c4fd4](https://github.com/kaltura/playkit-js-hotspots/commit/d7c4fd4096dc6ef19955d06add3ac35025ec82ab))
17
+ * **FEV-1526:** update hotspots layout ([#284](https://github.com/kaltura/playkit-js-hotspots/issues/284)) ([63dbdd2](https://github.com/kaltura/playkit-js-hotspots/commit/63dbdd24d35c174e9ffde541fac53ccaa568cab1))
6
18
 
7
19
  ### [2.1.4](https://github.com/kaltura/playkit-js-hotspots/compare/v2.1.3...v2.1.4) (2022-01-19)
8
20
 
package/README.md CHANGED
@@ -1 +1,125 @@
1
- #Converting to v7 contrib plugin
1
+ # PlayKit JS hotspots - plugin for the [PlayKit JS Player]
2
+
3
+ PlayKit JS hotspots is written in [ECMAScript6], statically analysed using [Typescript] and transpiled in ECMAScript5 using [Babel].
4
+
5
+ [typescript]: https://www.typescriptlang.org/
6
+ [ecmascript6]: https://github.com/ericdouglas/ES6-Learning#articles--tutorials
7
+ [babel]: https://babeljs.io
8
+
9
+ ## Getting Started
10
+
11
+ ### Prerequisites
12
+
13
+ The plugin requires [Kaltura Player] to be loaded first.
14
+
15
+ [kaltura player]: https://github.com/kaltura/kaltura-player-js
16
+
17
+ ### Installing
18
+
19
+ First, clone and run [yarn] to install dependencies:
20
+
21
+ [yarn]: https://yarnpkg.com/lang/en/
22
+
23
+ ```
24
+ git clone https://github.com/kaltura/playkit-js-hotspots.git
25
+ cd playkit-js-hotspots
26
+ yarn install
27
+ ```
28
+
29
+ ### Building
30
+
31
+ Then, build the player
32
+
33
+ ```javascript
34
+ yarn run build
35
+ ```
36
+
37
+ ### Embed the library in your test page
38
+
39
+ Finally, add the bundle as a script tag in your page, and initialize the player
40
+
41
+ ```html
42
+ <script type="text/javascript" src="/PATH/TO/FILE/kaltura-player.js"></script>
43
+ <!--Kaltura player-->
44
+ <script type="text/javascript" src="/PATH/TO/FILE/playkit-kaltura-cuepoints.js"></script>
45
+ <!--PlayKit cuepoints plugin-->
46
+ <script type="text/javascript" src="/PATH/TO/FILE/playkit-hotspots.js"></script>
47
+ <!--PlayKit hotspots plugin-->
48
+ <div id="player-placeholder" style="height:360px; width:640px">
49
+ <script type="text/javascript">
50
+ var playerContainer = document.querySelector("#player-placeholder");
51
+ var config = {
52
+ ...
53
+ targetId: 'player-placeholder',
54
+ plugins: {
55
+ hotspots: { ... },
56
+ kalturaCuepoints: { ... },
57
+ }
58
+ ...
59
+ };
60
+ var player = KalturaPlayer.setup(config);
61
+ player.loadMedia(...);
62
+ </script>
63
+ </div>
64
+ ```
65
+
66
+ ## Documentation
67
+
68
+ hotspots plugin configuration can been found here:
69
+
70
+ - **[Configuration](#configuration)**
71
+
72
+ hotspots plugin dependencies can been found here:
73
+
74
+ - **[Dependencies](#dependencies)**
75
+
76
+ ### And coding style tests
77
+
78
+ We use ESLint [recommended set](http://eslint.org/docs/rules/) with some additions for enforcing [Flow] types and other rules.
79
+
80
+ See [ESLint config](.eslintrc.json) for full configuration.
81
+
82
+ We also use [.editorconfig](.editorconfig) to maintain consistent coding styles and settings, please make sure you comply with the styling.
83
+
84
+ ## Contributing
85
+
86
+ Please read [CONTRIBUTING.md](https://gist.github.com/PurpleBooth/b24679402957c63ec426) for details on our code of conduct, and the process for submitting pull requests to us.
87
+
88
+ ## Versioning
89
+
90
+ We use [SemVer](http://semver.org/) for versioning. For the versions available, see the [tags on this repository](https://github.com/kaltura/playkit-js-hotspots/tags).
91
+
92
+ ## License
93
+
94
+ This project is licensed under the AGPL-3.0 License - see the [LICENSE.md](LICENSE.md) file for details
95
+
96
+ ## Commands
97
+
98
+ Run dev server: `yarn dev`;<br/>
99
+ Bump version: `yarn release`;<br/>
100
+
101
+ <a name="configuration"></a>
102
+ ## Configuration
103
+
104
+ #### Configuration Structure
105
+
106
+ ```js
107
+ //Default configuration
108
+ "hotspots" = {};
109
+ ```
110
+ ##
111
+
112
+ <a name="dependencies"></a>
113
+ ## Dependencies
114
+
115
+ Plugin dependencies:<br/>
116
+ <a href="https://github.com/kaltura/playkit-js-kaltura-cuepoints">Cue Points</a><br/>
117
+
118
+ ### Dev env
119
+
120
+ Node version: up to 14+<br/>
121
+ If nvm installed: `nvm use` change version of current terminal to required.<br/>
122
+
123
+ ### ARM Architecture support
124
+
125
+ Install dependencies with `npm install --target_arch=x64` set target arch for running it through Rosetta (requires Rosetta installation).<br/>