From e7071832aa84b7e569bdfa513015701f8fc695d3 Mon Sep 17 00:00:00 2001 From: lgf <18827634408@163.com> Date: Wed, 25 Aug 2021 11:06:07 +0800 Subject: [PATCH] update document --- README.md | 34 +++++++++++++++++----------------- zh.md | 34 +++++++++++++++++----------------- 2 files changed, 34 insertions(+), 34 deletions(-) diff --git a/README.md b/README.md index 4fdbc99..75b3e53 100644 --- a/README.md +++ b/README.md @@ -61,23 +61,23 @@ const App = () => ( The following attributes come from the `option` property configuration item -| Parameter | Description | type | Default value | -| ------------------- | ------------------------------------------------------------ | ----------------- | ------------- | -| width | The width of the video container (required) | `number` | required | -| height | The height of the video container (required) | `number` | required | -| videoSrc | Video address (required) | `string` | required | -| theme | theme | `string` | \#ffb821 | -| poster | Video cover image | `string` | - | -| setEndPlayContent | Customize what is displayed at the end of the video | `React.ReactNode` | - | -| setBufferContent | Custom video buffer loading component | `React.ReactNode` | - | -| pausePlacement | The position of the pause button | `bottomRight` | `center` | -| hideMouseTime | How many milliseconds, without any operation, hide the mouse and controller/ms | `number` | 2000 | -| isShowMultiple | Whether to display the multiplier function | `boolean` | true | -| isShowSet | Whether to display the setting function | `boolean` | true | -| isShowScreenshot | Whether to display the screenshot function | `boolean` | true | -| isShowPicture | Whether to show picture-in-picture | `boolean` | true | -| isShowWebFullScreen | Whether to display the full screen of the webpage | `boolean` | true | -| language | Language | `zh` | `en` | +| Parameter | Description | type | Default value | +| ------------------- | ------------------------------------------------------------ | ------------------------- | ------------- | +| width | The width of the video container (required) | `number` | required | +| height | The height of the video container (required) | `number` | required | +| videoSrc | Video address (required) | `string` | required | +| theme | theme | `string` | \#ffb821 | +| poster | Video cover image | `string` | - | +| setEndPlayContent | Customize what is displayed at the end of the video | `React.ReactNode` | - | +| setBufferContent | Custom video buffer loading component | `React.ReactNode` | - | +| 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 | +| isShowMultiple | Whether to display the multiplier function | `boolean` | true | +| isShowSet | Whether to display the setting function | `boolean` | true | +| isShowScreenshot | Whether to display the screenshot function | `boolean` | true | +| isShowPicture | Whether to show picture-in-picture | `boolean` | true | +| isShowWebFullScreen | Whether to display the full screen of the webpage | `boolean` | true | +| language | Language | `zh` | `en` | `zh` | #### Method diff --git a/zh.md b/zh.md index 82276f1..45af318 100644 --- a/zh.md +++ b/zh.md @@ -59,23 +59,23 @@ const App = () => ( 如下属性来自`option`属性配置项. -| 参数 | 说明 | 类型 | 默认值 | -| ------------------- | ----------------------------------------- | ----------------- | -------- | ----------- | -| width | 视频容器的 width(必传) | `number` | 必传 | -| height | 视频容器的 height(必传) | `number` | 必传 | -| videoSrc | 视频地址(必传) | `string` | 必传 | -| theme | 主题 | `string` | \#ffb821 | -| poster | 视频封面图 | `string` | - | -| setEndPlayContent | 自定义视频结束时显示的内容 | `React.ReactNode` | - | -| setBufferContent | 自定义视频缓冲加载组件 | `React.ReactNode` | - | -| pausePlacement | 暂停键的位置 | `bottomRight` | `center` | bottomRight | -| hideMouseTime | 多少毫秒,无任何操作,隐藏鼠标和控制器/ms | `number` | 2000 | -| isShowMultiple | 是否显示播放倍数功能 | `boolean` | true | -| isShowSet | 是否显示设置功能 | `boolean` | true | -| isShowScreenshot | 是否显示截图功能 | `boolean` | true | -| isShowPicture | 是否显示画中画 | `boolean` | true | -| isShowWebFullScreen | 是否显示网页全屏 | `boolean` | true | -| language | 语言 | `zh` | `en` | zh | +| 参数 | 说明 | 类型 | 默认值 | +| ------------------- | ----------------------------------------- | ------------------------ | ------------- | +| width | 视频容器的 width(必传) | `number` | 必传 | +| height | 视频容器的 height(必传) | `number` | 必传 | +| videoSrc | 视频地址(必传) | `string` | 必传 | +| theme | 主题 | `string` | \#ffb821 | +| poster | 视频封面图 | `string` | - | +| setEndPlayContent | 自定义视频结束时显示的内容 | `React.ReactNode` | - | +| setBufferContent | 自定义视频缓冲加载组件 | `React.ReactNode` | - | +| pausePlacement | 暂停键的位置 | `bottomRight` | `center` | `bottomRight` | +| hideMouseTime | 多少毫秒,无任何操作,隐藏鼠标和控制器/ms | `number` | 2000 | +| isShowMultiple | 是否显示播放倍数功能 | `boolean` | true | +| isShowSet | 是否显示设置功能 | `boolean` | true | +| isShowScreenshot | 是否显示截图功能 | `boolean` | true | +| isShowPicture | 是否显示画中画 | `boolean` | true | +| isShowWebFullScreen | 是否显示网页全屏 | `boolean` | true | +| language | 语言 | `zh` | `en` | `zh` | #### 方法