api.md 28.2 KB
Newer Older
W
wan201809 已提交
1 2
# API

study夏羽's avatar
study夏羽 已提交
3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383
## program

program 是uni-automator自动注入的全局对象


### 方法

#### program.pageStack

获取页面堆栈。

`program.pageStack(): Promise<Page[]> `


#### program.navigateTo

保留当前页面,跳转到应用内的某个页面,同 `uni.navigateTo`

`program.navigateTo(url: string): Promise<Page>`


|字段|类型|必填|默认值|说明|
|:-:|:-:|:-:|:-:|:-:|
|url|string|是|-|需要跳转的应用内非 tabBar 的页面的路径|

示例代码:

```
  const page = await program.navigateTo('/pages/index/index')
  console.log(page.path)// -> 'page/index/index'
```



#### program.redirectTo

关闭当前页面,跳转到应用内的某个页面,同 `uni.redirectTo`

`program.redirectTo(url: string): Promise<Page>`

|字段|类型|必填|默认值|说明|
|:-:|:-:|:-:|:-:|:-:|
|url|string|是|-|需要跳转的应用内非 tabBar 的页面的路径|


#### program.navigateBack

关闭当前页面,返回上一页面或多级页面,同 `uni.navigateBack`


`program.navigateBack(): Promise<Page>`



#### program.reLaunch

关闭所有页面,打开到应用内的某个页面,同 `uni.reLaunch`

`program.reLaunch(url: string): Promise<Page>`


|字段|类型|必填|默认值|说明|
|:-:|:-:|:-:|:-:|:-:|
|url|string|是|-|需要跳转的应用内页面路径|


#### program.switchTab

跳转到 tabBar 页面,并关闭其他所有非 tabBar 页面,同 `uni.switchTab`


`program.switchTab(url: string): Promise<Page>`


|字段|类型|必填|默认值|说明|
|:-:|:-:|:-:|:-:|:-:|
|url|string|是|-|需要跳转的 tabBar 页面的路径|


#### program.currentPage

获取当前页面。

`program.currentPage(): Promise<Page>`


#### program.systemInfo

获取系统信息,同 `uni.getSystemInfo`


`program.systemInfo(): Promise<Object>`


示例代码:

```
	const systemInfo = await program.systemInfo()
	if (systemInfo.uniPlatform === 'devtools') {
		// Do something
	}
```



#### program.pageScrollTo

将页面滚动到目标位置,同 `uni.pageScrollTo`


`program.pageScrollTo(scrollTop: number): Promise<void>`


|字段|类型|必填|默认值|说明|
|:-:|:-:|:-:|:-:|:-:|
|scrollTop|number|是|-|滚动到页面的目标位置,单位 px|

示例代码:

```
   const page = await program.currentPage()
   await program.pageScrollTo(20)
   console.log(await page.scrollTop())
```




#### program.callUniMethod

调用 uni 对象上的指定方法。


`program.callUniMethod(method: string, ...args: any[]): Promise<any>`


|字段|类型|必填|默认值|说明|
|:-:|:-:|:-:|:-:|:-:|
|method|string|是|-|需要调用的方法名|
|...args|`array<any>`|否|-|方法参数|

调用异步方法时无需传入 success 及 fail 回调函数。

示例代码:

```
	await program.callUniMethod('setStorage', {
	  key: 'test',
	  data: '123456'
	})
	const data = await program.callUniMethod('getStorageSync', 'test')
	console.log(data) // -> '123456'
```



#### program.screenshot

对当前页面截图,目前只有开发者工具模拟器支持,客户端无法使用。

`program.screenshot(options?: Object): Promise<string | void>`


|字段|类型|必填|默认值|说明|
|:-:|:-:|:-:|:-:|:-:|
|options|Object|否|-|截图选项|

如果不传 options,该方法返回图片数据的 base64 编码。

options 字段定义如下:

|字段|类型|必填|默认值|说明|
|:-:|:-:|:-:|:-:|:-:|
|path|string|是|-|图片保存路径|


```
	it('screenshot', async () => {
		await program.screenshot({
			path: "static/screenshot.png" // 默认项目根目录
		})
	});
```



#### program.mockUniMethod

覆盖 uni 对象上指定方法的调用结果。

利用该接口,你可以很方便地直接指定 `uni.chooseLocation` 等调用系统组件的返回结果。


`program.mockUniMethod(method: string, result: any): Promise<void> `


参数说明

