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 8c92eb8a03de16824b0511d0c54415106396aa1c..68ebd224a1dc3347fc4c098c4139be0836e820fe 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 @@ -24,7 +24,7 @@ | 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 | | ----------- | ---------- | ---- | ------- | --------------------------------- | - | type | ButtonType | 否 | Capsule | 描述按钮风格。 | + | type | ButtonType | 否 | ButtonType.Capsule | 描述按钮风格。 | | stateEffect | boolean | 否 | true | 按钮按下时是否开启切换效果，当状态置为false时，点击效果关闭。 | @@ -44,7 +44,7 @@ | 名称 | 参数类型 | 默认值 | 描述 | | ----------- | ---------- | ------- | --------------------------------- | -| 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-checkboxgroup.md b/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-checkboxgroup.md index 1eb4e1283c1c98c888489b5dbfa1e75ae33d488d..8e74180569272bb4127286c4e789e220884b6ed4 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,7 +30,7 @@ CheckboxGroup( group?: string ) | 名称 | 参数类型 | 默认值 | 描述 | | -------- | -------- | -------- | -------- | | selectAll | boolean | false | 设置是否全选。 | -| selectedColor | Color | - | 设置被选中或部分选中状态的颜色。 | +| 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 39df8b48adac45bcacf198f247d21f439bb514a4..2d29d796f38364b61c8a601c59d4b1ec45710d6c 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 @@ -19,7 +19,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-datepicker.md b/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-datepicker.md index 1e5f07e05723b1d0edc55eae66556192744428b6..575806e26ce59996c282d474c31ac1629300a77e 100644 --- a/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-datepicker.md +++ b/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-datepicker.md @@ -19,11 +19,11 @@ ## 接口 -DatePicker(options?: DatePickerOptions) +DatePicker(options?: {start?: Date, end?: Date, selected?: Date}) 根据指定范围的Date创建可以选择日期的滑动选择器。 -- options参数 +**参数:** | 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 | | -------- | -------- | -------- | -------- | -------- | | start | Date | 否 | Date('1970-1-1') | 指定选择器的起始日期。 | 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 626695f2f459615bd6abcbe195592f0380bc780b..6cd0eebd5a0b6eb2dc0268753b90da237a334f80 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 @@ -28,8 +28,8 @@ Divider() | -------- | -------- | -------- | -------- | | vertical | boolean | false | 使用水平分割线还是垂直分割线。false：水平分割线；true：垂直分割线。 | | color | [ResourceColor](../../ui/ts-types.md) | - | 分割线颜色。 | -| strokeWidth | Length | 1 | 分割线宽度。 | -| lineCap | [LineCapStyle](ts-appendix-enums.md#linecapstyle枚举说明) | LineCapStyle.Butt | 分割线的端点样式。 | +| 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 0bd4b42bc3be71418628fff23cb4a635843b8c50..34e32fe07d08622d06df3b80f59c460cd2a0ad86 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 @@ -20,7 +20,7 @@ ## 接口 -Gauge(value:{value: number, min?: number, max?: number}) +Gauge(options:{value: number, min?: number, max?: number}) - 参数 | 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 | @@ -37,9 +37,17 @@ Gauge(value:{value: number, min?: number, max?: number}) | value | number | 0 | 设置当前数据图表的值。 | | startAngle | number | -150 | 设置起始角度位置，时钟0点为0度，顺时针方向为正角度。 | | endAngle | number | 150 | 设置终止角度位置，时钟0点为0度，顺时针方向为正角度。 | -| colors | Array<any> | - | 设置图表的颜色，支持纯色和分段渐变色设置。 | +| colors | Array<ColorStop> | - | 设置图表的颜色，支持分段颜色设置。 | | strokeWidth | Length | - | 设置环形图表的环形厚度。 | +## ColorStop + +颜色断点类型，用于描述渐进色颜色断点。 + +| 名称 | 类型定义 | 描述 | +| --------- | -------------------- | ------------------------------------------------------------ | +| ColorStop | [ResourceColor](../../ui/ts-types.md#resourcecolor8), number] | 描述渐进色颜色断点类型，第一个参数为颜色值，第二个参数为0~1之间的比例值。 | + ## 示例 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 21358428e35a161a66fdb16d6523a9c24d2972b5..cf443778aaf27cf79732cbf5d17b5fa7085e1a3c 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 @@ -50,9 +50,13 @@ Image(src: string | PixelMap | Resource) | interpolation | [ImageInterpolation](#imageinterpolation) | ImageInterpolation.None | 设置图片的插值效果，即减轻低清晰度图片在放大显示的时候出现的锯齿问题，仅针对图片放大插值。
> **说明：**
> - svg类型图源不支持该属性。
> - PixelMap资源不支持该属性。 | | renderMode | [ImageRenderMode](#imagerendermode) | ImageRenderMode.Original | 设置图片渲染的模式。
> **说明：**
> - svg类型图源不支持该属性。 | | sourceSize | {
width: number,
height: number
} | - | 设置图片裁剪尺寸，将原始图片解码成pixelMap，指定尺寸的图片，单位为px。
> **说明：**
> PixelMap资源不支持该属性。 | +| matchTextDirection | boolean | false | 设置图片是否跟随系统语言方向，在RTL语言环境下显示镜像翻转显示效果。 | +| fitOriginalSize | boolean | true | 图片组件尺寸未设置时，其显示尺寸是否跟随图源尺寸。 | +| fillColor | [ResourceColor](../../ui/ts-types.md#resourcecolor8) | - | 仅对svg图源生效，设置后会替换svg图片的fill颜色。 | +| autoResize | boolean | true | 是否需要在图片解码过程中对图源做resize操作，该操作会根据显示区域的尺寸决定用于绘制的图源尺寸，有利于减少内存占用。 | | syncLoad8+ | boolean | false | 设置是否同步加载图片，默认是异步加载。同步加载时阻塞UI线程，不会显示占位图。 | | copyOption9+ | [CopyOptions](ts-appendix-enums.md#copyoptions9) | CopyOptions.None | 设置图片是否可复制（SVG图片不支持复制）。 | -| colorFilter9+ | [ColorFilter](../../ui/ts-types.md) | - | 给图像设置颜色滤镜效果。 | +| colorFilter9+ | [ColorFilter](../../ui/ts-types.md#colorfilter9) | - | 给图像设置颜色滤镜效果。 | ### ImageInterpolation @@ -78,7 +82,7 @@ Image(src: string | PixelMap | Resource) | ---------------------------------------- | ---------------------------------------- | | onComplete(callback: (event?: { width: number, height: number, componentWidth: number,
 componentHeight: number, loadingStatus: number }) => void) | 图片成功加载时触发该回调，返回成功加载的图片尺寸。
