• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1# MenuItem
2
3用来展示菜单Menu中具体的item菜单项。
4
5> **说明:**
6>
7> 该组件从API version 9开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。
8
9## 子组件
10
1112
13## 接口
14
15MenuItem(value?: MenuItemOptions| CustomBuilder)
16
17**原子化服务API:** 从API version 11开始,该接口支持在原子化服务中使用。
18
19**系统能力:** SystemCapability.ArkUI.ArkUI.Full
20
21**参数:**
22
23| 参数名 | 类型                                                         | 必填 | 说明                         |
24| ------ | ------------------------------------------------------------ | ---- | ---------------------------- |
25| value  | [MenuItemOptions](#menuitemoptions对象说明) \| [CustomBuilder](ts-types.md#custombuilder8) | 否   | 包含设置MenuItem的各项信息。 |
26
27## MenuItemOptions对象说明
28
29**系统能力:** SystemCapability.ArkUI.ArkUI.Full
30
31| 名称      | 类型                                        | 必填 | 说明                             |
32| --------- | ------------------------------------------- | ---- | -------------------------------------- |
33| startIcon | [ResourceStr](ts-types.md#resourcestr)      | 否   | item中显示在左侧的图标信息路径。 <br/>**原子化服务API:** 从API version 11开始,该接口支持在原子化服务中使用。      |
34| content   | [ResourceStr](ts-types.md#resourcestr)      | 否   | item的内容信息。<br/>**原子化服务API:** 从API version 11开始,该接口支持在原子化服务中使用。                        |
35| endIcon   | [ResourceStr](ts-types.md#resourcestr)      | 否   | item中显示在右侧的图标信息路径。<br/>**原子化服务API:** 从API version 11开始,该接口支持在原子化服务中使用。        |
36| labelInfo | [ResourceStr](ts-types.md#resourcestr)      | 否   | 定义结束标签信息,如快捷方式Ctrl+C等。<br/>**原子化服务API:** 从API version 11开始,该接口支持在原子化服务中使用。  |
37| builder   | [CustomBuilder](ts-types.md#custombuilder8) | 否   | 用于构建二级菜单。<br/>**原子化服务API:** 从API version 11开始,该接口支持在原子化服务中使用。                      |
38| symbolStartIcon<sup>12+</sup>   | [SymbolGlyphModifier](ts-universal-attributes-attribute-modifier.md) | 否   | item中显示在左侧的HMSymbol图标信息路径。配置该项时,原先startIcon图标不显示。<br/>**原子化服务API:** 从API version 12开始,该接口支持在原子化服务中使用。|
39| symbolEndIcon<sup>12+</sup>   | [SymbolGlyphModifier](ts-universal-attributes-attribute-modifier.md) | 否   | item中显示在右侧的HMSymbol图标信息路径。配置该项时,原先endIcon图标不显示。<br/>**原子化服务API:** 从API version 12开始,该接口支持在原子化服务中使用。|
40
41
42## 属性
43
44除支持[通用属性](ts-component-general-attributes.md)外,还支持以下属性:
45
46### selected
47
48selected(value: boolean)
49
50设置菜单项是否选中。
51
52从API version 10开始,该参数支持[$$](../../../ui/state-management/arkts-two-way-sync.md)双向绑定变量。
53从API version 18开始,该参数支持[!!](../../../ui/state-management/arkts-new-binding.md#系统组件参数双向绑定)双向绑定变量。
54
55**原子化服务API:** 从API version 11开始,该接口支持在原子化服务中使用。
56
57**系统能力:** SystemCapability.ArkUI.ArkUI.Full
58
59**参数:**
60
61| 参数名 | 类型    | 必填 | 说明                                                         |
62| ------ | ------- | ---- | ------------------------------------------------------------ |
63| value  | boolean | 是   | 菜单项是否选中。<br />默认值:false<br/>值为true时,菜单项被选中。值为false时,菜单项不被选中。 |
64
65### selectIcon
66
67selectIcon(value: boolean | ResourceStr | SymbolGlyphModifier)
68
69设置当菜单项被选中时,是否显示被选中的图标。
70
71**原子化服务API:** 从API version 11开始,该接口支持在原子化服务中使用。
72
73**系统能力:** SystemCapability.ArkUI.ArkUI.Full
74
75**参数:**
76
77| 参数名 | 类型                                                         | 必填 | 说明                                                         |
78| ------ | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ |
79| value  | boolean&nbsp;\|&nbsp;[ResourceStr](ts-types.md#resourcestr)<sup>10+</sup>\|&nbsp;[SymbolGlyphModifier](ts-universal-attributes-attribute-modifier.md)<sup>12+</sup> | 是   | 菜单项被选中时,是否显示被选中的图标。<br/>默认值:false<br/>true:菜单项被选中时,显示默认的对勾图标。<br/>false:即使菜单项被选中也不显示图标。<br/>ResourceStr:菜单项被选中时,显示指定的图标。<br/>SymbolGlyphModifier:菜单项被选中时,显示指定的HMSymbol图标。 |
80### contentFont<sup>10+</sup>
81
82contentFont(value: Font)
83
84设置菜单项中内容信息的字体样式。
85
86**原子化服务API:** 从API version 11开始,该接口支持在原子化服务中使用。
87
88**系统能力:** SystemCapability.ArkUI.ArkUI.Full
89
90**参数:**
91
92| 参数名 | 类型                     | 必填 | 说明                         |
93| ------ | ------------------------ | ---- | ---------------------------- |
94| value  | [Font](ts-types.md#font) | 是   | 菜单项中内容信息的字体样式。 |
95
96### contentFontColor<sup>10+</sup>
97
98contentFontColor(value: ResourceColor)
99
100设置菜单项中内容信息的字体颜色。
101
102**原子化服务API:** 从API version 11开始,该接口支持在原子化服务中使用。
103
104**系统能力:** SystemCapability.ArkUI.ArkUI.Full
105
106**参数:**
107
108| 参数名 | 类型                                       | 必填 | 说明                         |
109| ------ | ------------------------------------------ | ---- | ---------------------------- |
110| value  | [ResourceColor](ts-types.md#resourcecolor) | 是   | 菜单项中内容信息的字体颜色。<br />默认值:'#E5000000' |
111
112### labelFont<sup>10+</sup>
113
114labelFont(value: Font)
115
116设置菜单项中标签信息的字体样式。
117
118**原子化服务API:** 从API version 11开始,该接口支持在原子化服务中使用。
119
120**系统能力:** SystemCapability.ArkUI.ArkUI.Full
121
122**参数:**
123
124| 参数名 | 类型                     | 必填 | 说明                         |
125| ------ | ------------------------ | ---- | ---------------------------- |
126| value  | [Font](ts-types.md#font) | 是   | 菜单项中标签信息的字体样式。 |
127
128### labelFontColor<sup>10+</sup>
129
130labelFontColor(value: ResourceColor)
131
132设置菜单项中标签信息的字体颜色。
133
134**原子化服务API:** 从API version 11开始,该接口支持在原子化服务中使用。
135
136**系统能力:** SystemCapability.ArkUI.ArkUI.Full
137
138**参数:**
139
140| 参数名 | 类型                                       | 必填 | 说明                         |
141| ------ | ------------------------------------------ | ---- | ---------------------------- |
142| value  | [ResourceColor](ts-types.md#resourcecolor) | 是   | 菜单项中标签信息的字体颜色。<br />默认值:'#99000000' |
143
144## 事件
145
146### onChange
147
148onChange(callback: (selected: boolean) => void)
149
150当选中状态发生变化时,触发该回调。只有手动触发且MenuItem状态改变时才会触发onChange回调。
151
152**原子化服务API:** 从API version 11开始,该接口支持在原子化服务中使用。
153
154**系统能力:** SystemCapability.ArkUI.ArkUI.Full
155
156**参数:**
157
158| 参数名   | 类型    | 必填 | 说明                                                         |
159| -------- | ------- | ---- | ------------------------------------------------------------ |
160| selected | boolean | 是   | 选中状态发生变化时,触发该回调。<br />返回值为true时,表示已选中,为false时,表示未选中。 |
161
162## 示例
163
164详见[Menu组件示例](ts-basic-components-menu.md#示例)。
165