|字段|类型|必填|默认值|说明|
|:-:|:-:|:-:|:-:|:-:|
|method|string|是|-|需要覆盖的方法名|
|result|any|是|-|指定调用结果|


`program.mockUniMethod(method: string, fn: Function | string, ...args: any[]): Promise<void>`

参数说明

|字段|类型|必填|默认值|说明|
|:-:|:-:|:-:|:-:|:-:|
|method|string|是|-|需要覆盖的方法名|
|fn|Function string|是|-|处理返回函数|
|...args|`array<any>`|否|-|传入参数|


> fn 同 program.evaluate 的 appFunction 参数一样,无法使用闭包来引用外部变量。此外,你还可以在方法内使用 this.origin 来调用原始方法。


示例代码:

```
	await program.mockUniMethod('showModal', {
		confirm: true,
		cancel: false
	})

	await program.mockUniMethod(
		'getStorageSync',
		function(key, defVal) {
			if (key === 'name') return 'redhoodsu'
			if (key === 'sex') return 'male'
			return defVal
		},
		'unknown',
  )
  // 调用 uni.getStorageSync('name') 返回 'redhoodsu'

  // 更改 getSystemInfo 中的 platform 字段
	await program.mockUniMethod(
		'getSystemInfo',
		function(obj, platform) {
			return new Promise(resolve => {
				// origin 指向原始方法
				this.origin({
					success(res) {
						res.platform = platform
						resolve(res)
					},
				})
			})
		},
		'test',
	)
```


#### program.restoreUniMethod

重置 uni 指定方法,消除 mockUniMethod 调用的影响。

`program.restoreUniMethod(method: string): Promise<void>`


|字段|类型|必填|默认值|说明|
|:-:|:-:|:-:|:-:|:-:|
|method|string|是|-|需要覆盖的方法名|


示例代码:

```
	console.log(await program.callUniMethod('getStorageSync', 'test')) // -> ''
	await program.mockUniMethod('getStorageSync', 'mockValue')
	console.log(await program.callUniMethod('getStorageSync', 'test')) // -> 'mockValue'
	await program.restoreUniMethod('getStorageSync')
	console.log(await program.callUniMethod('getStorageSync', 'test')) // -> ''
```



#### program.evaluate

注入代码片段并返回执行结果。(仅微信小程序支持)

`program.evaluate(appFunction: Function | string, ...args: any[]): Promise<any>`

|字段|类型|必填|默认值|说明|
|:-:|:-:|:-:|:-:|:-:|
|appFunction|Function string|是|-|代码片段|
|...args|`array<any>`|否|-|执行时传入参数|

> appFunction 最终会被序列化传递到开发者工具,因此你无法在函数中利用闭包来引用外部变量。也就是说,传递 function () {} 函数事实上等同于传递其字符串。

示例代码:

```
	let systemInfo = await program.evaluate(() => {
		return new Promise(resolve => {
			uni.getSystemInfo({
				success(result) {
					resolve(result)
				}
			})
		})
	})
	systemInfo = await program.evaluate(() => {
		return uni.getSystemInfoSync()
	})
	console.log(systemInfo)
	await program.evaluate(key => {
		uni.setStorageSync(key, 'test')
	}, 'test')
	const hasLogin = await program.evaluate(() => getApp().globalData.hasLogin)
	console.log(hasLogin)
```



#### program.testAccounts

获取多账号调试中已添加的用户列表。(仅微信小程序支持)


`program.testAccounts(): Promise<Account[]>`

Account 字段定义如下:


|字段|类型|说明|
|:-:|:-:|:-:|
|nickName|string|用户昵称|
|openid|string|账号 openid|

示例代码:

```
	const testAccounts = await program.testAccounts()
	for (let i = 0, len = testAccounts.length; i < len; i++) {
		const miniProgram = await automator.launch({
			projectPath: 'path/to/project',
			account: testAccounts[i].openid
		})
		// 控制多个用户登录的不同小程序
	}
```


#### program.exposeFunction

在全局暴露方法,供小程序侧调用测试脚本中的方法(仅微信小程序支持)


`program.exposeFunction(name: string, bindingFunction: Function): Promise<void>`


|字段|类型|必填|默认值|说明|
|:-:|:-:|:-:|:-:|:-:|
|name|string|是|-|全局方法名|
|bindingFunction|Function|是|-|脚本方法|

> 你可以利用该方法来监听事件,不支持在小程序侧获取调用结果。


