From 569463efd72a45147a5c6aa2be4ebf739581b2cd Mon Sep 17 00:00:00 2001 From: Yao yuchi Date: Thu, 24 Feb 2022 20:56:36 +0800 Subject: [PATCH] pattern lock api docs modify Signed-off-by: Yao yuchi --- .../ts-basic-components-patternlock.md | 58 +++++++++++-------- 1 file changed, 34 insertions(+), 24 deletions(-) diff --git a/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-patternlock.md b/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-patternlock.md index a23cc9107c..22199f7261 100644 --- a/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-patternlock.md +++ b/zh-cn/application-dev/reference/arkui-ts/ts-basic-components-patternlock.md @@ -2,13 +2,15 @@ > ![icon-note.gif](public_sys-resources/icon-note.gif) **说明：** 该组件从API Version 8开始支持。后续版本如有新增内容，则采用上角标单独标记该内容的起始版本。 -图案密码锁组件，以宫格图案的方式输入密码，用于密码验证。 +图案密码锁组件，以宫格图案的方式输入密码，用于密码验证。手指触碰图案密码锁时开始进入输入状态，手指离开屏幕时结束输入状态并向应用返回输入的密码。 -手指触碰图案密码锁时开始进入输入状态，手指离开屏幕时结束输入状态并向应用返回输入的密码。 +## 权限列表 + +无 ## 子组件 -无。 +无 ## 接口 @@ -16,32 +18,40 @@ PatternLock(controller?: PatternLockController) - 参数 - | 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 | - | ---------- | --------------------- | ---- | ------ | -------------------------------------------- | - | controller | PatternLockController | 否 | null | 给组件绑定一个控制器，用来控制组件状态重置。 | + | 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 | + | ---------- | ----------------------------------------------- | ---- | ------ | -------------------------------------------- | + | controller | [PatternLockController](#PatternLockController) | 否 | null | 给组件绑定一个控制器，用来控制组件状态重置。 | -- PatternLockController +## 属性 - PatternLock组件的控制器，可以将此对象绑定至PatternLock组件，然后通过它进行状态重置。 +不支持`backgroundColor`以外的通用属性设置。 - | 接口名称 | 功能描述 | - | ------------- | -------------- | - | reset():void; | 重置组件状态。 | +| 名称 | 参数类型 | 默认值 | 描述 | +| --------------- | -------------------------------------------------------- | ----------- | ------------------------------------------------------------ | +| sideLength | Length | 300vp | 设置组件的宽度和高度（相同值）。最小可以设置为0。 | +| circleRadius | Length | 14vp | 设置宫格圆点的半径。 | +| regularColor | [ResourceColor](../../ui/ts-types.md#resourcecolor类型8) | Color.Black | 设置宫格圆点在“未选中”状态的填充颜色。 | +| selectedColor | [ResourceColor](../../ui/ts-types.md#resourcecolor类型8) | Color.Black | 设置宫格圆点在“选中”状态的填充颜色。 | +| activeColor | [ResourceColor](../../ui/ts-types.md#resourcecolor类型8) | Color.Black | 设置宫格圆点在“激活”状态的填充颜色。 | +| pathColor | [ResourceColor](../../ui/ts-types.md#resourcecolor类型8) | Color.Blue | 设置连线的颜色。 | +| pathStrokeWidth | Length | 34vp | 设置连线的宽度。最小可以设置为0。 | +| autoReset | boolean | true | 设置是否支持用户在完成输入后再次触屏重置组件状态。如果设置为true，用户可以通过触摸图案密码锁重置组件状态（清除之前的输入效果）；如果设置为false，用户手指离开屏幕完成输入后，再次触摸图案密码锁（包括圆点）不能改变之前的输入状态。 | -## 属性 +## PatternLockController + +PatternLock组件的控制器，可以将此对象绑定至PatternLock组件，然后通过它进行状态重置。 + +### 导入对象 + +```typescript +patternLockController: PatternLockController = new PatternLockController() +``` + +### patternLockController.reset + +reset():void -不支持*`backgroundColor`*以外的通用属性设置。 - -| 名称 | 参数类型 | 默认值 | 描述 | -| --------------- | ------------- | ----------- | ------------------------------------------------------------ | -| sideLength | Length | 300vp | 设置组件的宽度和高度（相同值）。最小可以设置为0。 | -| circleRadius | Length | 14vp | 设置宫格圆点的半径。 | -| regularColor | ResourceColor | Color.Black | 设置宫格圆点在“未选中”状态的填充颜色。 | -| selectedColor | ResourceColor | Color.Black | 设置宫格圆点在“选中”状态的填充颜色。 | -| activeColor | ResourceColor | Color.Black | 设置宫格圆点在“激活”状态的填充颜色。 | -| pathColor | ResourceColor | Color.Blue | 设置连线的颜色。 | -| pathStrokeWidth | Length | 34vp | 设置连线的宽度。最小可以设置为0。 | -| autoReset | boolean | true | 设置是否支持用户在完成输入后再次触屏重置组件状态。如果设置为true，用户可以通过触摸图案密码锁重置组件状态（清除之前的输入效果）；如果设置为false，用户手指离开屏幕完成输入后，再次触摸图案密码锁（包括圆点）不能改变之前的输入状态。 | +重置组件状态。 ## 事件 -- GitLab