@playkit-js/moderation 3.0.0 → 3.1.0-canary.10-08b2d40
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 +15 -0
- package/README.md +60 -7
- package/dist/playkit-moderation.js +1 -1
- package/dist/playkit-moderation.js.map +1 -1
- package/package.json +9 -2
- package/src/components/moderation/moderation.scss +31 -83
- package/src/components/moderation/moderation.tsx +87 -97
- package/src/components/plugin-button/plugin-button.tsx +2 -2
- package/src/components/popover/popover.scss +27 -0
- package/src/components/popover/popover.tsx +75 -157
- package/src/moderation-plugin.tsx +23 -13
- package/src/components/plugin-button/plugin-button.scss +0 -14
- package/src/components/popover/popover-menu.scss +0 -4
- package/src/components/popover/popover-menu.tsx +0 -57
- package/src/components/popover-menu/index.ts +0 -1
- package/src/components/popover-menu/popover-menu.scss +0 -4
- package/src/components/popover-menu/popover-menu.tsx +0 -52
package/CHANGELOG.md
CHANGED
|
@@ -2,6 +2,21 @@
|
|
|
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
|
+
## [3.1.0-canary.10-08b2d40](https://github.com/kaltura/playkit-js-moderation/compare/v3.0.0...v3.1.0-canary.10-08b2d40) (2022-12-11)
|
|
6
|
+
|
|
7
|
+
|
|
8
|
+
### Features
|
|
9
|
+
|
|
10
|
+
* **FEV-1453:** a11y fixes (remove unused files) ([649a782](https://github.com/kaltura/playkit-js-moderation/commit/649a78246d87e439d0d0e5f24b7f32111362dbeb))
|
|
11
|
+
* **FEV-1552:** Add support to the More plugin ([#34](https://github.com/kaltura/playkit-js-moderation/issues/34)) ([37260a3](https://github.com/kaltura/playkit-js-moderation/commit/37260a3a9676ac602cb2e95ac53f0083100383c5))
|
|
12
|
+
|
|
13
|
+
|
|
14
|
+
### Bug Fixes
|
|
15
|
+
|
|
16
|
+
* **FEV-1557:** Space doesn't work inside the reasons list and refactoring popover ([f2f3e1a](https://github.com/kaltura/playkit-js-moderation/commit/f2f3e1a9ed683b813b939e16c944f6785ee1fca7))
|
|
17
|
+
* **FEV-1557:** Space doesn't work inside the reasons list and refactoring popover ([#35](https://github.com/kaltura/playkit-js-moderation/issues/35)) ([4ffbe6d](https://github.com/kaltura/playkit-js-moderation/commit/4ffbe6d55663963f4083a38a1c55a32d2321406d))
|
|
18
|
+
* **FEV-1590:** mac a11y issues ([#37](https://github.com/kaltura/playkit-js-moderation/issues/37)) ([2699c73](https://github.com/kaltura/playkit-js-moderation/commit/2699c73bd5f0701479850cc6218c2ca2287f88f1))
|
|
19
|
+
|
|
5
20
|
### [2.1.1](https://github.com/kaltura/playkit-js-moderation/compare/v2.0.11...v2.1.1) (2022-01-19)
|
|
6
21
|
|
|
7
22
|
### [2.0.11](https://github.com/kaltura/playkit-js-moderation/compare/v2.0.10...v2.0.11) (2021-12-06)
|
package/README.md
CHANGED
|
@@ -1,5 +1,10 @@
|
|
|
1
1
|
# PlayKit JS Moderation - plugin for the [PlayKit JS Player]
|
|
2
2
|
|
|
3
|
+
|
|
4
|
+
### About
|
|
5
|
+
|
|
6
|
+
Moderation plugin provides applications ability to add reporting mechanisem for the content that being played in case users find it not appropriate.
|
|
7
|
+
|
|
3
8
|
PlayKit JS Moderation is written in [ECMAScript6], statically analysed using [Typescript] and transpiled in ECMAScript5 using [Babel].
|
|
4
9
|
|
|
5
10
|
[typescript]: https://www.typescriptlang.org/
|
|
@@ -50,7 +55,7 @@ Finally, add the bundle as a script tag in your page, and initialize the player
|
|
|
50
55
|
...
|
|
51
56
|
targetId: 'player-placeholder',
|
|
52
57
|
plugins: {
|
|
53
|
-
moderation: { ... }
|
|
58
|
+
playkit-js-moderation: { ... }
|
|
54
59
|
}
|
|
55
60
|
...
|
|
56
61
|
};
|
|
@@ -92,21 +97,69 @@ This project is licensed under the AGPL-3.0 License - see the [LICENSE.md](LICEN
|
|
|
92
97
|
#### Configuration Structure
|
|
93
98
|
|
|
94
99
|
```js
|
|
95
|
-
|
|
96
|
-
"moderation" = {};
|
|
100
|
+
|
|
97
101
|
//Plugin params
|
|
98
|
-
"moderation"
|
|
102
|
+
"playkit-js-moderation": {
|
|
99
103
|
reportLength?: number, // optional
|
|
100
104
|
onReportSentMessage?: string, // optional
|
|
101
105
|
onReportErrorMessage?: string, // optional
|
|
102
|
-
subtitle?: string, // optional
|
|
106
|
+
subtitle?: string, // optional extra information to be displayed
|
|
103
107
|
tooltipMessage?: string, // optional
|
|
104
|
-
notificatonDuration?: number, // optional
|
|
108
|
+
notificatonDuration?: number, // miliseconds, optional
|
|
105
109
|
moderateOptions?: Array< {id: number, label: string} > // optional
|
|
106
110
|
}
|
|
107
111
|
```
|
|
112
|
+
#### Plugin Default configuration
|
|
108
113
|
|
|
109
|
-
|
|
114
|
+
"playkit-js-moderation" = {};
|
|
115
|
+
|
|
116
|
+
```
|
|
117
|
+
"playkit-js-moderation": {
|
|
118
|
+
"reportLength": 500,
|
|
119
|
+
"onReportSentMessage": "The report sent",
|
|
120
|
+
"onReportErrorMessage": "The report failed to send",
|
|
121
|
+
"subtitle": "",
|
|
122
|
+
"notificatonDuration": 5000,
|
|
123
|
+
"tooltipMessage": "Send report",
|
|
124
|
+
"moderateOptions": [
|
|
125
|
+
{
|
|
126
|
+
"id": 1,
|
|
127
|
+
"label": "Sexual Content"
|
|
128
|
+
},
|
|
129
|
+
{
|
|
130
|
+
"id": 2,
|
|
131
|
+
"label": "Violent Or Repulsive"
|
|
132
|
+
},
|
|
133
|
+
{
|
|
134
|
+
"id": 3,
|
|
135
|
+
"label": 'Harmful Or Dangerous Act"
|
|
136
|
+
},
|
|
137
|
+
{
|
|
138
|
+
"id": 4,
|
|
139
|
+
"label": "Spam / Commercials"
|
|
140
|
+
},
|
|
141
|
+
{
|
|
142
|
+
"id": 5,
|
|
143
|
+
"label": "Copyright Violation"
|
|
144
|
+
},
|
|
145
|
+
{
|
|
146
|
+
"id": 6,
|
|
147
|
+
"label": "Terms of Use Violation"
|
|
148
|
+
}
|
|
149
|
+
]
|
|
150
|
+
}
|
|
151
|
+
```
|
|
152
|
+
|
|
153
|
+
### Example:
|
|
154
|
+
|
|
155
|
+
|
|
156
|
+
|
|
157
|
+
|
|
158
|
+
|
|
159
|
+
|
|
160
|
+
|
|
161
|
+
|
|
162
|
+
## Docs:
|
|
110
163
|
|
|
111
164
|
> ### config.reportLength
|
|
112
165
|
>
|