diff --git a/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-blank.md b/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-blank.md index ff5f4152d12aa8d4a76495a25ccb7af366703cf2..04e04b47272a13c9e4068134837c016e547a022f 100644 --- a/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-blank.md +++ b/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-blank.md @@ -31,7 +31,7 @@ Blank(min?: Length) | 名称 | 参数类型 | 默认值 | 描述 | | ----- | -------- | -------- | ------------------------ | -| color | Color | 0xffffff | 设置空白填充的填充颜色。 | +| color | [ResourceColor](../../ui/ts-types.md) | 0xffffff | 设置空白填充的填充颜色。 | > **说明：** > diff --git a/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-button.md b/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-button.md index 53541e4fb3ff29fca93adefceed3fe92c7ef5bb8..24658816288295310ec2b2a37901db0c897d82e2 100644 --- a/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-button.md +++ b/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-button.md @@ -27,7 +27,7 @@ | type | ButtonType | 否 | Capsule | 描述按钮风格。 | | stateEffect | boolean | 否 | true | 按钮按下时是否开启切换效果，当状态置为false时，点击效果关闭。 | -**方法2：** Button(label?: string, options?: { type?: ButtonType, stateEffect?: boolean }) +**方法2：** Button(label?: ResourceStr, options?: { type?: ButtonType, stateEffect?: boolean }) 使用文本内容创建相应的按钮组件，此时Button无法包含子组件。 @@ -35,14 +35,14 @@ | 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 | | ------- | ------ | ---- | ---- | ------------- | -| label | string | 否 | - | 按钮文本内容。 | +| label | [ResourceStr](../../ui/ts-types.md) | 否 | - | 按钮文本内容。 | | options | Object | 否 | - | 见options参数说明。 | ## 属性 | 名称 | 参数类型 | 默认值 | 描述 | | ----------- | ---------- | ------- | --------------------------------- | -| type | ButtonType | Capsule | 设置Button样式。 | +| type | ButtonType | ButtonType.Capsule | 设置Button样式。 | | stateEffect | boolean | true | 状态切换时是否开启切换效果，当状态置为false时，点击效果关闭。 | ## ButtonType枚举说明 diff --git a/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-checkbox.md b/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-checkbox.md index da728cd6f2392befb46e3fc939b82c757da81357..ee71c65e92e81eb7d5fd494dd9bfc4e17790b553 100644 --- a/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-checkbox.md +++ b/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-checkbox.md @@ -29,8 +29,8 @@ Checkbox( name?: string, group?: string ) | 名称 | 参数类型 | 默认值 | 描述 | | ------------- | ----- | ----- | ------------ | -| select | bool | false | 设置多选框是否选中。 | -| selectedColor | Color | - | 设置多选框选中状态颜色。 | +| select | boolean | false | 设置多选框是否选中。 | +| selectedColor | [ResourceColor](../../ui/ts-types.md) | - | 设置多选框选中状态颜色。 | ## 事件 diff --git a/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-checkboxgroup.md b/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-checkboxgroup.md index 5c63cf463447595749e1b34d5cc9de15749e00b8..dfcd6ae75ee000c5c3cd2af2741850fa688006f7 100644 --- a/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-checkboxgroup.md +++ b/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-checkboxgroup.md @@ -30,8 +30,8 @@ CheckboxGroup( group?: string ) | 名称 | 参数类型 | 默认值 | 描述 | | ------------- | ----- | ----- | ---------------- | -| selectAll | bool | false | 设置是否全选。 | -| selectedColor | Color | - | 设置被选中或部分选中状态的颜色。 | +| selectAll | boolean | false | 设置是否全选。 | +| selectedColor | [ResourceColor](../../ui/ts-types.md) | - | 设置被选中或部分选中状态的颜色。 | ## 事件 diff --git a/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-datapanel.md b/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-datapanel.md index c92d223978c7aa888390a370b57746250d7ce563..ff2fb565e4a16d9505f8f792c8aa21aad3db1468 100644 --- a/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-datapanel.md +++ b/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-datapanel.md @@ -12,7 +12,7 @@ ## 接口 -DataPanel(value:{values: number[], max?: number, type?: DataPanelType}) +DataPanel(options:{values: number[], max?: number, type?: DataPanelType}) **参数**: diff --git a/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-divider.md b/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-divider.md index b0db203ee2ad20a2575263340d39793174913671..9573a6e885b63c1b5a54002f6f336be4ad516163 100644 --- a/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-divider.md +++ b/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-divider.md @@ -23,8 +23,8 @@ Divider() | 名称 | 参数类型 | 默认值 | 描述 | | ----------- | ---------------------------------------- | ----------------- | ---------------------------------------- | | vertical | boolean | false | 使用水平分割线还是垂直分割线，false: 水平分割线， true:垂直分割线。 | -| color | Color | - | 设置分割线颜色。 | -| strokeWidth | Length | 1 | 设置分割线宽度。 | +| color | [ResourceColor](../../ui/ts-types.md) | - | 设置分割线颜色。 | +| strokeWidth | [Length](../../ui/ts-types.md) | 1 | 设置分割线宽度。 | | lineCap | [LineCapStyle](ts-appendix-enums.md#linecapstyle枚举说明) | LineCapStyle.Butt | 设置分割线条的端点样式。 | diff --git a/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-gauge.md b/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-gauge.md index 6c5cc216c0b2824344248feed4a3fb67193a195a..91d290bef726e242937dbdae7c9c91403f2f00e3 100644 --- a/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-gauge.md +++ b/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-gauge.md @@ -16,7 +16,7 @@ ## 接口 -Gauge(value:{value: number, min?: number, max?: number}) +Gauge(options:{value: number, min?: number, max?: number}) **参数：** @@ -31,9 +31,9 @@ Gauge(value:{value: number, min?: number, max?: number}) | 名称 | 参数类型 | 默认值 | 描述 | | ----------- | ---------------------------------------- | ---- | --------------------------- | | value | number | 0 | 设置当前数据图表的值。 | -| startAngle | Angle | -150 | 设置起始角度位置，时钟0点为0度，顺时针方向为正角度。 | -| endAngle | Angle | 150 | 设置终止角度位置，时钟0点为0度，顺时针方向为正角度。 | -| colors | Color \| Array<ColorStop> | - | 设置图表的颜色，支持纯色和分段渐变色设置。 | +| startAngle | number | -150 | 设置起始角度位置，时钟0点为0度，顺时针方向为正角度。 | +| endAngle | number | 150 | 设置终止角度位置，时钟0点为0度，顺时针方向为正角度。 | +| colors | Array<ColorStop> | - | 设置图表的颜色，支持分段颜色设置。 | | strokeWidth | Length | - | 设置环形图表的环形厚度。 | diff --git a/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-image.md b/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-image.md index 4ff7f9d399c042b87ad6c317d28aeaf3217a81cc..94f7bdd95716eb5ed6935a4baab3fc8451efada6 100644 --- a/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-image.md +++ b/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-image.md @@ -81,7 +81,7 @@ Image(src: string | PixelMap | Resource) | ---------------------------------------- | ---------------------------------------- | | onComplete(callback: (event?: { width: number, height: number, componentWidth: number,
 componentHeight: number, loadingStatus: number }) => void) | 图片成功加载时触发该回调，返回成功加载的图源尺寸。 | | onError(callback: (event?: { componentWidth: number, componentHeight: number }) => void) | 图片加载出现异常时触发该回调。 | -| onFinish(callback: () => void) | 当加载的源文件为带动效的svg图片时，当svg动效播放完成时会触发这个回调，如果动效为无限循环动效，则不会触发这个回调。 | +| onFinish(event: () => void) | 当加载的源文件为带动效的svg图片时，当svg动效播放完成时会触发这个回调，如果动效为无限循环动效，则不会触发这个回调。 | ## 示例 diff --git a/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-imageanimator.md b/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-imageanimator.md index 13fb64f8858c854472706e0f8a16e59a025573a0..f3494f5afb7aebc94749aa7de3a2bce9567bf9c8 100644 --- a/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-imageanimator.md +++ b/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-imageanimator.md @@ -55,11 +55,11 @@ ImageAnimator() | 名称 | 功能描述 | | ------------------------------- | --------------- | -| onStart() => void | 状态回调，动画开始播放时触发。 | -| onPause() => void | 状态回调，动画暂停播放时触发。 | -| onRepeat() => void | 状态回调，动画重新播放时触发。 | -| onCancel() => void | 状态回调，动画取消播放时触发。 | -| onFinish() => void | 状态回调，动画播放完成时触发。 | +| onStart(event: () => void) | 状态回调，动画开始播放时触发。 | +| onPause(event: () => void) | 状态回调，动画暂停播放时触发。 | +| onRepeat(event: () => void) | 状态回调，动画重新播放时触发。 | +| onCancel(event: () => void) | 状态回调，动画取消播放时触发。 | +| onFinish(event: () => void) | 状态回调，动画播放完成时触发。 | ## 示例 diff --git a/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-loadingprogress.md b/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-loadingprogress.md index 3e8e70b1caad58f05fd12d719abda3c36cf0ce91..a9de525c51a98599f6c4c2b23be43b996e11532e 100644 --- a/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-loadingprogress.md +++ b/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-loadingprogress.md @@ -27,7 +27,7 @@ LoadingProgress() | 名称 | 参数类型 | 默认值 | 描述 | | ----- | ----- | ---- | ----------- | -| color | Color | - | 设置加载进度条前景色。 | +| color | [ResourceColor](../../ui/ts-types.md) | - | 设置加载进度条前景色。 | ## 示例 diff --git a/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-marquee.md b/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-marquee.md index 144fb4fd695f8b3bcb672944aed86fbf6d42d4d3..4ca2c0fcc88d75cc1dc6b40d6bc3c2a5b2d4aef4 100644 --- a/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-marquee.md +++ b/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-marquee.md @@ -36,9 +36,9 @@ Marquee(value: { start: boolean, step?: number, loop?: number, fromStart?: boole | 名称 | 功能描述 | | ---------------------------------------- | ---------- | -| onStart(callback: () => void) | 开始滚动时触发回调。 | -| onBounce(callback: () => void) | 滚动到底时触发回调。 | -| onFinish(callback: () => void) | 滚动完成时触发回调。 | +| onStart(event: () => void) | 开始滚动时触发回调。 | +| onBounce(event: () => void) | 滚动到底时触发回调。 | +| onFinish(event: () => void) | 滚动完成时触发回调。 | ## 示例 diff --git a/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-navigation.md b/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-navigation.md index 2e3d048fec8818c5e6d9f00f805f3ea794822858..2081f0b2f1a57fd5c8abecc35452132dfdc0c6d2 100644 --- a/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-navigation.md +++ b/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-navigation.md @@ -32,7 +32,7 @@ Navigation() | subtitle | string | - | 页面副标题。 | | menus | Array8+ | - | 页面右上角菜单。 | | titleMode | NavigationTitleMode | NavigationTitleMode.Free | 页面标题栏显示模式。 | -| toolBar | {