示例代码:

```
	await program.exposeFunction('onAppShow', options => {
		// Do something... 
	})
	await program.evaluate(function() {
		uni.onAppShow(function(options) {
			onAppShow(options)
		})
	})
```





## Page
Q
qiang 已提交
384 385 386

Page 模块提供了控制页面的方法。

study夏羽's avatar
study夏羽 已提交
387
### 属性
Q
qiang 已提交
388

study夏羽's avatar
study夏羽 已提交
389
#### page.path
Q
qiang 已提交
390 391 392 393 394

页面路径。

`page.path: string`

study夏羽's avatar
study夏羽 已提交
395
#### page.query
Q
qiang 已提交
396 397 398 399 400

页面参数。
`page.query: Object`


study夏羽's avatar
study夏羽 已提交
401
### 方法
Q
qiang 已提交
402

study夏羽's avatar
study夏羽 已提交
403
#### page.$
Q
qiang 已提交
404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422

获取页面元素。

`page.$(selector: string): Promise<Element>`

参数说明

|字段|类型|必填|默认值|说明|
|:-:|:-:|:-:|:-:|:-:|
|selector|string|是|-|选择器|

示例代码:
```
  const page = await program.currentPage()
  const element = await page.$('.index-desc')
  console.log(element.tagName) // 'view'
```


study夏羽's avatar
study夏羽 已提交
423
#### page.$$
Q
qiang 已提交
424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444

获取页面元素数组。

`page.$$(selector: string): Promise<Element[]>`


参数说明

|字段|类型|必填|默认值|说明|
|:-:|:-:|:-:|:-:|:-:|
|selector|string|是|-|选择器|

该方法跟 $ 一样均无法选择自定义组件内的元素,请使用 element.$。

示例代码:
```
  const page = await program.currentPage()
  const elements = await page.$$('.list-text')
  console.log(elements.length)
```

study夏羽's avatar
study夏羽 已提交
445
#### page.waitFor
Q
qiang 已提交
446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475

等待直到指定条件成立。

`page.waitFor(condition: string | number | Function): Promise<void>`


参数说明

|字段|类型|必填|默认值|说明|
|:-:|:-:|:-:|:-:|:-:|
|condition|string number Function|是|-|等待条件|


如果条件是 `string` 类型,那么该参数会被当成选择器,当该选择器选中元素个数不为零时,结束等待。

如果条件是 `number` 类型,那么该参数会被当成超时时长,当经过指定时间后,结束等待。

如果条件是 `Function` 类型,那么该参数会被当成断言函数,当该函数返回真值时,结束等待。


示例代码:
```
  const page = await program.currentPage()
  await page.waitFor(5000) // 等待 5 秒
  await page.waitFor('picker') // 等待页面中出现 picker 元素
  await page.waitFor(async () => {
    return (await page.$$('picker')).length > 5
  }) // 等待页面中 picker 元素数量大于 5
```

study夏羽's avatar
study夏羽 已提交
476
#### page.data
Q
qiang 已提交
477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495

获取页面渲染数据。

`page.data(path?: string): Promise<Object>`


参数说明

|字段|类型|必填|默认值|说明|
|:-:|:-:|:-:|:-:|:-:|
|path|string|否|-|数据路径|

示例代码:
```
  const page = await program.currentPage()
  console.log(await page.data('list'))
```


study夏羽's avatar
study夏羽 已提交
496
#### page.setData
Q
qiang 已提交
497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517

设置页面渲染数据。

`page.setData(data: Object): Promise<void>`


参数说明

|字段|类型|必填|默认值|说明|
|:-:|:-:|:-:|:-:|:-:|
|data|Object|是|-|要改变的数据|

示例代码:
```
  const page = await program.currentPage()
  await page.setData({
    text: 'changed data'
  })
```


study夏羽's avatar
study夏羽 已提交
518
#### page.size
Q
qiang 已提交
519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540

获取页面大小。

`page.size(): Promise<Object>`


返回值说明

|字段|类型|说明|
|:-:|:-:|:-:|
|width|number|页面可滚动宽度|
|height|number|页面可滚动高度|


示例代码:
```
  const page = await program.currentPage()
  const { width, height } = await page.size()
  console.log(width, height)
```


study夏羽's avatar
study夏羽 已提交
541
#### page.scrollTop
Q
qiang 已提交
542 543 544 545 546 547 548 549 550 551 552 553 554 555

