primevue-mirror/doc/contextmenu/CommandDoc.vue

<template>
    <DocSectionText v-bind="$attrs">
        <p>ContextMenu requires a collection of menuitems as its <i>model</i> and the <i>show</i> method needs to be called explicity using an event of the target like <i>contextmenu</i> to display the menu.</p>
    </DocSectionText>
    <div class="card flex md:justify-content-center">
        <ul class="m-0 p-0 list-none border-1 surface-border border-round p-3 flex flex-column gap-2 w-full md:w-30rem">
            <li
                v-for="user in users"
                :key="user.id"
                :class="['p-2 hover:surface-hover border-round border-1 border-transparent transition-all transition-duration-200 flex align-items-center justify-content-between', { 'border-primary': selectedUser?.id === user.id }]"
                @contextmenu="onRightClick($event, user)"
            >
                <div class="flex align-items-center gap-2">
                    <img :alt="user.name" :src="`https://primefaces.org/cdn/primevue/images/avatar/${user.image}`" style="width: 32px" />
                    <span class="font-bold">{{ user.name }}</span>
                </div>
                <Tag :value="user.role" :severity="getBadge(user)" />
            </li>
        </ul>
        <ContextMenu ref="menu" :model="items" @hide="selectedUser = null" />
    </div>
    <DocSectionCode :code="code" />
</template>