items:[
Object
] }
\| [CustomBuilder](../../ui/ts-types.md)8+ | - | 设置工具栏内容。
items: 工具栏所有项。 | +| toolBar | {
items:Array<Object> }
\| [CustomBuilder](../../ui/ts-types.md)8+ | - | 设置工具栏内容。
items: 工具栏所有项。 | | hideToolBar | boolean | false | 设置隐藏/显示工具栏：
true: 隐藏工具栏。
false: 显示工具栏。 | | hideTitleBar | boolean | false | 隐藏标题栏。 | | hideBackButton | boolean | false | 隐藏返回键。 | @@ -45,7 +45,7 @@ Navigation() | icon | string | 否 | - | 菜单栏单个选项的图标资源路径。 | | action | () => void | 否 | - | 当前选项被选中的事件回调。 | -## Object类型接口说明 +## Object类型说明 | 名称 | 类型 | 必填 | 默认值 | 描述 | | ------ | ----------------------- | ---- | ---- | --------------- | diff --git a/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-progress.md b/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-progress.md index a59d012b9064ab6bdd31e36b707118369a303103..5a607c7e2df4b088b452466a9a704d79aee28bef 100644 --- a/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-progress.md +++ b/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-progress.md @@ -19,7 +19,7 @@ ## 接口 -Progress(value: {value: number, total?: number, type?: ProgressType}) +Progress(options: {value: number, total?: number, type?: ProgressType}) 创建进度组件，用于显示内容加载或操作处理进度。 @@ -46,7 +46,7 @@ Progress(value: {value: number, total?: number, type?: ProgressType}) | 名称 | 参数类型 | 默认值 | 描述 | | ------------------ | ---------------------------------------- | ---- | ---------------------------------------- | | value | number | - | 设置当前进度值。 | -| color | Color | - | 设置进度条前景色。 | +| color | [ResourceColor](../../ui/ts-types.md) | - | 设置进度条前景色。 | | style8+ | {
strokeWidth？: Length,
scaleCount？: number,
scaleWidth？: Length
} | - | 定义组件的样式。
strokeWidth: 设置进度条宽度。
scaleCount: 设置环形进度条总刻度数。
scaleWidth: 设置环形进度条刻度粗细。
刻度粗细大于进度条宽度时，刻度粗细为系统默认粗细。 | diff --git a/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-qrcode.md b/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-qrcode.md index e09b973bdb962fcfc1c8076c7e7f4072f4959b1a..e565fb099fab407ab8506cc3565f1f89900c853c 100644 --- a/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-qrcode.md +++ b/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-qrcode.md @@ -31,7 +31,7 @@ QRCode(value: string) | 名称 | 参数类型 | 默认值 | 描述 | | ----- | ----- | ----- | -------- | -| color | Color | Black | 设置二维码颜色。 | +| color | [ResourceColor](../../ui/ts-types.md) | Black | 设置二维码颜色。 | ## 事件 diff --git a/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-radio.md b/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-radio.md index bfc9e434f0e63eab55c932677a7f138e0b2415bf..69f29e9fcfe7d2007303043336c5f4a0d76875ac 100644 --- a/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-radio.md +++ b/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-radio.md @@ -39,7 +39,7 @@ Radio(options: {value: string, group: string}) | 名称 | 功能描述 | | ---------------------------------------- | ---------------------------------------- | -| onChange(callback: (value: boolean) => void) | 单选框选中状态改变时触发回调。
-value为true时，代表选中。
-value为false时，代表未选中。 | +| onChange(callback: (isChecked: boolean) => void) | 单选框选中状态改变时触发回调。
-isChecked为true时，代表选中。
-isChecked为false时，代表未选中。 | ## 示例 @@ -56,8 +56,8 @@ struct RadioExample { Radio({ value: 'Radio1', group: 'radioGroup' }).checked(true) .height(50) .width(50) - .onChange((value: boolean) => { - console.log('Radio1 status is ' + value) + .onChange((isChecked: boolean) => { + console.log('Radio1 status is ' + isChecked) }) } Column() { @@ -65,8 +65,8 @@ struct RadioExample { Radio({ value: 'Radio2', group: 'radioGroup' }).checked(false) .height(50) .width(50) - .onChange((value: boolean) => { - console.log('Radio2 status is ' + value) + .onChange((isChecked: boolean) => { + console.log('Radio2 status is ' + isChecked) }) } Column() { @@ -74,8 +74,8 @@ struct RadioExample { Radio({ value: 'Radio3', group: 'radioGroup' }).checked(false) .height(50) .width(50) - .onChange((value: boolean) => { - console.log('Radio3 status is ' + value) + .onChange((isChecked: boolean) => { + console.log('Radio3 status is ' + isChecked) }) } }.padding({ top: 30 }) diff --git a/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-richtext.md b/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-richtext.md index 2df3918ecbe9a621c98a58525b18643e7789c947..273467da3e613e579039991551f43d056cc4752b 100644 --- a/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-richtext.md +++ b/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-richtext.md @@ -16,7 +16,7 @@ ## 接口 -RichText\(content: string\) +RichText(content: string) **参数：** @@ -28,8 +28,8 @@ RichText\(content: string\) | 名称 | 描述 | | -------------------- | ---------- | -| onStart() => void | 加载网页时触发。 | -| onComplete() => void | 网页加载结束时触发。 | +| onStart(callback: () => void) | 加载网页时触发。 | +| onComplete(callback: () => void) | 网页加载结束时触发。 | ## 支持标签 diff --git a/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-scrollbar.md b/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-scrollbar.md index 13438fb94402aae10fc7d76c9eae897ca78526be..b3d84efe6d064e5cd705239e30a8ed2c5187ecfe 100644 --- a/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-scrollbar.md +++ b/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-scrollbar.md @@ -19,7 +19,7 @@ ## 接口 -ScrollBar(value: ScrollBarOptions) +ScrollBar(value: { scroller: Scroller, direction?: ScrollBarDirection, state?: BarState }) **参数：** diff --git a/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-search.md b/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-search.md index a7fd51486f1c17214da1f8bbef33f5720cf87f90..b5ccc7d1c63600338268721494c74eb1aef3cb6a 100644 --- a/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-search.md +++ b/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-search.md @@ -56,7 +56,7 @@ controller: SearchController = new SearchController() ``` ### caretPosition -caretPosition(value: number): viod +caretPosition(value: number): void 设置输入光标的位置。 diff --git a/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-select.md b/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-select.md index 967f5005cdd6894909939e4b03e110cfe5a38467..27dd1220854ba5d1f115b2db271c7ad5811fde61 100644 --- a/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-select.md +++ b/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-select.md @@ -44,7 +44,7 @@ Select(options: Array\) | 名称 | 功能描述 | | ---------------------------------------- | -------------------------------------- | -| onSelect(callback: (index: number, value?:string) => void） | 下拉菜单选中某一项的回调。index：选中项的索引。value：选中项的值。 | +| onSelect(callback: (index: number, value?:string) => void) | 下拉菜单选中某一项的回调。index：选中项的索引。value：选中项的值。 | ## 示例 diff --git a/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-slider.md b/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-slider.md index e52fc7d9753a4203ccdf32a939e01f696e0f6786..79e1c449516d16e54bd8580166715c5df1e1ccb2 100644 --- a/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-slider.md +++ b/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-slider.md @@ -19,7 +19,7 @@ ## 接口 -Slider(value:{value?: number, min?: number, max?: number, step?: number, style?: SliderStyle, direction?: Axis}) +Slider(options:{value?: number, min?: number, max?: number, step?: number, style?: SliderStyle, direction?: Axis, reverse?: boolean}) **参数：** @@ -46,11 +46,12 @@ Slider(value:{value?: number, min?: number, max?: number, step?: number, style?: | 名称 | 参数类型 | 默认值 | 描述 | | ------------- | ------- | ----- | ----------------- | -| blockColor | Color | - | 设置滑块的颜色。 | -| trackColor | Color | - | 设置滑轨的背景颜色。 | -| selectedColor | Color | - | 设置滑轨的已滑动颜色。 | +| blockColor | [ResourceColor](../../ui/ts-types.md) | - | 设置滑块的颜色。 | +| trackColor | [ResourceColor](../../ui/ts-types.md) | - | 设置滑轨的背景颜色。 | +| selectedColor | [ResourceColor](../../ui/ts-types.md) | - | 设置滑轨的已滑动颜色。 | | showSteps | boolean | false | 设置当前是否显示步长刻度值。 | | showTips | boolean | false | 设置滑动时是否显示气泡提示百分比。 | +| trackThickness | [Length](../../ui/ts-types.md) | - | 设置滑轨的粗细。 | ## 事件 @@ -59,7 +60,7 @@ Slider(value:{value?: number, min?: number, max?: number, step?: number, style?: | 名称 | 功能描述 | | ---------------------------------------- | ---------------------------------------- | -| onChange(callback: (value: number, mode: SliderChangeMode) => void） | Slider滑动时触发事件回调。
value：当前进度值。
mode：拖动状态。 | +| onChange(callback: (value: number, mode: SliderChangeMode) => void) | Slider滑动时触发事件回调。
value：当前进度值。
mode：拖动状态。 | ## SliderChangeMode枚举说明 @@ -68,6 +69,7 @@ Slider(value:{value?: number, min?: number, max?: number, step?: number, style?: | Begin | 0 | 用户开始拖动滑块。 | | Moving | 1 | 用户拖动滑块中。 | | End | 2 | 用户结束拖动滑块。 | +| Click | 3 | 用户点击滑动条使滑块位置移动。 | ## 示例 diff --git a/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-span.md b/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-span.md index 4e2b4d72755d45bd7251e56cf3f42ef684bb370f..903b365cfc78f4c2300939f9bedcff41a106cc6a 100644 --- a/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-span.md +++ b/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-span.md @@ -19,13 +19,13 @@ ## 接口 -Span(content: string) +Span(content: ResourceStr) **参数:** | 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 | | ------- | ------ | ---- | ---- | ----- | -| content | string | 是 | - | 文本内容。 | +| content | [ResourceStr](../../ui/ts-types.md) | 是 | - | 文本内容。 | ## 属性 @@ -33,7 +33,7 @@ Span(content: string) | 名称 | 参数类型 | 默认值 | 描述 | | ---------- | ---------------------------------------- | ---------------------------------------- | -------------- | -| decoration | {
type: [TextDecorationType](ts-appendix-enums.md#textdecorationtype枚举说明),
color?: Color
} | {
type: TextDecorationType.None
color：Color.Black
} | 设置文本装饰线样式及其颜色。 | +| decoration | {
type: [TextDecorationType](ts-appendix-enums.md#textdecorationtype枚举说明),
color?: [ResourceColor](../../ui/ts-types.md)
} | {
type: TextDecorationType.None
color：Color.Black
} | 设置文本装饰线样式及其颜色。 | | textCase | [TextCase](ts-appendix-enums.md#textcase枚举说明) | Normal | 设置文本大小写。 | diff --git a/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-stepper.md b/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-stepper.md index 5a6114086383a19ed245c9baab871b2691f30bf5..e1f8add9d7b0626bd9aed7a97e55a6a14d94ac18 100644 --- a/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-stepper.md +++ b/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-stepper.md @@ -40,6 +40,8 @@ Stepper(value?: { index?: number }) | onFinish(callback: () => void) | 步骤导航器最后一个StepperItem的nextLabel被点击时触发该回调 。 | | onSkip(callback: () => void) | 当前显示的StepperItem状态为ItemState.Skip时，nextLabel被点击时触发该回调。 | | onChange(callback: (prevIndex?: number, index?: number) => void) | 点击左边或者右边文本按钮进行步骤切换时触发该事件。
- prevIndex：切换前的步骤页索引值。
- index：切换后的步骤页（前一页或者下一页）索引值。 | +| onNext(callback: (index?: number, pendingIndex?: number) => void) | 点击切换下一步骤时触发该事件。
- index：当前步骤页索引值。
- pendingIndex：下一步骤页索引值。 | +| onPrevious(callback: (index?: number, pendingIndex?: number) => void) | 点击切换上一步骤时触发该事件。
- index：当前步骤页索引值。
- pendingIndex：上一步骤页索引值。 | ## 示例 diff --git a/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-text.md b/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-text.md index 67b5cd2d81a9773e9627257c0861a4d9055e4d86..9f1316e30d3459a626e50971391decaff32a6abc 100644 --- a/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-text.md +++ b/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-text.md @@ -19,13 +19,13 @@ ## 接口 -Text(content?: string) +Text(content?: ResourceStr) **参数：** | 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 | | ------- | ------ | ---- | ---- | ---------------------------------------- | -| content | string | 否 | '' | 文本内容。包含子组件Span时不生效，显示Span内容，并且此时text组件的样式不生效。 | +| content | [ResourceStr](../../ui/ts-types.md) | 否 | '' | 文本内容。包含子组件Span时不生效，显示Span内容，并且此时text组件的样式不生效。 | ## 属性 @@ -34,9 +34,9 @@ Text(content?: string) | textAlign | TextAlign | TextAlign.Start | 设置多行文本的文本对齐方式。 | | textOverflow | {overflow: TextOverflow} | {overflow: TextOverflow.Clip} | 设置文本超长时的显示方式。
**说明：**
文本截断是按字截断。例如，英文以单词为最小单位进行截断，若需要以字母为单位进行截断，可在字母间添加零宽空格：\u200B。 | | maxLines | number | Infinity | 设置文本的最大行数。 | -| lineHeight | Length | - | 设置文本的文本行高，设置值不大于0时，不限制文本行高，自适应字体大小，Length为number类型时单位为fp。 | -| decoration | {
type: TextDecorationType,
color?: Color
} | {
type: TextDecorationType.None,
color：Color.Black
} | 设置文本装饰线样式及其颜色。 | -| baselineOffset | Length | - | 设置文本基线的偏移量。 | +| lineHeight | string \| number \| [Resource](../../ui/ts-types.md) | - | 设置文本的文本行高，设置值不大于0时，不限制文本行高，自适应字体大小，Length为number类型时单位为fp。 | +| decoration | {
type: TextDecorationType,
color?: [ResourceColor](../../ui/ts-types.md)
} | {
type: TextDecorationType.None,
color：Color.Black
} | 设置文本装饰线样式及其颜色。 | +| baselineOffset | [Length](../../ui/ts-types.md) | - | 设置文本基线的偏移量。 | | textCase | TextCase | TextCase.Normal | 设置文本大小写。 | ## TextAlign枚举说明 diff --git a/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-textarea.md b/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-textarea.md index 29e933a4abd389b274782c150737d6763005550e..994fee4e6222014231aa945e7b1246361b453b32 100644 --- a/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-textarea.md +++ b/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-textarea.md @@ -19,13 +19,14 @@ ## 接口 -TextArea(value?:{placeholder?: string, controller?: TextAreaController}) +TextArea(value?:{placeholder?: ResourceStr, text?: ResourceStr, controller?: TextAreaController}) **参数：** | 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 | | ----------------------- | ---------------------------------------- | ---- | ---- | -------------- | -| placeholder | string | 否 | - | 无输入时的提示文本。 | +| placeholder | [ResourceStr](../../ui/ts-types.md) | 否 | - | 无输入时的提示文本。 | +| text | [ResourceStr](../../ui/ts-types.md) | 否 | - | 设置输入框当前的文本内容。 | | controller8+ | [TextAreaController](#textareacontroller8) | 否 | - | 设置TextArea控制器。 | ## 属性 @@ -34,11 +35,11 @@ TextArea(value?:{placeholder?: string, controller?: TextAreaController}) | 名称 | 参数类型 | 默认值 | 描述 | | ------------------------ | ---------------------------------------- | ----- | ---------------------------------------- | -| placeholderColor | Color | - | 设置placeholder文本颜色。 | +| placeholderColor | [ResourceColor](../../ui/ts-types.md) | - | 设置placeholder文本颜色。 | | placeholderFont | {
size?: number,
weight?:number \| [FontWeight](ts-universal-attributes-text-style.md)，
family?: string,
style?: [FontStyle](ts-universal-attributes-text-style.md)
} | - | 设置placeholder文本样式：
- size: 设置文本尺寸，Length为number类型时，使用fp单位。
- weight: 设置文本的字体粗细，number类型取值[100, 900]，取值间隔为100，默认为400，取值越大，字体越粗。
- family: 设置文本的字体列表。使用多个字体，使用','进行分割，优先级按顺序生效，例如：'Arial, sans-serif'。
- style: 设置文本的字体样式。 | | textAlign | TextAlign | Start | 设置文本水平对齐方式。 | -| caretColor | Color | - | 设置输入框光标颜色。 | -| inputFilter8+ | {
value: [ResourceStr](../../ui/ts-types.md)8+,
error?: (value: string)
} | - | 通过正则表达式设置输入过滤器。满足表达式的输入允许显示，不满足的输入被忽略。仅支持单个字符匹配，不支持字符串匹配。例如：^(?=.\*\d)(?=.\*[a-z])(?=.\*[A-Z]).{8,10}$，不支持过滤8到10位的强密码。
- value：设置正则表达式。
- error：正则匹配失败时，返回被忽略的内容。 | +| caretColor | [ResourceColor](../../ui/ts-types.md) | - | 设置输入框光标颜色。 | +| inputFilter8+ | {
value: [ResourceStr](../../ui/ts-types.md)8+,
error?: (value: string) => void
} | - | 通过正则表达式设置输入过滤器。满足表达式的输入允许显示，不满足的输入被忽略。仅支持单个字符匹配，不支持字符串匹配。例如：^(?=.\*\d)(?=.\*[a-z])(?=.\*[A-Z]).{8,10}$，不支持过滤8到10位的强密码。
- value：设置正则表达式。
- error：正则匹配失败时，返回被忽略的内容。 | ## TextAlign枚举说明 diff --git a/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-textclock.md b/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-textclock.md index c6d2e4543a5572a8c64cbbb5f91e579cd330767d..3edc447401258eecff860fc77315db48ef7a250f 100644 --- a/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-textclock.md +++ b/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-textclock.md @@ -16,14 +16,14 @@ TextClock通过文本显示当前系统时间，支持不同时区的时间显 ## 接口 -TextClock(options?: {timeZoneOffset?: number, contorller?: TextClockController}) +TextClock(options?: {timeZoneOffset?: number, controller?: TextClockController}) **参数:** | 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 | | -------------- | ---------------------------------------- | ---- | ----- | ---------------------------------------- | | timeZoneOffset | number | 否 | 时区偏移量 | 设置时区偏移量。取值范围为[-14, 12]，表示东十二区到西十二区，其中负值表示东时区，正值表示西时区，比如东八区为-8；对横跨国际日界线的国家或地区，用-13（UTC+13）和-14（UTC+14）来保证整个国家或者区域处在相同的时间。 | -| contorller | [TextClockContorller](#TextClockController) | 否 | null | 绑定一个控制器，用来控制文本时钟的状态。 | +| controller | [TextClockController](#TextClockController) | 否 | null | 绑定一个控制器，用来控制文本时钟的状态。 | ## 属性 diff --git a/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-textinput.md b/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-textinput.md index 256d46695d97da5fca06be600725c24a6c5e0dcf..7db34fc148ccd56874a15ff2de16389bccc22c4a 100644 --- a/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-textinput.md +++ b/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-textinput.md @@ -19,13 +19,14 @@ ## 接口 -TextInput(value?:{placeholder?: string controller?: TextInputController}) +TextInput(value?:{placeholder?: ResourceStr, text?: ResourceStr, controller?: TextInputController}) **参数：** | 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 | | ----------------------- | ---------------------------------------- | ---- | ---- | --------------- | -| placeholder | string | 否 | - | 无输入时的提示文本。 | +| placeholder | [ResourceStr](../../ui/ts-types.md) | 否 | - | 无输入时的提示文本。 | +| text | [ResourceStr](../../ui/ts-types.md) | 否 | - | 设置输入框当前的文本内容。 | | controller8+ | [TextInputController](#textinputcontroller8) | 否 | - | 设置TextInput控制器。 | ## 属性 @@ -35,38 +36,38 @@ TextInput(value?:{placeholder?: string controller?: TextInputController}) | 名称 | 参数类型 | 默认值 | 描述 | | ----------------------------- | ------------------------------------------------------------ | ----------------- | ------------------------------------------------------------ | | type | InputType | InputType.Normal | 设置输入框类型。 | -| placeholderColor | Color | - | 设置placeholder颜色。 | +| placeholderColor | [ResourceColor](../../ui/ts-types.md) | - | 设置placeholder颜色。 | | placeholderFont | {
size?: Length,
weight?: number\|[FontWeight](ts-universal-attributes-text-style.md),
family?: string,
style?: [FontStyle](ts-universal-attributes-text-style.md)
} | - | 设置placeholder文本样式：
- size: 设置文本尺寸，Length为number类型时，使用fp单位。
- weight: 设置文本的字体粗细，number类型取值[100, 900]，取值间隔为100，默认为400，取值越大，字体越粗。
- family: 设置文本的字体列表。使用多个字体，使用','进行分割，优先级按顺序生效。例如：'Arial, sans-serif'。
- style: 设置文本的字体样式。 | | enterKeyType | EnterKeyType | EnterKeyType.Done | 设置输入法回车键类型。 | -| caretColor | Color | - | 设置输入框光标颜色。 | +| caretColor | [ResourceColor](../../ui/ts-types.md) | - | 设置输入框光标颜色。 | | maxLength | number | - | 设置文本的最大输入字符数。 | -| inputFilter8+ | {
value: [ResourceStr](../../ui/ts-types.md)8+,
error?: (value: string)
} | - | 正则表达式，满足表达式的输入允许显示，不满足正则表达式的输入被忽略。仅支持单个字符匹配，不支持字符串匹配。例如：^(?=.\*\d)(?=.\*[a-z])(?=.\*[A-Z]).{8,10}$，8到10位的强密码不支持过滤。
- value：设置正则表达式。
- error：正则匹配失败时，返回被忽略的内容。 | +| inputFilter8+ | {
value: [ResourceStr](../../ui/ts-types.md)8+,
error?: (value: string) => void
} | - | 正则表达式，满足表达式的输入允许显示，不满足正则表达式的输入被忽略。仅支持单个字符匹配，不支持字符串匹配。例如：^(?=.\*\d)(?=.\*[a-z])(?=.\*[A-Z]).{8,10}$，8到10位的强密码不支持过滤。
- value：设置正则表达式。
- error：正则匹配失败时，返回被忽略的内容。 | | showPasswordIcon9+ | boolean | true | 密码输入模式时，密码框末尾的图标是否显示。 | ## EnterKeyType枚举说明 | 名称 | 描述 | | ------------------- | --------- | -| EnterKeyType.Go | 显示Go文本。 | -| EnterKeyType.Search | 显示为搜索样式。 | -| EnterKeyType.Send | 显示为发送样式。 | -| EnterKeyType.Next | 显示为下一个样式。 | -| EnterKeyType.Done | 标准样式。 | +| Go | 显示Go文本。 | +| Search | 显示为搜索样式。 | +| Send | 显示为发送样式。 | +| Next | 显示为下一个样式。 | +| Done | 标准样式。 | ## InputType枚举说明 | 名称 | 描述 | | ------------------ | ------------- | -| InputType.Normal | 基本输入模式。 | -| InputType.Password | 密码输入模式。 | -| InputType.Email | e-mail地址输入模式。 | -| InputType.Number | 纯数字输入模式。 | +| Normal | 基本输入模式。 | +| Password | 密码输入模式。 | +| Email | e-mail地址输入模式。 | +| Number | 纯数字输入模式。 | ## 事件 | 名称 | 功能描述 | | ---------------------------------------- | ---------------------------------------- | -| onChange(value: string) => void | 输入发生变化时，触发回调。 | +| onChange(callback: (value: string) => void) | 输入发生变化时，触发回调。 | | onSubmit(callback: (enterKey: EnterKeyType) => void) | 回车键或者软键盘回车键触发该回调，参数为当前软键盘回车键类型。 | | onEditChanged(callback: (isEditing: boolean) => void)(deprecated) | 输入状态变化时，触发回调。 | | onEditChange(callback: (isEditing: boolean) => void) 8+ | 输入状态变化时，触发回调。 | diff --git a/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-textpicker.md b/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-textpicker.md index feecd13e4e65edca5b624212ad9453c3a5d1c00c..6dead6a086fcc49a77fc31e5a6f7e2c8b5c6bb29 100644 --- a/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-textpicker.md +++ b/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-textpicker.md @@ -19,7 +19,7 @@ ## 接口 -TextPicker(value: {range: string[], selected?: number}) +TextPicker(options: {range: string[]|Resource, selected?: number}) 根据range指定的选择范围创建文本选择器。 @@ -27,7 +27,7 @@ TextPicker(value: {range: string[], selected?: number}) | 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 | | -------- | -------- | ---- | ----- | --------------- | -| range | string[] | 是 | - | 选择器的数据选择范围。 | +| range | string[] \| Resource | 是 | - | 选择器的数据选择范围。 | | selected | number | 否 | 第一个元素 | 选中项在数组中的index值。 | ## 属性 diff --git a/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-texttimer.md b/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-texttimer.md index 9e2faddbd24705c60ccf568719d96269f3344f05..df1a877c05ef010250e75a3f515af8a5233ccebf 100644 --- a/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-texttimer.md +++ b/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-texttimer.md @@ -27,7 +27,7 @@ TextTimer(options: { isCountDown?: boolean, count?: number, controller?: TextTim | ----------- | ---------------------------------------- | ---- | ----- | ---------------------------------------- | | isCountDown | boolean | 否 | false | 是否倒计时。 | | count | number | 否 | 60000 | 倒计时时间（isCountDown为true时生效），单位为毫秒。
- count<=0时，使用默认值为倒计时初始值。
- count>0时，count值为倒计时初始值。 | -| controller | [TextTimerController](#texttimercontroller) | 否 | null | TextTimer控制器。 | +| controller | [TextTimerController](#texttimercontroller) | 否 | - | TextTimer控制器。 | ## 属性 @@ -40,7 +40,7 @@ TextTimer(options: { isCountDown?: boolean, count?: number, controller?: TextTim | 名称 | 功能描述 | | ---------------------------------------- | ---------------------------------------- | -| onTimer(callback: (utc: number, elapsedTime: number) => void) | 时间文本发生变化时触发。
utc：当前显示的时间，单位为毫秒。
elapsedTime：计时器经过的时间，单位为毫秒。 | +| onTimer(event: (utc: number, elapsedTime: number) => void) | 时间文本发生变化时触发。
utc：当前显示的时间，单位为毫秒。
elapsedTime：计时器经过的时间，单位为毫秒。 | ## TextTimerController diff --git a/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-toggle.md b/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-toggle.md index 067af04129a0bf7595e1c398adcc6c0bcb93cac9..0fe6d8eaba0707369c7d4c1567c58cf025eaa045 100644 --- a/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-toggle.md +++ b/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-toggle.md @@ -38,8 +38,8 @@ Toggle(options: { type: ToggleType, isOn?: boolean }) | 名称 | 参数 | 默认值 | 参数描述 | | ---------------- | ----- | ---- | ---------------------------------------- | -| selectedColor | Color | - | 设置组件打开状态的背景颜色。 | -| switchPointColor | Color | - | 设置Switch类型的圆形滑块颜色。
> **说明：**
> 仅对type为ToggleType.Switch生效。 | +| selectedColor | [ResourceColor](../../ui/ts-types.md) | - | 设置组件打开状态的背景颜色。 | +| switchPointColor | [ResourceColor](../../ui/ts-types.md) | - | 设置Switch类型的圆形滑块颜色。
> **说明：**
> 仅对type为ToggleType.Switch生效。 | ## 事件 diff --git a/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-web.md b/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-web.md index f5e20aa89de9eae59df83aa64b1acac97e42eda5..41bb56df3d378795d825fc443c2c6cd3a05b30ea 100755 --- a/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-web.md +++ b/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-web.md @@ -15,13 +15,13 @@ ## 接口 -Web\(options: { src: string, controller?: WebController }\) +Web(options: { src: ResourceStr, controller: WebController }) 表1 options参数说明 | 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 | | ---------- | ------------------------------- | ---- | ---- | ------- | -| src | string | 是 | - | 网页资源地址。 | +| src | [ResourceStr](../../ui/ts-types.md) | 是 | - | 网页资源地址。 | | controller | [WebController](#webcontroller) | 否 | - | 控制器。 | > **说明：** diff --git a/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-xcomponent.md b/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-xcomponent.md index dbd5d7fc0de9e232e4b05fac3b0a80d7c9e1bf41..fd40b14efd933baddde4928caad98a2611459a6e 100644 --- a/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-xcomponent.md +++ b/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-xcomponent.md @@ -16,7 +16,7 @@ ## 接口 - XComponent\(value: {id: string, type: string, libraryname?: string, controller?: XComponentController}\) + XComponent(value: {id: string, type: string, libraryname?: string, controller?: XComponentController}) **参数：** @@ -31,8 +31,8 @@ | 名称 | 功能描述 | | -------------------------------- | ------------ | -| onLoad(context?: object) => void | 插件加载完成时回调事件。 | -| onDestroy() => void | 插件卸载完成时回调事件。 | +| onLoad(callback: (event?: object) => void) | 插件加载完成时回调事件, 返回值object即为XComponent实例对象的context。 | +| onDestroy(event: () => void) | 插件卸载完成时回调事件。 | ## XComponentController