-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathminiprogram-config.toml
9870 lines (8275 loc) · 524 KB
/
miniprogram-config.toml
1
2
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
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
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
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
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
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
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
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
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
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
[[component]]
tag-name = "ad"
description = "Banner 广告。"
reference = "https://developers.weixin.qq.com/miniprogram/dev/component/ad.html"
deprecated = false
[[component.property]]
name = "unit-id"
ty = "string"
description = "广告单元id，可在[小程序管理后台](https://mp.weixin.qq.com)的流量主模块新建"
reference = "https://developers.weixin.qq.com/miniprogram/dev/component/ad.html"
value-option = []
deprecated = false
[[component.property]]
name = "ad-intervals"
ty = "string"
description = "广告自动刷新的间隔时间，单位为秒，参数值必须大于等于30（该参数不传入时 Banner 广告不会自动刷新）"
reference = "https://developers.weixin.qq.com/miniprogram/dev/component/ad.html"
value-option = []
deprecated = false
[[component.property]]
name = "ad-type"
ty = "string"
description = "广告类型，默认为展示banner，可通过设置该属性为`video`展示视频广告, `grid`为格子广告"
reference = "https://developers.weixin.qq.com/miniprogram/dev/component/ad.html"
value-option = []
deprecated = false
[[component.property]]
name = "ad-theme"
ty = "string"
description = ""
reference = "https://developers.weixin.qq.com/miniprogram/dev/component/ad.html"
value-option = []
deprecated = false
[[component.event]]
name = "load"
description = "广告加载成功的回调"
reference = "https://developers.weixin.qq.com/miniprogram/dev/component/ad.html"
deprecated = false
[[component.event]]
name = "error"
description = "广告加载失败的回调，event.detail = {errCode: 1002}"
reference = "https://developers.weixin.qq.com/miniprogram/dev/component/ad.html"
deprecated = false
[[component.event]]
name = "close"
description = "广告关闭的回调"
reference = "https://developers.weixin.qq.com/miniprogram/dev/component/ad.html"
deprecated = false
[[component]]
tag-name = "ad-custom"
description = "原生模板 广告。"
reference = "https://developers.weixin.qq.com/miniprogram/dev/component/ad-custom.html"
deprecated = false
[[component.property]]
name = "unit-id"
ty = "string"
description = "广告单元id，可在[小程序管理后台](https://mp.weixin.qq.com)的流量主模块新建"
reference = "https://developers.weixin.qq.com/miniprogram/dev/component/ad-custom.html"
value-option = []
deprecated = false
[[component.property]]
name = "ad-intervals"
ty = "string"
description = "广告自动刷新的间隔时间，单位为秒，参数值必须大于等于30（该参数不传入时 模板 广告不会自动刷新）"
reference = "https://developers.weixin.qq.com/miniprogram/dev/component/ad-custom.html"
value-option = []
deprecated = false
[[component.event]]
name = "load"
description = "广告加载成功的回调"
reference = "https://developers.weixin.qq.com/miniprogram/dev/component/ad-custom.html"
deprecated = false
[[component.event]]
name = "error"
description = "广告加载失败的回调，event.detail = {errCode: 1002}"
reference = "https://developers.weixin.qq.com/miniprogram/dev/component/ad-custom.html"
deprecated = false
[[component]]
tag-name = "audio"
description = "音频。"
reference = "https://developers.weixin.qq.com/miniprogram/dev/component/audio.html"
deprecated = false
[[component.property]]
name = "id"
ty = "string"
description = "audio 组件的唯一标识符"
reference = "https://developers.weixin.qq.com/miniprogram/dev/component/audio.html"
value-option = []
deprecated = false
[[component.property]]
name = "src"
ty = "string"
description = "要播放音频的资源地址"
reference = "https://developers.weixin.qq.com/miniprogram/dev/component/audio.html"
value-option = []
deprecated = false
[[component.property]]
name = "loop"
ty = "boolean"
description = "是否循环播放"
reference = "https://developers.weixin.qq.com/miniprogram/dev/component/audio.html"
value-option = []
deprecated = false
[[component.property]]
name = "controls"
ty = "boolean"
description = "是否显示默认控件"
reference = "https://developers.weixin.qq.com/miniprogram/dev/component/audio.html"
value-option = []
deprecated = false
[[component.property]]
name = "poster"
ty = "string"
description = "默认控件上的音频封面的图片资源地址，如果 controls 属性值为 false 则设置 poster 无效"
reference = "https://developers.weixin.qq.com/miniprogram/dev/component/audio.html"
value-option = []
deprecated = false
[[component.property]]
name = "name"
ty = "string"
description = "默认控件上的音频名字，如果 controls 属性值为 false 则设置 name 无效"
reference = "https://developers.weixin.qq.com/miniprogram/dev/component/audio.html"
value-option = []
deprecated = false
[[component.property]]
name = "author"
ty = "string"
description = "默认控件上的作者名字，如果 controls 属性值为 false 则设置 author 无效"
reference = "https://developers.weixin.qq.com/miniprogram/dev/component/audio.html"
value-option = []
deprecated = false
[[component.event]]
name = "error"
description = "当发生错误时触发 error 事件，detail = {errMsg:MediaError.code}"
reference = "https://developers.weixin.qq.com/miniprogram/dev/component/audio.html"
deprecated = false
[[component.event]]
name = "play"
description = "当开始/继续播放时触发play事件"
reference = "https://developers.weixin.qq.com/miniprogram/dev/component/audio.html"
deprecated = false
[[component.event]]
name = "pause"
description = "当暂停播放时触发 pause 事件"
reference = "https://developers.weixin.qq.com/miniprogram/dev/component/audio.html"
deprecated = false
[[component.event]]
name = "timeupdate"
description = "当播放进度改变时触发 timeupdate 事件，detail = {currentTime, duration}"
reference = "https://developers.weixin.qq.com/miniprogram/dev/component/audio.html"
deprecated = false
[[component.event]]
name = "ended"
description = "当播放到末尾时触发 ended 事件"
reference = "https://developers.weixin.qq.com/miniprogram/dev/component/audio.html"
deprecated = false
[[component]]
tag-name = "button"
description = "按钮。"
reference = "https://developers.weixin.qq.com/miniprogram/dev/component/button.html"
deprecated = false
[[component.property]]
name = "size"
ty = "string"
description = "按钮的大小"
reference = "https://developers.weixin.qq.com/miniprogram/dev/component/button.html"
deprecated = false
[[component.property.value-option]]
value = "default"
description = "默认大小"
deprecated = false
[[component.property.value-option]]
value = "mini"
description = "小尺寸"
deprecated = false
[[component.property]]
name = "type"
ty = "string"
description = "按钮的样式类型"
reference = "https://developers.weixin.qq.com/miniprogram/dev/component/button.html"
deprecated = false
[[component.property.value-option]]
value = "primary"
description = "绿色"
deprecated = false
[[component.property.value-option]]
value = "default"
description = "白色"
deprecated = false
[[component.property.value-option]]
value = "warn"
description = "红色"
deprecated = false
[[component.property]]
name = "plain"
ty = "boolean"
description = "按钮是否镂空，背景色透明"
reference = "https://developers.weixin.qq.com/miniprogram/dev/component/button.html"
value-option = []
deprecated = false
[[component.property]]
name = "disabled"
ty = "boolean"
description = "是否禁用"
reference = "https://developers.weixin.qq.com/miniprogram/dev/component/button.html"
value-option = []
deprecated = false
[[component.property]]
name = "loading"
ty = "boolean"
description = "名称前是否带 loading 图标"
reference = "https://developers.weixin.qq.com/miniprogram/dev/component/button.html"
value-option = []
deprecated = false
[[component.property]]
name = "form-type"
ty = "string"
description = "用于 [form]((form)) 组件，点击分别会触发 [form]((form)) 组件的 submit/reset 事件"
reference = "https://developers.weixin.qq.com/miniprogram/dev/component/button.html"
deprecated = false
[[component.property.value-option]]
value = "submit"
description = "提交表单"
deprecated = false
[[component.property.value-option]]
value = "reset"
description = "重置表单"
deprecated = false
[[component.property]]
name = "open-type"
ty = "string"
description = "微信开放能力"
reference = "https://developers.weixin.qq.com/miniprogram/dev/component/button.html"
deprecated = false
[[component.property.value-option]]
value = "contact"
description = "打开客服会话，如果用户在会话中点击消息卡片后返回小程序，可以从 bindcontact 回调中获得具体信息，[具体说明]((customer-message))"
deprecated = false
[[component.property.value-option]]
value = "liveActivity"
description = "通过前端获取[新的一次性订阅消息下发机制](https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/subscribe-message-2.html)使用的 code"
deprecated = false
[[component.property.value-option]]
value = "share"
description = "触发用户转发，使用前建议先阅读[使用指引]((share#使用指引))"
deprecated = false
[[component.property.value-option]]
value = "getPhoneNumber"
description = "手机号快速验证，向用户申请，并在用户同意后，快速填写和验证手机，[具体说明]((getPhoneNumber)) （*小程序插件中不能使用*）"
deprecated = false
[[component.property.value-option]]
value = "getRealtimePhoneNumber"
description = "手机号实时验证，向用户申请，并在用户同意后，快速填写和实时验证手机号。[具体说明]((getRealtimePhoneNumber)) （*小程序插件中不能使用*）"
deprecated = false
[[component.property.value-option]]
value = "getUserInfo"
description = "获取用户信息，可以从bindgetuserinfo回调中获取到用户信息 （*小程序插件中不能使用*）"
deprecated = false
[[component.property.value-option]]
value = "launchApp"
description = "打开APP，可以通过app-parameter属性设定向APP传的参数[具体说明]((launchApp))"
deprecated = false
[[component.property.value-option]]
value = "openSetting"
description = "打开授权设置页"
deprecated = false
[[component.property.value-option]]
value = "feedback"
description = "打开“意见反馈”页面，用户可提交反馈内容并上传[日志]((wx.getLogManager))，开发者可以登录[小程序管理后台](https://mp.weixin.qq.com/)后进入左侧菜单“客服反馈”页面获取到反馈内容"
deprecated = false
[[component.property.value-option]]
value = "chooseAvatar"
description = "获取用户头像，可以从bindchooseavatar回调中获取到头像信息"
deprecated = false
[[component.property.value-option]]
value = "agreePrivacyAuthorization"
description = "用户同意隐私协议按钮。用户点击一次此按钮后，所有已声明过的隐私接口可以正常调用。可通过 bindagreeprivacyauthorization 监听用户同意隐私协议事件。隐私合规开发指南详情可见[《小程序隐私协议开发指南》](https://developers.weixin.qq.com/miniprogram/dev/framework/user-privacy/PrivacyAuthorize.html)"
deprecated = false
[[component.property]]
name = "hover-class"
ty = "string"
description = '指定按钮按下去的样式类。当 `hover-class="none"` 时，没有点击态效果'
reference = "https://developers.weixin.qq.com/miniprogram/dev/component/button.html"
value-option = []
deprecated = false
[[component.property]]
name = "hover-stop-propagation"
ty = "boolean"
description = "指定是否阻止本节点的祖先节点出现点击态"
reference = "https://developers.weixin.qq.com/miniprogram/dev/component/button.html"
value-option = []
deprecated = false
[[component.property]]
name = "hover-start-time"
ty = "string"
description = "按住后多久出现点击态，单位毫秒"
reference = "https://developers.weixin.qq.com/miniprogram/dev/component/button.html"
value-option = []
deprecated = false
[[component.property]]
name = "hover-stay-time"
ty = "string"
description = "手指松开后点击态保留时间，单位毫秒"
reference = "https://developers.weixin.qq.com/miniprogram/dev/component/button.html"
value-option = []
deprecated = false
[[component.property]]
name = "lang"
ty = "string"
description = "指定返回用户信息的语言，zh_CN 简体中文，zh_TW 繁体中文，en 英文。"
reference = "https://developers.weixin.qq.com/miniprogram/dev/component/button.html"
deprecated = false
[[component.property.value-option]]
value = "en"
description = "英文"
deprecated = false
[[component.property.value-option]]
value = "zh_CN"
description = "简体中文"
deprecated = false
[[component.property.value-option]]
value = "zh_TW"
description = "繁体中文"
deprecated = false
[[component.property]]
name = "session-from"
ty = "string"
description = '会话来源，open-type="contact"时有效'
reference = "https://developers.weixin.qq.com/miniprogram/dev/component/button.html"
value-option = []
deprecated = false
[[component.property]]
name = "send-message-title"
ty = "string"
description = '会话内消息卡片标题，open-type="contact"时有效'
reference = "https://developers.weixin.qq.com/miniprogram/dev/component/button.html"
value-option = []
deprecated = false
[[component.property]]
name = "send-message-path"
ty = "string"
description = '会话内消息卡片点击跳转小程序路径，open-type="contact"时有效'
reference = "https://developers.weixin.qq.com/miniprogram/dev/component/button.html"
value-option = []
deprecated = false
[[component.property]]
name = "send-message-img"
ty = "string"
description = '会话内消息卡片图片，open-type="contact"时有效'
reference = "https://developers.weixin.qq.com/miniprogram/dev/component/button.html"
value-option = []
deprecated = false
[[component.property]]
name = "app-parameter"
ty = "string"
description = "打开 APP 时，向 APP 传递的参数，open-type=launchApp时有效"
reference = "https://developers.weixin.qq.com/miniprogram/dev/component/button.html"
value-option = []
deprecated = false
[[component.property]]
name = "show-message-card"
ty = "boolean"
description = '是否显示会话内消息卡片，设置此参数为 true，用户进入客服会话会在右下角显示"可能要发送的小程序"提示，用户点击后可以快速发送小程序消息，open-type="contact"时有效'
reference = "https://developers.weixin.qq.com/miniprogram/dev/component/button.html"
value-option = []
deprecated = false
[[component.property]]
name = "phone-number-no-quota-toast"
ty = "boolean"
description = '当手机号快速验证或手机号实时验证额度用尽时，是否对用户展示“申请获取你的手机号，但该功能使用次数已达当前小程序上限，暂时无法使用”的提示，默认展示，open-type="getPhoneNumber" 或 open-type="getRealtimePhoneNumber" 时有效'
reference = "https://developers.weixin.qq.com/miniprogram/dev/component/button.html"
value-option = []
deprecated = false
[[component.event]]
name = "getuserinfo"
description = '用户点击该按钮时，会返回获取到的用户信息，回调的detail数据与[wx.getUserInfo]((wx.getUserInfo))返回的一致，open-type="getUserInfo"时有效'
reference = "https://developers.weixin.qq.com/miniprogram/dev/component/button.html"
deprecated = false
[[component.event]]
name = "contact"
description = '客服消息回调，open-type="contact"时有效。'
reference = "https://developers.weixin.qq.com/miniprogram/dev/component/button.html"
deprecated = false
[[component.event]]
name = "createliveactivity"
description = "[新的一次性订阅消息下发机制](https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/subscribe-message-2.html)回调，open-type=liveActivity时有效"
reference = "https://developers.weixin.qq.com/miniprogram/dev/component/button.html"
deprecated = false
[[component.event]]
name = "getphonenumber"
description = "手机号快速验证回调，open-type=getPhoneNumber时有效。Tips：在触发 bindgetphonenumber 回调后应立即隐藏手机号按钮组件，或置为 disabled 状态，避免用户重复授权手机号产生额外费用。"
reference = "https://developers.weixin.qq.com/miniprogram/dev/component/button.html"
deprecated = false
[[component.event]]
name = "getrealtimephonenumber"
description = "手机号实时验证回调，open-type=getRealtimePhoneNumber 时有效。Tips：在触发 bindgetrealtimephonenumber 回调后应立即隐藏手机号按钮组件，或置为 disabled 状态，避免用户重复授权手机号产生额外费用。"
reference = "https://developers.weixin.qq.com/miniprogram/dev/component/button.html"
deprecated = false
[[component.event]]
name = "error"
description = "当使用开放能力时，发生错误的回调，open-type=launchApp时有效"
reference = "https://developers.weixin.qq.com/miniprogram/dev/component/button.html"
deprecated = false
[[component.event]]
name = "opensetting"
description = "在打开授权设置页后回调，open-type=openSetting时有效"
reference = "https://developers.weixin.qq.com/miniprogram/dev/component/button.html"
deprecated = false
[[component.event]]
name = "launchapp"
description = "打开 APP 成功的回调，open-type=launchApp时有效"
reference = "https://developers.weixin.qq.com/miniprogram/dev/component/button.html"
deprecated = false
[[component.event]]
name = "chooseavatar"
description = "获取用户头像回调，open-type=chooseAvatar时有效"
reference = "https://developers.weixin.qq.com/miniprogram/dev/component/button.html"
deprecated = false
[[component.event]]
name = "agreeprivacyauthorization"
description = '用户同意隐私协议事件回调，open-type=agreePrivacyAuthorization时有效 （Tips: 如果使用 onNeedPrivacyAuthorization 接口，需要在 bindagreeprivacyauthorization 触发后再调用 `resolve({ event: "agree", buttonId })`）'
reference = "https://developers.weixin.qq.com/miniprogram/dev/component/button.html"
deprecated = false
[[component]]
tag-name = "camera"
description = """
系统相机。扫码二维码功能，需升级微信客户端至6.7.3。需要[用户授权]((open-ability/authorize)) `scope.camera`。
{%version('2.10.0')%}起 initdone 事件返回 maxZoom，最大变焦范围，相关接口 [CameraContext.setZoom]((CameraContext.setZoom))。"""
reference = "https://developers.weixin.qq.com/miniprogram/dev/component/camera.html"
deprecated = false
[[component.property]]
name = "mode"
ty = "string"
description = "应用模式，只在初始化时有效，不能动态变更"
reference = "https://developers.weixin.qq.com/miniprogram/dev/component/camera.html"
deprecated = false
[[component.property.value-option]]
value = "normal"
description = "相机模式"
deprecated = false
[[component.property.value-option]]
value = "scanCode"
description = "扫码模式"
deprecated = false
[[component.property]]
name = "resolution"
ty = "string"
description = "分辨率，不支持动态修改"
reference = "https://developers.weixin.qq.com/miniprogram/dev/component/camera.html"
deprecated = false
[[component.property.value-option]]
value = "low"
description = "低"
deprecated = false
[[component.property.value-option]]
value = "medium"
description = "中"
deprecated = false
[[component.property.value-option]]
value = "high"
description = "高"
deprecated = false
[[component.property]]
name = "device-position"
ty = "string"
description = "摄像头朝向"
reference = "https://developers.weixin.qq.com/miniprogram/dev/component/camera.html"
deprecated = false
[[component.property.value-option]]
value = "front"
description = "前置"
deprecated = false
[[component.property.value-option]]
value = "back"
description = "后置"
deprecated = false
[[component.property]]
name = "flash"
ty = "string"
description = "闪光灯，值为auto, on, off"
reference = "https://developers.weixin.qq.com/miniprogram/dev/component/camera.html"
deprecated = false
[[component.property.value-option]]
value = "auto"
description = "自动"
deprecated = false
[[component.property.value-option]]
value = "on"
description = "打开"
deprecated = false
[[component.property.value-option]]
value = "off"
description = "关闭"
deprecated = false
[[component.property.value-option]]
value = "torch"
description = "常亮"
deprecated = false
[[component.property]]
name = "frame-size"
ty = "string"
description = "指定期望的相机帧数据尺寸"
reference = "https://developers.weixin.qq.com/miniprogram/dev/component/camera.html"
deprecated = false
[[component.property.value-option]]
value = "small"
description = "小尺寸帧数据"
deprecated = false
[[component.property.value-option]]
value = "medium"
description = "中尺寸帧数据"
deprecated = false
[[component.property.value-option]]
value = "large"
description = "大尺寸帧数据"
deprecated = false
[[component.event]]
name = "stop"
description = "摄像头在非正常终止时触发，如退出后台等情况"
reference = "https://developers.weixin.qq.com/miniprogram/dev/component/camera.html"
deprecated = false
[[component.event]]
name = "error"
description = "用户不允许使用摄像头时触发"
reference = "https://developers.weixin.qq.com/miniprogram/dev/component/camera.html"
deprecated = false
[[component.event]]
name = "initdone"
description = "相机初始化完成时触发，`e.detail = {maxZoom}`"
reference = "https://developers.weixin.qq.com/miniprogram/dev/component/camera.html"
deprecated = false
[[component.event]]
name = "scancode"
description = '在扫码识别成功时触发，仅在 mode="scanCode" 时生效'
reference = "https://developers.weixin.qq.com/miniprogram/dev/component/camera.html"
deprecated = false
[[component]]
tag-name = "canvas"
description = "画布。2.9.0 起支持一套新 Canvas 2D 接口（需指定 type 属性），同时支持[同层渲染]((native-component#原生组件同层渲染))，原有接口不再维护。旧版本可参考 [旧版画布迁移指南]((ability/canvas-legacy-migration)) 进行迁移。"
reference = "https://developers.weixin.qq.com/miniprogram/dev/component/canvas.html"
deprecated = false
[[component.property]]
name = "type"
ty = "string"
description = "指定 canvas 类型，支持 2d (2.9.0) 和 webgl (2.7.0)"
reference = "https://developers.weixin.qq.com/miniprogram/dev/component/canvas.html"
value-option = []
deprecated = false
[[component.property]]
name = "canvas-id"
ty = "string"
description = "canvas 组件的唯一标识符，若指定了 type 则无需再指定该属性"
reference = "https://developers.weixin.qq.com/miniprogram/dev/component/canvas.html"
value-option = []
deprecated = false
[[component.property]]
name = "disable-scroll"
ty = "boolean"
description = "当在 canvas 中移动时且有绑定手势事件时，禁止屏幕滚动以及下拉刷新"
reference = "https://developers.weixin.qq.com/miniprogram/dev/component/canvas.html"
value-option = []
deprecated = false
[[component.event]]
name = "touchstart"
description = "手指触摸动作开始"
reference = "https://developers.weixin.qq.com/miniprogram/dev/component/canvas.html"
deprecated = false
[[component.event]]
name = "touchmove"
description = "手指触摸后移动"
reference = "https://developers.weixin.qq.com/miniprogram/dev/component/canvas.html"
deprecated = false
[[component.event]]
name = "touchend"
description = "手指触摸动作结束"
reference = "https://developers.weixin.qq.com/miniprogram/dev/component/canvas.html"
deprecated = false
[[component.event]]
name = "touchcancel"
description = "手指触摸动作被打断，如来电提醒，弹窗"
reference = "https://developers.weixin.qq.com/miniprogram/dev/component/canvas.html"
deprecated = false
[[component.event]]
name = "longtap"
description = "手指长按 500ms 之后触发，触发了长按事件后进行移动不会触发屏幕的滚动"
reference = "https://developers.weixin.qq.com/miniprogram/dev/component/canvas.html"
deprecated = false
[[component.event]]
name = "error"
description = "当发生错误时触发 error 事件，detail = {errMsg}"
reference = "https://developers.weixin.qq.com/miniprogram/dev/component/canvas.html"
deprecated = false
[[component]]
tag-name = "channel-live"
description = "小程序内嵌视频号直播组件，展示视频号直播状态和封面，并无弹窗跳转至视频号。注意：使用该组件打开的视频号视频需要与小程序的主体一致。"
reference = "https://developers.weixin.qq.com/miniprogram/dev/component/channel-live.html"
event = []
deprecated = false
[[component.property]]
name = "feed-id"
ty = "string"
description = "视频 feedId"
reference = "https://developers.weixin.qq.com/miniprogram/dev/component/channel-live.html"
value-option = []
deprecated = false
[[component.property]]
name = "finder-user-name"
ty = "string"
description = "视频号 id，以“sph”开头的id，可在视频号助手获取。视频号必须与当前小程序相同主体。"
reference = "https://developers.weixin.qq.com/miniprogram/dev/component/channel-live.html"
value-option = []
deprecated = false
[[component]]
tag-name = "channel-video"
description = """
小程序内嵌视频号视频组件，支持在小程序中播放视频号视频，并无弹窗跳转至视频号。注意：
1. 若小程序与内嵌视频号视频为同主体，则内嵌视频号视频可支持自动播放；
2. 基础库 2.31.1 起，对于非个人主体小程序，若小程序于内嵌视频号视频非同主体，则内嵌视频号视频不可自动播放，即强制 autoplay=false。"""
reference = "https://developers.weixin.qq.com/miniprogram/dev/component/channel-video.html"
deprecated = false
[[component.property]]
name = "feed-id"
ty = "string"
description = "仅视频号视频与小程序同主体时生效。若内嵌非同主体视频，请使用 feed-token。"
reference = "https://developers.weixin.qq.com/miniprogram/dev/component/channel-video.html"
value-option = []
deprecated = false
[[component.property]]
name = "finder-user-name"
ty = "string"
description = "视频号 id，以“sph”开头的id，可在视频号助手获取。视频号必须与当前小程序相同主体。"
reference = "https://developers.weixin.qq.com/miniprogram/dev/component/channel-video.html"
value-option = []
deprecated = false
[[component.property]]
name = "feed-token"
ty = "string"
description = "仅内嵌小程序非同主体视频号视频时使用，获取方式参考[本指引](https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/channels-activity#feed-token)。"
reference = "https://developers.weixin.qq.com/miniprogram/dev/component/channel-video.html"
value-option = []
deprecated = false
[[component.property]]
name = "autoplay"
ty = "string"
description = "是否自动播放。仅视频号视频与小程序同主体时支持设置为 true。"
reference = "https://developers.weixin.qq.com/miniprogram/dev/component/channel-video.html"
value-option = []
deprecated = false
[[component.property]]
name = "loop"
ty = "boolean"
description = "是否循环播放"
reference = "https://developers.weixin.qq.com/miniprogram/dev/component/channel-video.html"
value-option = []
deprecated = false
[[component.property]]
name = "muted"
ty = "boolean"
description = "是否静音播放"
reference = "https://developers.weixin.qq.com/miniprogram/dev/component/channel-video.html"
value-option = []
deprecated = false
[[component.property]]
name = "object-fit"
ty = "boolean"
description = "当视频大小与 video 容器大小不一致时，视频的表现形式"
reference = "https://developers.weixin.qq.com/miniprogram/dev/component/channel-video.html"
deprecated = false
[[component.property.value-option]]
value = "contain"
description = "包含"
deprecated = false
[[component.property.value-option]]
value = "fill"
description = "填充"
deprecated = false
[[component.property.value-option]]
value = "cover"
description = "覆盖"
deprecated = false
[[component.event]]
name = "error"
description = "视频播放出错时触发"
reference = "https://developers.weixin.qq.com/miniprogram/dev/component/channel-video.html"
deprecated = false
[[component]]
tag-name = "checkbox"
description = "多选项目。"
reference = "https://developers.weixin.qq.com/miniprogram/dev/component/checkbox.html"
event = []
deprecated = false
[[component.property]]
name = "value"
ty = "string"
description = "[checkbox]((checkbox))标识，选中时触发[checkbox-group]((checkbox-group))的 change 事件，并携带 [checkbox]((checkbox)) 的 value"
reference = "https://developers.weixin.qq.com/miniprogram/dev/component/checkbox.html"
value-option = []
deprecated = false
[[component.property]]
name = "disabled"
ty = "boolean"
description = "是否禁用"
reference = "https://developers.weixin.qq.com/miniprogram/dev/component/checkbox.html"
value-option = []
deprecated = false
[[component.property]]
name = "checked"
ty = "boolean"
description = "当前是否选中，可用来设置默认选中"
reference = "https://developers.weixin.qq.com/miniprogram/dev/component/checkbox.html"
value-option = []
deprecated = false
[[component.property]]
name = "color"
ty = "string"
description = "checkbox的颜色，同css的color"
reference = "https://developers.weixin.qq.com/miniprogram/dev/component/checkbox.html"
value-option = []
deprecated = false
[[component]]
tag-name = "checkbox-group"
description = "多项选择器，内部由多个[checkbox]((checkbox))组成。"
reference = "https://developers.weixin.qq.com/miniprogram/dev/component/checkbox-group.html"
property = []
deprecated = false
[[component.event]]
name = "change"
description = "[checkbox-group]((checkbox-group))中选中项发生改变时触发 change 事件，detail = {value:[选中的checkbox的value的数组]}"
reference = "https://developers.weixin.qq.com/miniprogram/dev/component/checkbox-group.html"
deprecated = false
[[component]]
tag-name = "cover-image"
description = """
覆盖在原生组件之上的图片视图。
可覆盖的原生组件同[cover-view]((cover-view))，支持嵌套在[cover-view]((cover-view))里。"""
reference = "https://developers.weixin.qq.com/miniprogram/dev/component/cover-image.html"
deprecated = false
[[component.property]]
name = "src"
ty = "string"
description = "图标路径，支持临时路径、网络地址（1.6.0起支持）、云文件ID（2.2.3起支持）。"
reference = "https://developers.weixin.qq.com/miniprogram/dev/component/cover-image.html"
value-option = []
deprecated = false
[[component.property]]
name = "referrer-policy"
ty = "string"
description = "格式固定为 `https://servicewechat.com/{appid}/{version}/page-frame.html`，其中 {appid} 为小程序的 appid，{version} 为小程序的版本号，版本号为 0 表示为开发版、体验版以及审核版本，版本号为 devtools 表示为开发者工具，其余为正式版本；"
reference = "https://developers.weixin.qq.com/miniprogram/dev/component/cover-image.html"
deprecated = false
[[component.property.value-option]]
value = "origin"
description = "发送完整的referrer"
deprecated = false
[[component.property.value-option]]
value = "no-referrer"
description = "不发送"
deprecated = false
[[component.event]]
name = "load"
description = "图片加载成功时触发"
reference = "https://developers.weixin.qq.com/miniprogram/dev/component/cover-image.html"
deprecated = false
[[component.event]]
name = "error"
description = "图片加载失败时触发"
reference = "https://developers.weixin.qq.com/miniprogram/dev/component/cover-image.html"
deprecated = false
[[component]]
tag-name = "cover-view"
description = """
覆盖在原生组件之上的文本视图。
可覆盖的原生组件包括 [map]((map))、[video]((video))、[canvas]((canvas))、[camera]((camera))、[live-player]((live-player))、[live-pusher]((live-pusher))
只支持嵌套 [cover-view]((cover-view))、[cover-image]((cover-image))，可在 [cover-view]((cover-view)) 中使用 [button]((button))。组件属性的长度单位默认为px，{%version('2.4.0')%}起支持传入单位(rpx/px)。"""
reference = "https://developers.weixin.qq.com/miniprogram/dev/component/cover-view.html"
event = []
deprecated = false
[[component.property]]
name = "scroll-top"
ty = "string"
description = "设置顶部滚动偏移量，仅在设置了 overflow-y: scroll 成为滚动元素后生效"
reference = "https://developers.weixin.qq.com/miniprogram/dev/component/cover-view.html"
value-option = []
deprecated = false
[[component]]
tag-name = "draggable-sheet"
description = "半屏可拖拽组件。该组件需配合 [DraggableSheetContext]((DraggableSheetContext)) 接口使用。 目前仅在 Skyline 渲染引擎下支持。"
reference = "https://developers.weixin.qq.com/miniprogram/dev/component/draggable-sheet.html"
event = []
deprecated = false
[[component.property]]
name = "initial-child-size"
ty = "string"
description = "初始时占父容器的比例"
reference = "https://developers.weixin.qq.com/miniprogram/dev/component/draggable-sheet.html"
value-option = []
deprecated = false
[[component.property]]
name = "min-child-size"
ty = "string"
description = "最小时占父容器的比例"
reference = "https://developers.weixin.qq.com/miniprogram/dev/component/draggable-sheet.html"
value-option = []
deprecated = false
[[component.property]]
name = "max-child-size"
ty = "string"
description = "最大时占父容器的比例"
reference = "https://developers.weixin.qq.com/miniprogram/dev/component/draggable-sheet.html"
value-option = []
deprecated = false
[[component.property]]
name = "snap"
ty = "boolean"
description = "拖拽后是否自动对齐关键点"
reference = "https://developers.weixin.qq.com/miniprogram/dev/component/draggable-sheet.html"
value-option = []
deprecated = false
[[component.property]]
name = "snap-sizes"
ty = "string"
description = "拖拽后对齐的关键点，无需包含最小和最大值"
reference = "https://developers.weixin.qq.com/miniprogram/dev/component/draggable-sheet.html"
value-option = []
deprecated = false
[[component.property]]
name = "snap"
ty = "boolean"
description = "拖拽后是否自动对齐关键点"
reference = "https://developers.weixin.qq.com/miniprogram/dev/component/draggable-sheet.html"
value-option = []
deprecated = false
[[component.property]]
name = "worklet:onsizeupdate"
ty = "string"
description = "尺寸发生变化时触发，仅支持 worklet 作为回调。event = {pixels, size}"
reference = "https://developers.weixin.qq.com/miniprogram/dev/component/draggable-sheet.html"
value-option = []
deprecated = false
[[component]]
tag-name = "editor"
description = '''
富文本编辑器，可以对图片、文字进行编辑。
编辑器导出内容支持带标签的 `html`和纯文本的 `text`，编辑器内部采用 `delta` 格式进行存储。