获取页面滚动位置。

`page.scrollTop(): Promise<number>`


示例代码:
```
  const page = await program.currentPage()
  await program.pageScrollTo(20)
  console.log(await page.scrollTop())
```


study夏羽's avatar
study夏羽 已提交
556
#### page.callMethod
Q
qiang 已提交
557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578

调用页面指定方法。

`page.callMethod(method: string, ...args: any[]): Promise<any>`


参数说明

|字段|类型|必填|默认值|说明|
|:-:|:-:|:-:|:-:|:-:|
|method|string|是|-|需要调用的方法名|
|...args|array|否|-|方法参数|


示例代码:
```
  const page = await program.currentPage()
  await page.callMethod('onShareAppMessage')
```



study夏羽's avatar
study夏羽 已提交
579
## Element
Q
qiang 已提交
580 581
Element 模块提供了控制页面元素的方法。

study夏羽's avatar
study夏羽 已提交
582
### 属性
Q
qiang 已提交
583

study夏羽's avatar
study夏羽 已提交
584
#### element.tagName
Q
qiang 已提交
585 586 587 588 589 590

标签名,小写。

`element.tagName: string`


study夏羽's avatar
study夏羽 已提交
591
### 方法
Q
qiang 已提交
592

study夏羽's avatar
study夏羽 已提交
593
#### element.$
Q
qiang 已提交
594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614

在元素范围内获取元素。

`element.$(selector: string): Promise<Element>`


参数说明

|字段|类型|必填|默认值|说明|
|:-:|:-:|:-:|:-:|:-:|
|selector|string|是|-|选择器|

示例代码:
```
  const page = await program.currentPage()
  let element = await page.$('.index-hd')
  element = await element.$('.index-desc')
  console.log(await element.text())
```


study夏羽's avatar
study夏羽 已提交
615
#### element.$$
Q
qiang 已提交
616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636

在元素范围内获取元素数组。

`element.$$(selector: string): Promise<Element[]>`


参数说明

|字段|类型|必填	|默认值|说明|
|:-:|:-:|:-:|:-:|:-:|
|selector|string|是|-|选择器|

示例代码:
```
  const page = await program.currentPage()
  const element = await page.$('.index-bd')
  const elements = await element.$$('.list-text')
  console.log(await elements[0].text())
```


study夏羽's avatar
study夏羽 已提交
637
#### element.size
Q
qiang 已提交
638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659

获取元素大小。

`element.size(): Promise<Object>`


返回值说明

|字段|类型|说明|
|:-:|:-:|:-:|
|width|number|元素宽度|
|height|number|元素高度|

示例代码:
```
  const page = await program.currentPage()
  const element = await page.$('.index-bd')
  const { width, height } = await element.size()
  console.log(width, height)
```


study夏羽's avatar
study夏羽 已提交
660
#### element.offset
Q
qiang 已提交
661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685

获取元素绝对位置。

`element.offset(): Promise<Object>`


返回值说明

|字段|类型|说明|
|:-:|:-:|:-:|
|left|number|左上角x坐标,单位:px|
|top|number|左上角y坐标,单位:px|

坐标信息以页面左上角为原点。


示例代码:
```
  const page = await program.currentPage()
  const element = await page.$('.index-bd')
  const { left top } = await element.offset()
  console.log(left, top)
```


study夏羽's avatar
study夏羽 已提交
686
#### element.text
Q
qiang 已提交
687 688 689 690 691 692 693 694 695 696 697 698 699 700

获取元素文本。

`element.text(): Promise<string>`


示例代码:
```
  const page = await program.currentPage()
  const element = await page.$('.index-desc')
  console.log(await element.text())
```


study夏羽's avatar
study夏羽 已提交
701
#### element.attribute
Q
qiang 已提交
702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721

获取元素特性。

`element.attribute(name: string): Promise<string>`


参数说明

|字段|类型|必填|默认值|说明|
|:-:|:-:|:-:|:-:|:-:|
|name|string|是|-|特性名|

示例代码:
```
  const page = await program.currentPage()
  const element = await page.$('.logo')
  console.log(await element.attribute('src')) // -> 'static/logo.png'
```


study夏羽's avatar
study夏羽 已提交
722
#### element.property
Q
qiang 已提交
723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751

获取元素属性。

`element.property(name: string): Promise<any>`


参数说明

|字段|类型|必填|默认值|说明|
|:-:|:-:|:-:|:-:|:-:|
|name|string|是|-|属性名|

