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