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 0353f790214dc946241653120f9447ca12153b45..ea8cce2af4c9619c7d21012fe458baf430d3f1e5 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 @@ -6,10 +6,6 @@ > > 该组件从API Version 8开始支持。后续版本如有新增内容，则采用上角标单独标记该内容的起始版本。 -## 权限列表 - -无 - ## 子组件 无 @@ -20,21 +16,21 @@ Gauge(options:{value: number, min?: number, max?: number}) **参数：** -| 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 | -| ----- | ------ | ---- | ---- | --------- | -| value | number | 是 | - | 当前数据值。 | -| min | number | 否 | 0 | 当前数据段最小值。 | -| max | number | 否 | 100 | 当前数据段最大值。 | +| 参数名 | 参数类型 | 必填 | 参数描述 | +| ------ | -------- | ---- | ---------------------------------- | +| value | number | 是 | 当前数据值。 | +| min | number | 否 | 当前数据段最小值。
默认值：0 | +| max | number | 否 | 当前数据段最大值。
默认值：100 | ## 属性 -| 名称 | 参数类型 | 默认值 | 描述 | -| ----------- | ---------------------------------------- | ---- | --------------------------- | -| value | number | 0 | 设置当前数据图表的值。 | -| startAngle | number | -150 | 设置起始角度位置，时钟0点为0度，顺时针方向为正角度。 | -| endAngle | number | 150 | 设置终止角度位置，时钟0点为0度，顺时针方向为正角度。 | -| colors | Array<ColorStop> | - | 设置图表的颜色，支持分段颜色设置。 | -| strokeWidth | [Length](ts-types.md#length) | - | 设置环形图表的环形厚度。 | +| 名称 | 参数类型 | 描述 | +| ----------- | ---------------------------------------- | --------------------------- | +| value | number | 设置当前数据图表的值。
默认值：0 | +| startAngle | number | 设置起始角度位置，时钟0点为0度，顺时针方向为正角度。
默认值：-150 | +| endAngle | number | 设置终止角度位置，时钟0点为0度，顺时针方向为正角度。
默认值：150 | +| colors | Array<ColorStop> | 设置图表的颜色，支持分段颜色设置。 | +| strokeWidth | [Length](ts-types.md#length) | 设置环形图表的环形厚度。 | ## ColorStop 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 037c063d2da5df9fda5aa055909b8236f3d58c87..144aa0933d300740fc14ddbcb1f91e1442f8191f 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 @@ -7,11 +7,6 @@ Navigation组件一般作为Page页面的根容器，通过属性设置来展示 > 该组件从API Version 8开始支持。后续版本如有新增内容，则采用上角标单独标记该内容的起始版本。 -## 权限列表 - -无 - - ## 子组件 可以包含子组件。 @@ -26,32 +21,32 @@ Navigation() ## 属性 -| 名称 | 参数类型 | 默认值 | 描述 | -| -------------- | ---------------------------------------- | ------------------------ | ---------------------------------------- | -| title | string \| [CustomBuilder](ts-types.md#custombuilder8)8+ | - | 页面标题。 | -| subtitle | string | - | 页面副标题。 | -| menus | Array8+ | - | 页面右上角菜单。 | -| titleMode | NavigationTitleMode | NavigationTitleMode.Free | 页面标题栏显示模式。 | -| toolBar | object \| [CustomBuilder](ts-types.md#custombuilder8)8+ | - | 设置工具栏内容。
items: 工具栏所有项。 | -| hideToolBar | boolean | false | 设置隐藏/显示工具栏：
true: 隐藏工具栏。
false: 显示工具栏。 | -| hideTitleBar | boolean | false | 隐藏标题栏。 | -| hideBackButton | boolean | false | 隐藏返回键。 | +| 名称 | 参数类型 | 描述 | +| -------------- | ---------------------------------------- | ---------------------------------------- | +| title | string \| [CustomBuilder](ts-types.md#custombuilder8)8+ | 页面标题。 | +| subtitle | string | 页面副标题。 | +| menus | Array8+ | 页面右上角菜单。 | +| titleMode | NavigationTitleMode | 页面标题栏显示模式。
默认值：NavigationTitleMode.Free | +| toolBar | object \| [CustomBuilder](ts-types.md#custombuilder8)8+ | 设置工具栏内容。
items: 工具栏所有项。 | +| hideToolBar | boolean | 设置隐藏/显示工具栏：
默认值：false
true: 隐藏工具栏。
false: 显示工具栏。 | +| hideTitleBar | boolean | 隐藏标题栏。
默认值：false | +| hideBackButton | boolean | 隐藏返回键。
默认值：false | ## NavigationMenuItem类型说明 -| 名称 | 类型 | 必填 | 默认值 | 描述 | -| ------ | ----------------------- | ---- | ---- | --------------- | -| value | string | 是 | - | 菜单栏单个选项的显示文本。 | -| icon | string | 否 | - | 菜单栏单个选项的图标资源路径。 | -| action | () => void | 否 | - | 当前选项被选中的事件回调。 | +| 名称 | 类型 | 必填 | 描述 | +| ------ | ----------------------- | ---- | ------------------------------ | +| value | string | 是 | 菜单栏单个选项的显示文本。 | +| icon | string | 否 | 菜单栏单个选项的图标资源路径。 | +| action | () => void | 否 | 当前选项被选中的事件回调。 | ## Object类型说明 -| 名称 | 类型 | 必填 | 默认值 | 描述 | -| ------ | ----------------------- | ---- | ---- | --------------- | -| value | string | 是 | - | 工具栏单个选项的显示文本。 | -| icon | string | 否 | - | 工具栏单个选项的图标资源路径。 | -| action | () => void | 否 | - | 当前选项被选中的事件回调。 | +| 名称 | 类型 | 必填 | 描述 | +| ------ | ----------------------- | ---- | ------------------------------ | +| value | string | 是 | 工具栏单个选项的显示文本。 | +| icon | string | 否 | 工具栏单个选项的图标资源路径。 | +| action | () => void | 否 | 当前选项被选中的事件回调。 | ## NavigationTitleMode枚举说明 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 d3bb6d270cd9121caad6d58b2791c8cff2e001d7..aad55d704e49a0701d278c725713dd829aff01dc 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 @@ -7,11 +7,6 @@ > 该组件从API Version 7开始支持。后续版本如有新增内容，则采用上角标单独标记该内容的起始版本。 -## 权限列表 - -无 - - ## 子组件 无 @@ -25,12 +20,12 @@ Progress(options: {value: number, total?: number, style?: ProgressStyle, type?: **参数：** -| 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 | -| -------------------------- | ------------- | ---- | -------------------- | --------------------------------------------------- | -| value | number | 是 | - | 指定当前进度值。 | -| total | number | 否 | 100 | 指定进度总长。 | -| type8+ | ProgressType | 否 | ProgressType.Linear | 指定进度条类型。 | -| styledeprecated | ProgressStyle | 否 | ProgressStyle.Linear | 指定进度条样式。
该参数从API Version8开始废弃。 | +| 参数名 | 参数类型 | 必填 | 参数描述 | +| -------------------------- | ------------- | ---- | ------------------------------------------------------------ | +| value | number | 是 | 指定当前进度值。 | +| total | number | 否 | 指定进度总长。
默认值：100 | +| type8+ | ProgressType | 否 | 指定进度条类型。
默认值：ProgressType.Linear | +| styledeprecated | ProgressStyle | 否 | 指定进度条类型。
该参数从API Version8开始废弃，建议使用type替代。
默认值：ProgressStyle.Linear | ## ProgressType枚举说明 @@ -54,11 +49,11 @@ Progress(options: {value: number, total?: number, style?: ProgressStyle, type?: ## 属性 -| 名称 | 参数类型 | 默认值 | 描述 | -| ------------------ | ------------------------------------------------------------ | ------ | ------------------------------------------------------------ | -| value | number | - | 设置当前进度值。 | -| color | [ResourceColor](ts-types.md#resourcecolor8) | - | 设置进度条前景色。 | -| style8+ | {
strokeWidth?: [Length](ts-types.md#length),
scaleCount?: number,
scaleWidth?: [Length](ts-types.md#length)
} | - | 定义组件的样式。
strokeWidth: 设置进度条宽度。
scaleCount: 设置环形进度条总刻度数。
scaleWidth: 设置环形进度条刻度粗细。
刻度粗细大于进度条宽度时，刻度粗细为系统默认粗细。 | +| 名称 | 参数类型 | 描述 | +| ------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | +| value | number | 设置当前进度值。 | +| color | [ResourceColor](ts-types.md#resourcecolor8) | 设置进度条前景色。 | +| style8+ | {
strokeWidth?: [Length](ts-types.md#length),
scaleCount?: number,
scaleWidth?: [Length](ts-types.md#length)
} | 定义组件的样式。
strokeWidth: 设置进度条宽度。
scaleCount: 设置环形进度条总刻度数。
scaleWidth: 设置环形进度条刻度粗细。
刻度粗细大于进度条宽度时，刻度粗细为系统默认粗细。 | ## 示例 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 69f29e9fcfe7d2007303043336c5f4a0d76875ac..015c324810f97d9dd986bdbe722525d610bb9bae 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 @@ -7,11 +7,6 @@ > 该组件从API Version 8开始支持。后续版本如有新增内容，则采用上角标单独标记该内容的起始版本。 -## 权限列表 - -无 - - ## 子组件 无 @@ -23,23 +18,23 @@ Radio(options: {value: string, group: string}) **参数：** -| 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 | -| ----- | ------ | ---- | ---- | ----------------------------------- | -| value | string | 是 | - | 当前单选框的值。 | -| group | string | 是 | - | 当前单选框的所属群组名称，相同group的Radio只能有一个被选中。 | +| 参数名 | 参数类型 | 必填 | 参数描述 | +| ------ | -------- | ---- | ------------------------------------------------------------ | +| value | string | 是 | 当前单选框的值。 | +| group | string | 是 | 当前单选框的所属群组名称，相同group的Radio只能有一个被选中。 | ## 属性 -| 名称 | 参数类型 | 默认值 | 描述 | -| ------- | ------- | ----- | ----------- | -| checked | boolean | false | 设置单选框的选中状态。 | +| 名称 | 参数类型 | 描述 | +| ------- | -------- | ---------------------------------------- | +| checked | boolean | 设置单选框的选中状态。
默认值：false | ## 事件 -| 名称 | 功能描述 | -| ---------------------------------------- | ---------------------------------------- | -| onChange(callback: (isChecked: boolean) => void) | 单选框选中状态改变时触发回调。
-isChecked为true时，代表选中。
-isChecked为false时，代表未选中。 | +| 名称 | 功能描述 | +| ------------------------------------------------ | ------------------------------------------------------------ | +| onChange(callback: (isChecked: boolean) => void) | 单选框选中状态改变时触发回调。
- isChecked为true时，代表选中。
- isChecked为false时，代表未选中。 | ## 示例 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 1f1038d5d03cea38ae18d0dd9f701a4a6d1aa9dd..95e7221fd461c629737bae93c0f0e6bb711de982 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 @@ -6,10 +6,6 @@ > > 该组件从API Version 8开始支持。后续版本如有新增内容，则采用上角标单独标记该内容的起始版本。 -## 权限列表 - -无 - ## 子组件 无 @@ -20,21 +16,21 @@ Search(options?: { value?: string; placeholder?: string; icon?: string; controll **参数：** -| 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 | -| ----------- | ---------------- | ---- | ---- | ---------------------------------------- | -| value | string | 否 | - | 搜索文本值。 | -| placeholder | string | 否 | - | 无输入时的提示文本。 | -| icon | string | 否 | - | 搜索图标路径，默认使用系统搜索图标，支持的图标格式: svg, jpg和png。 | -| controller | SearchController | 否 | - | 控制器。 | +| 参数名 | 参数类型 | 必填 | 参数描述 | +| ----------- | ---------------- | ---- | ------------------------------------------------------------ | +| value | string | 否 | 搜索文本值。 | +| placeholder | string | 否 | 无输入时的提示文本。 | +| icon | string | 否 | 搜索图标路径，默认使用系统搜索图标，支持的图标格式: svg, jpg和png。 | +| controller | SearchController | 否 | 控制器。 | ## 属性 -| 名称 | 参数类型 | 默认值 | 描述 | -| ---------------- | ------------------------------------------- | ------ | ------------------------------------------ | -| searchButton | string | 无 | 搜索框末尾搜索按钮文本值，默认无搜索按钮。 | -| placeholderColor | [ResourceColor](ts-types.md#resourcecolor8) | - | 设置placeholder颜色。 | -| placeholderFont | [Font](ts-types.md#font) | - | 设置placeholder文本样式。 | -| textFont | [Font](ts-types.md#font) | - | 设置搜索框内文本样式。 | +| 名称 | 参数类型 | 描述 | +| ---------------- | ------------------------------------------- | ------------------------------------------ | +| searchButton | string | 搜索框末尾搜索按钮文本值，默认无搜索按钮。 | +| placeholderColor | [ResourceColor](ts-types.md#resourcecolor8) | 设置placeholder颜色。 | +| placeholderFont | [Font](ts-types.md#font) | 设置placeholder文本样式。 | +| textFont | [Font](ts-types.md#font) | 设置搜索框内文本样式。 | ## 事件 @@ -62,9 +58,9 @@ caretPosition(value: number): void **参数：** -| 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 | -| ----- | ------ | ---- | ---- | ----------------- | -| value | number | 是 | - | 从字符串开始到光标所在位置的长度。 | +| 参数名 | 参数类型 | 必填 | 参数描述 | +| ------ | -------- | ---- | ---------------------------------- | +| value | number | 是 | 从字符串开始到光标所在位置的长度。 | ## 示例 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 6a725256acbcf522cc04af70fd41c790bb1bdd3d..32263cb14021ec5000ac04c828a264b88227b34e 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 @@ -7,11 +7,6 @@ > 该组件从API Version 7开始支持。后续版本如有新增内容，则采用上角标单独标记该内容的起始版本。 -## 权限列表 - -无 - - ## 子组件 无 @@ -19,23 +14,23 @@ ## 接口 -Span(content: string | Resource) +Span(value: string | Resource) **参数:** -| 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 | -| ------- | ---------------------------------------- | ---- | ------ | ---------- | -| content | string\|[Resource](ts-types.md#resource) | 是 | - | 文本内容。 | +| 参数名 | 参数类型 | 必填 | 参数描述 | +| ------ | ---------------------------------------------------- | ---- | ---------- | +| value | string \| [Resource](ts-types.md#resource) | 是 | 文本内容。 | ## 属性 通用属性方法仅支持通用文本样式，不支持触摸热区设置。 -| 名称 | 参数类型 | 默认值 | 描述 | -| ---------- | ---------------------------------------- | ---------------------------------------- | -------------- | -| decoration | {
type: [TextDecorationType](ts-appendix-enums.md#textdecorationtype枚举说明),
color?: [ResourceColor](ts-types.md#resourcecolor8)
} | {
type: TextDecorationType.None
color：Color.Black
} | 设置文本装饰线样式及其颜色。 | -| letterSpacing | number \| string | - | 设置文本字符间距。 | -| textCase | [TextCase](ts-appendix-enums.md#textcase枚举说明) | Normal | 设置文本大小写。 | +| 名称 | 参数类型 | 描述 | +| ---------- | ---------------------------------------- | -------------- | +| decoration | {
type: [TextDecorationType](ts-appendix-enums.md#textdecorationtype枚举说明),
color?: [ResourceColor](ts-types.md#resourcecolor8)
} | 设置文本装饰线样式及其颜色。
默认值：{
type: TextDecorationType.None
color：Color.Black
} | +| letterSpacing | number \| string | 设置文本字符间距。 | +| textCase | [TextCase](ts-appendix-enums.md#textcase枚举说明) | 设置文本大小写。
默认值：Normal | ## 事件 @@ -43,6 +38,7 @@ Span(content: string | Resource) 通用事件仅支持点击事件。 > **说明：** +> > 由于Span组件无尺寸信息，因此点击事件返回的ClickEvent对象的target属性无效。 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 46310bdef3e2a623b58deda098c1273d814f17e5..b79b655518acbd8c42c6425d063ac053de89baff 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 @@ -7,11 +7,6 @@ > 该组件从API Version 7开始支持。后续版本如有新增内容，则采用上角标单独标记该内容的起始版本。 -## 权限列表 - -无 - - ## 子组件 可以包含[Span](ts-basic-components-span.md)子组件。 @@ -23,24 +18,24 @@ Text(content?: string | Resource) **参数：** -| 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 | -| ------- | ------------------------------------------ | ---- | ------ | ------------------------------------------------------------ | -| content | string \| [Resource](ts-types.md#resource) | 否 | '' | 文本内容。包含子组件Span时不生效，显示Span内容，并且此时text组件的样式不生效。 | +| 参数名 | 参数类型 | 必填 | 参数描述 | +| ------- | ------------------------------------------ | ---- | ------------------------------------------------------------ | +| content | string \| [Resource](ts-types.md#resource) | 否 | 文本内容。包含子组件Span时不生效，显示Span内容，并且此时text组件的样式不生效。
默认值：' ' | ## 属性 -| 名称 | 参数类型 | 默认值 | 描述 | -| -------------- | ---------------------------------------- | ---------------------------------------- | ---------------------------------------- | -| textAlign | [TextAlign](ts-appendix-enums.md#textalign) | TextAlign.Start | 设置多行文本的文本对齐方式。 | -| textOverflow | {overflow: [TextOverflow](ts-appendix-enums.md#textoverflow)} | {overflow: TextOverflow.Clip} | 设置文本超长时的显示方式。
**说明：**
文本截断是按字截断。例如，英文以单词为最小单位进行截断，若需要以字母为单位进行截断，可在字母间添加零宽空格：\u200B。 | -| maxLines | number | Infinity | 设置文本的最大行数。 | -| lineHeight | string \| number \| [Resource](ts-types.md#resource) | - | 设置文本的文本行高，设置值不大于0时，不限制文本行高，自适应字体大小，Length为number类型时单位为fp。 | -| decoration | {
type: [TextDecorationType](ts-appendix-enums.md#textdecorationtype),
color?: [ResourceColor](ts-types.md#resourcecolor8)
} | {
type: TextDecorationType.None,
color：Color.Black
} | 设置文本装饰线样式及其颜色。 | -| baselineOffset | number \| string | - | 设置文本基线的偏移量。 | -| letterSpacing | number \| string | - | 设置文本字符间距。 | -| minFontSize | number \| string \| [Resource](ts-types.md#resource) | - | 设置文本最小显示字号。 | -| maxFontSize | number \| string \| [Resource](ts-types.md#resource) | - | 设置文本最大显示字号。 | -| textCase | [TextCase](ts-appendix-enums.md#textcase) | TextCase.Normal | 设置文本大小写。 | +| 名称 | 参数类型 | 描述 | +| -------------- | ---------------------------------------- | ---------------------------------------- | +| textAlign | [TextAlign](ts-appendix-enums.md#textalign) | 设置多行文本的文本对齐方式。
默认值：TextAlign.Start | +| textOverflow | {overflow: [TextOverflow](ts-appendix-enums.md#textoverflow)} | 设置文本超长时的显示方式。
默认值：{overflow: TextOverflow.Clip}
**说明：**
文本截断是按字截断。例如，英文以单词为最小单位进行截断，若需要以字母为单位进行截断，可在字母间添加零宽空格：\u200B。 | +| maxLines | number | 设置文本的最大行数。
默认值：Infinity | +| lineHeight | string \| number \| [Resource](ts-types.md#resource) | 设置文本的文本行高，设置值不大于0时，不限制文本行高，自适应字体大小，Length为number类型时单位为fp。 | +| decoration | {
type: [TextDecorationType](ts-appendix-enums.md#textdecorationtype),
color?: [ResourceColor](ts-types.md#resourcecolor8)
} | 设置文本装饰线样式及其颜色。
默认值：{
type: TextDecorationType.None,
color：Color.Black
} | +| baselineOffset | number \| string | 设置文本基线的偏移量。 | +| letterSpacing | number \| string | 设置文本字符间距。 | +| minFontSize | number \| string \| [Resource](ts-types.md#resource) | 设置文本最小显示字号。 | +| maxFontSize | number \| string \| [Resource](ts-types.md#resource) | 设置文本最大显示字号。 | +| textCase | [TextCase](ts-appendix-enums.md#textcase) | 设置文本大小写。
默认值：TextCase.Normal | > **说明：** 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 6e3b78cf19a4dc2883bba20da0b8d152eb37b370..1c35376c8ab894c623cdc696b826eb554bd2a2f6 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 @@ -7,11 +7,6 @@ > 该组件从API Version 7开始支持。后续版本如有新增内容，则采用上角标单独标记该内容的起始版本。 -## 权限列表 - -无 - - ## 子组件 无 @@ -23,32 +18,32 @@ TextArea(value?:{placeholder?: ResourceStr, text?: ResourceStr, controller?: Tex **参数：** -| 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 | -| ----------------------- | ---------------------------------------- | ---- | ---- | -------------- | -| placeholder | [ResourceStr](ts-types.md#resourcestr8) | 否 | - | 无输入时的提示文本。 | -| text | [ResourceStr](ts-types.md#resourcestr8) | 否 | - | 设置输入框当前的文本内容。 | -| controller8+ | [TextAreaController](#textareacontroller8) | 否 | - | 设置TextArea控制器。 | +| 参数名 | 参数类型 | 必填 | 参数描述 | +| ----------------------- | ---------------------------------------- | ---- | -------------- | +| placeholder | [ResourceStr](ts-types.md#resourcestr8) | 否 | 无输入时的提示文本。 | +| text | [ResourceStr](ts-types.md#resourcestr8) | 否 | 设置输入框当前的文本内容。 | +| controller8+ | [TextAreaController](#textareacontroller8) | 否 | 设置TextArea控制器。 | ## 属性 除支持通用属性外，还支持以下属性： -| 名称 | 参数类型 | 默认值 | 描述 | -| ------------------------ | ------------------------------------------------------------ | ------ | ------------------------------------------------------------ | -| placeholderColor | [ResourceColor](ts-types.md#resourcecolor8) | - | 设置placeholder文本颜色。 | -| placeholderFont | [Font](ts-types.md#font) | - | 设置placeholder文本样式：
- size: 设置文本尺寸，Length为number类型时，使用fp单位。
- weight: 设置文本的字体粗细，number类型取值[100, 900]，取值间隔为100，默认为400，取值越大，字体越粗。
- family: 设置文本的字体列表。使用多个字体，使用','进行分割，优先级按顺序生效，例如：'Arial, sans-serif'。
- style: 设置文本的字体样式。 | -| textAlign | [TextAlign](ts-appendix-enums.md#textalign) | Start | 设置文本水平对齐方式。 | -| caretColor | [ResourceColor](ts-types.md#resourcecolor8) | - | 设置输入框光标颜色。 | -| inputFilter8+ | {
value: [ResourceStr](ts-types.md#resourcestr8)8+,
error?: (value: string) => void
} | - | 通过正则表达式设置输入过滤器。满足表达式的输入允许显示，不满足的输入被忽略。仅支持单个字符匹配，不支持字符串匹配。例如：^(?=.\*\d)(?=.\*[a-z])(?=.\*[A-Z]).{8,10}$，不支持过滤8到10位的强密码。
- value：设置正则表达式。
- error：正则匹配失败时，返回被忽略的内容。 | +| 名称 | 参数类型 | 描述 | +| ------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | +| placeholderColor | [ResourceColor](ts-types.md#resourcecolor8) | 设置placeholder文本颜色。 | +| placeholderFont | [Font](ts-types.md#font) | 设置placeholder文本样式：
- size: 设置文本尺寸，Length为number类型时，使用fp单位。
- weight: 设置文本的字体粗细，number类型取值[100, 900]，取值间隔为100，默认为400，取值越大，字体越粗。
- family: 设置文本的字体列表。使用多个字体，使用','进行分割，优先级按顺序生效，例如：'Arial, sans-serif'。
- style: 设置文本的字体样式。 | +| textAlign | [TextAlign](ts-appendix-enums.md#textalign) | 设置文本水平对齐方式。
默认值：TextAlign.Start | +| caretColor | [ResourceColor](ts-types.md#resourcecolor8) | 设置输入框光标颜色。 | +| inputFilter8+ | {
value: [ResourceStr](ts-types.md#resourcestr8)8+,
error?: (value: string) => void
} | 通过正则表达式设置输入过滤器。满足表达式的输入允许显示，不满足的输入被忽略。仅支持单个字符匹配，不支持字符串匹配。例如：^(?=.\*\d)(?=.\*[a-z])(?=.\*[A-Z]).{8,10}$，不支持过滤8到10位的强密码。
- value：设置正则表达式。
- error：正则匹配失败时，返回被忽略的内容。 | ## 事件 -| 名称 | 功能描述 | -| ---------------------------------------- | ---------------------------------------- | -| onChange(callback: (value: string) => void) | 输入发生变化时，触发回调。 | -| onCopy8+(callback:(value: string) => void) | 长按输入框内部区域弹出剪贴板后，点击剪切板复制按钮，触发回调。
value：复制的文本内容。 | -| onCut8+(callback:(value: string) => void) | 长按输入框内部区域弹出剪贴板后，点击剪切板剪切按钮，触发回调。
value：剪切的文本内容。 | -| onPaste8+(callback:(value: string) => void) | 长按输入框内部区域弹出剪贴板后，点击剪切板粘贴按钮，触发回调。
value：粘贴的文本内容。 | +| 名称 | 功能描述 | +| ------------------------------------------------------------ | ------------------------------------------------------------ | +| onChange(callback: (value: string) => void) | 输入发生变化时，触发回调。 | +| onCopy8+(callback:(value: string) => void) | 长按输入框内部区域弹出剪贴板后，点击剪切板复制按钮，触发回调。
- value：复制的文本内容。 | +| onCut8+(callback:(value: string) => void) | 长按输入框内部区域弹出剪贴板后，点击剪切板剪切按钮，触发回调。
- value：剪切的文本内容。 | +| onPaste8+(callback:(value: string) => void) | 长按输入框内部区域弹出剪贴板后，点击剪切板粘贴按钮，触发回调。
- value：粘贴的文本内容。 | ## TextAreaController8+ @@ -69,9 +64,9 @@ caretPosition(value: number): void **参数：** -| 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 | -| ----- | ------ | ---- | ---- | ------------------- | -| value | number | 是 | - | 从字符串开始到光标所在位置的字符长度。 | +| 参数名 | 参数类型 | 必填 | 参数描述 | +| ------ | -------- | ---- | -------------------------------------- | +| value | number | 是 | 从字符串开始到光标所在位置的字符长度。 | ## 示例 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 4b762cda550d778132eeb398752b8d0b5fe8a03e..1d2f8efdfa245cee7b4c943dac6dcc2071200e7a 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 @@ -7,11 +7,6 @@ > 该组件从API Version 7开始支持。后续版本如有新增内容，则采用上角标单独标记该内容的起始版本。 -## 权限列表 - -无 - - ## 子组件 无 @@ -23,25 +18,25 @@ TextInput(value?:{placeholder?: [ResourceStr](ts-types.md#resourcestr8), text?: **参数：** -| 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 | -| ----------------------- | ---------------------------------------- | ---- | ---- | --------------- | -| placeholder | [ResourceStr](ts-types.md#resourcestr8) | 否 | - | 无输入时的提示文本。 | -| text | [ResourceStr](ts-types.md#resourcestr8) | 否 | - | 设置输入框当前的文本内容。 | -| controller8+ | [TextInputController](#textinputcontroller8) | 否 | - | 设置TextInput控制器。 | +| 参数名 | 参数类型 | 必填 | 参数描述 | +| ----------------------- | ---------------------------------------- | ---- | --------------- | +| placeholder | [ResourceStr](ts-types.md#resourcestr8) | 否 | 无输入时的提示文本。 | +| text | [ResourceStr](ts-types.md#resourcestr8) | 否 | 设置输入框当前的文本内容。 | +| controller8+ | [TextInputController](#textinputcontroller8) | 否 | 设置TextInput控制器。 | ## 属性 除支持通用属性外，还支持以下属性： -| 名称 | 参数类型 | 默认值 | 描述 | -| ----------------------------- | ------------------------------------------------------------ | ----------------- | ------------------------------------------------------------ | -| type | InputType | InputType.Normal | 设置输入框类型。 | -| placeholderColor | [ResourceColor](ts-types.md#resourcecolor8) | - | 设置placeholder颜色。 | -| placeholderFont | [Font](ts-types.md#font) | - | 设置placeholder文本样式：
- size: 设置文本尺寸，Length为number类型时，使用fp单位。
- weight: 设置文本的字体粗细，number类型取值[100, 900]，取值间隔为100，默认为400，取值越大，字体越粗。
- family: 设置文本的字体列表。使用多个字体，使用','进行分割，优先级按顺序生效。例如：'Arial, sans-serif'。
- style: 设置文本的字体样式。 | -| enterKeyType | EnterKeyType | EnterKeyType.Done | 设置输入法回车键类型。 | -| caretColor | [ResourceColor](ts-types.md#resourcecolor8) | - | 设置输入框光标颜色。 | -| maxLength | number | - | 设置文本的最大输入字符数。 | -| inputFilter8+ | {
value: [ResourceStr](ts-types.md#resourcestr8)8+,
error?: (value: string) => void
} | - | 正则表达式，满足表达式的输入允许显示，不满足正则表达式的输入被忽略。仅支持单个字符匹配，不支持字符串匹配。例如：^(?=.\*\d)(?=.\*[a-z])(?=.\*[A-Z]).{8,10}$，8到10位的强密码不支持过滤。
- value：设置正则表达式。
- error：正则匹配失败时，返回被忽略的内容。 | +| 名称 | 参数类型 | 描述 | +| ----------------------------- | ------------------------------------------------------------ | ------------------------------------------------------------ | +| type | InputType | 设置输入框类型。
默认值：InputType.Normal | +| placeholderColor | [ResourceColor](ts-types.md#resourcecolor8) | 设置placeholder颜色。 | +| placeholderFont | [Font](ts-types.md#font) | 设置placeholder文本样式：
- size: 设置文本尺寸，Length为number类型时，使用fp单位。
- weight: 设置文本的字体粗细，number类型取值[100, 900]，取值间隔为100，默认为400，取值越大，字体越粗。
- family: 设置文本的字体列表。使用多个字体，使用','进行分割，优先级按顺序生效。例如：'Arial, sans-serif'。
- style: 设置文本的字体样式。 | +| enterKeyType | EnterKeyType | 设置输入法回车键类型。
默认值：EnterKeyType.Done | +| caretColor | [ResourceColor](ts-types.md#resourcecolor8) | 设置输入框光标颜色。 | +| maxLength | number | 设置文本的最大输入字符数。 | +| inputFilter8+ | {
value: [ResourceStr](ts-types.md#resourcestr8)8+,
error?: (value: string) => void
} | 正则表达式，满足表达式的输入允许显示，不满足正则表达式的输入被忽略。仅支持单个字符匹配，不支持字符串匹配。例如：^(?=.\*\d)(?=.\*[a-z])(?=.\*[A-Z]).{8,10}$，8到10位的强密码不支持过滤。
- value：设置正则表达式。
- error：正则匹配失败时，返回被忽略的内容。 | ## EnterKeyType枚举说明 @@ -90,9 +85,9 @@ caretPosition(value: number): void **参数：** -| 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 | -| ----- | ------ | ---- | ---- | ---------------------------------------- | -| value | number | 是 | - | 设置输入光标的位置。
value：从字符串开始到光标所在位置的字符长度。 | +| 参数名 | 参数类型 | 必填 | 参数描述 | +| ------ | -------- | ---- | ------------------------------------------------------------ | +| value | number | 是 | 设置输入光标的位置。
value：从字符串开始到光标所在位置的字符长度。 | ## 示例 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 1dcf6750980351550ba965e01d69f01588cced28..028b6a61b14c9729341d8018202f379cb6f16da5 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 @@ -7,11 +7,6 @@ > 该组件从API Version 8开始支持。后续版本如有新增内容，则采用上角标单独标记该内容的起始版本。 -## 权限列表 - -无 - - ## 子组件 无 @@ -25,17 +20,17 @@ TextPicker(options?: {range: string[] | [Resource](ts-types.md#resource), select **参数：** -| 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 | -| -------- | -------- | ---- | ----- | --------------- | -| range | string[] \| [Resource](ts-types.md#resource) | 是 | - | 选择器的数据选择范围。 | -| selected | number | 否 | 0 | 选中项在数组中的index值。 | -| value | string | 否 | 第一个元素值 | 选中项的值，优先级低于selected。 | +| 参数名 | 参数类型 | 必填 | 参数描述 | +| -------- | -------- | ---- | --------------- | +| range | string[] \| [Resource](ts-types.md#resource) | 是 | 选择器的数据选择范围。 | +| selected | number | 否 | 选中项在数组中的index值。
默认值：0 | +| value | string | 否 | 选中项的值，优先级低于selected。
默认值：第一个元素值 | ## 属性 -| 名称 | 参数类型 | 默认值 | 描述 | -| ----------------------- | ---------------- | ------ | -------------------------- | -| defaultPickerItemHeight | number \| string | - | 默认Picker内容项元素高度。 | +| 名称 | 参数类型 | 描述 | +| ----------------------- | ---------------- | -------------------------- | +| defaultPickerItemHeight | number \| string | 默认Picker内容项元素高度。 | ## 事件 diff --git a/zh-cn/application-dev/reference/arkui-ts/ts-basic-gestures-longpressgesture.md b/zh-cn/application-dev/reference/arkui-ts/ts-basic-gestures-longpressgesture.md index 9c0ee70cedd0cf0c0aa98db7f2af2dfe832431ef..968822562d65285622fec9dd220f1890b5eea363 100644 --- a/zh-cn/application-dev/reference/arkui-ts/ts-basic-gestures-longpressgesture.md +++ b/zh-cn/application-dev/reference/arkui-ts/ts-basic-gestures-longpressgesture.md @@ -5,30 +5,25 @@ > 从API Version 7开始支持。后续版本如有新增内容，则采用上角标单独标记该内容的起始版本。 -## 权限列表 - -无 - - ## 接口 -LongPressGesture(options?: { fingers?: number, repeat?: boolean, duration?: number }) +LongPressGesture(value?: { fingers?: number, repeat?: boolean, duration?: number }) **参数：** -| 参数名称 | 参数类型 | 必填 | 默认值 | 参数描述 | -| -------- | ------- | ---- | ----- | -------------------------------- | -| fingers | number | 否 | 1 | 触发长按的最少手指数，最小为1指， 最大取值为10指。 | -| repeat | boolean | 否 | false | 是否连续触发事件回调。 | -| duration | number | 否 | 500 | 最小触发长按的时间，单位为毫秒（ms）。 | +| 参数名称 | 参数类型 | 必填 | 参数描述 | +| -------- | -------- | ---- | ------------------------------------------------------------ | +| fingers | number | 否 | 触发长按的最少手指数，最小为1指， 最大取值为10指。
默认值：1 | +| repeat | boolean | 否 | 是否连续触发事件回调。
默认值：false | +| duration | number | 否 | 最小触发长按的时间，单位为毫秒（ms）。
默认值：500 | ## 事件 -| 名称 | 功能描述 | -| ---------------------------------------- | ------------------------------ | -| onAction((event?: GestureEvent) => void) | LongPress手势识别成功回调。 | -| onActionEnd((event?: GestureEvent) => void) | LongPress手势识别成功，手指抬起后触发回调。 | -| onActionCancel(event: () => void) | LongPress手势识别成功，接收到触摸取消事件触发回调。 | +| 名称 | 功能描述 | +| ------------------------------------------------------------ | --------------------------------------------------- | +| onAction(event: (event?: [GestureEvent](ts-gesture-settings.md)) => void) | LongPress手势识别成功回调。 | +| onActionEnd(event: (event?: [GestureEvent](ts-gesture-settings.md)) => void) | LongPress手势识别成功，手指抬起后触发回调。 | +| onActionCancel(event: () => void) | LongPress手势识别成功，接收到触摸取消事件触发回调。 | ## GestureEvent对象中与LongPress手势相关的属性 diff --git a/zh-cn/application-dev/reference/arkui-ts/ts-basic-gestures-pangesture.md b/zh-cn/application-dev/reference/arkui-ts/ts-basic-gestures-pangesture.md index e68833ad709882e28935663f2e0578c901e9018e..2790bb7d157c54a67d3468c0832ad92fce682e88 100644 --- a/zh-cn/application-dev/reference/arkui-ts/ts-basic-gestures-pangesture.md +++ b/zh-cn/application-dev/reference/arkui-ts/ts-basic-gestures-pangesture.md @@ -1,26 +1,23 @@ # PanGesture +用于触发拖动手势事件，滑动的最小距离为5vp时拖动手势识别成功。 + > **说明：** > > 从API Version 7开始支持。后续版本如有新增内容，则采用上角标单独标记该内容的起始版本。 -## 权限列表 - -无 - - ## 接口 -PanGesture(options?: { fingers?: number, direction?: PanDirection, distance?: number } | [PanGestureOptions](#pangestureoptions)) +PanGesture(value?: { fingers?: number, direction?: PanDirection, distance?: number } | [PanGestureOptions](#pangestureoptions)) **参数：** -| 参数名称 | 参数类型 | 必填 | 默认值 | 参数描述 | -| --------- | ------------ | ---- | ------ | ------------------------------------------------------------ | -| fingers | number | 否 | 1 | 触发滑动的最少手指数，最小为1指， 最大取值为10指。 | -| direction | PanDirection | 否 | All | 设置滑动方向，此枚举值支持逻辑与(&)和逻辑或（\|）运算。 | -| distance | number | 否 | 5.0 | 最小滑动识别距离，单位为vp。
**说明：**
> tab滑动与该拖动手势事件同时存在时，可将distance值设为1，使拖动更灵敏，避免造成事件错乱。 | +| 参数名称 | 参数类型 | 必填 | 参数描述 | +| --------- | ------------ | ---- | ------------------------------------------------------------ | +| fingers | number | 否 | 触发滑动的最少手指数，最小为1指， 最大取值为10指。
默认值：1 | +| direction | PanDirection | 否 | 触发拖动的手势方向，此枚举值支持逻辑与(&)和逻辑或（\|）运算。
默认值：PanDirection.All | +| distance | number | 否 | 最小拖动识别距离，单位为vp。
默认值：5.0
**说明：**
> tab滑动与该拖动手势事件同时存在时，可将distance值设为1，使拖动更灵敏，避免造成事件错乱。 | ## PanDirection枚举说明 @@ -55,12 +52,12 @@ PanGestureOptions(options?: { fingers?: number, direction?: PanDirection, distan ## 事件 -| 名称 | 功能描述 | -| ---------------------------------------- | ------------------------ | -| onActionStart(callback: (event?: GestureEvent) => void) | Pan手势识别成功回调。 | -| onActionUpdate(callback: (event?: GestureEvent) => void) | Pan手势移动过程中回调。 | -| onActionEnd(callback: (event?: GestureEvent) => void) | Pan手势识别成功，手指抬起后触发回调。 | -| onActionCancel(callback: () => void) | Pan手势识别成功，接收到触摸取消事件触发回调。 | +| 名称 | 功能描述 | +| ------------------------------------------------------------ | --------------------------------------------- | +| onActionStart(event: (event?: [GestureEvent](ts-gesture-settings.md)) => void) | Pan手势识别成功回调。 | +| onActionUpdate(event: (event?: [GestureEvent](ts-gesture-settings.md)) => void) | Pan手势移动过程中回调。 | +| onActionEnd(event: (event?: [GestureEvent](ts-gesture-settings.md)) => void) | Pan手势识别成功，手指抬起后触发回调。 | +| onActionCancel(event: () => void) | Pan手势识别成功，接收到触摸取消事件触发回调。 | ## GestureEvent对象中与Pan手势相关的属性 diff --git a/zh-cn/application-dev/reference/arkui-ts/ts-basic-gestures-pinchgesture.md b/zh-cn/application-dev/reference/arkui-ts/ts-basic-gestures-pinchgesture.md index 9a0c0617016eeaba265be78b3ebda0a10704d4aa..6a91265143b898025950c6a711c1694cb604ba58 100644 --- a/zh-cn/application-dev/reference/arkui-ts/ts-basic-gestures-pinchgesture.md +++ b/zh-cn/application-dev/reference/arkui-ts/ts-basic-gestures-pinchgesture.md @@ -5,30 +5,25 @@ > 从API Version 7开始支持。后续版本如有新增内容，则采用上角标单独标记该内容的起始版本。 -## 权限列表 - -无 - - ## 接口 -PinchGesture(options?: { fingers?: number, distance?: number }) +PinchGesture(value?: { fingers?: number, distance?: number }) **参数：** -| 参数名称 | 参数类型 | 必填 | 默认值 | 参数描述 | -| -------- | ------ | ---- | ---- | ----------------------------- | -| fingers | number | 否 | 2 | 触发捏合的最少手指数, 最小为2指，最大为5指。 | -| distance | number | 否 | 3.0 | 最小识别距离，单位为vp。 | +| 参数名称 | 参数类型 | 必填 | 参数描述 | +| -------- | -------- | ---- | ------------------------------------------------------------ | +| fingers | number | 否 | 触发捏合的最少手指数, 最小为2指，最大为5指。
默认值：2 | +| distance | number | 否 | 最小识别距离，单位为vp。
默认值：3.0 | ## 事件 -| 名称 | 功能描述 | -| ---------------------------------------- | -------------------------- | -| onActionStart((event?: GestureEvent) => void) | Pinch手势识别成功回调。 | -| onActionUpdate((event?: GestureEvent) => void) | Pinch手势移动过程中回调。 | -| onActionEnd((event?: GestureEvent) => void) | Pinch手势识别成功，手指抬起后触发回调。 | -| onActionCancel(event: () => void) | Pinch手势识别成功，接收到触摸取消事件触发回调。 | +| 名称 | 功能描述 | +| ------------------------------------------------------------ | ----------------------------------------------- | +| onActionStart(event:(event?: [GestureEvent](ts-gesture-settings.md)) => void) | Pinch手势识别成功回调。 | +| onActionUpdate(event:(event?: [GestureEvent](ts-gesture-settings.md)) => void) | Pinch手势移动过程中回调。 | +| onActionEnd(event:(event?: [GestureEvent](ts-gesture-settings.md)) => void) | Pinch手势识别成功，手指抬起后触发回调。 | +| onActionCancel(event: () => void) | Pinch手势识别成功，接收到触摸取消事件触发回调。 | ## GestureEvent对象中与Pinch手势相关的属性 diff --git a/zh-cn/application-dev/reference/arkui-ts/ts-basic-gestures-rotationgesture.md b/zh-cn/application-dev/reference/arkui-ts/ts-basic-gestures-rotationgesture.md index b7d7b34289a953ae15aa191215dec83e362093bd..e2a12b1b1236e806ec71102fc64bc0a9a33b7cfb 100644 --- a/zh-cn/application-dev/reference/arkui-ts/ts-basic-gestures-rotationgesture.md +++ b/zh-cn/application-dev/reference/arkui-ts/ts-basic-gestures-rotationgesture.md @@ -5,30 +5,25 @@ > 从API Version 7开始支持。后续版本如有新增内容，则采用上角标单独标记该内容的起始版本。 -## 权限列表 - -无 - - ## 接口 -RotationGesture(options?: { fingers?: number, angle?: number }) +RotationGesture(value?: { fingers?: number, angle?: number }) **参数：** -| 参数名称 | 参数类型 | 必填 | 默认值 | 参数描述 | -| ------- | ------ | ---- | ---- | ----------------------------- | -| fingers | number | 否 | 2 | 触发旋转的最少手指数, 最小为2指，最大为5指。 | -| angle | number | 否 | 1.0 | 触发旋转手势的最小改变度数，单位为度数。 | +| 参数名称 | 参数类型 | 必填 | 参数描述 | +| -------- | -------- | ---- | ------------------------------------------------------------ | +| fingers | number | 否 | 触发旋转的最少手指数, 最小为2指，最大为5指。
默认值：2 | +| angle | number | 否 | 触发旋转手势的最小改变度数，单位为度数。
默认值：1.0 | ## 事件 -| 名称 | 功能描述 | -| ---------------------------------------- | ----------------------------- | -| onActionStart((event?: GestureEvent) => void) | Rotation手势识别成功回调。 | -| onActionUpdate((event?: GestureEvent) => void) | Rotation手势移动过程中回调。 | -| onActionEnd((event?: GestureEvent) => void) | Rotation手势识别成功，手指抬起后触发回调。 | -| onActionCancel(event: () => void) | Rotation手势识别成功，接收到触摸取消事件触发回调。 | +| 名称 | 功能描述 | +| ------------------------------------------------------------ | -------------------------------------------------- | +| onActionStart(event: (event?: [GestureEvent](ts-gesture-settings.md)) => void) | Rotation手势识别成功回调。 | +| onActionUpdate(event: (event?: [GestureEvent](ts-gesture-settings.md)) => void) | Rotation手势移动过程中回调。 | +| onActionEnd(event: (event?: [GestureEvent](ts-gesture-settings.md)) => void) | Rotation手势识别成功，手指抬起后触发回调。 | +| onActionCancel(event: () => void) | Rotation手势识别成功，接收到触摸取消事件触发回调。 | ## GestureEvent对象中与Rotation手势相关的属性 diff --git a/zh-cn/application-dev/reference/arkui-ts/ts-basic-gestures-swipegesture.md b/zh-cn/application-dev/reference/arkui-ts/ts-basic-gestures-swipegesture.md index 7ed289a2dbb41da40eafbfad3b991a956ddb61b3..8e7e8cd3f868ef2e864b93033fc2c6311377bf74 100644 --- a/zh-cn/application-dev/reference/arkui-ts/ts-basic-gestures-swipegesture.md +++ b/zh-cn/application-dev/reference/arkui-ts/ts-basic-gestures-swipegesture.md @@ -5,11 +5,6 @@ > 从API Version 8开始支持。后续版本如有新增内容，则采用上角标单独标记该内容的起始版本。 -## 权限列表 - -无 - - ## 接口 SwipeGesture(value?: { fingers?: number; direction?: SwipeDirection; speed?: number }) @@ -32,16 +27,9 @@ SwipeGesture(value?: { fingers?: number; direction?: SwipeDirection; speed?: num ## 事件 -| 名称 | 功能描述 | -| ---------------------------------------- | ----------- | -| onAction(callback:(event?: GestureEvent) => void) | 滑动手势识别成功回调。 | - -## GestureEvent对象中与Swipe手势相关的属性 - -| 参数名 | 类型 | 说明 | -| ----- | ------ | ---------------------------------------- | -| angle | number | 滑动手势的角度，即两根手指间的线段与水平方向的夹角变化的度数。
>  **说明：**
> 角度计算方式：滑动手势被识别到后，连接两根手指之间的线被识别为起始线条，随着手指的滑动，手指之间的线条会发生旋转，根据起始线条两端点和当前线条两端点的坐标，使用反正切函数分别计算其相对于水平方向的夹角，最后arctan2(cy2-cy1,cx2-cx1)-arctan2(y2-y1,x2-x1)为旋转的角度。以起始线条为坐标系，顺时针旋转为0到180度，逆时针旋转为-180到0度。 | -| speed | number | 滑动手势的速度，是所有手指滑动的平均速度，单位为VP/秒。 | +| 名称 | 功能描述 | +| ------------------------------------------------------------ | ---------------------- | +| onAction(event: (event?: [GestureEvent](ts-gesture-settings.md)) => void) | 滑动手势识别成功回调。 | ![zh-cn_image_0000001231374559](figures/zh-cn_image_0000001231374661.png) ## 示例 diff --git a/zh-cn/application-dev/reference/arkui-ts/ts-basic-gestures-tapgesture.md b/zh-cn/application-dev/reference/arkui-ts/ts-basic-gestures-tapgesture.md index 4c332ec0f342a372c72e8a3074c88675d8c2b956..87a7adc53548fb270421ac709452d94bfd236a86 100644 --- a/zh-cn/application-dev/reference/arkui-ts/ts-basic-gestures-tapgesture.md +++ b/zh-cn/application-dev/reference/arkui-ts/ts-basic-gestures-tapgesture.md @@ -5,27 +5,22 @@ > 从API Version 7开始支持。后续版本如有新增内容，则采用上角标单独标记该内容的起始版本。 -## 权限列表 - -无 - - ## 接口 -TapGesture(options?: { count?: number, fingers?: number }) +TapGesture(value?: { count?: number, fingers?: number }) **参数：** -| 参数名称 | 参数类型 | 必填 | 默认值 | 参数描述 | -| ------- | ------ | ---- | ---- | ---------------------------------------- | -| count | number | 否 | 1 | 识别的连续点击次数。如果设置小于1，会被转化为默认值。
>  **说明：**
> 如配置多击，上一次抬起和下一次按下的超时时间为300毫秒（ms）。 | -| fingers | number | 否 | 1 | 触发点击的最少手指数，最小为1指， 最大为10指。
>  **说明：**
> 1. 当配置多指时，第一根手指按下后300毫秒（ms）内未有足够的手指数按下，手势识别失败。
> 
> 2. 实际点击手指数超过配置值，手势识别失败。 | +| 参数名称 | 参数类型 | 必填 | 参数描述 | +| -------- | -------- | ---- | ------------------------------------------------------------ | +| count | number | 否 | 识别的连续点击次数。如果设置小于1，会被转化为默认值。
默认值：1
>  **说明：**
> 如配置多击，上一次抬起和下一次按下的超时时间为300毫秒（ms）。 | +| fingers | number | 否 | 触发点击的最少手指数，最小为1指， 最大为10指。
默认值：1
>  **说明：**
> 1. 当配置多指时，第一根手指按下后300毫秒（ms）内未有足够的手指数按下，手势识别失败。
> 2. 实际点击手指数超过配置值，手势识别失败。 | ## 事件 -| 名称 | 功能描述 | -| ---------------------------------------- | ------------ | -| onAction((event?: [GestureEvent](ts-gesture-settings.md)) => void) | Tap手势识别成功回调。 | +| 名称 | 功能描述 | +| ------------------------------------------------------------ | --------------------- | +| onAction(event: (event?: [GestureEvent](ts-gesture-settings.md)) => void) | Tap手势识别成功回调。 | ## 示例