Skip to content

Commit aa1c8e1

Browse files
committed
Update API readme for new component icon support
1 parent 891f745 commit aa1c8e1

File tree

1 file changed

+2
-2
lines changed

1 file changed

+2
-2
lines changed

API.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ my_menu = [
1515
text: String, // Text displayed on the button, if any
1616
html: String, // Raw HTML to display, if any
1717
title: String, // Text to display in the button tooltip, if any
18-
icon: String, // Name of Material icon to display, if any (see https://material.io/resources/icons/)
18+
icon: String || Object, // Name of Material icon to display, if any (see https://material.io/resources/icons/), or an icon component (e.g. https://github.com/antfu/unplugin-icons)
1919
emoji: String, // Name of Emoji to display, if any (from this list: https://raw.githubusercontent.com/omnidan/node-emoji/master/lib/emoji.json)
2020
hotkey: String, // Hotkey combination shortcut for the button, if any (use this format: https://github.com/jaywcjlove/hotkeys#supported-keys)
2121
active: Boolean, // Set to true if the button is toggled
@@ -39,7 +39,7 @@ my_menu = [
3939
// === item properties ===
4040
text: String, // Text displayed on the menu item, if any
4141
html: String, // Raw HTML to display, if any
42-
icon: String, // Name of Material icon to display, if any (see https://material.io/resources/icons/)
42+
icon: String || Object, // Name of Material icon to display, if any (see https://material.io/resources/icons/), or an icon component (e.g. https://github.com/antfu/unplugin-icons)
4343
emoji: String, // Name of Emoji to display, if any (from this list: https://raw.githubusercontent.com/omnidan/node-emoji/master/lib/emoji.json)
4444
hotkey: String, // Hotkey combination shortcut for the menu, if any (use this format: https://github.com/jaywcjlove/hotkeys#supported-keys)
4545
disabled: Boolean, // Set to true if the menu is disabled (it will prevent click event)

0 commit comments

Comments
 (0)