@ekg.training/ekg-video-player 1.0.3 → 1.0.4

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/README.md CHANGED
@@ -35,6 +35,12 @@ yarn add @ekg.training/ekg-video-player
35
35
 
36
36
  ## Usage
37
37
 
38
+ Below html is common and required for all examples, in which, evp-root class is neccessary to load tailwind styles used by the ekg video player
39
+
40
+ ```html
41
+ <div id="root" class="evp-root"></div>
42
+ ```
43
+
38
44
  ### React
39
45
 
40
46
  ```js
@@ -49,11 +55,11 @@ useEffect(() => {
49
55
  ### ESM (Browser)
50
56
 
51
57
  ```html
58
+ <script src="https://unpkg.com/@ekg.training/ekg-video-player@latest/dist/ekg_video_player.bundle.js"></script>
52
59
  <script type="module">
53
- import { VideoPlayer } from 'https://unpkg.com/@ekg.training/ekg-video-player@latest/dist/ekg_video_player.module.js';
54
- window.React = React;
55
- window.ReactDOM = ReactDOM;
56
- const player = new VideoPlayer('root', { mediaPlayerProps: { src: '...', poster: '...' } });
60
+ const player = new EkgVideoPlayer.VideoPlayer('root', {
61
+ mediaPlayerProps: { src: '...', poster: '...' },
62
+ });
57
63
  player.init();
58
64
  </script>
59
65
  ```
@@ -137,7 +143,6 @@ See [`examples/React/src/App.js`](examples/React/src/App.js) or [`examples/Javas
137
143
  - `isPseudoFullscreen` (boolean): iOS fullscreen workaround
138
144
  - `toggleSkipQuiz`, `toggleIphoneFullScreen`, `toggleInfo` (function): UI toggles
139
145
  - `isQuizOpen`, `isInfoOpen` (boolean): UI state
140
- - `infoLink` (string): Info link URL
141
146
  - `chapterTracks`, `subtitleTracks` (array): Track arrays (see above)
142
147
  - `windowProps` (object): Window size/orientation
143
148
  - `translations` (object): UI translations
package/README.npm.md CHANGED
@@ -35,6 +35,12 @@ yarn add @ekg.training/ekg-video-player
35
35
 
36
36
  ## Usage
37
37
 
38
+ Below html is common and required for all examples, in which, evp-root class is neccessary to load tailwind styles used by the ekg video player
39
+
40
+ ```html
41
+ <div id="root" class="evp-root"></div>
42
+ ```
43
+
38
44
  ### React
39
45
 
40
46
  ```js
@@ -49,11 +55,11 @@ useEffect(() => {
49
55
  ### ESM (Browser)
50
56
 
51
57
  ```html
58
+ <script src="https://unpkg.com/@ekg.training/ekg-video-player@latest/dist/ekg_video_player.bundle.js"></script>
52
59
  <script type="module">
53
- import { VideoPlayer } from 'https://unpkg.com/@ekg.training/ekg-video-player@latest/dist/ekg_video_player.module.js';
54
- window.React = React;
55
- window.ReactDOM = ReactDOM;
56
- const player = new VideoPlayer('root', { mediaPlayerProps: { src: '...', poster: '...' } });
60
+ const player = new EkgVideoPlayer.VideoPlayer('root', {
61
+ mediaPlayerProps: { src: '...', poster: '...' },
62
+ });
57
63
  player.init();
58
64
  </script>
59
65
  ```
@@ -137,7 +143,6 @@ See [`examples/React/src/App.js`](examples/React/src/App.js) or [`examples/Javas
137
143
  - `isPseudoFullscreen` (boolean): iOS fullscreen workaround
138
144
  - `toggleSkipQuiz`, `toggleIphoneFullScreen`, `toggleInfo` (function): UI toggles
139
145
  - `isQuizOpen`, `isInfoOpen` (boolean): UI state
140
- - `infoLink` (string): Info link URL
141
146
  - `chapterTracks`, `subtitleTracks` (array): Track arrays (see above)
142
147
  - `windowProps` (object): Window size/orientation
143
148
  - `translations` (object): UI translations