<script>
export default {
    data() {
        return {
            selectedUser: null,
            users: [
                { id: 0, name: 'Amy Elsner', image: 'amyelsner.png', role: 'Admin' },
                { id: 1, name: 'Anna Fali', image: 'annafali.png', role: 'Member' },
                { id: 2, name: 'Asiya Javayant', image: 'asiyajavayant.png', role: 'Member' },
                { id: 3, name: 'Bernardo Dominic', image: 'bernardodominic.png', role: 'Guest' },
                { id: 4, name: 'Elwin Sharvill', image: 'elwinsharvill.png', role: 'Member' }
            ],
            items: [
                {
                    label: 'Roles',
                    icon: 'pi pi-users',
                    items: [
                        {
                            label: 'Admin',
                            command: () => {
                                this.selectedUser.role = 'Admin';
                            }
                        },
                        {
                            label: 'Member',
                            command: () => {
                                this.selectedUser.role = 'Member';
                            }
                        },
                        {
                            label: 'Guest',
                            command: () => {
                                this.selectedUser.role = 'Guest';
                            }
                        }
                    ]
                },
                {
                    label: 'Invite',
                    icon: 'pi pi-user-plus',
                    command: () => {
                        this.$toast.add({ severity: 'success', summary: 'Success', detail: 'Invitation sent!', life: 3000 });
                    }
                }
            ],
            code: {
                basic: `
<ul class="m-0 p-0 list-none border-1 surface-border border-round p-3 flex flex-column gap-2 w-full md:w-30rem">
    <li
        v-for="user in users"
        :key="user.id"
        :class="['p-2 hover:surface-hover border-round border-1 border-transparent transition-all transition-duration-200 flex align-items-center justify-content-between', { 'border-primary': selectedUser?.id === user.id }]"
        @contextmenu="onRightClick($event, user)"
    >
        <div class="flex align-items-center gap-2">
            <img :alt="user.name" :src="\`/images/avatar/\${user.image}\`" style="width: 32px" />
            <span class="font-bold">{{ user.name }}</span>
        </div>
        <Tag :value="user.role" :severity="getBadge(user)" />
    </li>
</ul>
<ContextMenu ref="menu" :model="items" @hide="selectedUser = null" />
<Toast />
`,
                options: `
<template>
    <div class="card flex md:justify-content-center">
        <ul class="m-0 p-0 list-none border-1 surface-border border-round p-3 flex flex-column gap-2 w-full md:w-30rem">
            <li
                v-for="user in users"
                :key="user.id"
                :class="['p-2 hover:surface-hover border-round border-1 border-transparent transition-all transition-duration-200 flex align-items-center justify-content-between', { 'border-primary': selectedUser?.id === user.id }]"
                @contextmenu="onRightClick($event, user)"
            >
                <div class="flex align-items-center gap-2">
                    <img :alt="user.name" :src="\`https://primefaces.org/cdn/primevue/images/avatar/\${user.image}\`" style="width: 32px" />
                    <span class="font-bold">{{ user.name }}</span>
                </div>
                <Tag :value="user.role" :severity="getBadge(user)" />
            </li>
        </ul>
        <ContextMenu ref="menu" :model="items" @hide="selectedUser = null" />
        <Toast />
    </div>
</template>

<script>
export default {
    data() {
        return {
            selectedUser: null,
            users: [
                { id: 0, name: 'Amy Elsner', image: 'amyelsner.png', role: 'Admin' },
                { id: 1, name: 'Anna Fali', image: 'annafali.png', role: 'Member' },
                { id: 2, name: 'Asiya Javayant', image: 'asiyajavayant.png', role: 'Member' },
                { id: 3, name: 'Bernardo Dominic', image: 'bernardodominic.png', role: 'Guest' },
                { id: 4, name: 'Elwin Sharvill', image: 'elwinsharvill.png', role: 'Member' }
            ],
            items: [
                {
                    label: 'Roles',
                    icon: 'pi pi-users',
                    items: [
                        {
                            label: 'Admin',
                            command: () => {
                                this.selectedUser.role = 'Admin';
                            }
                        },
                        {
                            label: 'Member',
                            command: () => {
                                this.selectedUser.role = 'Member';
                            }
                        },
                        {
                            label: 'Guest',
                            command: () => {
                                this.selectedUser.role = 'Guest';
                            }
                        }
                    ]
                },
                {
                    label: 'Invite',
                    icon: 'pi pi-user-plus',
                    command: () => {
                        this.$toast.add({ severity: 'success', summary: 'Success', detail: 'Invitation sent!', life: 3000 });
                    }
                }
            ]
        };
    },
    methods: {
        onRightClick(event, user) {
            this.selectedUser = user;
            this.$refs.menu.show(event);
        },
        getBadge(user) {
            if (user.role === 'Member') return 'info';
            else if (user.role === 'Guest') return 'warn';
            else return null;
        }
    }
};
<\/script>
`,
                composition: `
<template>
    <div class="card flex md:justify-content-center">
        <ul class="m-0 p-0 list-none border-1 surface-border border-round p-3 flex flex-column gap-2 w-full md:w-30rem">
            <li
                v-for="user in users"
                :key="user.id"
                :class="['p-2 hover:surface-hover border-round border-1 border-transparent transition-all transition-duration-200 flex align-items-center justify-content-between', { 'border-primary': selectedUser?.id === user.id }]"
                @contextmenu="onRightClick($event, user)"
            >
                <div class="flex align-items-center gap-2">
                    <img :alt="user.name" :src="\`https://primefaces.org/cdn/primevue/images/avatar/\${user.image}\`" style="width: 32px" />
                    <span class="font-bold">{{ user.name }}</span>
                </div>
                <Tag :value="user.role" :severity="getBadge(user)" />
            </li>
        </ul>
        <ContextMenu ref="menu" :model="items" @hide="selectedUser = null" />
        <Toast />
    </div>
</template>

<script setup>
import { ref } from 'vue';
import { useToast } from "primevue/usetoast";

const toast = useToast();
const selectedUser = ref();
const menu = ref();
const users = ref([
    { id: 0, name: 'Amy Elsner', image: 'amyelsner.png', role: 'Admin' },
    { id: 1, name: 'Anna Fali', image: 'annafali.png', role: 'Member' },
    { id: 2, name: 'Asiya Javayant', image: 'asiyajavayant.png', role: 'Member' },
    { id: 3, name: 'Bernardo Dominic', image: 'bernardodominic.png', role: 'Guest' },
    { id: 4, name: 'Elwin Sharvill', image: 'elwinsharvill.png', role: 'Member' }
]);
const items = ref([
    {
        label: 'Roles',
        icon: 'pi pi-users',
        items: [
            {
                label: 'Admin',
                command: () => {
                    selectedUser.value.role = 'Admin';
                }
            },
            {
                label: 'Member',
                command: () => {
                    selectedUser.value.role = 'Member';
                }
            },
            {
                label: 'Guest',
                command: () => {
                    selectedUser.value.role = 'Guest';
                }
            }
        ]
    },
    {
        label: 'Invite',
        icon: 'pi pi-user-plus',
        command: () => {
            toast.add({ severity: 'success', summary: 'Success', detail: 'Invitation sent!', life: 3000 });
        }
    }
]);

const onRightClick = (event, user) => {
    selectedUser.value = user;
    menu.value.show(event);
};

const getBadge = (user) => {
    if (user.role === 'Member') return 'info';
    else if (user.role === 'Guest') return 'warn';
    else return null;
}
<\/script>
`
            }
        };
    },
    methods: {
        onRightClick(event, user) {
            this.selectedUser = user;
            this.$refs.menu.show(event);
        },
        getBadge(user) {
            if (user.role === 'Member') return 'info';
            else if (user.role === 'Guest') return 'warn';
            else return null;
        }
    }
};
</script>