`element.property``element.attribute` 主要区别如下:

`element.attribute` 获取的是标签上的值,因此它的返回类型一定是字符串,element.property 则不一定。

`element.attribute` 可以获取到 class 和 id 之类的值,element.property 不行。

`element.property` 可以获取到文档里对应组件列举的大部分属性值,比如表单 input 等组件的 value 值。


示例代码:
```
  const page = await program.currentPage()
  const element = await page.$('input')
  console.log(await element.property('value'))
```


study夏羽's avatar
study夏羽 已提交
752
#### element.html
Q
qiang 已提交
753 754 755 756 757 758

获取元素 HTML。

`element.html(): Promise<string>`


study夏羽's avatar
study夏羽 已提交
759
#### element.outerHtml
Q
qiang 已提交
760 761 762 763 764 765 766 767 768 769 770 771 772 773 774

同 html,只是会获取到元素本身。

`element.outerHtml(): Promise<string>`


示例代码:
```
  const page = await program.currentPage()
  const element = await page.$('.index-desc')
  console.log(await element.html())
  console.log(await element.outerHtml())
```


study夏羽's avatar
study夏羽 已提交
775
#### element.value
Q
qiang 已提交
776 777 778 779 780 781 782 783 784 785 786 787 788 789

获取元素值。

`element.value(): Promise<string>`


示例代码:
```
  const page = await program.currentPage()
  const element = await page.$('.input')
  console.log(await element.value())
```


study夏羽's avatar
study夏羽 已提交
790
#### element.style
Q
qiang 已提交
791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810

获取元素样式值。

`element.style(name: string): Promise<string>`


参数说明

|字段|类型|必填|默认值|说明|
|:-:|:-:|:-:|:-:|:-:|
|name|string|是|-|样式名|

示例代码:
```
  const page = await program.currentPage()
  const element = await page.$('.index-desc')
  console.log(await element.style('color')) // -> 'rgb(128, 128, 128)'
```


study夏羽's avatar
study夏羽 已提交
811
#### element.tap
Q
qiang 已提交
812 813 814 815 816 817 818 819 820 821 822 823 824 825

点击元素。

`element.tap(): Promise<void>`


示例代码:
```
  const page = await program.currentPage()
  const element = await page.$('.list-item-hd')
  await element.tap()
```


study夏羽's avatar
study夏羽 已提交
826
#### element.longpress
Q
qiang 已提交
827 828 829 830 831 832

长按元素。

`element.longpress(): Promise<void>`


study夏羽's avatar
study夏羽 已提交
833
#### element.touchstart
Q
qiang 已提交
834 835 836 837 838 839 840 841 842 843 844 845 846 847

手指开始触摸元素。

`element.touchstart(options: Object): Promise<void>`


options 字段定义如下:

|字段|类型|必填|默认值|说明|
|:-:|:-:|:-:|:-:|:-:|
|touches|array|是|-|触摸事件,当前停留在屏幕中的触摸点信息的数组|
|changedTouches|array|是|-|触摸事件,当前变化的触摸点信息的数组|


study夏羽's avatar
study夏羽 已提交
848
#### element.touchmove
Q
qiang 已提交
849 850 851 852 853 854 855 856

手指触摸元素后移动。

`element.touchmove(options: Object): Promise<void>`

options 字段同 touchstart。


study夏羽's avatar
study夏羽 已提交
857
#### element.touchend
Q
qiang 已提交
858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897

手指结束触摸元素。

`element.touchend(options: Object): Promise<void>`

options 字段同 touchstart。


```
  const page = await program.currentPage()
  const element = await page.$('.touch')
  await element.touchstart({
    touches: [
      {
        identifier: 1,
        pageX: 500,
        pageY: 500
      }
    ],
    changedTouches: [
      {
        identifier: 1,
        pageX: 500,
        pageY: 500
      }
    ]
  })
  await element.touchend({
    touches: [],
    changedTouches: [
      {
        identifier: 1,
        pageX: 500,
        pageY: 500
      }
    ]
  })
```


study夏羽's avatar
study夏羽 已提交
898
#### element.trigger
Q
qiang 已提交
899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920

触发元素事件。

`element.trigger(type: string, detail?: Object): Promise<void>`


参数说明

|字段|类型|必填|默认值|说明|
|:-:|:-:|:-:|:-:|:-:|
|type|string|是|-|触发事件类型|
|detail|Object|否|-|触发事件时传递的 detail 值|

