图案密码锁组件
图案密码锁组件，以九宫格图案的方式输入密码，用于密码验证场景。手指在PatternLock组件区域按下时开始进入输入状态，手指离开屏幕时结束输入状态完成密码输入。
说明
该组件从API Version 9开始支持。后续版本如有新增内容，则采用上角标单独标记该内容的起始版本。
接口
PatternLock(controller?: PatternLockController)
参数:
| 参数名 | 参数类型 | 必填 | 描述 |
|---|---|---|---|
| controller | PatternLockController | 否 | 设置PatternLock组件控制器，可用于控制组件状态重置。 |
属性
不支持除backgroundColor以外的通用属性设置。
| 名称 | 参数类型 | 描述 |
|---|---|---|
| sideLength | Length | 设置组件的宽度和高度（宽高相同）。设置为0或负数等非法值时组件不显示。 默认值：300vp |
| circleRadius | Length | 设置宫格中圆点的半径。 默认值：14vp |
| regularColor | ResourceColor | 设置宫格圆点在“未选中”状态的填充颜色。 默认值：Color.Black |
| selectedColor | ResourceColor | 设置宫格圆点在“选中”状态的填充颜色。 默认值：Color.Black |
| activeColor | ResourceColor | 设置宫格圆点在“激活”状态的填充颜色（“激活”状态为手指经过圆点但还未选中的状态）。 默认值：Color.Black |
| pathColor | ResourceColor | 设置连线的颜色。 默认值：Color.Blue |
| pathStrokeWidth | number | string | 设置连线的宽度。设置为0或负数等非法值时连线不显示。 默认值：34vp |
| autoReset | boolean | 设置在完成密码输入后再次在组件区域按下时是否重置组件状态。设置为true，完成密码输入后再次在组件区域按下时会重置组件状态（即清除之前输入的密码）；反之若设置为false，则不会重置组件状态。 默认值：true |
事件
除支持通用事件外，还支持以下事件：
| 名称 | 描述 |
|---|---|
| onPatternComplete(callback: (input: Array<number>) => void) | 密码输入结束时触发该回调。 input: 与选中宫格圆点顺序一致的数字数组，数字为选中宫格圆点的索引值（第一行圆点从左往右依次为0,1,2，第二行圆点依次为3,4,5，第三行圆点依次为6,7,8）。 |
示例
- // xxx.ets
- @Entry
- @Component
- struct PatternLockExample {
- @State passwords: Number[] = []
- @State message: string = 'please input password!'
- private patternLockController: PatternLockController = new PatternLockController()
- build() {
- Column() {
- Text(this.message).textAlign(TextAlign.Center).margin(20).fontSize(20)
- PatternLock(this.patternLockController)
- .sideLength(200)
- .circleRadius(9)
- .pathStrokeWidth(18)
- .activeColor('#B0C4DE')
- .selectedColor('#228B22')
- .pathColor('#90EE90')
- .backgroundColor('#F5F5F5')
- .autoReset(true)
- .onPatternComplete((input: Array<number>) => {
- // 输入的密码长度小于5时，提示重新输入
- if (input === null || input === undefined || input.length < 5) {
- this.message = 'The password length needs to be greater than 5, please enter again.'
- return
- }
- // 判断密码长度是否大于0
- if (this.passwords.length > 0) {
- // 判断两次输入的密码是否相同，相同则提示密码设置成功，否则提示重新输入
- if (this.passwords.toString() === input.toString()) {
- this.passwords = input
- this.message = 'Set password successfully: ' + this.passwords.toString()
- } else {
- this.message = 'Inconsistent passwords, please enter again.'
- }
- } else {
- // 提示第二次输入密码
- this.passwords = input
- this.message = "Please enter again."
- }
- })
- Button('Reset PatternLock').margin(30).onClick(() => {
- // 重置密码锁
- this.patternLockController.reset()
- this.passwords = []
- this.message = 'Please input password'
- })
- }.width('100%').height('100%')
- }
- }
