• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1# FormLink
2
3提供静态卡片交互组件,用于静态卡片内部和提供方应用间的交互,当前支持router、message和call三种类型的事件。
4
5> **说明:**
6>
7> - 该组件从API Version 10开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。
8>
9> - 该组件仅可以在静态卡片中使用。
10>
11
12## 权限
13
1415
16## 子组件
17
18支持单个子组件
19
20## 接口
21
22FormLink(options: FormLinkOptions)
23
24**参数:**
25
26| 参数名       | 参数类型                            | 必填   | 参数描述   |
27| --------- | ------------------------------- | ---- | ------ |
28| options | [FormLinkOptions](#formlinkoptions类型说明) | 是    | 定义卡片信息 |
29
30## FormLinkOptions类型说明
31
32| 参数名      | 参数类型 | 必填 | 参数描述                                                     |
33| ----------- | -------- | ---- | ------------------------------------------------------------ |
34| action      | string   | 是   | action的类型,支持三种预定义的类型:<br/>-&nbsp;"router":跳转到提供方应用的指定UIAbility。<br/>-&nbsp;"message":自定义消息,触发后会调用提供方FormExtensionAbility的[onFormEvent()](../apis/js-apis-app-form-formExtensionAbility.md#onformevent)生命周期回调。<br/>-&nbsp;"call":后台启动提供方应用。触发后会拉起提供方应用的指定UIAbility(仅支持[launchType](../../application-models/uiability-launch-type.md)为singleton的UIAbility,即启动模式为单实例的UIAbility),但不会调度到前台。提供方应用需要具备后台运行权限([ohos.permission.KEEP_BACKGROUND_RUNNING](../../security/permission-list.md#ohospermissionkeep_background_running))。 <br/>**说明:** <br/>不推荐使用router事件刷新卡片UI。|
35| moduleName  | string   | 否   | "router"&nbsp;/&nbsp;"call"&nbsp;类型时跳转的模块名,可选。  |
36| bundleName  | string   | 否   | "router"&nbsp;/&nbsp;"call"&nbsp;类型时跳转的包名,可选。    |
37| abilityName | string   | 是   | "router"&nbsp;/&nbsp;"call"&nbsp;类型时跳转的UIAbility名,必填。 |
38| params      | Object   | 是   | 当前action携带的额外参数,内容使用JSON格式的键值对形式。"call"&nbsp;类型时需填入参数'method',且类型需要为string类型,用于触发UIAbility中对应的方法,必填。 <br/>**说明:** <br/>不推荐通过params传递卡片内部的状态变量。|
39
40## 属性
41
42支持[通用属性](ts-universal-attributes-size.md)
43
44## 事件
45
46不支持[通用事件](ts-universal-events-click.md)
47
48## 示例
49
50```ts
51@Entry
52@Component
53struct FormLinkDemo {
54  build() {
55    Column() {
56      Text("这是一个静态卡片").fontSize(20).margin(10)
57
58      // router事件用于静态卡片跳转到对应的UIAbility
59      FormLink({
60        action: "router",
61        abilityName: "EntryAbility",
62        params: {
63          'message': 'testForRouter' // 自定义要发送的message
64        }
65      }) {
66        Button("router event").width(120)
67      }.margin(10)
68
69
70      // message事件触发FormExtensionAbility的onFormEvent生命周期
71      FormLink({
72        action: "message",
73        abilityName: "EntryAbility",
74        params: {
75          'message': 'messageEvent' // 自定义要发送的message
76        }
77      }) {
78        Button("message event").width(120)
79      }.margin(10)
80
81
82      // call事件用于触发UIAbility中对应的方法
83      FormLink({
84        action: "call",
85        abilityName: "EntryAbility",
86        params: {
87          'method': 'funA', // 在EntryAbility中调用的方法名
88          'num': 1 // 需要传递的其他参数
89        }
90      }) {
91        Button("call event").width(120)
92      }.margin(10)
93    }
94    .justifyContent(FlexAlign.Center)
95    .width('100%').height('100%')
96  }
97}
98```
99
100![FormLink](figures/formLink.jpeg)