update document

master
lgf 3 years ago
parent b4124900cd
commit e7071832aa
  1. 34
      README.md
  2. 34
      zh.md

@ -61,23 +61,23 @@ const App = () => (
The following attributes come from the `option` property configuration item The following attributes come from the `option` property configuration item
| Parameter | Description | type | Default value | | Parameter | Description | type | Default value |
| ------------------- | ------------------------------------------------------------ | ----------------- | ------------- | | ------------------- | ------------------------------------------------------------ | ------------------------- | ------------- |
| width | The width of the video container (required) | `number` | required | | width | The width of the video container (required) | `number` | required |
| height | The height of the video container (required) | `number` | required | | height | The height of the video container (required) | `number` | required |
| videoSrc | Video address (required) | `string` | required | | videoSrc | Video address (required) | `string` | required |
| theme | theme | `string` | \#ffb821 | | theme | theme | `string` | \#ffb821 |
| poster | Video cover image | `string` | - | | poster | Video cover image | `string` | - |
| setEndPlayContent | Customize what is displayed at the end of the video | `React.ReactNode` | - | | setEndPlayContent | Customize what is displayed at the end of the video | `React.ReactNode` | - |
| setBufferContent | Custom video buffer loading component | `React.ReactNode` | - | | setBufferContent | Custom video buffer loading component | `React.ReactNode` | - |
| pausePlacement | The position of the pause button | `bottomRight` | `center` | | pausePlacement | The position of the pause button | `bottomRight` | `center` | `bottomRight` |
| hideMouseTime | How many milliseconds, without any operation, hide the mouse and controller/ms | `number` | 2000 | | hideMouseTime | How many milliseconds, without any operation, hide the mouse and controller/ms | `number` | 2000 |
| isShowMultiple | Whether to display the multiplier function | `boolean` | true | | isShowMultiple | Whether to display the multiplier function | `boolean` | true |
| isShowSet | Whether to display the setting function | `boolean` | true | | isShowSet | Whether to display the setting function | `boolean` | true |
| isShowScreenshot | Whether to display the screenshot function | `boolean` | true | | isShowScreenshot | Whether to display the screenshot function | `boolean` | true |
| isShowPicture | Whether to show picture-in-picture | `boolean` | true | | isShowPicture | Whether to show picture-in-picture | `boolean` | true |
| isShowWebFullScreen | Whether to display the full screen of the webpage | `boolean` | true | | isShowWebFullScreen | Whether to display the full screen of the webpage | `boolean` | true |
| language | Language | `zh` | `en` | | language | Language | `zh` | `en` | `zh` |
#### Method #### Method

34
zh.md

@ -59,23 +59,23 @@ const App = () => (
如下属性来自`option`属性配置项. 如下属性来自`option`属性配置项.
| 参数 | 说明 | 类型 | 默认值 | | 参数 | 说明 | 类型 | 默认值 |
| ------------------- | ----------------------------------------- | ----------------- | -------- | ----------- | | ------------------- | ----------------------------------------- | ------------------------ | ------------- |
| width | 视频容器的 width(必传) | `number` | 必传 | | width | 视频容器的 width(必传) | `number` | 必传 |
| height | 视频容器的 height(必传) | `number` | 必传 | | height | 视频容器的 height(必传) | `number` | 必传 |
| videoSrc | 视频地址(必传) | `string` | 必传 | | videoSrc | 视频地址(必传) | `string` | 必传 |
| theme | 主题 | `string` | \#ffb821 | | theme | 主题 | `string` | \#ffb821 |
| poster | 视频封面图 | `string` | - | | poster | 视频封面图 | `string` | - |
| setEndPlayContent | 自定义视频结束时显示的内容 | `React.ReactNode` | - | | setEndPlayContent | 自定义视频结束时显示的内容 | `React.ReactNode` | - |
| setBufferContent | 自定义视频缓冲加载组件 | `React.ReactNode` | - | | setBufferContent | 自定义视频缓冲加载组件 | `React.ReactNode` | - |
| pausePlacement | 暂停键的位置 | `bottomRight` | `center` | bottomRight | | pausePlacement | 暂停键的位置 | `bottomRight` | `center` | `bottomRight` |
| hideMouseTime | 多少毫秒,无任何操作,隐藏鼠标和控制器/ms | `number` | 2000 | | hideMouseTime | 多少毫秒,无任何操作,隐藏鼠标和控制器/ms | `number` | 2000 |
| isShowMultiple | 是否显示播放倍数功能 | `boolean` | true | | isShowMultiple | 是否显示播放倍数功能 | `boolean` | true |
| isShowSet | 是否显示设置功能 | `boolean` | true | | isShowSet | 是否显示设置功能 | `boolean` | true |
| isShowScreenshot | 是否显示截图功能 | `boolean` | true | | isShowScreenshot | 是否显示截图功能 | `boolean` | true |
| isShowPicture | 是否显示画中画 | `boolean` | true | | isShowPicture | 是否显示画中画 | `boolean` | true |
| isShowWebFullScreen | 是否显示网页全屏 | `boolean` | true | | isShowWebFullScreen | 是否显示网页全屏 | `boolean` | true |
| language | 语言 | `zh` | `en` | zh | | language | 语言 | `zh` | `en` | `zh` |
#### 方法 #### 方法

Loading…
Cancel
Save