Skip to content

Add support for using components as icons #19

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Nov 20, 2022
Merged

Add support for using components as icons #19

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
891f745
Support using a Component as the 'icon' argument for BarButtonGeneric…
jamesWalker55 Nov 17, 2022
aa1c8e1
Update API readme for new component icon support
jamesWalker55 Nov 17, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions API.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ my_menu = [
text: String, // Text displayed on the button, if any
html: String, // Raw HTML to display, if any
title: String, // Text to display in the button tooltip, if any
icon: String, // Name of Material icon to display, if any (see https://material.io/resources/icons/)
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)
emoji: String, // Name of Emoji to display, if any (from this list: https://raw.githubusercontent.com/omnidan/node-emoji/master/lib/emoji.json)
hotkey: String, // Hotkey combination shortcut for the button, if any (use this format: https://github.com/jaywcjlove/hotkeys#supported-keys)
active: Boolean, // Set to true if the button is toggled
Expand All @@ -39,7 +39,7 @@ my_menu = [
// === item properties ===
text: String, // Text displayed on the menu item, if any
html: String, // Raw HTML to display, if any
icon: String, // Name of Material icon to display, if any (see https://material.io/resources/icons/)
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)
emoji: String, // Name of Emoji to display, if any (from this list: https://raw.githubusercontent.com/omnidan/node-emoji/master/lib/emoji.json)
hotkey: String, // Hotkey combination shortcut for the menu, if any (use this format: https://github.com/jaywcjlove/hotkeys#supported-keys)
disabled: Boolean, // Set to true if the menu is disabled (it will prevent click event)
Expand Down
5 changes: 4 additions & 1 deletion src/Bar/BarButtonGeneric.vue
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,10 @@
@mousedown="(e) => e.preventDefault()"
@click="(e) => (item.click && !item.disabled) ? item.click(e) : e.stopPropagation()">

<span v-if="item.icon" class="material-icons icon">{{ item.icon }}</span>
<template v-if="item.icon">
<component v-if="typeof item.icon == 'object'" class="icon" :is="item.icon"></component>
<span v-else class="material-icons icon">{{ item.icon }}</span>
</template>
<span v-if="item.emoji" class="emoji">{{ get_emoji(item.emoji) }}</span>
<span v-if="item.text" class="label">{{ item.text }}</span>
<span v-if="item.html" class="label" v-html="item.html"></span>
Expand Down
5 changes: 4 additions & 1 deletion src/Bar/BarMenuItem.vue
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,10 @@
:title="item.title"
:style="{ height: item.height+'px' }">

<span v-if="item.icon" class="material-icons icon">{{ item.icon }}</span>
<template v-if="item.icon">
<component v-if="typeof item.icon == 'object'" class="icon" :is="item.icon"></component>
<span v-else class="material-icons icon">{{ item.icon }}</span>
</template>
<span v-if="item.emoji" class="emoji">{{ get_emoji(item.emoji) }}</span>
<span v-if="item.text" class="label">{{ item.text }}</span>
<span v-if="item.html" class="label" v-html="item.html"></span>
Expand Down