未验证 提交 b6fa7cc6 编写于 作者: O openharmony_ci 提交者: Gitee

!2454 TS组件controller格式整改+断链修改

Merge pull request !2454 from LiAn/master
...@@ -20,8 +20,8 @@ Select(options: Array<SelectOption>) ...@@ -20,8 +20,8 @@ Select(options: Array<SelectOption>)
| 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 | | 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 |
| ------ | ----------------------------------------------- | ---- | ------ | -------------- | | ------ | ----------------------------------------------- | ---- | ------ | -------------- |
| value | [ResourceStr](../../ui/ts-types.md#ResourceStr) | 是 | - | 下拉选项内容。 | | value | [ResourceStr](../../ui/ts-types.md) | 是 | - | 下拉选项内容。 |
| icon | [ResourceStr](../../ui/ts-types.md#ResourceStr) | 否 | - | 下拉选项图片。 | | icon | [ResourceStr](../../ui/ts-types.md) | 否 | - | 下拉选项图片。 |
## 属性 ## 属性
...@@ -29,14 +29,14 @@ Select(options: Array<SelectOption>) ...@@ -29,14 +29,14 @@ Select(options: Array<SelectOption>)
| ----------------------- | --------------------------------------------------- | ------ | ----------------------------------------------- | | ----------------------- | --------------------------------------------------- | ------ | ----------------------------------------------- |
| selected | number | - | 设置下拉菜单初始选择项的索引,第一项的索引为0。 | | selected | number | - | 设置下拉菜单初始选择项的索引,第一项的索引为0。 |
| value | string | - | 设置下拉按钮本身的文本显示。 | | value | string | - | 设置下拉按钮本身的文本显示。 |
| font | [Font](../../ui/ts-types.md#Font类型) | - | 设置下拉按钮本身的文本样式: | | font | [Font](../../ui/ts-types.md) | - | 设置下拉按钮本身的文本样式: |
| fontColor | [ResourceColor](../../ui/ts-types.md#ResourceColor) | - | 设置下拉按钮本身的文本颜色。 | | fontColor | [ResourceColor](../../ui/ts-types.md) | - | 设置下拉按钮本身的文本颜色。 |
| selectedOptionBgColor | [ResourceColor](../../ui/ts-types.md#ResourceColor) | - | 设置下拉菜单选中项的背景色。 | | selectedOptionBgColor | [ResourceColor](../../ui/ts-types.md) | - | 设置下拉菜单选中项的背景色。 |
| selectedOptionFont | [Font](../../ui/ts-types.md#Font类型) | - | 设置下拉菜单选中项的文本样式: | | selectedOptionFont | [Font](../../ui/ts-types.md) | - | 设置下拉菜单选中项的文本样式: |
| selectedOptionFontColor | [ResourceColor](../../ui/ts-types.md#ResourceColor) | - | 设置下拉菜单选中项的文本颜色。 | | selectedOptionFontColor | [ResourceColor](../../ui/ts-types.md) | - | 设置下拉菜单选中项的文本颜色。 |
| optionBgColor | [ResourceColor](../../ui/ts-types.md#ResourceColor) | - | 设置下拉菜单项的背景色。 | | optionBgColor | [ResourceColor](../../ui/ts-types.md) | - | 设置下拉菜单项的背景色。 |
| optionFont | [Font](../../ui/ts-types.md#Font类型) | - | 设置下拉菜单项的文本样式: | | optionFont | [Font](../../ui/ts-types.md) | - | 设置下拉菜单项的文本样式: |
| optionFontColor | [ResourceColor](../../ui/ts-types.md#ResourceColor) | - | 设置下拉菜单项的文本颜色。 | | optionFontColor | [ResourceColor](../../ui/ts-types.md) | - | 设置下拉菜单项的文本颜色。 |
## 事件 ## 事件
......
...@@ -48,15 +48,6 @@ TextArea(value?:{placeholder?: string controller?: TextAreaController}) ...@@ -48,15 +48,6 @@ TextArea(value?:{placeholder?: string controller?: TextAreaController})
| End | 水平对齐尾部。 | | End | 水平对齐尾部。 |
### TextAreaController<sup>8+</sup>
TextArea组件的控制器,通过它操作TextArea组件。
| 接口名称 | 功能描述 |
| -------- | -------- |
| caretPosition(value:&nbsp;number):&nbsp;void | 设置输入光标的位置。<br/>value:从字符串开始到光标所在位置的字符长度。 |
## 事件 ## 事件
| 名称 | 功能描述 | | 名称 | 功能描述 |
...@@ -66,6 +57,28 @@ TextArea组件的控制器,通过它操作TextArea组件。 ...@@ -66,6 +57,28 @@ TextArea组件的控制器,通过它操作TextArea组件。
| onCut<sup>8+</sup>(callback:(value:&nbsp;string)&nbsp;=&gt;&nbsp;void) | 长按输入框内部区域弹出剪贴板后,点击剪切板剪切按钮,触发回调。<br/>value:剪切的文本内容。 | | onCut<sup>8+</sup>(callback:(value:&nbsp;string)&nbsp;=&gt;&nbsp;void) | 长按输入框内部区域弹出剪贴板后,点击剪切板剪切按钮,触发回调。<br/>value:剪切的文本内容。 |
| onPaste<sup>8+</sup>(callback:(value:&nbsp;string)&nbsp;=&gt;&nbsp;void) | 长按输入框内部区域弹出剪贴板后,点击剪切板粘贴按钮,触发回调。<br/>value:粘贴的文本内容。 | | onPaste<sup>8+</sup>(callback:(value:&nbsp;string)&nbsp;=&gt;&nbsp;void) | 长按输入框内部区域弹出剪贴板后,点击剪切板粘贴按钮,触发回调。<br/>value:粘贴的文本内容。 |
## TextAreaController<sup>8+</sup>
TextArea组件的控制器,通过它操作TextArea组件。
### 导入对象
```
controller: TextAreaController = new TextAreaController()
```
### caretPosition<sup>8+</sup>
caretPosition(value: number): void
设置输入光标的位置。
- 参数
| 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 |
| -------- | -------- | -------- | -------- | -------- |
| value | number | 是 | - | 从字符串开始到光标所在位置的字符长度。 |
## 示例 ## 示例
......
...@@ -29,21 +29,35 @@ TextClock(options?: {timeZoneOffset?: number, contorller?: TextClockController}) ...@@ -29,21 +29,35 @@ TextClock(options?: {timeZoneOffset?: number, contorller?: TextClockController})
| ------ | -------- | -------- | ------------------------------------------------------------ | | ------ | -------- | -------- | ------------------------------------------------------------ |
| format | string | 'hhmmss' | 设置显示时间格式,如“yyyy/mm/dd”、“yyyy-mm-dd”等。支持的时间格式化字符串:<ul><li>yyyy(年份)</li><li>mm(英文月份简写)</li><li>mmm(英文月份简写)</li><li>mmmm(英文月份全称)</li><li>dd(英文星期简写)</li><li>ddd(英文星期简写)</li><li>dddd(英文星期全称)</li><li>HH(24小时制)</li><li>hh(12小时制)</li><li>MM/mm(分钟)</li><li>SS/ss(秒)</li></ul> | | format | string | 'hhmmss' | 设置显示时间格式,如“yyyy/mm/dd”、“yyyy-mm-dd”等。支持的时间格式化字符串:<ul><li>yyyy(年份)</li><li>mm(英文月份简写)</li><li>mmm(英文月份简写)</li><li>mmmm(英文月份全称)</li><li>dd(英文星期简写)</li><li>ddd(英文星期简写)</li><li>dddd(英文星期全称)</li><li>HH(24小时制)</li><li>hh(12小时制)</li><li>MM/mm(分钟)</li><li>SS/ss(秒)</li></ul> |
## 事件
| 名称 | 功能描述 |
| -------------------------------------------- | ------------------------------------------------------------ |
| onDateChange(event: (value: number) => void) | 提供时间变化回调,该事件最小回调间隔为秒。<br /> value: Unix Time Stamp,即自1970年1月1日(UTC)起经过的毫秒数。 |
## TextClockController ## TextClockController
TextClock容器组件的控制器,可以将此对象绑定至TextClock组件,然后通过它控制文本时钟状态的启动与停止。 TextClock容器组件的控制器,可以将此对象绑定至TextClock组件,然后通过它控制文本时钟状态的启动与停止。
| 接口名称 | 功能描述 | ### 导入对象
| -------------------------------------------- | ------------------------------------------------------------ |
| start() | 启动文本时钟。 |
| stop() | 停止文本时钟。 |
```
controller: TextClockController = new TextClockController()
## 事件 ```
### start
start()
启动文本时钟。
### stop
stop()
停止文本时钟。
| 名称 | 功能描述 |
| -------------------------------------------- | ------------------------------------------------------------ |
| onDateChange(event: (value: number) => void) | 提供时间变化回调,该事件最小回调间隔为秒。<br /> value: Unix Time Stamp,即自1970年1月1日(UTC)起经过的毫秒数。 |
## 示例 ## 示例
......
...@@ -28,18 +28,6 @@ TextTimer(options: { isCountDown?: boolean, count?: number, controller?: TextTim ...@@ -28,18 +28,6 @@ TextTimer(options: { isCountDown?: boolean, count?: number, controller?: TextTim
| count | number | 否 | 60000 | 倒计时时间(isCountDown为true时生效),单位为毫秒。<br/>-&nbsp;count&lt;=0时,使用默认值为倒计时初始值。<br/>-&nbsp;count&gt;0时,count值为倒计时初始值。 | | count | number | 否 | 60000 | 倒计时时间(isCountDown为true时生效),单位为毫秒。<br/>-&nbsp;count&lt;=0时,使用默认值为倒计时初始值。<br/>-&nbsp;count&gt;0时,count值为倒计时初始值。 |
| controller | [TextTimerController](#texttimercontroller) | 否 | null | TextTimer控制器。 | | controller | [TextTimerController](#texttimercontroller) | 否 | null | TextTimer控制器。 |
### TextTimerController
TextTimer组件的控制器,用于控制文本计时器。
| 接口名称 | 功能描述 |
| -------- | -------- |
| start() | 计时开始。 |
| pause() | 计时暂停。 |
| reset() | 重置计时器。 |
## 属性 ## 属性
| 名称 | 参数类型 | 默认值 | 描述 | | 名称 | 参数类型 | 默认值 | 描述 |
...@@ -54,18 +42,48 @@ TextTimer组件的控制器,用于控制文本计时器。 ...@@ -54,18 +42,48 @@ TextTimer组件的控制器,用于控制文本计时器。
| onTimer(callback:&nbsp;(utc:&nbsp;number,&nbsp;elapsedTime:&nbsp;number)&nbsp;=&gt;&nbsp;void) | 时间文本发生变化时触发。<br/>utc:当前显示的时间,单位为毫秒。<br/>elapsedTime:计时器经过的时间,单位为毫秒。 | | onTimer(callback:&nbsp;(utc:&nbsp;number,&nbsp;elapsedTime:&nbsp;number)&nbsp;=&gt;&nbsp;void) | 时间文本发生变化时触发。<br/>utc:当前显示的时间,单位为毫秒。<br/>elapsedTime:计时器经过的时间,单位为毫秒。 |
## TextTimerController
TextTimer组件的控制器,用于控制文本计时器。
### 导入对象
```
textTimerController: TextTimerController = new TextTimerController()
```
### start
start()
计时开始。
### pause
pause()
计时暂停。
### reset
reset()
重置计时器。
## 示例 ## 示例
``` ```
@Entry @Entry
@Component @Component
struct TextTimerExample { struct TextTimerExample {
myTimerController: TextTimerController = new TextTimerController() textTimerController: TextTimerController = new TextTimerController()
@State format: string = 'hh:mm:ss.ms' @State format: string = 'hh:mm:ss.ms'
build() { build() {
Column() { Column() {
TextTimer({controller: this.myTimerController}) TextTimer({controller: this.textTimerController})
.format(this.format) .format(this.format)
.fontColor(Color.Black) .fontColor(Color.Black)
.fontSize(50) .fontSize(50)
...@@ -74,13 +92,13 @@ struct TextTimerExample { ...@@ -74,13 +92,13 @@ struct TextTimerExample {
}) })
Row() { Row() {
Button("start").onClick(() => { Button("start").onClick(() => {
this.myTimerController.start(); this.textTimerController.start();
}); });
Button("pause").onClick(() => { Button("pause").onClick(() => {
this.myTimerController.pause(); this.textTimerController.pause();
}); });
Button("reset").onClick(() => { Button("reset").onClick(() => {
this.myTimerController.reset(); this.textTimerController.reset();
}); });
} }
} }
......
...@@ -127,10 +127,10 @@ Web组件返回的请求/响应头对象。 ...@@ -127,10 +127,10 @@ Web组件返回的请求/响应头对象。
- 参数 - 参数
| 参数名称 | 参数描述 | | 参数名称 | 参数类型 |参数描述 |
| ----------- | ---------------------- | | ----------- | ----------- |---------------------- |
| headerKey: string | <p>请求/响应头的key。</p> | | headerKey | string |请求/响应头的key。 |
| headerValue: string | <p>请求/响应头的value。</p> | | headerValue | string |请求/响应头的value。|
### WebResourceResponse对象说明 ### WebResourceResponse对象说明
...@@ -180,6 +180,12 @@ accessStep(step: number): boolean ...@@ -180,6 +180,12 @@ accessStep(step: number): boolean
| ---- | ------ | ---- | ---- | --------------------- | | ---- | ------ | ---- | ---- | --------------------- |
| step | number | 是 | - | 要跳转的步数,正数代表前进,负数代表后退。 | | step | number | 是 | - | 要跳转的步数,正数代表前进,负数代表后退。 |
- 返回值
| 参数类型 | 说明 |
| ---- | ------ |
| boolean | 页面是否前进或后退 |
### backward ### backward
backward(): void backward(): void
......
...@@ -35,15 +35,6 @@ Tabs(value: {barPosition?: BarPosition, index?: number, controller?: [TabsContro ...@@ -35,15 +35,6 @@ Tabs(value: {barPosition?: BarPosition, index?: number, controller?: [TabsContro
| End | vertical属性方法设置为true时,页签位于容器右侧;vertical属性方法设置为false时,页签位于容器底部。 | | End | vertical属性方法设置为true时,页签位于容器右侧;vertical属性方法设置为false时,页签位于容器底部。 |
### TabsController
Tabs组件的控制器,用于控制Tabs组件进行页签切换。
| 接口名称 | 功能描述 |
| -------- | -------- |
| changeIndex(value:&nbsp;number):&nbsp;void | 控制Tabs切换到指定页签,index:&nbsp;页签在Tabs里的索引值,索引值从0开始。 |
## 属性 ## 属性
不支持触摸热区设置。 不支持触摸热区设置。
...@@ -70,6 +61,28 @@ Tabs组件的控制器,用于控制Tabs组件进行页签切换。 ...@@ -70,6 +61,28 @@ Tabs组件的控制器,用于控制Tabs组件进行页签切换。
| -------- | -------- | | -------- | -------- |
| onChange(callback:&nbsp;(index:&nbsp;number)&nbsp;=&gt;&nbsp;void) | Tab页签切换后触发的事件。 | | onChange(callback:&nbsp;(index:&nbsp;number)&nbsp;=&gt;&nbsp;void) | Tab页签切换后触发的事件。 |
## TabsController
Tabs组件的控制器,用于控制Tabs组件进行页签切换。
### 导入对象
```
controller: TabsController = new TabsController()
```
### changeIndex
changeIndex(value: number): void
控制Tabs切换到指定页签。
- 参数
| 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 |
| -------- | -------- | -------- | -------- | -------- |
| value | number | 是 | - | 页签在Tabs里的索引值,索引值从0开始。 |
## 示例 ## 示例
......
...@@ -60,18 +60,75 @@ Video(value: VideoOptions) ...@@ -60,18 +60,75 @@ Video(value: VideoOptions)
| onUpdate(event?:&nbsp;{&nbsp;time:&nbsp;number&nbsp;})&nbsp;=&gt;&nbsp;void | 播放进度变化时触发该事件,单位为s,更新时间间隔为250ms。 | | onUpdate(event?:&nbsp;{&nbsp;time:&nbsp;number&nbsp;})&nbsp;=&gt;&nbsp;void | 播放进度变化时触发该事件,单位为s,更新时间间隔为250ms。 |
### VideoController ## VideoController
> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:** 一个VideoController对象可以控制一个或多个video。
> 一个VideoController对象可以控制一个或多个video。
| 接口名称 | 描述 |
| -------- | -------- | ### 导入对象
| start()&nbsp;:&nbsp;void | 开始播放。 |
| pause()&nbsp;:&nbsp;void | 暂停播放。 | ```
| stop()&nbsp;:&nbsp;void | 停止播放。 | controller: VideoController = new VideoController();
| setCurrentTime(value:&nbsp;number) | 指定视频播放的进度位置。 | ```
| setCurrentTime(value:&nbsp;number,&nbsp;seekMode:&nbsp;SeekMode | 指定视频播放的进度位置,并指定跳转模式。 |
### start
start(): void
开始播放。
### pause
pause(): void
暂停播放。
### stop
stop(): void
停止播放。
### setCurrentTime
setCurrentTime(value: number)
指定视频播放的进度位置。
- 参数
| 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 |
| -------- | -------- | -------- | -------- | -------- |
| value | number | 是 | - | 视频播放进度位置。 |
### requestFullscreen
requestFullscreen(value: boolean)
请求全屏播放。
- 参数
| 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 |
| -------- | -------- | -------- | -------- | -------- |
| value | number | 是 | false | 是否全屏播放。 |
### exitFullscreen
exitFullscreen()
退出全屏播放。
### setCurrentTime<sup>8+</sup>
setCurrentTime(value: number, seekMode: SeekMode)
指定视频播放的进度位置,并指定跳转模式。
- 参数
| 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 |
| -------- | -------- | -------- | -------- | -------- |
| value | number | 是 | - | 视频播放进度位置。 |
| seekMode | SeekMode | 是 | - | 跳转模式。 |
- SeekMode<sup>8+</sup>类型接口说明 - SeekMode<sup>8+</sup>类型接口说明
| 名称 | 描述 | | 名称 | 描述 |
...@@ -82,6 +139,7 @@ Video(value: VideoOptions) ...@@ -82,6 +139,7 @@ Video(value: VideoOptions)
| Accurate | 精准跳转,不论是否为关键帧。 | | Accurate | 精准跳转,不论是否为关键帧。 |
## 示例 ## 示例
``` ```
...@@ -93,7 +151,7 @@ struct VideoCreateComponent { ...@@ -93,7 +151,7 @@ struct VideoCreateComponent {
@State currentProgressRates: number = 1; @State currentProgressRates: number = 1;
@State autoPlays: boolean = false; @State autoPlays: boolean = false;
@State controlsss: boolean = true; @State controlsss: boolean = true;
myVideoController: VideoController = new VideoController(); controller: VideoController = new VideoController();
@State startStaus: boolean = true; @State startStaus: boolean = true;
build() { build() {
Column() { Column() {
...@@ -101,7 +159,7 @@ struct VideoCreateComponent { ...@@ -101,7 +159,7 @@ struct VideoCreateComponent {
src: this.srcs, src: this.srcs,
previewUri: this.previewUris, previewUri: this.previewUris,
currentProgressRate: this.currentProgressRates, currentProgressRate: this.currentProgressRates,
controller: this.myVideoController controller: this.controller
}).width(700).height(500) }).width(700).height(500)
.autoPlay(this.autoPlays) .autoPlay(this.autoPlays)
.controls(this.controlsss) .controls(this.controlsss)
...@@ -151,19 +209,19 @@ struct VideoCreateComponent { ...@@ -151,19 +209,19 @@ struct VideoCreateComponent {
Row() { Row() {
Button("start").onClick(() => { Button("start").onClick(() => {
this.myVideoController.start(); this.controller.start();
}); });
Button("pause").onClick(() => { Button("pause").onClick(() => {
this.myVideoController.pause(); this.controller.pause();
}); });
Button("stop").onClick(() => { Button("stop").onClick(() => {
this.myVideoController.stop(); this.controller.stop();
}); });
} }
Row() { Row() {
Button("setCurrentTime").onClick(() => { Button("setCurrentTime").onClick(() => {
this.myVideoController.setCurrentTime(9, SeekMode.Accurate); this.controller.setCurrentTime(9, SeekMode.Accurate);
}); });
} }
} }
......
Markdown is supported
0% .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑!
想要评论请 注册