react-covideo-embed 0.1.1 → 0.1.2
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 +7 -0
- package/build/index.js +1 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -31,6 +31,10 @@ const MyApp = () => {
|
|
|
31
31
|
export default MyApp;
|
|
32
32
|
```
|
|
33
33
|
|
|
34
|
+
## Demo
|
|
35
|
+
|
|
36
|
+
Explore the capabilities of react-covideo-embed through our [Demo Project](https://github.com/covideodevteam/cv-react-integration-demo-app). This repository serves as a practical example to understand how different props and configurations can be implemented. To run the demo locally, please follow the instructions available in the project’s README.
|
|
37
|
+
|
|
34
38
|
## Props
|
|
35
39
|
|
|
36
40
|
### `token` (optional)
|
|
@@ -49,6 +53,7 @@ export default MyApp;
|
|
|
49
53
|
- **Type**: `function`
|
|
50
54
|
- **Description**: Callback triggered when a video is inserted.
|
|
51
55
|
- **Parameters**:
|
|
56
|
+
|
|
52
57
|
- `shareData`: Object containing the URL and HTML of the inserted video.
|
|
53
58
|
- `url`: `string` - The URL of the inserted video.
|
|
54
59
|
- `html`: `string` - The HTML representation of the inserted video.
|
|
@@ -58,12 +63,14 @@ export default MyApp;
|
|
|
58
63
|
- **Type**: `function`
|
|
59
64
|
- **Description**: Callback triggered when there is an error inserting a video.
|
|
60
65
|
- **Parameters**:
|
|
66
|
+
|
|
61
67
|
- `error`: `unknown` - The error occurred during video insert.
|
|
62
68
|
|
|
63
69
|
### `hideFeatures` (optional)
|
|
64
70
|
|
|
65
71
|
- **Type**: `Array<Feature>`
|
|
66
72
|
- **Description**: Determines which Covideo features to hide. Acceptable values are as follows:
|
|
73
|
+
|
|
67
74
|
- `insert`
|
|
68
75
|
- `recordScreen`
|
|
69
76
|
- `recordBoth`
|