示例代码:
```
  const page = await program.currentPage()
  const element = await page.$('picker')
  await element.trigger('change', { value: 1 })
```
该方法无法改变组件状态,仅触发响应方法,也无法触发用户操作事件,即 `tap``longpress` 等事件,请使用对应的其它方法调用。


study夏羽's avatar
study夏羽 已提交
921
#### element.input
Q
qiang 已提交
922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941

输入文本,仅 input、textarea 组件可以使用。

`element.input(value: string): Promise<void>`


参数说明

|字段|类型|必填|默认值|说明|
|:-:|:-:|:-:|:-:|:-:|
|value|string|是|-|需要输入的文本|

示例代码:
```
  const page = await program.currentPage()
  const element = await page.$('input')
  await element.input('test')
```


study夏羽's avatar
study夏羽 已提交
942
#### element.callMethod
Q
qiang 已提交
943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963

调用组件实例指定方法,仅自定义组件可以使用。

`element.callMethod(method: string, ...args: any[]): Promise<any>`


参数说明

|字段|类型|必填|默认值|说明|
|:-:|:-:|:-:|:-:|:-:|
|method|string|是|-|需要调用的方法名|
|...args|array|否|-|方法参数|

示例代码:
```
  const page = await program.currentPage()
  const element = await page.$('set-tab-bar')
  await element.callMethod('navigateBack')
```


study夏羽's avatar
study夏羽 已提交
964
#### element.data
Q
qiang 已提交
965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984

获取组件实例渲染数据,仅自定义组件可以使用。

`element.data(path?: string): Promise<Object>`


参数说明

|字段|类型|必填|默认值|说明|
|:-:|:-:|:-:|:-:|:-:|
|path|string|否|-|数据路径|

示例代码:
```
  const page = await program.currentPage()
  const element = await page.$('set-tab-bar')
  console.log(await element.data('hasSetTabBarBadge'))
```


study夏羽's avatar
study夏羽 已提交
985
#### element.setData
Q
qiang 已提交
986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007

设置组件实例渲染数据,仅自定义组件可以使用。

`element.setData(data: Object): Promise<void>`


参数说明

|字段|类型|必填|默认值|说明|
|:-:|:-:|:-:|:-:|:-:|
|data|Object|是|-|要改变的数据|

示例代码:
```
  const page = await program.currentPage()
  const element = await page.$('set-tab-bar')
  await page.setData({
    hasSetTabBarBadge: true
  })
```


study夏羽's avatar
study夏羽 已提交
1008
#### element.callContextMethod
Q
qiang 已提交
1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030

调用上下文 Context 对象方法,仅 video 组件可以使用。

`element.callContextMethod(method: string, ...args: any[]): Promise<any>`


参数说明

|字段|类型|必填|默认值|说明|
|:-:|:-:|:-:|:-:|:-:|
|method|string|是|-|需要调用的方法名|
|...args|array|否|-|方法参数|

video 组件必须设置了 id 才能使用。

```
  const page = await program.currentPage()
  const element = await page.$('video')
  await element.callContextMethod('play')
```


study夏羽's avatar
study夏羽 已提交
1031
#### element.scrollWidth
Q
qiang 已提交
1032 1033 1034 1035 1036 1037

获取滚动宽度,仅 scroll-view 组件可以使用。

`element.scrollWidth(): Promise<number>`


study夏羽's avatar
study夏羽 已提交
1038
#### element.scrollHeight
Q
qiang 已提交
1039 1040 1041 1042 1043 1044

获取滚动高度,仅 scroll-view 组件可以使用。

`element.scrollHeight(): Promise<number>`


study夏羽's avatar
study夏羽 已提交
1045
#### element.scrollTo
Q
qiang 已提交
1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067

滚动到指定位置,仅 scroll-view 组件可以使用。

`element.scrollTo(x: number, y: number): Promise<void>`


参数说明

|字段|类型|必填|默认值|说明|
|:-:|:-:|:-:|:-:|:-:|
|x|number|是|-|横向滚动位置|
|y|number|是|-|纵向滚动位置|

示例代码:
```
  const page = await program.currentPage()
  const element = await page.$('scroll-view')
  const y = (await element.scrollHeight()) - 50
  await element.scrollTo(0, y)
```


study夏羽's avatar
study夏羽 已提交
1068
#### element.swipeTo
Q
qiang 已提交
1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088

