primevue-mirror/pages/dock/DockDoc.vue

1600 lines
57 KiB
Vue
Raw Normal View History

2022-09-09 20:41:18 +00:00
<template>
2022-12-08 12:26:57 +00:00
<AppDoc name="DockDemo" :sources="sources" github="dock/DockDemo.vue" :service="['NodeService', 'PhotoService']" :data="['treenodes', 'photos']">
<h5>Import via Module</h5>
<pre v-code.script><code>
2022-09-09 20:41:18 +00:00
import Dock from 'primevue/dock';
</code></pre>
2022-12-08 12:26:57 +00:00
<h5>Import via CDN</h5>
<pre v-code><code>
2022-09-09 20:41:18 +00:00
&lt;script src="https://unpkg.com/primevue@^3/core/core.min.js"&gt;&lt;/script&gt;
&lt;script src="https://unpkg.com/primevue@^3/slider/slider.min.js"&gt;&lt;/script&gt;
</code></pre>
2022-12-08 12:26:57 +00:00
<h5>Getting Started</h5>
<p>Dock is a navigation component consisting of menuitems. It has a collection of additional options defined by the <i>model</i> property.</p>
2022-09-09 20:41:18 +00:00
2022-12-08 12:26:57 +00:00
<pre v-code><code>
2022-09-09 20:41:18 +00:00
&lt;Dock :model="items" /&gt;
</code></pre>
2022-12-08 12:26:57 +00:00
<pre v-code.script><code><template>
2022-09-09 20:41:18 +00:00
export default {
data() {
return {
items: [
{
label: "Finder",
2022-12-09 07:52:51 +00:00
icon: "/demo/images/dock/finder.svg"
2022-09-09 20:41:18 +00:00
},
{
label: "App Store",
2022-12-09 07:52:51 +00:00
icon: "/demo/images/dock/appstore.svg"
2022-09-09 20:41:18 +00:00
},
{
label: "Photos",
2022-12-09 07:52:51 +00:00
icon: "/demo/images/dock/photos.svg"
2022-09-09 20:41:18 +00:00
},
{
label: "Trash",
2022-12-09 07:52:51 +00:00
icon: "/demo/images/dock/trash.png"
2022-09-09 20:41:18 +00:00
}
]
}
}
}
</template>
</code></pre>
2022-12-08 12:26:57 +00:00
<h5>MenuModel API</h5>
<p>Dock uses the common MenuModel API to define the items, visit <router-link to="/menumodel">MenuModel API</router-link> for details.</p>
<h5>Properties</h5>
<p>Any property as style and class are passed to the main container element. Following are the additional properties to configure the component.</p>
<div class="doc-tablewrapper">
<table class="doc-table">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Default</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>model</td>
<td>object</td>
<td>null</td>
<td>MenuModel instance to define the action items.</td>
</tr>
<tr>
<td>position</td>
<td>string</td>
<td>bottom</td>
<td>Position of element. Valid values are 'bottom', 'top', 'left' and 'right'.</td>
</tr>
<tr>
<td>class</td>
<td>string</td>
<td>null</td>
<td>Style class of the element.</td>
</tr>
<tr>
<td>style</td>
<td>object</td>
<td>null</td>
<td>Inline style of the element.</td>
</tr>
<tr>
<td>exact</td>
<td>boolean</td>
<td>true</td>
<td>Whether to apply 'router-link-active-exact' class if route exactly matches the item path.</td>
</tr>
<tr>
<td>tooltipOptions</td>
<td>object</td>
<td>null</td>
<td>Whether to display the tooltip on items. The modifiers of <router-link to="/tooltip">Tooltip</router-link> can be used like an object in it. Valid keys are 'event' and 'position'.</td>
</tr>
<tr>
<td>menuId</td>
<td>string</td>
<td>null</td>
<td>Unique identifier of the menu.</td>
</tr>
<tr>
<td>tabindex</td>
<td>number</td>
<td>0</td>
<td>Index of the element in tabbing order.</td>
</tr>
</tbody>
</table>
</div>
2022-09-09 20:41:18 +00:00
2022-12-08 12:26:57 +00:00
<h5>Events</h5>
<div class="doc-tablewrapper">
<table class="doc-table">
<thead>
<tr>
<th>Name</th>
<th>Parameters</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>focus</td>
<td>event</td>
<td>Callback to invoke when the component receives focus.</td>
</tr>
<tr>
<td>blur</td>
<td>event</td>
<td>Callback to invoke when the component loses focus.</td>
</tr>
</tbody>
</table>
</div>
2022-09-09 20:41:18 +00:00
2022-12-08 12:26:57 +00:00
<h5>Styling</h5>
<p>Following is the list of structural style classes, for theming classes visit <router-link to="/theming">theming</router-link> page.</p>
<div class="doc-tablewrapper">
<table class="doc-table">
<thead>
<tr>
<th>Name</th>
<th>Element</th>
</tr>
</thead>
<tbody>
<tr>
<td>p-dock</td>
<td>Container element.</td>
</tr>
<tr>
<td>p-dock-list-container</td>
<td>Container of the list.</td>
</tr>
<tr>
<td>p-dock-list</td>
<td>List of items.</td>
</tr>
<tr>
<td>p-dock-item</td>
<td>Each items in list.</td>
</tr>
<tr>
<td>p-menuitem-content</td>
<td>Content of menuitem.</td>
</tr>
<tr>
<td>p-dock-link</td>
<td>Link of the menuitem.</td>
</tr>
<tr>
<td>p-dock-icon</td>
<td>Icon of a menuitem.</td>
</tr>
</tbody>
</table>
</div>
<h5>Slots</h5>
<div class="doc-tablewrapper">
<table class="doc-table">
<thead>
<tr>
<th>Name</th>
<th>Parameters</th>
</tr>
</thead>
<tbody>
<tr>
<td>item</td>
<td>
item: Custom content for menuitem<br />
index: Index of the menuitem
</td>
</tr>
<tr>
<td>icon</td>
<td>item: Custom content for icon</td>
</tr>
</tbody>
</table>
</div>
2022-09-09 20:41:18 +00:00
2022-12-08 12:26:57 +00:00
<h5>Accessibility</h5>
<h6>Screen Reader</h6>
<p>
Dock component uses the <i>menu</i> role with the <i>aria-orientation</i> and the value to describe the menu can either be provided with <i>aria-labelledby</i> or <i>aria-label</i> props. Each list item has a <i>menuitem</i> role with
<i>aria-label</i> referring to the label of the item and <i>aria-disabled</i> defined if the item is disabled.
</p>
<h6>Keyboard Support</h6>
<div class="doc-tablewrapper">
<table class="doc-table">
<thead>
<tr>
<th>Key</th>
<th>Function</th>
</tr>
</thead>
<tbody>
<tr>
<td>
<i>tab</i>
</td>
<td>Moves focus to the first menuitem.</td>
</tr>
<tr>
<td>
<i>enter</i>
</td>
<td>Activates the focused menuitem.</td>
</tr>
<tr>
<td>
<i>space</i>
</td>
<td>Activates the focused menuitem.</td>
</tr>
<tr>
<td>
<i>down arrow</i>
</td>
<td>Moves focus to the next menuitem in vertical layout.</td>
</tr>
<tr>
<td>
<i>up arrow</i>
</td>
<td>Moves focus to the previous menuitem in vertical layout.</td>
</tr>
<tr>
<td>
<i>right arrow</i>
</td>
<td>Moves focus to the next menuitem in horizontal layout.</td>
</tr>
<tr>
<td>
<i>left arrow</i>
</td>
<td>Moves focus to the previous menuitem in horizontal layout.</td>
</tr>
<tr>
<td>
<i>home</i>
</td>
<td>Moves focus to the first menuitem.</td>
</tr>
<tr>
<td>
<i>end</i>
</td>
<td>Moves focus to the last menuitem.</td>
</tr>
</tbody>
</table>
</div>
<h5>Dependencies</h5>
<p>None.</p>
</AppDoc>
2022-09-09 20:41:18 +00:00
</template>
<script>
export default {
data() {
return {
sources: {
'options-api': {
tabName: 'Options API Source',
content: `
<template>
<div>
<div class="dock-demo">
<Toast />
<Toast position="top-center" group="tc" />
<h5>Basic</h5>
<div class="dock-window">
2022-12-08 12:26:57 +00:00
<Dock :model="dockBasicItems" position="top">
2022-09-09 20:41:18 +00:00
<template #icon="{ item }">
<img :alt="item.label" :src="item.icon" style="width: 100%" />
</template>
</Dock>
2022-12-08 12:26:57 +00:00
<Dock :model="dockBasicItems" position="right">
2022-09-09 20:41:18 +00:00
<template #icon="{ item }">
<img :alt="item.label" :src="item.icon" style="width: 100%" />
</template>
</Dock>
2022-12-08 12:26:57 +00:00
<Dock :model="dockBasicItems" position="bottom">
2022-09-09 20:41:18 +00:00
<template #icon="{ item }">
<img :alt="item.label" :src="item.icon" style="width: 100%" />
</template>
</Dock>
2022-12-08 12:26:57 +00:00
<Dock :model="dockBasicItems" position="left">
2022-09-09 20:41:18 +00:00
<template #icon="{ item }">
<img :alt="item.label" :src="item.icon" style="width: 100%" />
</template>
</Dock>
</div>
<h5>Advanced</h5>
<Menubar :model="menubarItems">
<template #start>
<i class="pi pi-apple"></i>
</template>
<template #end>
<i class="pi pi-video" />
<i class="pi pi-wifi" />
<i class="pi pi-volume-up" />
<span>Fri 13:07</span>
<i class="pi pi-search" />
<i class="pi pi-bars" />
</template>
</Menubar>
<div class="dock-window dock-advanced">
<Dock :model="dockItems">
<template #item="{ item }">
2022-12-08 12:26:57 +00:00
<a href="#" class="p-dock-link" v-tooltip.top="item.label" @click="onDockItemClick($event, item)">
2022-09-09 20:41:18 +00:00
<img :alt="item.label" src="https://www.primefaces.org/wp-content/uploads/2020/05/placeholder.png" style="width: 100%">
</a>
</template>
</Dock>
<Dialog v-model:visible="displayTerminal" header="Terminal" :breakpoints="{ '960px': '50vw' }" :style="{ width: '40vw' }" :maximizable="true">
<Terminal welcomeMessage="Welcome to PrimeVue(cmd: 'date', 'greet {0}', 'random' and 'clear')" prompt="primevue $" />
</Dialog>
<Dialog v-model:visible="displayFinder" header="Finder" :breakpoints="{ '960px': '50vw' }" :style="{ width: '40vw' }" :maximizable="true">
<Tree :value="nodes" />
</Dialog>
<Galleria v-model:visible="displayPhotos" :value="images" :responsiveOptions="responsiveOptions" :numVisible="2" containerStyle="width: 400px"
:circular="true" :fullScreen="true" :showThumbnails="false" :showItemNavigators="true">
<template #item="slotProps">
<img src='https://www.primefaces.org/wp-content/uploads/2020/05/placeholder.png' :alt="slotProps.item.alt" style="width: 100%" />
</template>
</Galleria>
</div>
</div>
</div>
</template>
<script>
import NodeService from './service/NodeService';
import PhotoService from './service/PhotoService';
import TerminalService from 'primevue/terminalservice';
export default {
data() {
return {
displayFinder: false,
displayTerminal: false,
displayPhotos: false,
images: null,
nodes: null,
imgErrorPath: 'https://www.primefaces.org/wp-content/uploads/2020/05/placeholder.png',
dockItems: [
{
label: 'Finder',
2022-12-09 07:52:51 +00:00
icon: "/demo/images/dock/finder.svg",
2022-09-09 20:41:18 +00:00
command: () => {
this.displayFinder = true;
}
},
{
label: 'Terminal',
2022-12-09 07:52:51 +00:00
icon: "/demo/images/dock/terminal.svg",
2022-09-09 20:41:18 +00:00
command: () => {
this.displayTerminal = true;
}
},
{
label: 'App Store',
2022-12-09 07:52:51 +00:00
icon: "/demo/images/dock/appstore.svg",
2022-09-09 20:41:18 +00:00
command: () => {
this.$toast.add({ severity: 'error', summary: 'An unexpected error occurred while signing in.', detail: 'UNTRUSTED_CERT_TITLE', group: 'tc', life: 3000 });
}
},
{
label: 'Safari',
2022-12-09 07:52:51 +00:00
icon: "/demo/images/dock/safari.svg",
2022-09-09 20:41:18 +00:00
command: () => {
this.$toast.add({ severity: 'warn', summary: 'Safari has stopped working', group: 'tc', life: 3000 });
}
},
{
label: 'Photos',
2022-12-09 07:52:51 +00:00
icon: "/demo/images/dock/photos.svg",
2022-09-09 20:41:18 +00:00
command: () => {
this.displayPhotos = true;
}
},
{
label: 'GitHub',
2022-12-09 07:52:51 +00:00
icon: "/demo/images/dock/github.svg",
2022-09-09 20:41:18 +00:00
},
{
label: 'Trash',
2022-12-09 07:52:51 +00:00
icon: "/demo/images/dock/trash.png",
2022-09-09 20:41:18 +00:00
command: () => {
this.$toast.add({ severity: 'info', summary: 'Empty Trash', life: 3000 });
}
}
],
dockBasicItems: [
{
label: "Finder",
2022-12-09 07:52:51 +00:00
icon: "/demo/images/dock/finder.svg"
2022-09-09 20:41:18 +00:00
},
{
label: "App Store",
2022-12-09 07:52:51 +00:00
icon: "/demo/images/dock/appstore.svg"
2022-09-09 20:41:18 +00:00
},
{
label: "Photos",
2022-12-09 07:52:51 +00:00
icon: "/demo/images/dock/photos.svg"
2022-09-09 20:41:18 +00:00
},
{
label: "Trash",
2022-12-09 07:52:51 +00:00
icon: "/demo/images/dock/trash.png"
2022-09-09 20:41:18 +00:00
}
],
menubarItems: [
{
label: 'Finder',
class: 'menubar-root'
},
{
label: 'File',
items: [
{
label: 'New',
icon: 'pi pi-fw pi-plus',
items: [
{
label: 'Bookmark',
icon: 'pi pi-fw pi-bookmark'
},
{
label: 'Video',
icon: 'pi pi-fw pi-video'
},
]
},
{
label: 'Delete',
icon: 'pi pi-fw pi-trash'
},
{
separator: true
},
{
label: 'Export',
icon: 'pi pi-fw pi-external-link'
}
]
},
{
label: 'Edit',
items: [
{
label: 'Left',
icon: 'pi pi-fw pi-align-left'
},
{
label: 'Right',
icon: 'pi pi-fw pi-align-right'
},
{
label: 'Center',
icon: 'pi pi-fw pi-align-center'
},
{
label: 'Justify',
icon: 'pi pi-fw pi-align-justify'
},
]
},
{
label: 'Users',
items: [
{
label: 'New',
icon: 'pi pi-fw pi-user-plus',
},
{
label: 'Delete',
icon: 'pi pi-fw pi-user-minus',
},
{
label: 'Search',
icon: 'pi pi-fw pi-users',
items: [
{
label: 'Filter',
icon: 'pi pi-fw pi-filter',
items: [
{
label: 'Print',
icon: 'pi pi-fw pi-print'
}
]
},
{
icon: 'pi pi-fw pi-bars',
label: 'List'
}
]
}
]
},
{
label: 'Events',
items: [
{
label: 'Edit',
icon: 'pi pi-fw pi-pencil',
items: [
{
label: 'Save',
icon: 'pi pi-fw pi-calendar-plus'
},
{
label: 'Delete',
icon: 'pi pi-fw pi-calendar-minus'
}
]
},
{
label: 'Archieve',
icon: 'pi pi-fw pi-calendar-times',
items: [
{
label: 'Remove',
icon: 'pi pi-fw pi-calendar-minus'
}
]
}
]
},
{
label: 'Quit'
}
],
responsiveOptions: [
{
breakpoint: '1024px',
numVisible: 3
},
{
breakpoint: '768px',
numVisible: 2
},
{
breakpoint: '560px',
numVisible: 1
}
]
}
},
nodeService: null,
photoService: null,
created() {
this.nodeService = new NodeService();
this.photoService = new PhotoService();
},
mounted() {
this.photoService.getImages().then(data => this.images = data);
this.nodeService.getTreeNodes().then(data => this.nodes = data);
TerminalService.on('command', this.commandHandler);
},
beforeUnmount() {
TerminalService.off('command', this.commandHandler);
},
methods: {
onDockItemClick(event, item) {
if (item.command) {
item.command();
}
event.preventDefault();
},
commandHandler(text) {
let response;
let argsIndex = text.indexOf(' ');
let command = argsIndex !== -1 ? text.substring(0, argsIndex) : text;
switch(command) {
case "date":
response = 'Today is ' + new Date().toDateString();
break;
case "greet":
response = 'Hola ' + text.substring(argsIndex + 1);
break;
case "random":
response = Math.floor(Math.random() * 100);
break;
default:
response = "Unknown command: " + command;
}
TerminalService.emit('response', response);
}
}
}
<\\/script>
<style scoped lang="scss">
::v-deep(.dock-demo) {
.dock-window {
width: 100%;
height: 450px;
position: relative;
background-image: url("https://www.primefaces.org/wp-content/uploads/2021/02/primevue-blog.jpg");
background-repeat: no-repeat;
background-size: cover;
background-position: center;
z-index: 1;
}
.p-dock {
z-index: 1000;
}
.p-menubar {
padding-top: 0;
padding-bottom: 0;
border-radius: 0;
.menubar-root {
font-weight: bold;
padding: 0 1rem;
}
.p-menuitem-link {
padding: 0.5rem .75rem;
}
2022-12-08 12:26:57 +00:00
.p-menubar-root-list > .p-menuitem > .p-menuitem-content > .p-menuitem-link {
2022-09-09 20:41:18 +00:00
padding: 0.5rem .75rem;
> .p-submenu-icon {
display: none;
}
}
.p-menubar-end {
span, i {
padding: 0 .75rem;
}
}
.p-submenu-list {
z-index: 2;
}
}
}
</style>
`
},
'composition-api': {
tabName: 'Composition API Source',
content: `
<template>
<div>
<div class="content-section implementation dock-demo">
<Toast />
<Toast position="top-center" group="tc" />
<h5>Basic</h5>
<div class="dock-window">
2022-12-08 12:26:57 +00:00
<Dock :model="dockBasicItems" position="top">
2022-09-09 20:41:18 +00:00
<template #icon="{ item }">
<img :alt="item.label" :src="item.icon" style="width: 100%" />
</template>
</Dock>
2022-12-08 12:26:57 +00:00
<Dock :model="dockBasicItems" position="right">
2022-09-09 20:41:18 +00:00
<template #icon="{ item }">
<img :alt="item.label" :src="item.icon" style="width: 100%" />
</template>
</Dock>
2022-12-08 12:26:57 +00:00
<Dock :model="dockBasicItems" position="bottom">
2022-09-09 20:41:18 +00:00
<template #icon="{ item }">
<img :alt="item.label" :src="item.icon" style="width: 100%" />
</template>
</Dock>
2022-12-08 12:26:57 +00:00
<Dock :model="dockBasicItems" position="left">
2022-09-09 20:41:18 +00:00
<template #icon="{ item }">
<img :alt="item.label" :src="item.icon" style="width: 100%" />
</template>
</Dock>
</div>
<h5>Advanced</h5>
<Menubar :model="menubarItems">
<template #start>
<i class="pi pi-apple"></i>
</template>
<template #end>
<i class="pi pi-video" />
<i class="pi pi-wifi" />
<i class="pi pi-volume-up" />
<span>Fri 13:07</span>
<i class="pi pi-search" />
<i class="pi pi-bars" />
</template>
</Menubar>
<div class="dock-window dock-advanced">
<Dock :model="dockItems">
<template #item="{ item }">
2022-12-08 12:26:57 +00:00
<a href="#" class="p-dock-link" v-tooltip.top="item.label" @click="onDockItemClick($event, item)">
2022-09-09 20:41:18 +00:00
<img :alt="item.label" src="https://www.primefaces.org/wp-content/uploads/2020/05/placeholder.png" style="width: 100%" />
</a>
</template>
</Dock>
<Dialog v-model:visible="displayTerminal" header="Terminal" :breakpoints="{ '960px': '50vw' }" :style="{ width: '40vw' }" :maximizable="true">
<Terminal welcomeMessage="Welcome to PrimeVue(cmd: 'date', 'greet {0}', 'random' and 'clear')" prompt="primevue $" />
</Dialog>
<Dialog v-model:visible="displayFinder" header="Finder" :breakpoints="{ '960px': '50vw' }" :style="{ width: '40vw' }" :maximizable="true">
<Tree :value="nodes" />
</Dialog>
<Galleria v-model:visible="displayPhotos" :value="images" :responsiveOptions="responsiveOptions" :numVisible="2" containerStyle="width: 400px"
:circular="true" :fullScreen="true" :showThumbnails="false" :showItemNavigators="true">
<template #item="slotProps">
<img src="https://www.primefaces.org/wp-content/uploads/2020/05/placeholder.png" :alt="slotProps.item.alt" style="width: 100%" />
</template>
</Galleria>
</div>
</div>
</div>
</template>
<script>
import { ref, onMounted, onBeforeUnmount } from 'vue';
import { useToast } from 'primevue/usetoast';
import NodeService from './service/NodeService';
import PhotoService from './service/PhotoService';
import TerminalService from 'primevue/terminalservice';
export default {
setup() {
onMounted(() => {
photoService.value.getImages().then(data => images.value = data);
nodeService.value.getTreeNodes().then(data => nodes.value = data);
TerminalService.on('command', commandHandler);
})
onBeforeUnmount(() => {
TerminalService.off('command', commandHandler);
})
const displayFinder = ref(false);
const displayTerminal = ref(false);
const displayPhotos = ref(false);
const nodeService = ref(new NodeService());
const photoService = ref(new PhotoService());
const images = ref();
const nodes = ref();
const toast = useToast();
const imgErrorPath = ref('https://www.primefaces.org/wp-content/uploads/2020/05/placeholder.png');
const dockItems = ref([
{
label: 'Finder',
2022-12-09 07:52:51 +00:00
icon: "/demo/images/dock/finder.svg",
2022-09-09 20:41:18 +00:00
command: () => {
displayFinder.value = true;
}
},
{
label: 'Terminal',
2022-12-09 07:52:51 +00:00
icon: "/demo/images/dock/terminal.svg",
2022-09-09 20:41:18 +00:00
command: () => {
displayTerminal.value = true;
}
},
{
label: 'App Store',
2022-12-09 07:52:51 +00:00
icon: "/demo/images/dock/appstore.svg",
2022-09-09 20:41:18 +00:00
command: () => {
toast.add({ severity: 'error', summary: 'An unexpected error occurred while signing in.', detail: 'UNTRUSTED_CERT_TITLE', group: 'tc', life: 3000 });
}
},
{
label: 'Safari',
2022-12-09 07:52:51 +00:00
icon: "/demo/images/dock/safari.svg",
2022-09-09 20:41:18 +00:00
command: () => {
toast.add({ severity: 'warn', summary: 'Safari has stopped working', group: 'tc', life: 3000 });
}
},
{
label: 'Photos',
2022-12-09 07:52:51 +00:00
icon: "/demo/images/dock/photos.svg",
2022-09-09 20:41:18 +00:00
command: () => {
displayPhotos.value = true;
}
},
{
label: 'GitHub',
2022-12-09 07:52:51 +00:00
icon: "/demo/images/dock/github.svg",
2022-09-09 20:41:18 +00:00
},
{
label: 'Trash',
2022-12-09 07:52:51 +00:00
icon: "/demo/images/dock/trash.png",
2022-09-09 20:41:18 +00:00
command: () => {
toast.add({ severity: 'info', summary: 'Empty Trash', life: 3000 });
}
}
]);
const dockBasicItems = ref([
{
label: "Finder",
2022-12-09 07:52:51 +00:00
icon: "/demo/images/dock/finder.svg"
2022-09-09 20:41:18 +00:00
},
{
label: "App Store",
2022-12-09 07:52:51 +00:00
icon: "/demo/images/dock/appstore.svg"
2022-09-09 20:41:18 +00:00
},
{
label: "Photos",
2022-12-09 07:52:51 +00:00
icon: "/demo/images/dock/photos.svg"
2022-09-09 20:41:18 +00:00
},
{
label: "Trash",
2022-12-09 07:52:51 +00:00
icon: "/demo/images/dock/trash.png"
2022-09-09 20:41:18 +00:00
}
]);
const menubarItems = ref([
{
label: 'Finder',
class: 'menubar-root'
},
{
label: 'File',
items: [
{
label: 'New',
icon: 'pi pi-fw pi-plus',
items: [
{
label: 'Bookmark',
icon: 'pi pi-fw pi-bookmark'
},
{
label: 'Video',
icon: 'pi pi-fw pi-video'
},
]
},
{
label: 'Delete',
icon: 'pi pi-fw pi-trash'
},
{
separator: true
},
{
label: 'Export',
icon: 'pi pi-fw pi-external-link'
}
]
},
{
label: 'Edit',
items: [
{
label: 'Left',
icon: 'pi pi-fw pi-align-left'
},
{
label: 'Right',
icon: 'pi pi-fw pi-align-right'
},
{
label: 'Center',
icon: 'pi pi-fw pi-align-center'
},
{
label: 'Justify',
icon: 'pi pi-fw pi-align-justify'
},
]
},
{
label: 'Users',
items: [
{
label: 'New',
icon: 'pi pi-fw pi-user-plus',
},
{
label: 'Delete',
icon: 'pi pi-fw pi-user-minus',
},
{
label: 'Search',
icon: 'pi pi-fw pi-users',
items: [
{
label: 'Filter',
icon: 'pi pi-fw pi-filter',
items: [
{
label: 'Print',
icon: 'pi pi-fw pi-print'
}
]
},
{
icon: 'pi pi-fw pi-bars',
label: 'List'
}
]
}
]
},
{
label: 'Events',
items: [
{
label: 'Edit',
icon: 'pi pi-fw pi-pencil',
items: [
{
label: 'Save',
icon: 'pi pi-fw pi-calendar-plus'
},
{
label: 'Delete',
icon: 'pi pi-fw pi-calendar-minus'
}
]
},
{
label: 'Archieve',
icon: 'pi pi-fw pi-calendar-times',
items: [
{
label: 'Remove',
icon: 'pi pi-fw pi-calendar-minus'
}
]
}
]
},
{
label: 'Quit'
}
]);
const responsiveOptions = ref([
{
breakpoint: '1024px',
numVisible: 3
},
{
breakpoint: '768px',
numVisible: 2
},
{
breakpoint: '560px',
numVisible: 1
}
]);
const onDockItemClick = (event, item) => {
if (item.command) {
item.command();
}
event.preventDefault();
};
const commandHandler = (text) => {
let response;
let argsIndex = text.indexOf(' ');
let command = argsIndex !== -1 ? text.substring(0, argsIndex) : text;
switch(command) {
case "date":
response = 'Today is ' + new Date().toDateString();
break;
case "greet":
response = 'Hola ' + text.substring(argsIndex + 1);
break;
case "random":
response = Math.floor(Math.random() * 100);
break;
default:
response = "Unknown command: " + command;
}
TerminalService.emit('response', response);
};
return { images, nodes, dockItems, dockBasicItems, menubarItems, onDockItemClick, commandHandler,
displayTerminal, displayFinder, displayPhotos, responsiveOptions }
},
methods: {
onDockItemClick(event, item) {
if (item.command) {
item.command();
}
event.preventDefault();
},
commandHandler(text) {
let response;
let argsIndex = text.indexOf(' ');
let command = argsIndex !== -1 ? text.substring(0, argsIndex) : text;
switch(command) {
case "date":
response = 'Today is ' + new Date().toDateString();
break;
case "greet":
response = 'Hola ' + text.substring(argsIndex + 1);
break;
case "random":
response = Math.floor(Math.random() * 100);
break;
default:
response = "Unknown command: " + command;
}
TerminalService.emit('response', response);
}
}
}
<\\/script>
<style scoped lang="scss">
::v-deep(.dock-demo) {
.dock-window {
width: 100%;
height: 450px;
position: relative;
background-image: url("https://www.primefaces.org/wp-content/uploads/2021/02/primevue-blog.jpg");
background-repeat: no-repeat;
background-size: cover;
background-position: center;
z-index: 1;
}
.p-dock {
z-index: 1000;
}
.p-menubar {
padding-top: 0;
padding-bottom: 0;
border-radius: 0;
.menubar-root {
font-weight: bold;
padding: 0 1rem;
}
.p-menuitem-link {
padding: 0.5rem .75rem;
}
2022-12-08 12:26:57 +00:00
.p-menubar-root-list > .p-menuitem > .p-menuitem-content > .p-menuitem-link {
2022-09-09 20:41:18 +00:00
padding: 0.5rem .75rem;
> .p-submenu-icon {
display: none;
}
}
.p-menubar-end {
span, i {
padding: 0 .75rem;
}
}
.p-submenu-list {
z-index: 2;
}
}
}
</style>
`
},
'browser-source': {
tabName: 'Browser Source',
imports: `<script src="https://unpkg.com/vue-router@4.0.0/dist/vue-router.global.js"><\\/script>
<script src="https://unpkg.com/primevue@^3/dock/dock.min.js"><\\/script>
<script src="https://unpkg.com/primevue@^3/toast/toast.min.js"><\\/script>
<script src="https://unpkg.com/primevue@^3/toastservice/toastservice.min.js"><\\/script>
<script src="https://unpkg.com/primevue@^3/menubar/menubar.min.js"><\\/script>
<script src="https://unpkg.com/primevue@^3/terminal/terminal.min.js"><\\/script>
<script src="https://unpkg.com/primevue@^3/galleria/galleria.min.js"><\\/script>
<script src="./NodeService.js"><\\/script>
<script src="./PhotoService.js"><\\/script>`,
content: `<div id="app" class="dock-demo">
<p-toast></p-toast>
<p-toast position="top-center" group="tc"></p-toast>
<h5>Basic</h5>
<div class="dock-window">
2022-12-08 12:26:57 +00:00
<p-dock :model="dockBasicItems" position="top">
2022-09-09 20:41:18 +00:00
<template #icon="{ item }">
<img :alt="item.label" src="https://www.primefaces.org/wp-content/uploads/2020/05/placeholder.png" style="width: 100%" />
</template>
</p-dock>
2022-12-08 12:26:57 +00:00
<p-dock :model="dockBasicItems" position="right">
2022-09-09 20:41:18 +00:00
<template #icon="{ item }">
<img :alt="item.label" src="https://www.primefaces.org/wp-content/uploads/2020/05/placeholder.png" style="width: 100%" />
</template>
</p-dock>
2022-12-08 12:26:57 +00:00
<p-dock :model="dockBasicItems" position="bottom">
2022-09-09 20:41:18 +00:00
<template #icon="{ item }">
<img :alt="item.label" src="https://www.primefaces.org/wp-content/uploads/2020/05/placeholder.png" style="width: 100%" />
</template>
</p-dock>
2022-12-08 12:26:57 +00:00
<p-dock :model="dockBasicItems" position="left">
2022-09-09 20:41:18 +00:00
<template #icon="{ item }">
<img :alt="item.label" src="https://www.primefaces.org/wp-content/uploads/2020/05/placeholder.png" style="width: 100%" />
</template>
</p-dock>
</div>
<h5>Advanced</h5>
<p-menubar :model="menubarItems">
<template #start>
<i class="pi pi-apple"></i>
</template>
<template #end>
<i class="pi pi-video"></i>
<i class="pi pi-wifi"></i>
<i class="pi pi-volume-up"></i>
<span>Fri 13:07</span>
<i class="pi pi-search"></i>
<i class="pi pi-bars"></i>
</template>
</p-menubar>
<div class="dock-window dock-advanced">
<p-dock :model="dockItems">
<template #item="{ item }">
2022-12-08 12:26:57 +00:00
<a href="#" class="p-dock-link" v-tooltip.top="item.label" @click="onDockItemClick($event, item)">
2022-09-09 20:41:18 +00:00
<img :alt="item.label" src="https://www.primefaces.org/wp-content/uploads/2020/05/placeholder.png" style="width: 100%" />
</a>
</template>
</p-dock>
<p-dialog v-model:visible="displayTerminal" header="Terminal" :breakpoints="{ '960px': '50vw' }" :style="{ width: '40vw' }" :maximizable="true">
<p-terminal welcome-message="Welcome to PrimeVue(cmd: 'date', 'greet {0}', 'random' and 'clear')" prompt="primevue $"></p-terminal>
</p-dialog>
<p-dialog v-model:visible="displayFinder" header="Finder" :breakpoints="{ '960px': '50vw' }" :style="{ width: '40vw' }" :maximizable="true">
<p-tree :value="nodes"></p-tree>
</p-dialog>
<p-galleria v-model:visible="displayPhotos" :value="images" :responsive-options="responsiveOptions" :num-visible="2" container-style="width: 400px"
:circular="true" :full-screen="true" :show-thumbnails="false" :show-item-navigators="true">
<template #item="slotProps">
<img src="https://www.primefaces.org/wp-content/uploads/2020/05/placeholder.png" :alt="slotProps.item.alt" style="width: 100%" />
</template>
</p-galleria>
</div>
</div>
<script type="module">
const { createApp, ref, onMounted, onBeforeUnmount } = Vue;
const { useToast } = primevue.usetoast;
const TerminalService = primevue.terminalservice;
const Tooltip = primevue.tooltip;
const App = {
setup() {
onMounted(() => {
photoService.value.getImages().then(data => images.value = data);
nodeService.value.getTreeNodes().then(data => nodes.value = data);
TerminalService.on('command', commandHandler);
})
onBeforeUnmount(() => {
TerminalService.off('command', commandHandler);
})
const displayFinder = ref(false);
const displayTerminal = ref(false);
const displayPhotos = ref(false);
const nodeService = ref(new NodeService());
const photoService = ref(new PhotoService());
const images = ref();
const nodes = ref();
const toast = useToast();
const imgErrorPath = ref('https://www.primefaces.org/wp-content/uploads/2020/05/placeholder.png');
const dockItems = ref([
{
label: 'Finder',
2022-12-09 07:52:51 +00:00
icon: "/demo/images/dock/finder.svg",
2022-09-09 20:41:18 +00:00
command: () => {
displayFinder.value = true;
}
},
{
label: 'Terminal',
2022-12-09 07:52:51 +00:00
icon: "/demo/images/dock/terminal.svg",
2022-09-09 20:41:18 +00:00
command: () => {
displayTerminal.value = true;
}
},
{
label: 'App Store',
2022-12-09 07:52:51 +00:00
icon: "/demo/images/dock/appstore.svg",
2022-09-09 20:41:18 +00:00
command: () => {
toast.add({ severity: 'error', summary: 'An unexpected error occurred while signing in.', detail: 'UNTRUSTED_CERT_TITLE', group: 'tc', life: 3000 });
}
},
{
label: 'Safari',
2022-12-09 07:52:51 +00:00
icon: "/demo/images/dock/safari.svg",
2022-09-09 20:41:18 +00:00
command: () => {
toast.add({ severity: 'warn', summary: 'Safari has stopped working', group: 'tc', life: 3000 });
}
},
{
label: 'Photos',
2022-12-09 07:52:51 +00:00
icon: "/demo/images/dock/photos.svg",
2022-09-09 20:41:18 +00:00
command: () => {
displayPhotos.value = true;
}
},
{
label: 'GitHub',
2022-12-09 07:52:51 +00:00
icon: "/demo/images/dock/github.svg",
2022-09-09 20:41:18 +00:00
},
{
label: 'Trash',
2022-12-09 07:52:51 +00:00
icon: "/demo/images/dock/trash.png",
2022-09-09 20:41:18 +00:00
command: () => {
toast.add({ severity: 'info', summary: 'Empty Trash', life: 3000 });
}
}
]);
const dockBasicItems = ref([
{
label: "Finder",
2022-12-09 07:52:51 +00:00
icon: "/demo/images/dock/finder.svg"
2022-09-09 20:41:18 +00:00
},
{
label: "App Store",
2022-12-09 07:52:51 +00:00
icon: "/demo/images/dock/appstore.svg"
2022-09-09 20:41:18 +00:00
},
{
label: "Photos",
2022-12-09 07:52:51 +00:00
icon: "/demo/images/dock/photos.svg"
2022-09-09 20:41:18 +00:00
},
{
label: "Trash",
2022-12-09 07:52:51 +00:00
icon: "/demo/images/dock/trash.png"
2022-09-09 20:41:18 +00:00
}
]);
const menubarItems = ref([
{
label: 'Finder',
class: 'menubar-root'
},
{
label: 'File',
items: [
{
label: 'New',
icon: 'pi pi-fw pi-plus',
items: [
{
label: 'Bookmark',
icon: 'pi pi-fw pi-bookmark'
},
{
label: 'Video',
icon: 'pi pi-fw pi-video'
},
]
},
{
label: 'Delete',
icon: 'pi pi-fw pi-trash'
},
{
separator: true
},
{
label: 'Export',
icon: 'pi pi-fw pi-external-link'
}
]
},
{
label: 'Edit',
items: [
{
label: 'Left',
icon: 'pi pi-fw pi-align-left'
},
{
label: 'Right',
icon: 'pi pi-fw pi-align-right'
},
{
label: 'Center',
icon: 'pi pi-fw pi-align-center'
},
{
label: 'Justify',
icon: 'pi pi-fw pi-align-justify'
},
]
},
{
label: 'Users',
items: [
{
label: 'New',
icon: 'pi pi-fw pi-user-plus',
},
{
label: 'Delete',
icon: 'pi pi-fw pi-user-minus',
},
{
label: 'Search',
icon: 'pi pi-fw pi-users',
items: [
{
label: 'Filter',
icon: 'pi pi-fw pi-filter',
items: [
{
label: 'Print',
icon: 'pi pi-fw pi-print'
}
]
},
{
icon: 'pi pi-fw pi-bars',
label: 'List'
}
]
}
]
},
{
label: 'Events',
items: [
{
label: 'Edit',
icon: 'pi pi-fw pi-pencil',
items: [
{
label: 'Save',
icon: 'pi pi-fw pi-calendar-plus'
},
{
label: 'Delete',
icon: 'pi pi-fw pi-calendar-minus'
}
]
},
{
label: 'Archieve',
icon: 'pi pi-fw pi-calendar-times',
items: [
{
label: 'Remove',
icon: 'pi pi-fw pi-calendar-minus'
}
]
}
]
},
{
label: 'Quit'
}
]);
const responsiveOptions = ref([
{
breakpoint: '1024px',
numVisible: 3
},
{
breakpoint: '768px',
numVisible: 2
},
{
breakpoint: '560px',
numVisible: 1
}
]);
const onDockItemClick = (event, item) => {
if (item.command) {
item.command();
}
event.preventDefault();
};
const commandHandler = (text) => {
let response;
let argsIndex = text.indexOf(' ');
let command = argsIndex !== -1 ? text.substring(0, argsIndex) : text;
switch(command) {
case "date":
response = 'Today is ' + new Date().toDateString();
break;
case "greet":
response = 'Hola ' + text.substring(argsIndex + 1);
break;
case "random":
response = Math.floor(Math.random() * 100);
break;
default:
response = "Unknown command: " + command;
}
TerminalService.emit('response', response);
};
return { images, nodes, dockItems, dockBasicItems, menubarItems, onDockItemClick, commandHandler,
displayTerminal, displayFinder, displayPhotos, responsiveOptions }
},
methods: {
onDockItemClick(event, item) {
if (item.command) {
item.command();
}
event.preventDefault();
},
commandHandler(text) {
let response;
let argsIndex = text.indexOf(' ');
let command = argsIndex !== -1 ? text.substring(0, argsIndex) : text;
switch(command) {
case "date":
response = 'Today is ' + new Date().toDateString();
break;
case "greet":
response = 'Hola ' + text.substring(argsIndex + 1);
break;
case "random":
response = Math.floor(Math.random() * 100);
break;
default:
response = "Unknown command: " + command;
}
TerminalService.emit('response', response);
}
},
components: {
"p-dock": primevue.dock,
"p-toast": primevue.toast,
"p-menubar": primevue.menubar,
"p-dialog": primevue.dialog,
"p-terminal": primevue.terminal,
"p-galleria": primevue.galleria,
"p-tree": primevue.tree
}
};
const routes = [{ path: "/", component: App }];
const router = VueRouter.createRouter({
history: VueRouter.createWebHashHistory(),
routes
});
createApp(App)
.use(router)
.use(primevue.config.default, { ripple: true })
.use(primevue.toastservice)
.directive("tooltip", Tooltip)
.mount("#app");
<\\/script>
<style>
.dock-demo .dock-window {
width: 100%;
height: 450px;
position: relative;
background-image: url("https://www.primefaces.org/wp-content/uploads/2021/02/primevue-blog.jpg");
background-repeat: no-repeat;
background-size: cover;
background-position: center;
z-index: 1;
}
.dock-demo .p-dock {
z-index: 1000;
}
.dock-demo .p-menubar {
padding-top: 0;
padding-bottom: 0;
border-radius: 0;
}
.dock-demo .p-menubar .menubar-root {
font-weight: bold;
padding: 0 1rem;
}
.dock-demo .p-menubar .p-menuitem-link {
padding: 0.5rem .75rem;
}
2022-12-08 12:26:57 +00:00
.dock-demo .p-menubar .p-menubar-root-list > .p-menuitem > .p-menuitem-content > .p-menuitem-link {
2022-09-09 20:41:18 +00:00
padding: 0.5rem .75rem;
}
2022-12-08 12:26:57 +00:00
.dock-demo .p-menubar .p-menubar-root-list > .p-menuitem > .p-menuitem-content > .p-menuitem-link > .p-submenu-icon {
2022-09-09 20:41:18 +00:00
display: none;
}
.dock-demo .p-menubar .p-menubar-end span,
.dock-demo .p-menubar .p-menubar-end i {
padding: 0 .75rem;
}
.dock-demo .p-menubar .p-submenu-list {
z-index: 2;
}
</style>
`
}
}
};
}
};
</script>