- width：图片的宽，单位为像素。
- height：图片的高，单位为像素。
- componentWidth：组件的宽，单位为像素。
- componentHeight：组件的高，单位为像素。
- loadingStatus：图片加载成功的状态。
| | onError(callback: (event?: { componentWidth: number, componentHeight: number }) => void) | 图片加载出现异常时触发该回调。
- componentWidth：组件的宽，单位为像素。
- componentHeight：组件的高，单位为像素。
| -| 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 7455098d02ebfd42f6752b30552540a0f031f9e0..e24457c1753d5b4381941387adda9fc10f10a866 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 @@ -50,11 +50,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-marquee.md b/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-marquee.md index 26bb4d5972e32b7156f2a02b3630652e74b1ed78..914f9300b4d1600630c650dadc1af135c621c44c 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 e43d6028a406de05e4b632fa65f7932a6ef4d66b..ea8b2dee5d36c34a6390f4194c5635ba2506ad77 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 @@ -30,9 +30,9 @@ Navigation() | -------------- | ---------------------------------------- | ------------------------ | ---------------------------------------- | | title | string \| [CustomBuilder](../../ui/ts-types.md) | - | 页面标题。 | | subTitle | string | - | 页面副标题。 | -| menus | Array8+ | - | 页面右上角菜单。 | | titleMode | NavigationTitleMode | NavigationTitleMode.Free | 页面标题栏显示模式。 | -| toolBar | {
items:[
Object
] }
\| [CustomBuilder](../../ui/ts-types.md) | - | 设置工具栏内容。
items: 工具栏所有项。 | +| toolBar | {
items:Array<Object> }
\| [CustomBuilder](../../ui/ts-types.md#custombuilder8)8+ | - | 设置工具栏内容。
items: 工具栏所有项。 | | hideToolBar | boolean | false | 设置隐藏/显示工具栏：
true: 隐藏工具栏。
false: 显示工具栏。 | | hideTitleBar | boolean | false | 隐藏标题栏。 | | hideBackButton | boolean | false | 隐藏返回键。 | @@ -44,7 +44,7 @@ Navigation() | icon | string | 否 | - | 菜单栏单个选项的图标资源路径。 | | action | () => void | 否 | - | 当前选项被选中的事件回调。 | -- Object类型接口说明 +- Object类型说明 | 名称 | 类型 | 必填 | 默认值 | 描述 | | ------ | ----------------------- | ---- | ---- | --------------- | | value | string | 是 | - | 工具栏单个选项的显示文本。 | 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 ad58b4380305f683297d065507636d576bda0b04..d88b30a0810742301790fb8fec397d7dddef9792 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}) 创建进度组件，用于显示内容加载或操作处理进度。 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 00272186a92ee094528c74a948431d514db47564..50e25d07d62c1e3cd2713e5934bc9bf1b4dc65e9 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 0f6bafb6ce0a4fffc2f41e93c164e3c9d41bceeb..ae8b911928b881235999699462ad9858db8cdeea 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 @@ -15,7 +15,7 @@ ## 接口 -RichText\(content:string\) +RichText(content:string) - 参数 @@ -29,8 +29,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 7f389c6b596969ee99aa45d999e15de7d7732e17..af9d1d00d59ea0ba147cfcaabacac4cfc57642e6 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 }) - ScrollBarOptions的参数描述 | 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 | 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 b7b0543679eab4ca33d6d88e88f3ab3144f977d0..ba7a356c549286ec40a10361c27ab8557505c3d7 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 @@ -16,7 +16,7 @@ Select(options: Array\) -- SelectOption参数 +**SelectOption对象说明：** | 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 | | ----- | ----------------------------------- | ---- | ---- | ------- | @@ -42,7 +42,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 bc01e8bd1f71a5dc8c195d937e95433b2aab3fbc..28c6ba13e0f2bd0cc47958f0ed8b267cb1517f6e 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}) - 参数 | 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 | @@ -29,7 +29,7 @@ Slider(value:{value?: number, min?: number, max?: number, step?: number, style?: | max | number | 否 | 100 | 设置最大值。 | | step | number | 否 | 1 | 设置Slider滑动跳动值，当设置相应的step时，Slider为间歇滑动。 | | style | SliderStyle | 否 | SliderStyle.OutSet | 设置Slider的滑块样式。 | - | direction8+ | [Axis](ts-appendix-enums.md#axis枚举说明) | 否 | Axis.Horizontal | 设置滑动条滑动方向为水平或竖直方向。 | + | direction8+ | [Axis](ts-appendix-enums.md#axis) | 否 | Axis.Horizontal | 设置滑动条滑动方向为水平或竖直方向。 | | reverse8+ | boolean | 否 | false | 设置滑动条取值范围是否反向。 | - SliderStyle枚举说明 @@ -45,11 +45,12 @@ Slider(value:{value?: number, min?: number, max?: number, step?: number, style?: | 名称 | 参数类型 | 默认值 | 描述 | | -------- | -------- | -------- | -------- | -| blockColor | Color | - | 设置滑块的颜色。 | -| trackColor | Color | - | 设置滑轨的背景颜色。 | -| selectedColor | Color | - | 设置滑轨的已滑动颜色。 | +| blockColor | [ResourceColor](../../ui/ts-types.md#resourcecolor8) | - | 设置滑块的颜色。 | +| trackColor | [ResourceColor](../../ui/ts-types.md#resourcecolor8) | - | 设置滑轨的背景颜色。 | +| selectedColor | [ResourceColor](../../ui/ts-types.md#resourcecolor8) | - | 设置滑轨的已滑动颜色。 | | showSteps | boolean | false | 设置当前是否显示步长刻度值。 | | showTips | boolean | false | 设置滑动时是否显示气泡提示百分比。 | +| trackThickness | [Length](../../ui/ts-types.md#length) | - | 设置滑轨的粗细。 | ## 事件 @@ -58,7 +59,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枚举说明 | 名称 | 值 | 描述 | @@ -66,6 +67,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 59fdeceedc35e0c5b27f74dfb903805339821bc9..f6b8955b87082aed538d55693c2a9c97f4f197c6 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 @@ -18,12 +18,12 @@ ## 接口 -Span(content: string) +Span(content: ResourceStr) - 参数 | 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 | | -------- | -------- | -------- | -------- | -------- | - | content | string | 是 | - | 文本内容。 | + | content | [ResourceStr](../../ui/ts-types.md#resourcestr8) | 是 | - | 文本内容。 | ## 属性 @@ -32,8 +32,9 @@ Span(content: string) | 名称 | 参数类型 | 默认值 | 描述 | | -------- | -------- | -------- | -------- | -| decoration | {
type: [TextDecorationType](ts-appendix-enums.md#textdecorationtype枚举说明),
color?: Color
} | {
type: TextDecorationType.None
color：Color.Black
} | 设置文本装饰线样式及其颜色。 | -| textCase | [TextCase](ts-appendix-enums.md#textcase枚举说明) | Normal | 设置文本大小写。 | +| decoration | {
type: [TextDecorationType](ts-appendix-enums.md#textdecorationtype),
color?: [ResourceColor](../../ui/ts-types.md#resourcecolor8)
} | {
type: TextDecorationType.None
color：Color.Black
} | 设置文本装饰线样式及其颜色。 | +| letterSpacing | [Length](../../ui/ts-types.md#length) | - | 设置文本字符间距。 | +| 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 d8cb0bb3008facedca47015abeb1270802e1f9a9..96049969c5a438476325ab009204e139af74c764 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 d16a8db00031db071f89da3223ea6cb757db0277..81d825798cff133111564a798f08794313da83ba 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 @@ -18,12 +18,12 @@ ## 接口 -Text(content?: string) +Text(content?: ResourceStr) - 参数 | 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 | | -------- | -------- | -------- | -------- | -------- | - | content | string | 否 | '' | 文本内容。包含子组件Span时不生效，显示Span内容，并且此时text组件的样式不生效。 | + | content | [ResourceStr](../../ui/ts-types.md#resourcestr8) | 否 | '' | 文本内容。包含子组件Span时不生效，显示Span内容，并且此时text组件的样式不生效。 | ## 属性 @@ -33,9 +33,12 @@ Text(content?: string) | textAlign | [TextAlign](ts-appendix-enums.md#textalign) | TextAlign.Start | 设置多行文本的文本对齐方式。 | | textOverflow | {overflow: [TextOverflow](ts-appendix-enums.md#textoverflow)} | {overflow: TextOverflow.Clip} | 设置文本超长时的显示方式。
**说明：**
文本截断是按字截断。例如，英文以单词为最小单位进行截断，若需要以字母为单位进行截断，可在字母间添加零宽空格：\u200B。
需配合`maxLines`使用，单独设置不生效。 | | maxLines | number | Infinity | 设置文本的最大行数。
**说明：**
默认情况下，文本是自动折行的，如果指定此参数，则文本最多不会超过指定的行。如果有多余的文本，可以通过 `textOverflow`来指定截断方式。 | -| lineHeight | Length | - | 设置文本的文本行高，设置值不大于0时，不限制文本行高，自适应字体大小，Length为number类型时单位为fp。 | -| decoration | {
type: [TextDecorationType](ts-appendix-enums.md#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) | - | 设置文本基线的偏移量。 | +| letterSpacing | [Length](../../ui/ts-types.md) | - | 设置文本字符间距。 | +| minFontSize | number \| string \| [Resource](../../ui/ts-types.md) | - | 设置文本最小显示字号。 | +| maxFontSize | number \| string \| [Resource](../../ui/ts-types.md) | - | 设置文本最大显示字号。 | | textCase | [TextCase](ts-appendix-enums.md#textcase) | TextCase.Normal | 设置文本大小写。 | | copyOption9+ | [CopyOptions](ts-appendix-enums.md#copyoptions9) | CopyOptions.None | 组件支持设置文本是否可复制粘贴。 | 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 31b4d591397ecdb675ed1b4773e7a4afe7b81a10..d2b8e2ee6858ad78ed06ad31fabc2f175f63499f 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 @@ -18,13 +18,13 @@ ## 接口 -TextArea(value?:{placeholder?: string| Resource, text?: string| Resource, controller?: TextAreaController}) +TextArea(value?:{placeholder?: ResourceStr, text?: ResourceStr, controller?: TextAreaController}) - 参数 | 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 | | ----------------------- | ---------------------------------------- | ---- | ---- | -------------- | - | placeholder | string \| [Resource](../../ui/ts-types.md#resource类型) | 否 | - | 无输入时的提示文本。 | - | text | string \| [Resource](../../ui/ts-types.md#resource类型) | 否 | - | 设置提示文本的当前值。 | + | placeholder | [ResourceStr](../../ui/ts-types.md) | 否 | - | 无输入时的提示文本。 | + | text | [ResourceStr](../../ui/ts-types.md) | 否 | - | 设置输入框当前的文本内容。 | | controller8+ | [TextAreaController](#textareacontroller8) | 否 | - | 设置TextArea控制器。 | 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 9c36c5f32c78b870089b7c97de46611da195d046..5d14a6be16867f484cad76501346a357eadb51d8 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 @@ -22,7 +22,7 @@ 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 d2c801dcebb80bf0c78b9031755b21733222c4a8..09d867d0b3825905de493f91e47661ecaf5027b5 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 @@ -18,13 +18,13 @@ ## 接口 -TextInput(value?:{placeholder?: string | Resource, text?: string | Resource, controller?: TextInputController}) +TextInput(value?:{placeholder?: ResourceStr, text?: ResourceStr, controller?: TextInputController}) - 参数 | 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 | | ----------------------- | ---------------------------------------- | ---- | ---- | --------------- | - | placeholder | string \| [Resource](../../ui/ts-types.md#resource类型) | 否 | - | 无输入时的提示文本。 | - | text | string \| [Resource](../../ui/ts-types.md#resource类型) | 否 | - | 设置提示文本的当前值。 | + | placeholder | [ResourceStr](../../ui/ts-types.md) | 否 | - | 无输入时的提示文本。 | + | text | [ResourceStr](../../ui/ts-types.md) | 否 | - | 设置输入框当前的文本内容。 | | controller8+ | [TextInputController](#textinputcontroller8) | 否 | - | 设置TextInput控制器。 | @@ -35,12 +35,12 @@ TextInput(value?:{placeholder?: string | Resource, text?: string | Resource, con | 名称 | 参数类型 | 默认值 | 描述 | | ------------------------ | ---------------------------------------- | ----------------- | ---------------------------------------- | | 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：正则匹配失败时，返回被忽略的内容。 | | copyOption9+ | [CopyOptions](ts-basic-components-text.md) | CopyOptions.CrossDevice | 设置文本是否可复制。 | | showPasswordIcon9+ | boolean | true | 密码输入模式时，密码框末尾的图标是否显示。 | | style9+ | TextInputStyle | Default | TextInput风格。 | @@ -48,19 +48,19 @@ TextInput(value?:{placeholder?: string | Resource, text?: string | Resource, con - 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 | 纯数字输入模式。 | - TextInputStyle枚举说明 | 名称 | 描述 | @@ -72,7 +72,7 @@ TextInput(value?:{placeholder?: string | Resource, text?: string | Resource, con | 名称 | 功能描述 | | ---------------------------------------- | ---------------------------------------- | -| 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 25a79d79177a39e0b0ea91eeac001ca659783a7a..0b1e6ead8cb0d9f73e389fb7e4f267eb982a4b30 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 @@ -18,7 +18,7 @@ ## 接口 -TextPicker(value: {range: string[] | Resource, value?: string, selected?: number}) +TextPicker(options: {range: string[]|Resource, selected?: number, value?: string}) 根据range指定的选择范围创建文本选择器。 @@ -26,8 +26,8 @@ TextPicker(value: {range: string[] | Resource, value?: string, selected?: number | 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 | | -------- | -------- | -------- | -------- | -------- | | range | string[] \| [Resource](../../ui/ts-types.md#resource类型) | 是 | - | 选择器的数据选择范围。 | - | value | string | 否 | - | 选中项文本值。当设置了selected参数时，该值不生效。如果该值不在range范围内，则默认取range第一个元素。| - | selected | number | 否 | 第一个元素 | 选中项在数组中的index值。 | + | selected | number | 否 | 0 | 选中项在数组中的index值。 | + | value | string | 否 | 第一个元素值 | 选中项的值，优先级低于selected。 | ## 属性 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 024b03570c8acf59f12f1839bbe1c8d6bd6f8419..aa0e3b67c193e262606c133e2e76c697605be3cc 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 @@ -25,7 +25,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控制器。 | ## 属性 @@ -38,7 +38,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 d410e2a0aec9d0f2507e5661f40a2d63c49645a0..8bca323f30a2569a7a781b462191cc17666d36cf 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 @@ -13,7 +13,7 @@ ## 子组件 -无 +仅当ToggleType为Button时可包含子组件。 ## 接口 @@ -30,17 +30,17 @@ Toggle(options: { type: ToggleType, isOn?: boolean }) - ToggleType枚举说明 | 名称 | 描述 | | -------- | -------- | - | Checkbox | 提供勾选框样式，子组件设置文本不生效，如需文本设置，可将Text和当前组件放入布局组件中。
> **说明：**
> [通用属性padding](ts-universal-attributes-size.md)的默认值为：
{
 top: 14 vp,
 right: 6 vp,
 bottom: 14 vp,
 left: 6 vp
} | - | Button | 提供状态按钮样式，如果有文本设置，则相应的文本内容会显示在按钮内部。 | - | Switch | 提供开关样式，子组件设置文本不生效，如需文本设置，可将Text和当前组件放入布局组件中。
> **说明：**
> [通用属性padding](ts-universal-attributes-size.md)默认值为：
{
 top: 12 vp,
 right: 12 vp,
 bottom: 12 vp,
 left: 12 vp
} | + | Checkbox | 提供单选框样式。
> **说明：**
> [通用属性padding](ts-universal-attributes-size.md)的默认值为：
{
 top: 14 vp,
 right: 6 vp,
 bottom: 14 vp,
 left: 6 vp
} | + | Button | 提供状态按钮样式，如果子组件有文本设置，则相应的文本内容会显示在按钮内部。 | + | Switch | 提供开关样式。
> **说明：**
> [通用属性padding](ts-universal-attributes-size.md)默认值为：
{
 top: 12 vp,
 right: 12 vp,
 bottom: 12 vp,
 left: 12 vp
} | ## 属性 | 名称 | 参数 | 默认值 | 参数描述 | | -------- | -------- | -------- | -------- | -| 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 ee5541a5d861c5771b14313572d847ece1a720d3..7b4760eab40a1aeb49986a9d5a42c96b6829e7f1 100644 --- 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 @@ -16,12 +16,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 7ec01cd1c95acabd638e8f78acef211df9a65aee..de7f7e9a839bb2bba9d6dc7484829ef707b1133b 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}) **参数:** diff --git a/zh-cn/application-dev/reference/arkui-ts/ts-container-alphabet-indexer.md b/zh-cn/application-dev/reference/arkui-ts/ts-container-alphabet-indexer.md index e671bf7ad635b3ce3cf4698f68b1a5e6f5beeef7..a28d583595b5ad8f280ecf7f9d9a459cc1664030 100644 --- a/zh-cn/application-dev/reference/arkui-ts/ts-container-alphabet-indexer.md +++ b/zh-cn/application-dev/reference/arkui-ts/ts-container-alphabet-indexer.md @@ -17,29 +17,30 @@ ## 接口 -AlphabetIndexer(value: {arrayValue : Array<string>, selected : number}) +AlphabetIndexer(value: {arrayValue: Array<string>, selected: number}) - 参数 | 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 | | -------- | -------- | -------- | -------- | -------- | | arrayValue | Array<string> | 是 | - | 字母索引字符串数组。 | - | selected | number | 是 | - | 选中项编号。 | + | selected | number | 是 | - | 初始选中项索引值。 | ## 属性 -| 名称 | 参数类型 | 描述 | -| -------- | -------- | -------- | -| selectedColor | [ResourceColor](../../ui/ts-types.md) | 选中文本文字颜色。 | -| popupColor | [ResourceColor](../../ui/ts-types.md) | 弹出提示文本字体颜色。 | -| selectedBackgroundColor | [ResourceColor](../../ui/ts-types.md) | 选中文本背景颜色。 | -| popupBackground | [ResourceColor](../../ui/ts-types.md) | 弹窗索引背景色。 | -| usingPopup | boolean | 是否使用弹出索引提示。 | -| selectedFont | {
size?: number,
weight?: FontWeight,
family?: string,
style?: FontStyle
} | 选中文本文字样式。 | -| popupFont | {
size?: number,
weight?: FontWeight,
family?: string,
style?: FontStyle
} | 弹出提示文本字体样式。 | -| font | {
size?: number,
weight?: FontWeight,
family?: string,
style?: FontStyle
} | 字母索引条默认文本字体样式。 | -| itemSize | Length | 字母索引条字母区域大小，字母区域为正方形，设置正方形边长。 | -| alignStyle | IndexerAlign | 字母索引条对齐样式，支持左侧对齐样式与右侧对齐样式，影响弹窗弹出位置。 | +| 名称 | 参数类型 | 描述 | +| ----------------------- | --------------- | ----------------------------------------------------------- | +| color | [ResourceColor](../../ui/ts-types.md) | 设置文字颜色。 | +| selectedColor | [ResourceColor](../../ui/ts-types.md) | 设置选中项文字颜色。 | +| popupColor | [ResourceColor](../../ui/ts-types.md) | 设置提示弹窗文字颜色。 | +| selectedBackgroundColor | [ResourceColor](../../ui/ts-types.md) | 设置选中项背景颜色。 | +| popupBackground | [ResourceColor](../../ui/ts-types.md) | 设置提示弹窗背景色。 | +| usingPopup | boolean | 设置是否使用提示弹窗。 | +| selectedFont | [Font](../../ui/ts-types.md) | 设置选中项文字样式。 | +| popupFont | [Font](../../ui/ts-types.md) | 设置提示弹窗字体样式。 | +| font | [Font](../../ui/ts-types.md) | 设置字母索引条默认字体样式。 | +| itemSize | Length | 设置字母索引条字母区域大小，字母区域为正方形，即正方形边长。 | +| alignStyle | IndexerAlign | 设置提示弹窗的弹出位置。 | - IndexerAlign枚举说明 | 名称 | 描述 | @@ -52,10 +53,10 @@ AlphabetIndexer(value: {arrayValue : Array<string>, selected : number}) | 名称 | 功能描述 | | -------- | -------- | -| onSelected(index: number) => void(deprecated) | 索引条选中回调。 | -| onSelect(index: number) => void8+ | 索引条选中回调。 | -| onRequestPopupData(callback: (index: number) => Array<string>)8+ | 选中字母索引后，请求索引提示窗口显示内容回调。
返回值：索引对应的字符串数组，此字符串数组在弹出窗口中竖排显示，字符串列表最多显示5个，超出部分可以滑动显示。 | -| onPopupSelect(callback: (index: number) => void)8+ | 字母索引提示窗口选中回调。 | +| onSelected(callback: (index: number) => void)(deprecated) | 索引条选中回调,返回值为当前选中索引。 | +| onSelect(callback: (index: number) => void)8+ | 索引条选中回调,返回值为当前选中索引。 | +| onRequestPopupData(callback: (index: number) => Array<string>)8+ | 选中字母索引后，请求索引提示弹窗显示内容回调。
返回值：索引对应的字符串数组，此字符串数组在弹窗中竖排显示，字符串列表最多显示5个，超出部分可以滑动显示。 | +| onPopupSelect(callback: (index: number) => void)8+ | 字母索引提示弹窗字符串列表选中回调。 | ## 示例 diff --git a/zh-cn/application-dev/reference/arkui-ts/ts-container-badge.md b/zh-cn/application-dev/reference/arkui-ts/ts-container-badge.md index fae42d19c1f934a58a80e670033bc60d5bc52a98..6990d3d93cd24b5db073a41604b31943ad14fd9e 100644 --- a/zh-cn/application-dev/reference/arkui-ts/ts-container-badge.md +++ b/zh-cn/application-dev/reference/arkui-ts/ts-container-badge.md @@ -18,26 +18,28 @@ ## 接口 -Badge(value: {count: number, position?: BadgePosition, maxCount?: number, style?: BadgeStyle}) +方法1：Badge(value: {count: number, position?: BadgePosition, maxCount?: number, style: BadgeStyle}) -- 参数 +创建数字标记组件。 + +**参数：** | 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 | | -------- | -------- | -------- | -------- | -------- | | count | number | 是 | - | 设置提醒消息数。 | | position | BadgePosition | 否 | BadgePosition.RightTop | 设置提示点显示位置。 | | maxCount | number | 否 | 99 | 最大消息数，超过最大消息时仅显示maxCount+。 | - | style | BadgeStyle | 否 | - | Badge组件可设置样式，支持设置文本颜色、尺寸、圆点颜色和尺寸。 | + | style | BadgeStyle | 是 | - | Badge组件可设置样式，支持设置文本颜色、尺寸、圆点颜色和尺寸。 | -Badge(value: {value: string, position?: BadgePosition, style?: BadgeStyle}) +方法2： Badge(value: {value: string, position?: BadgePosition, style: BadgeStyle}) -根据字符串创建提醒组件。 +根据字符串创建标记组件。 - 参数 | 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 | | -------- | -------- | -------- | -------- | -------- | | value | string | 是 | - | 提示内容的文本字符串。 | | position | BadgePosition | 否 | BadgePosition.RightTop | 设置提示点显示位置。 | - | style | BadgeStyle | 否 | - | Badge组件可设置样式，支持设置文本颜色、尺寸、圆点颜色和尺寸。 | + | style | BadgeStyle | 是 | - | Badge组件可设置样式，支持设置文本颜色、尺寸、圆点颜色和尺寸。 | - BadgeStyle对象说明 | 名称 | 类型 | 必填 | 默认值 | 描述 | @@ -50,8 +52,8 @@ Badge(value: {value: string, position?: BadgePosition, style?: BadgeStyle}) - BadgePosition枚举说明 | 名称 | 描述 | | -------- | -------- | - | Right | 圆点显示在右侧纵向居中。 | | RightTop | 圆点显示在右上角。 | + | Right | 圆点显示在右侧纵向居中。 | | Left | 圆点显示在左侧纵向居中。 | diff --git a/zh-cn/application-dev/reference/arkui-ts/ts-container-column.md b/zh-cn/application-dev/reference/arkui-ts/ts-container-column.md index 73899d2a5952044b515c76642749e3b37c0862cb..7a8d588ffe3b33d02b8b6a35d3b352148ce9664a 100644 --- a/zh-cn/application-dev/reference/arkui-ts/ts-container-column.md +++ b/zh-cn/application-dev/reference/arkui-ts/ts-container-column.md @@ -19,7 +19,7 @@ ## 接口 -Column(value:{space?: Length}) +Column(value?:{space?: Length}) - 参数 diff --git a/zh-cn/application-dev/reference/arkui-ts/ts-container-flex.md b/zh-cn/application-dev/reference/arkui-ts/ts-container-flex.md index d9379dc6f1b6b0fa4693f374bedce67f36643d1d..0866c340ab550bd65cb246fb28f77acaa2dfe4ea 100644 --- a/zh-cn/application-dev/reference/arkui-ts/ts-container-flex.md +++ b/zh-cn/application-dev/reference/arkui-ts/ts-container-flex.md @@ -19,7 +19,7 @@ ## 接口 -Flex(options?: { direction?: FlexDirection, wrap?: FlexWrap, justifyContent?: FlexAlign, alignItems?: ItemAlign, alignContent?: FlexAlign }) +Flex(value?: { direction?: FlexDirection, wrap?: FlexWrap, justifyContent?: FlexAlign, alignItems?: ItemAlign, alignContent?: FlexAlign }) 标准Flex布局容器。 diff --git a/zh-cn/application-dev/reference/arkui-ts/ts-container-grid.md b/zh-cn/application-dev/reference/arkui-ts/ts-container-grid.md index 0401d38367b3c09f8174606908984252e272e7bd..be3ec23faf597ba91313e14070b3e97929b905cf 100644 --- a/zh-cn/application-dev/reference/arkui-ts/ts-container-grid.md +++ b/zh-cn/application-dev/reference/arkui-ts/ts-container-grid.md @@ -22,10 +22,10 @@ Grid(scroller?: Scroller) -- 参数 - | 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 | - | -------- | -------- | -------- | -------- | -------- | - | scroller | [Scroller](ts-container-scroll.md#scroller) | 是 | - | 可滚动组件的控制器。用于与可滚动组件进行绑定。 | +**参数：** +| 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 | +| --------- | ---------------------------------------- | ---- | --------------------------- | ----------------------- | +| scroller | [Scroller](ts-container-scroll.md#scroller) | 否 | - | 可滚动组件的控制器。用于与可滚动组件进行绑定。 | ## 属性 @@ -36,19 +36,35 @@ Grid(scroller?: Scroller) | rowsTemplate | string | '1fr' | 用于设置当前网格布局行的数量，不设置时默认1行 示例, '1fr 1fr 2fr'分三行，将父组件允许的高分为4等份，第一行占1份，第二行占一份，第三行占2份。 | | columnsGap | Length | 0 | 用于设置列与列的间距。 | | rowsGap | Length | 0 | 用于设置行与行的间距。 | -| editMode8+ | boolean | flase | 是否进入编辑模式，进入编辑模式可以拖拽Gird组件内部[GridItem](ts-container-griditem.md)。 | -| layoutDirection8+ | number | 0 |设置布局的主轴方向，目前支持的主轴布局方向如下：
- 0：主轴布局方向沿水平方向布局，即先填满一列，再去填下一列。
- 1：主轴布局方向沿垂直方向布局，即先填满一行，再去填下一行。| -| maxCount8+ | number | 1 | 当layoutDirection是Row时，表示可显示的最大行数
当layoutDirection是Column时，表示可显示的最大列数。 | -| minCount8+ | number | 1 | 当layoutDirection是Row时，表示可显示的最小行数
当layoutDirection是Column时，表示可显示的最小列数。 | -| cellLength8+ | number | 0 | 当layoutDirection是Row时，表示一行的高度
当layoutDirection是Column时，表示一列的宽度。 | -| multiSelectable8+ | boolean | false | 是否开启鼠标框选。
- false：关闭框选。
- true：开启框选。 | -| supportAnimation8+ | boolean | false | 控制Grid是否支持动画。 | +| scrollBar | [BarState](ts-appendix-enums.md#barstate) | BarState.Off | 设置滚动条状态。 | +| scrollBarColor | string \| number \| Color | - | 设置滚动条的颜色。 | +| scrollBarWidth | Length | - | 设置滚动条的宽度。 | +| cachedCount | number | 1 | 设置预加载的GridItem的数量。 | +| editMode 8+ | boolean | flase | 是否进入编辑模式，进入编辑模式可以拖拽Grid组件内部[GridItem](ts-container-griditem.md)。 | +| layoutDirection8+ | GridDirection | GridDirection.Row | 设置布局的主轴方向。 | +| maxCount8+ | number | 1 | 当layoutDirection是Row/RowReverse时，表示可显示的最大行数
当layoutDirection是Column/ColumnReverse时，表示可显示的最大列数。 | +| minCount8+ | number | 1 | 当layoutDirection是Row/RowReverse时，表示可显示的最小行数。
当layoutDirection是Column/ColumnReverse时，表示可显示的最小列数。 | +| cellLength8+ | number | 0 | 当layoutDirection是Row/RowReverse时，表示一行的高度。
当layoutDirection是Column/ColumnReverse时，表示一列的宽度。 | +| multiSelectable8+ | boolean | false | 是否开启鼠标框选。
- false：关闭框选。
- true：开启框选。 | +| supportAnimation8+ | boolean | false | 是否支持动画。 | ## 事件 | 名称 | 功能描述 | | -------- | -------- | -| onScrollIndex(first: number) => void | 当前列表显示的起始位置item发生变化时触发。 | +| onScrollIndex(event: (first: number) => void) | 当前网格显示的起始位置item发生变化时触发，返回值为当前显示的网格起始位置的索引值。 | +| onItemDragStart(event: (event: ItemDragInfo, itemIndex: number) => (() => any) \| void) | 开始拖拽网格元素时触发，返回值event见ItemDragInfo对象说明，itemIndex为被拖拽网格元素索引值。 | +| onItemDragEnter(event: (event: ItemDragInfo) => void) | 拖拽进入网格元素范围内时触发，返回值event见ItemDragInfo对象说明。 | +| onItemDragMove(event: (event: ItemDragInfo, itemIndex: number, insertIndex: number) => void) | 拖拽在网格元素范围内移动时触发，返回值event见ItemDragInfo对象说明，itemIndex为拖拽起始位置，insertIndex为拖拽插入位置。 | +| onItemDragLeave(event: (event: ItemDragInfo, itemIndex: number) => void) | 拖拽离开网格元素时触发，返回值event见ItemDragInfo对象说明，itemIndex为拖拽离开的网格元素索引值。 | +| onItemDrop(event: (event: ItemDragInfo, itemIndex: number, insertIndex: number, isSuccess: boolean) => void) | 绑定该事件的网格元素可作为拖拽释放目标，当在网格元素内停止拖拽时触发，返回值event见ItemDragInfo对象说明，itemIndex为拖拽起始位置，insertIndex为拖拽插入位置，isSuccess为是否成功释放。 | + +## ItemDragInfo对象说明 + +| 名称 | 类型 | 描述 | +| ---------- | ---------- | ---------- | +| x | number | 当前拖拽点的x坐标。 | +| y | number | 当前拖拽点的y坐标。 | ## 示例 diff --git a/zh-cn/application-dev/reference/arkui-ts/ts-container-griditem.md b/zh-cn/application-dev/reference/arkui-ts/ts-container-griditem.md index ebc1a958206f2a3201616dbc510bb7b171ea1c57..8377d8dccf74ba49bd94c9dba68f5bd4ad0bb2cf 100644 --- a/zh-cn/application-dev/reference/arkui-ts/ts-container-griditem.md +++ b/zh-cn/application-dev/reference/arkui-ts/ts-container-griditem.md @@ -38,7 +38,7 @@ GridItem() | 名称 | 功能描述 | | -------- | -------- | -| onSelect(callback: (isSelected: boolean) => any)8+ | GridItem元素被鼠标框选的状态改变时触发回调。
isSelected：进入鼠标框选范围即被选中返回true， 移出鼠标框选范围即未被选中返回false。 | +| onSelect(callback: (isSelected: boolean) => void)8+ | GridItem元素被鼠标框选的状态改变时触发回调。
isSelected：进入鼠标框选范围即被选中返回true， 移出鼠标框选范围即未被选中返回false。 | ## 示例 diff --git a/zh-cn/application-dev/reference/arkui-ts/ts-container-list.md b/zh-cn/application-dev/reference/arkui-ts/ts-container-list.md index 8e56157a7504fe5f600fcaa049e0b0685e42c44b..f93e9e33c8e2f53dfc0d70e3e4cb2a808f347596 100644 --- a/zh-cn/application-dev/reference/arkui-ts/ts-container-list.md +++ b/zh-cn/application-dev/reference/arkui-ts/ts-container-list.md @@ -26,7 +26,7 @@ List(value:{space?: number | string, initialIndex?: number, scroller?: Scroller} - 参数 | 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 | | -------- | -------- | -------- | -------- | -------- | - | space | number \| string | 否 | 0 | 列表项间距。 | + | space | [Length](../../ui/ts-types.md#length) | 否 | 0 | 列表项间距。 | | initialIndex | number | 否 | 0 | 设置当前List初次加载时视口起始位置显示的item，即显示第一个item，如设置的序号超过了最后一个item的序号，则设置不生效。 | | scroller | [Scroller](ts-container-scroll.md#scroller) | 否 | - | 可滚动组件的控制器。用于与可滚动组件进行绑定。 | @@ -36,7 +36,9 @@ List(value:{space?: number | string, initialIndex?: number, scroller?: Scroller} | 名称 | 参数类型 | 默认值 | 描述 | | -------- | -------- | -------- | -------- | | listDirection | [Axis](ts-appendix-enums.md#axis) | Vertical | 设置List组件排列方向参照Axis枚举说明。 | -| divider | {
strokeWidth: Length,
color?:Color,
startMargin?: Length,
endMargin?: Length
} | - | 用于设置ListItem分割线样式，默认无分割线。
strokeWidth: 分割线的线宽。
color: 分割线的颜色。
startMargin： 分割线距离列表侧边起始端的距离。
endMargin: 分割线距离列表侧边结束端的距离。 | +| divider | {
strokeWidth: Length,
color?:[ResourceColor](../../ui/ts-types.md),
startMargin?: Length,
endMargin?: Length
} | - | 用于设置ListItem分割线样式，默认无分割线。
strokeWidth: 分割线的线宽。
color: 分割线的颜色。
startMargin： 分割线距离列表侧边起始端的距离。
endMargin: 分割线距离列表侧边结束端的距离。 | +| scrollBar | [BarState](ts-appendix-enums.md#barstate) | BarState.Off | 设置滚动条状态。 | +| cachedCount | number | 1 | 设置预加载的ListItem的数量。 | | editMode | boolean | false | 声明当前List组件是否处于可编辑模式。 | | edgeEffect | [EdgeEffect](ts-appendix-enums.md#edgeeffect) | EdgeEffect.Spring | 滑动效果，目前支持的滑动效果参见EdgeEffect的枚举说明。 | | chainAnimation | boolean | false | 用于设置当前list是否启用链式联动动效，开启后列表滑动以及顶部和底部拖拽时会有链式联动的效果。链式联动效果：list内的list-item间隔一定距离，在基本的滑动交互行为下，主动对象驱动从动对象进行联动，驱动效果遵循弹簧物理动效。
- false：不启用链式联动。
- true：启用链式联动。 | @@ -58,9 +60,26 @@ List(value:{space?: number | string, initialIndex?: number, scroller?: Scroller} | 名称 | 功能描述 | | -------- | -------- | -| onItemDelete(index: number) => boolean | 列表项删除时触发。 | -| onScrollBegin9+(dx: number, dy: number) => { dxRemain: number, dyRemain: number } | 滚动开始事件回调。
参数：
- dx：即将发生的水平方向滚动量。
- dy：即将发生的竖向方向滚动量。
返回值：
- dxRemain：水平方向滚动剩余量。
- dyRemain：竖直方向滚动剩余量。 | -| onScrollIndex(firstIndex: number, lastIndex: number) => void | 当前列表显示的起始位置和终止位置发生变化时触发。 | +| onItemDelete(event: (index: number) => boolean) | 列表项删除时触发。 | +| onScroll(event: (scrollOffset: number, scrollState: ScrollState) => void) | 列表滑动时触发，返回值scrollOffset为滑动偏移量，scrollState为当前滑动状态。 | +| onScrollIndex(event: (start: number, end: number) => void) | 列表滑动时触发，返回值分别为滑动起始位置索引值与滑动结束位置索引值。 | +| onReachStart(event: () => void) | 列表到达起始位置时触发。 | +| onReachEnd(event: () => void) | 列表到底末尾位置时触发。 | +| onScrollStop(event: () => void) | 列表滑动停止时触发。 | +| onItemMove(event: (from: number, to: number) => boolean) | 列表元素发生移动时触发，返回值from、to分别为移动前索引值与移动后索引值。 | +| onItemDragStart(event: (event: ItemDragInfo, itemIndex: number) => (() => any) \| void) | 开始拖拽列表元素时触发，返回值event见ItemDragInfo对象说明，itemIndex为被拖拽列表元素索引值。 | +| onItemDragEnter(event: (event: ItemDragInfo) => void) | 拖拽进入列表元素范围内时触发，返回值event见ItemDragInfo对象说明。 | +| onItemDragMove(event: (event: ItemDragInfo, itemIndex: number, insertIndex: number) => void) | 拖拽在列表元素范围内移动时触发，返回值event见ItemDragInfo对象说明，itemIndex为拖拽起始位置，insertIndex为拖拽插入位置。 | +| onItemDragLeave(event: (event: ItemDragInfo, itemIndex: number) => void) | 拖拽离开列表元素时触发，返回值event见ItemDragInfo对象说明，itemIndex为拖拽离开的列表元素索引值。 | +| onItemDrop(event: (event: ItemDragInfo, itemIndex: number, insertIndex: number, isSuccess: boolean) => void) | 绑定该事件的列表元素可作为拖拽释放目标，当在列表元素内停止拖拽时触发，返回值event见ItemDragInfo对象说明，itemIndex为拖拽起始位置，insertIndex为拖拽插入位置，isSuccess为是否成功释放。 | + +## ScrollState枚举说明 + +| 名称 | 描述 | +| ------ | ------------------------- | +| Idle | 未滑动状态。 | +| Scroll | 惯性滑动状态。 | +| Fling | 手指拖动状态。 | > **说明：** > List使能可编辑模式需配合onItemDelete事件和ListItem的editable属性，即可编辑模式实现删除列表项功能，需满足以下条件： diff --git a/zh-cn/application-dev/reference/arkui-ts/ts-container-listitem.md b/zh-cn/application-dev/reference/arkui-ts/ts-container-listitem.md index 749bd049d31e648e2680b3c5a9b1a99b1e9c151a..51b4f079c1a64dca5d2cb18a678611d760178965 100644 --- a/zh-cn/application-dev/reference/arkui-ts/ts-container-listitem.md +++ b/zh-cn/application-dev/reference/arkui-ts/ts-container-listitem.md @@ -27,17 +27,26 @@ ListItem() | 名称 | 参数类型 | 默认值 | 描述 | | -------- | -------- | -------- | -------- | | sticky | Sticky | Sticky.None | 设置ListItem吸顶效果，参见Sticky枚举描述。 | -| editable | boolean | false | 当前ListItem元素是否可编辑，进入编辑模式后可删除。 | +| editable | boolean \| EditMode | false | 当前ListItem元素是否可编辑，进入编辑模式后可删除或移动。 | | selectable8+ | boolean | true | 当前ListItem元素是否可以被鼠标框选。
>  **说明：**
> 外层List容器的鼠标框选开启时，ListItem的框选才生效。 | | swipeAction9+ | {
start?: CustomBuilder,
end?:CustomBuilder,
edgeEffect?: SwipeEdgeEffect,
} | - | 用于设置ListItem的划出组件。
start: ListItem向右划动时item左边的组件（List垂直布局时）或ListItem向下划动时item上方的组件（List水平布局时）。
end: ListItem向左划动时item右边的组件（List垂直布局时）或ListItem向上划动时item下方的组件（List水平布局时）。
edgeEffect: 滑动效果，参见SwipeEdgeEffect的枚举说明。
| -- Sticky枚举说明 +## Sticky枚举说明 | 名称 | 描述 | | -------- | -------- | | None | 无吸顶效果。 | | Normal | 当前item吸顶。 | + | Opacity | 当前item吸顶显示透明度变化效果。 | -- SwipeEdgeEffect9+枚举说明 +## EditMode枚举说明 + +| 名称 | 描述 | +| ------ | --------- | +| None | 编辑操作不限制。 | +| Deletable | 可删除。 | +| Movable | 可移动。 | + +## SwipeEdgeEffect9+枚举说明 | 名称 | 描述 | | -------- | -------- | | Spring | ListItem划动距离超过划出组件大小后可以继续划动，松手后按照弹簧阻尼曲线回弹。 | @@ -47,7 +56,7 @@ ListItem() | 名称 | 功能描述 | | -------- | -------- | -| onSelect(callback: (isSelected: boolean) => any)8+ | ListItem元素被鼠标框选的状态改变时触发回调。
isSelected：进入鼠标框选范围即被选中返回true， 移出鼠标框选范围即未被选中返回false。 | +| onSelect(event: (isSelected: boolean) => void)8+ | ListItem元素被鼠标框选的状态改变时触发回调。
isSelected：进入鼠标框选范围即被选中返回true， 移出鼠标框选范围即未被选中返回false。 | ## 示例 diff --git a/zh-cn/application-dev/reference/arkui-ts/ts-container-row.md b/zh-cn/application-dev/reference/arkui-ts/ts-container-row.md index a28a7e0277fe9bf309dfac23e4242c6e5aed90a5..4179c135dec5b9e3c202039680a5edc361fb1356 100644 --- a/zh-cn/application-dev/reference/arkui-ts/ts-container-row.md +++ b/zh-cn/application-dev/reference/arkui-ts/ts-container-row.md @@ -19,7 +19,7 @@ ## 接口 -Row(value:{space?: Length}) +Row(value?:{space?: Length}) - 参数 | 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 | @@ -32,7 +32,7 @@ Row(value:{space?: Length}) | 名称 | 参数类型 | 默认值 | 描述 | | -------- | -------- | -------- | -------- | | alignItems | [VerticalAlign](ts-appendix-enums.md#verticalalign) | VerticalAlign.Center | 在垂直方向上子组件的对齐格式。 | -| justifyContent8+ | [FlexAlign](ts-appendix-enums.md#flexalign) | FlexAlign.Start | 设置子组件在水平方向上的对齐格式。 | +| justifyContent8+ | [FlexAlign](ts-appendix-enums.md#flexalign) | FlexAlign.Start | 设置子组件在水平方向上的对齐格式。 | ## 示例 diff --git a/zh-cn/application-dev/reference/arkui-ts/ts-container-scroll.md b/zh-cn/application-dev/reference/arkui-ts/ts-container-scroll.md index 1573f14f9bd3518557156d71e6cd43921934689b..10549452d1f1471464b06f7795a48477a905fbe1 100644 --- a/zh-cn/application-dev/reference/arkui-ts/ts-container-scroll.md +++ b/zh-cn/application-dev/reference/arkui-ts/ts-container-scroll.md @@ -29,32 +29,41 @@ Scroll(scroller?: Scroller) | 名称 | 参数类型 | 默认值 | 描述 | | -------------- | ---------------------------------------- | ------------------------ | --------- | | scrollable | ScrollDirection | ScrollDirection.Vertical | 设置滚动方法。 | -| scrollBar | [BarState](ts-appendix-enums.md#barstate) | ScrollDirection.Auto | 设置滚动条状态。 | -| scrollBarColor | Color | - | 设置滚动条的颜色。 | +| scrollBar | [BarState](ts-appendix-enums.md#barstate) | BarState.Off | 设置滚动条状态。 | +| scrollBarColor | string \| number \| Color | - | 设置滚动条的颜色。 | | scrollBarWidth | Length | - | 设置滚动条的宽度。 | +| edgeEffect | EdgeEffect | EdgeEffect.Spring | 设置滑动效果，目前支持的滑动效果参见EdgeEffect的枚举说明。 | -- ScrollDirection枚举说明 +## ScrollDirection枚举说明 | 名称 | 描述 | | ---------- | ---------- | | Horizontal | 仅支持水平方向滚动。 | | Vertical | 仅支持竖直方向滚动。 | | None | 不可滚动。 | +## EdgeEffect枚举说明 + +| 名称 | 描述 | +| ------ | ---------------------------------------- | +| Spring | 弹性物理动效，滑动到边缘后可以根据初始速度或通过触摸事件继续滑动一段距离，松手后回弹。 | +| Fade | 阴影效果，滑动到边缘后会有圆弧状的阴影。 | +| None | 滑动到边缘后无效果。 | + ## 事件 | 名称 | 功能描述 | | ---------------------------------------- | ----------------------------- | | onScrollBegin9+(dx: number, dy: number) => { dxRemain: number, dyRemain: number } | 滚动开始事件回调。
参数：
- dx：即将发生的水平方向滚动量。
- dy：即将发生的竖向方向滚动量。
返回值：
- dxRemain：水平方向滚动剩余量。
- dyRemain：竖直方向滚动剩余量。 | -| onScroll(xOffset: number, yOffset: number) => void | 滚动事件回调, 返回滚动时水平、竖直方向偏移量。 | -| onScrollEdge(side: Edge) => void | 滚动到边缘事件回调。 | -| onScrollEnd() => void | 滚动停止事件回调。 | +| onScroll(event: (xOffset: number, yOffset: number) => void) | 滚动事件回调, 返回滚动时水平、竖直方向偏移量。 | +| onScrollEdge(event: (side: Edge) => void) | 滚动到边缘事件回调。 | +| onScrollEnd(event: () => void) | 滚动停止事件回调。 | > **说明：** > 若通过onScrollBegin事件和scrollBy方法实现容器嵌套滚动，需设置子滚动节点的EdgeEffect为None。如Scroll嵌套List滚动时，List组件的edgeEffect属性需设置为EdgeEffect.None。 ## Scroller -可滚动容器组件的控制器，可以将此组件绑定至容器组件，然后通过它控制容器组件的滚动，目前支持绑定到List和Scroll组件上。 +可滚动容器组件的控制器，可以将此组件绑定至容器组件，然后通过它控制容器组件的滚动，目前支持绑定到List、Scroll、ScrollBar上。 ### 导入对象 @@ -91,14 +100,8 @@ scrollEdge(value: Edge): void - 参数 | 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 | | ----- | ---- | ---- | ---- | --------- | - | value | Edge | 是 | - | 滚动到的边缘位置。 | - -- Edge枚举说明 + | value | [Edge](ts-appendix-enums.md#edge) | 是 | - | 滚动到的边缘位置。 | - | 名称 | 值 | 描述 | - | ------ | ---- | ---------- | - | Top | 0 | 滑动到顶部 | - | Bottom | 2 | 滑动到底部 | @@ -112,7 +115,7 @@ scrollPage(value: { next: boolean, direction?: Axis }): void | 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 | | --------- | ------- | ---- | ---- | ------------------------------ | | next | boolean | 是 | - | 是否向下翻页。true表示向下翻页，false表示向上翻页。 | - | direction | Axis | 否 | - | 设置滚动方向为水平或竖直方向。 | + | direction | [Axis](ts-appendix-enums.md#axis) | 否 | - | 设置滚动方向为水平或竖直方向。 | ### currentOffset diff --git a/zh-cn/application-dev/reference/arkui-ts/ts-container-swiper.md b/zh-cn/application-dev/reference/arkui-ts/ts-container-swiper.md index a5f9adb455746165ab1cef419015d96d04fcced4..4440a82f815fd8a3272a6ee562ab78e2bec3a935 100644 --- a/zh-cn/application-dev/reference/arkui-ts/ts-container-swiper.md +++ b/zh-cn/application-dev/reference/arkui-ts/ts-container-swiper.md @@ -46,10 +46,10 @@ Swiper(value:{controller?: SwiperController}) | displayMode | SwiperDisplayMode | 主轴方向上元素排列的模式，优先以displayCount设置的个数显示，displayCount未设置时本属性生效。
默认值：SwiperDisplayMode.Stretch | | cachedCount8+ | number | 设置预加载子组件个数。
默认值：1 | | disableSwipe8+ | boolean | 禁用组件滑动切换功能。
默认值：false | -| curve8+ | [Curve](ts-animatorproperty.md#Curve枚举说明) \| string | 设置Swiper的动画曲线，默认为淡入淡出曲线，常用曲线参考[Curve枚举说明](ts-animatorproperty.md#Curve枚举说明)，也可以通过插值计算模块提供的接口创建自定义的Curves([插值曲线对象](ts-interpolation-calculation.md))。
默认值：Curve.Ease | -| indicatorStyle8+ | {
left?: Length,
top?: Length,
right?: Length,
bottom?: Length,
size?: Length,
color?: Color,
selectedColor?: Color
} | 设置indicator样式：
- left: 设置导航点距离Swiper组件左边的距离。
- top: 设置导航点距离Swiper组件顶部的距离。
- right: 设置导航点距离Swiper组件右边的距离。
- bottom: 设置导航点距离Swiper组件底部的距离。
- size: 设置导航点的直径。
- color: 设置导航点的颜色。
- selectedColor: 设置选中的导航点的颜色。 | +| curve8+ | [Curve](ts-appendix-enums.md#curve) \| string | 设置Swiper的动画曲线，默认为淡入淡出曲线，常用曲线参考[Curve枚举说明](ts-appendix-enums.md#curve)，也可以通过插值计算模块提供的接口创建自定义的Curves([插值曲线对象](ts-interpolation-calculation.md))。
默认值：Curve.Ease | +| indicatorStyle8+ | {
left?: Length,
top?: Length,
right?: Length,
bottom?: Length,
size?: Length,
mask?: boolean,
color?: [ResourceColor](../../ui/ts-types.md),
selectedColor?: [ResourceColor](../../ui/ts-types.md)
} | - | 设置indicator样式：
- left: 设置导航点距离Swiper组件左边的距离。
- top: 设置导航点距离Swiper组件顶部的距离。
- right: 设置导航点距离Swiper组件右边的距离。
- bottom: 设置导航点距离Swiper组件底部的距离。
- size: 设置导航点的直径。
- mask: 设置是否显示导航点蒙层样式。
- color: 设置导航点的颜色。
- selectedColor: 设置选中的导航点的颜色。 | | displayCount8+ | number\|string | 设置元素显示个数。
默认值：1 | -| effectMode8+ | EdgeEffect | 滑动效果，目前支持的滑动效果参见EdgeEffect的枚举说明。
默认值：EdgeEffect.Spring | +| effectMode8+ | [EdgeEffect](ts-appendix-enums.md#edgeeffect) | 滑动效果，目前支持的滑动效果参见EdgeEffect的枚举说明。
默认值：EdgeEffect.Spring | ## SwiperDisplayMode枚举说明 @@ -98,9 +98,9 @@ finishAnimation(callback?: () => void): void ### onChange -onChange( index: number) => void +onChange(event: (index: number) => void) -当前显示的组件索引变化时触发该事件。 +当前显示的子组件索引变化时触发该事件,返回值为当前显示的子组件的索引值。 **参数：** diff --git a/zh-cn/application-dev/reference/arkui-ts/ts-container-tabcontent.md b/zh-cn/application-dev/reference/arkui-ts/ts-container-tabcontent.md index 4eaf5bbef7feca2b90edf5ce49cbb23b038dd636..834917593487e19a4dc6d990c0047000c9410f29 100644 --- a/zh-cn/application-dev/reference/arkui-ts/ts-container-tabcontent.md +++ b/zh-cn/application-dev/reference/arkui-ts/ts-container-tabcontent.md @@ -28,7 +28,7 @@ TabContent() | 名称 | 参数类型 | 默认值 | 描述 | | -------- | -------- | -------- | -------- | -| tabBar | string \| {
icon?: string,
text?: string
}
\| [CustomBuilder](../../ui/ts-types.md)8+ | - | 设置TabBar上显示内容。
CustomBuilder: 构造器，内部可以传入组件（API8版本以上适用）。
>  **说明：**
> 如果icon采用svg格式图源，则要求svg图源删除其自有宽高属性值。如采用带有自有宽高属性的svg图源，icon大小则是svg本身内置的宽高属性值大小。 | +| tabBar | string \| Resource \| {
icon?: string \| Resource,
text?: string \| Resource
}
\| [CustomBuilder](../../ui/ts-types.md)8+ | - | 设置TabBar上显示内容。
CustomBuilder: 构造器，内部可以传入组件（API8版本以上适用）。
>  **说明：**
> 如果icon采用svg格式图源，则要求svg图源删除其自有宽高属性值。如采用带有自有宽高属性的svg图源，icon大小则是svg本身内置的宽高属性值大小。 | > **说明：** > - TabContent组件不支持设置通用宽度属性，其宽度默认撑满Tabs父组件。 diff --git a/zh-cn/application-dev/reference/arkui-ts/ts-container-tabs.md b/zh-cn/application-dev/reference/arkui-ts/ts-container-tabs.md index ea24e62cf3c731f2c63e493f23c741469d136c2c..628dd15c7a7b3ba4d9a5214af9330d3d698766b5 100644 --- a/zh-cn/application-dev/reference/arkui-ts/ts-container-tabs.md +++ b/zh-cn/application-dev/reference/arkui-ts/ts-container-tabs.md @@ -41,11 +41,11 @@ Tabs(value: {barPosition?: BarPosition, index?: number, controller?: [TabsContro | 名称 | 参数类型 | 默认值 | 描述 | | -------- | -------- | -------- | -------- | -| vertical | boolean | false | 是否为纵向Tab，默认为false。 | -| scrollable | boolean | true | 是否可以通过左右滑动进行页面切换，默认为true。 | -| barMode | BarMode | BarMode.Fixed | TabBar布局模式。 | -| barWidth | number | - | TabBar的宽度值，不设置时使用系统主题中的默认值。 | -| barHeight | number | - | TabBar的高度值，不设置时使用系统主题中的默认值。 | +| vertical | boolean | false | 设置为false是为横向Tabs，设置为true时为纵向Tabs。 | +| scrollable | boolean | true | 设置为true时可以通过滑动页面进行页面切换，为false时不可滑动切换页面。 | +| barMode | BarMode | BarMode.Fixed | TabBar布局模式，具体描述见BarMode枚举说明。 | +| barWidth | number \| string8+ | - | TabBar的宽度值。 | +| barHeight | number \| string8+ | - | TabBar的高度值。 | | animationDuration | number | 200 | TabContent滑动动画时长。 | - BarMode枚举说明 diff --git a/zh-cn/application-dev/reference/arkui-ts/ts-drawing-components-line.md b/zh-cn/application-dev/reference/arkui-ts/ts-drawing-components-line.md index 6658359608e1a26a888b62e1981964150481c861..60cb3df611118571adab5f1c8aa925094a1dfbc3 100644 --- a/zh-cn/application-dev/reference/arkui-ts/ts-drawing-components-line.md +++ b/zh-cn/application-dev/reference/arkui-ts/ts-drawing-components-line.md @@ -37,10 +37,16 @@ Line(options?: {width: Length, height: Length}) | 参数名称 | 参数类型 | 默认值 | 必填 | 参数描述 | | -------- | -------- | -------- | -------- | -------- | -| width | Length | 0 | 否 | 直线所在矩形的宽度。 | -| height | Length | 0 | 否 | 直线所在矩形的高度。 | -| startPoint | Point | [0, 0] | 是 | 直线起点坐标(相对坐标)。 | -| endPoint | Point | [0, 0] | 是 | 直线终点坐标(相对坐标)。 | +| width | [Length](../../ui/ts-types.md#length) | 0 | 否 | 直线所在矩形的宽度。 | +| height | [Length](../../ui/ts-types.md#length) | 0 | 否 | 直线所在矩形的高度。 | +| startPoint | Array<Point> | [0, 0] | 是 | 直线起点坐标(相对坐标)。 | +| endPoint | Array<Point> | [0, 0] | 是 | 直线终点坐标(相对坐标)。 | + +## Point + +| 名称 | 类型定义 | 描述 | +| ----- | --------------------- | ---------------------------------------------------- | +| Point | [[Length](../../ui/ts-types.md#length), [Length](ts-types.md#length)] | 用于描述点坐标，第一个值为x轴坐标，第二个值为y坐标。 | ## 示例 diff --git a/zh-cn/application-dev/reference/arkui-ts/ts-methods-datepicker-dialog.md b/zh-cn/application-dev/reference/arkui-ts/ts-methods-datepicker-dialog.md index 1105439ca168879cc24627eede820afd5fa29613..7b442f93de876c69c909970fee623809819adfb1 100644 --- a/zh-cn/application-dev/reference/arkui-ts/ts-methods-datepicker-dialog.md +++ b/zh-cn/application-dev/reference/arkui-ts/ts-methods-datepicker-dialog.md @@ -16,7 +16,7 @@ show(options?: DatePickerDialogOptions) 定义日期滑动选择器弹窗并弹出。 -- options参数 +- DatePickerDialogOptions参数说明 | 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 | | -------- | -------- | -------- | -------- | -------- | | start | Date | 否 | Date('1970-1-1') | 指定选择器的起始日期。 | diff --git a/zh-cn/application-dev/reference/arkui-ts/ts-methods-textpicker-dialog.md b/zh-cn/application-dev/reference/arkui-ts/ts-methods-textpicker-dialog.md index 52fbd0dee4d7156777f3a41405b0faa132c97086..b5d516dd4065bad8d2694fdfbde420ee65d5c9a4 100644 --- a/zh-cn/application-dev/reference/arkui-ts/ts-methods-textpicker-dialog.md +++ b/zh-cn/application-dev/reference/arkui-ts/ts-methods-textpicker-dialog.md @@ -20,7 +20,7 @@ show(options: TextPickerDialogOptions) | 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 | | -------- | -------- | -------- | -------- | -------- | | range | string[] | 是 | - | 选择器的数据选择范围。 | - | selected | number | 否 | 第一个元素 | 选中项在数组中的index值。 | + | selected | number | 否 | 0 | 选中项在数组中的index值。 | | value | string | 否 | - | 选中项文本值。当设置了selected参数时，该值不生效。如果该值不在range范围内，则默认取range第一个元素。| | defaultPickerItemHeight | number | 否 | - | 默认Picker内容项元素高度。 | | onAccept | (value: TextPickerResult) => void | 否 | - | 点击弹窗中确定按钮时触发。 | diff --git a/zh-cn/application-dev/reference/arkui-ts/ts-universal-events-click.md b/zh-cn/application-dev/reference/arkui-ts/ts-universal-events-click.md index 78689dca4d56faa7b67ecec8e4618fb558e99419..80e147ef093935853d2e861b35ae63706917a050 100644 --- a/zh-cn/application-dev/reference/arkui-ts/ts-universal-events-click.md +++ b/zh-cn/application-dev/reference/arkui-ts/ts-universal-events-click.md @@ -30,21 +30,8 @@ ## EventTarget8+对象说明 | 名称 | 参数类型 | 描述 | | ---- | ----------------- | ---------- | -| area | [Area](#area8对象说明) | 目标元素的区域信息。 | - -## Area8+对象说明 -| 属性名称 | 类型 | 描述 | -| -------------- | -------------------------- | ------------------- | -| width | number | 目标元素的宽度，单位为vp。 | -| height | number | 目标元素的高度，单位为vp。 | -| position | Position | 目标元素左上角相对父元素左上角的位置。 | -| globalPosition | Position | 目标元素左上角相对页面左上角的位置。 | - -## Position8+对象说明 -| 属性名称 | 参数类型 | 描述 | -| ---- | ------ | ----------- | -| x | number | x轴坐标，单位为vp。 | -| y | number | y轴坐标，单位为vp。 | +| area | [Area](../../ui/ts-types.md#area8) | 目标元素的区域信息。 | + ## 示例