滑动到指定滑块,仅 swiper 组件可以使用。

`element.swipeTo(index: number): Promise<void>`


参数说明

|字段|类型|必填|默认值|说明|
|:-:|:-:|:-:|:-:|:-:|
|index|number|是|-|目标滑块的 index|

示例代码:
```
  const page = await program.currentPage()
  const element = await page.$('swiper')
  await element.swipeTo(2)
```


study夏羽's avatar
study夏羽 已提交
1089
#### element.moveTo
Q
qiang 已提交
1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110

移动视图容器,仅 movable-view 组件可以使用。

`element.moveTo(x: number, y: number): Promise<void>`


参数说明

|字段|类型|必填|默认值|说明|
|:-:|:-:|:-:|:-:|:-:|
|x|number|是|-|x 轴方向的偏移|
|y|number|是|-|y 轴方向的偏移|

示例代码:
```
  const page = await program.currentPage()
  const element = await page.$('movable-view')
  await element.moveTo(40, 40)
```


study夏羽's avatar
study夏羽 已提交
1111
#### element.slideTo
Q
qiang 已提交
1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132

滑动到指定数值,仅 slider 组件可以使用。

`element.slideTo(value: number): Promise<void>`


参数说明

|字段|类型|必填|默认值|说明|
|:-:|:-:|:-:|:-:|:-:|
|value|number|是|-|要设置的值|


示例代码:
```
  const page = await program.currentPage()
  const element = await page.$('slider')
  await element.slideTo(10)
```


study夏羽's avatar
study夏羽 已提交
1133
## 平台差异
Q
qiang 已提交
1134

study夏羽's avatar
study夏羽 已提交
1135
### program(全局对象)
Q
qiang 已提交
1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155

|方法							|APP-NVUE	|APP-VUE|H5	|微信小程序	|百度小程序	|说明																																|
|--								|--				|--			|--	|--					|--					|--																																	|
|pageStack				|√				|√			|√	|√					|√					|获取小程序页面堆栈																									|
|navigateTo				|√				|√			|√	|√					|√					|保留当前页面,跳转到应用内的某个页面,同`uni.navigateTo`						|
|redirectTo				|√				|√			|√	|√					|√					|关闭当前页面,跳转到应用内的某个页面,同`uni.redirectTo`						|
|navigateBack			|√				|√			|√	|√					|√					|关闭当前页面,返回上一页面,同`uni.navigateBack`										|
|reLaunch					|√				|√			|√	|√					|√					|关闭所有页面,打开到应用内的某个页面,同`uni.reLaunch`							|
|switchTab				|√				|√			|√	|√					|√					|跳转到 tabBar 页面,并关闭其他所有非 tabBar 页面,同`uni.switchTab`|
|currentPage			|√				|√			|√	|√					|√					|获取当前页面																												|
|systemInfo				|√				|√			|√	|√					|√					|获取系统信息,同`uni.getSystemInfo`																|
|pageScrollTo			|x				|√			|√	|√					|√					|将页面滚动到目标位置,同`uni.pageScrollTo`													|
|callUniMethod		|√				|√			|√	|√					|√					|调用 uni 对象上的指定方法																					|
|screenshot				|√				|√			|√	|√					|x					|对当前页面截图,目前只有开发者工具模拟器支持,客户端无法使用				|
|mockUniMethod		|√				|√			|√	|√					|√					|覆盖 uni 对象上指定方法的调用结果																	|
|restoreUniMethod	|√				|√			|√	|√					|√					|重置 uni 指定方法,消除 mockUniMethod 调用的影响										|
|testAccounts			|x				|x			|x	|√					|x					|获取多账号调试中已添加的用户列表																		|
|evaluate					|x				|x			|x	|√					|x					|注入代码片段并返回执行结果																					|
|exposeFunction		|x				|x			|x	|√					|x					|在全局暴露方法,供小程序侧调用测试脚本中的方法											|

study夏羽's avatar
study夏羽 已提交
1156
### Page
Q
qiang 已提交
1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173

|属性	|APP-NVUE	|APP-VUE|H5	|微信小程序	|百度小程序	|说明			|
|--		|--				|--			|--	|--					|--					|--				|
|path	|√				|√			|√	|√					|√					|页面路径	|
|query|√				|√			|√	|√					|√					|页面参数	|

|方法				|APP-NVUE	|APP-VUE|H5	|微信小程序	|百度小程序	|说明												|
|--					|--				|--			|--	|--					|--					|--													|
|$					|√				|√			|√	|√					|√					|获取页面元素								|
|$$					|√				|√			|√	|√					|√					|获取页面元素数组						|
|waitFor		|√				|√			|√	|√					|√					|等待直到指定条件成立				|
|data				|√				|√			|√	|√					|√					|获取页面渲染数据						|
|setData		|√				|√			|√	|√					|√					|设置页面渲染数据						|
|size				|√				|√			|√	|√					|√					|获取页面大小(width,height)	|
|scrollTop	|√				|√			|√	|√					|√					|获取页面滚动位置						|
|callMethod	|√				|√			|√	|√					|√					|调用页面指定方法						|

study夏羽's avatar
study夏羽 已提交
1174
### Element
Q
qiang 已提交
1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198
|属性		|APP-NVUE	|APP-VUE|H5	|微信小程序	|百度小程序	|说明					|
|--			|--				|--			|--	|--					|--					|--						|
|tagName|√				|√			|√	|√					|√					|标签名,小写	|

|方法							|APP-NVUE	|APP-VUE|H5	|微信小程序	|百度小程序	|说明																								|
|--								|--				|--			|--	|--					|--					|--																									|
|$								|√				|√			|√	|√					|√					|在元素范围内获取元素																|
|$$								|√				|√			|√	|√					|√					|在元素范围内获取元素数组														|
|size							|√				|√			|√	|√					|√					|获取元素大小(width,height)													|
|offset						|√				|√			|√	|√					|√					|获取元素绝对位置(left,top)													|
|text							|√				|√			|√	|√					|√					|获取元素文本																				|
|attribute				|√				|√			|√	|√					|√					|获取元素特性																				|
|style						|√				|√			|√	|√					|√					|获取元素样式值																			|
|tap							|√				|√			|√	|√					|√					|点击元素																						|
|value						|√				|√			|√	|√					|√					|获取元素值																					|
|callMethod				|√				|√			|√	|√					|√					|调用组件实例指定方法,仅自定义组件可以使用					|
|html							|√				|√			|√	|√					|√					|获取元素 HTML																			|
|outerHtml				|√				|√			|√	|√					|√					|同 html,只是会获取到元素本身											|
|data							|√				|√			|√	|√					|√					|获取组件实例渲染数据,仅自定义组件可以使用					|
|setData					|√				|√			|√	|√					|√					|设置组件实例渲染数据,仅自定义组件可以使用					|
|property					|√				|√			|√	|√					|x					|获取元素属性																				|
|touchstart				|√				|√			|√	|√					|x					|手指开始触摸元素																		|
|touchmove				|√				|√			|√	|√					|x					|手指触摸元素后移动																	|
|touchend					|√				|√			|√	|√					|x					|手指结束触摸元素																		|
L
Lele.er 已提交
1199
|longpress				|√				|√			|√	|√					|x					|长按																				|
Q
qiang 已提交
1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210
|trigger					|√				|√			|√	|√					|x					|触发元素事件																				|
|input						|√				|√			|√	|√					|x					|输入文本,仅 input、textarea 组件可以使用					|
|callContextMethod|x				|x			|x	|√					|x					|调用上下文 Context 对象方法,仅 video 组件可以使用	|
|scrollWidth			|x				|√			|√	|√					|x					|获取滚动宽度,仅 scroll-view 组件可以使用					|
|scrollHeight			|x				|√			|√	|√					|x					|获取滚动高度,仅 scroll-view 组件可以使用					|
|scrollTo					|x				|√			|√	|√					|x					|滚动到指定位置,仅 scroll-view 组件可以使用				|
|swipeTo					|√				|√			|√	|√					|x					|滑动到指定滑块,仅 swiper 组件可以使用							|
|moveTo						|√				|√			|√	|√					|x					|移动视图容器,仅 movable-view 组件可以使用					|
|slideTo					|√				|√			|√	|√					|x					|滑动到指定数值,仅 slider 组件可以使用							|


study夏羽's avatar
study夏羽 已提交
1211
### 测试平台判断
Q
qiang 已提交
1212 1213 1214 1215 1216 1217
```
if (process.env.UNI_PLATFORM === "h5") {}
if (process.env.UNI_PLATFORM === "app-plus") {}
if (process.env.UNI_PLATFORM === "mp-weixin") {}
if (process.env.UNI_PLATFORM === "mp-baidu") {}
```