primevue-mirror/components/lib/steps/Steps.vue

261 lines
7.8 KiB
Vue
Raw Normal View History

2022-09-06 12:03:37 +00:00
<template>
2023-04-26 09:58:46 +00:00
<nav :id="id" :class="containerClass" v-bind="ptm('root')">
<ol ref="list" class="p-steps-list" v-bind="ptm('menu')">
2022-09-14 11:26:01 +00:00
<template v-for="(item, index) of model" :key="item.to">
2023-04-26 09:58:46 +00:00
<li v-if="visible(item)" :class="getItemClass(item)" :style="item.style" v-bind="ptm('menuitem')">
2022-09-06 12:03:37 +00:00
<template v-if="!$slots.item">
2022-09-14 11:26:01 +00:00
<router-link v-if="!isItemDisabled(item)" v-slot="{ navigate, href, isActive, isExactActive }" :to="item.to" custom>
2022-12-08 11:04:25 +00:00
<a
:href="href"
:class="linkClass({ isActive, isExactActive })"
:tabindex="-1"
:aria-current="isExactActive ? 'step' : undefined"
@click="onItemClick($event, item, navigate)"
@keydown="onItemKeydown($event, item, navigate)"
2023-04-26 09:58:46 +00:00
v-bind="ptm('action')"
2022-12-08 11:04:25 +00:00
>
2023-04-26 09:58:46 +00:00
<span class="p-steps-number" v-bind="ptm('step')">{{ index + 1 }}</span>
<span class="p-steps-title" v-bind="ptm('label')">{{ label(item) }}</span>
2022-09-06 12:03:37 +00:00
</a>
</router-link>
2023-04-26 09:58:46 +00:00
<span v-else :class="linkClass()" @keydown="onItemKeydown($event, item)" v-bind="ptm('action')">
<span class="p-steps-number" v-bind="ptm('step')">{{ index + 1 }}</span>
<span class="p-steps-title" v-bind="ptm('label')">{{ label(item) }}</span>
2022-09-06 12:03:37 +00:00
</span>
</template>
<component v-else :is="$slots.item" :item="item"></component>
</li>
</template>
2022-12-08 11:04:25 +00:00
</ol>
</nav>
2022-09-06 12:03:37 +00:00
</template>
<script>
2023-04-26 09:58:46 +00:00
import BaseComponent from 'primevue/basecomponent';
2022-12-08 11:04:25 +00:00
import { DomHandler, UniqueComponentId } from 'primevue/utils';
2022-09-06 12:03:37 +00:00
export default {
name: 'Steps',
2023-04-26 09:58:46 +00:00
extends: BaseComponent,
2022-09-06 12:03:37 +00:00
props: {
id: {
type: String,
default: UniqueComponentId()
},
2022-09-14 11:26:01 +00:00
model: {
2022-09-06 12:03:37 +00:00
type: Array,
default: null
},
readonly: {
type: Boolean,
default: true
},
exact: {
type: Boolean,
default: true
}
},
2022-12-08 11:04:25 +00:00
mounted() {
const firstItem = this.findFirstItem();
firstItem.tabIndex = '0';
},
2022-09-06 12:03:37 +00:00
methods: {
onItemClick(event, item, navigate) {
if (this.disabled(item) || this.readonly) {
event.preventDefault();
2022-09-14 11:26:01 +00:00
2022-09-06 12:03:37 +00:00
return;
}
if (item.command) {
item.command({
originalEvent: event,
item: item
});
}
if (item.to && navigate) {
navigate(event);
}
},
2022-12-08 11:04:25 +00:00
onItemKeydown(event, item, navigate) {
switch (event.code) {
case 'ArrowRight': {
this.navigateToNextItem(event.target);
event.preventDefault();
break;
}
case 'ArrowLeft': {
this.navigateToPrevItem(event.target);
event.preventDefault();
break;
}
case 'Home': {
this.navigateToFirstItem(event.target);
event.preventDefault();
break;
}
case 'End': {
this.navigateToLastItem(event.target);
event.preventDefault();
break;
}
case 'Tab':
//no op
break;
case 'Enter':
case 'Space': {
this.onItemClick(event, item, navigate);
event.preventDefault();
break;
}
default:
break;
}
},
navigateToNextItem(target) {
const nextItem = this.findNextItem(target);
nextItem && this.setFocusToMenuitem(target, nextItem);
},
navigateToPrevItem(target) {
const prevItem = this.findPrevItem(target);
prevItem && this.setFocusToMenuitem(target, prevItem);
},
navigateToFirstItem(target) {
const firstItem = this.findFirstItem(target);
firstItem && this.setFocusToMenuitem(target, firstItem);
},
navigateToLastItem(target) {
const lastItem = this.findLastItem(target);
lastItem && this.setFocusToMenuitem(target, lastItem);
},
findNextItem(item) {
const nextItem = item.parentElement.nextElementSibling;
return nextItem ? nextItem.children[0] : null;
},
findPrevItem(item) {
const prevItem = item.parentElement.previousElementSibling;
return prevItem ? prevItem.children[0] : null;
},
findFirstItem() {
const firstSibling = DomHandler.findSingle(this.$refs.list, '.p-steps-item');
return firstSibling ? firstSibling.children[0] : null;
},
findLastItem() {
const siblings = DomHandler.find(this.$refs.list, '.p-steps-item');
return siblings ? siblings[siblings.length - 1].children[0] : null;
},
setFocusToMenuitem(target, focusableItem) {
target.tabIndex = '-1';
focusableItem.tabIndex = '0';
focusableItem.focus();
},
2022-09-06 12:03:37 +00:00
isActive(item) {
return item.to ? this.$router.resolve(item.to).path === this.$route.path : false;
},
getItemClass(item) {
2022-09-14 11:26:01 +00:00
return [
'p-steps-item',
item.class,
{
'p-highlight p-steps-current': this.isActive(item),
'p-disabled': this.isItemDisabled(item)
}
];
2022-09-06 12:03:37 +00:00
},
linkClass(routerProps) {
2022-09-14 11:26:01 +00:00
return [
'p-menuitem-link',
{
'router-link-active': routerProps && routerProps.isActive,
'router-link-active-exact': this.exact && routerProps && routerProps.isExactActive
}
];
2022-09-06 12:03:37 +00:00
},
isItemDisabled(item) {
2022-09-14 11:26:01 +00:00
return this.disabled(item) || (this.readonly && !this.isActive(item));
2022-09-06 12:03:37 +00:00
},
visible(item) {
2022-09-14 11:26:01 +00:00
return typeof item.visible === 'function' ? item.visible() : item.visible !== false;
2022-09-06 12:03:37 +00:00
},
disabled(item) {
2022-09-14 11:26:01 +00:00
return typeof item.disabled === 'function' ? item.disabled() : item.disabled;
2022-09-06 12:03:37 +00:00
},
label(item) {
2022-09-14 11:26:01 +00:00
return typeof item.label === 'function' ? item.label() : item.label;
2022-09-06 12:03:37 +00:00
}
},
computed: {
containerClass() {
2022-09-14 11:26:01 +00:00
return ['p-steps p-component', { 'p-readonly': this.readonly }];
2022-09-06 12:03:37 +00:00
}
}
2022-09-14 11:26:01 +00:00
};
2022-09-06 12:03:37 +00:00
</script>
<style>
.p-steps {
position: relative;
}
2022-12-08 11:04:25 +00:00
.p-steps .p-steps-list {
2022-09-06 12:03:37 +00:00
padding: 0;
margin: 0;
list-style-type: none;
display: flex;
}
.p-steps-item {
position: relative;
display: flex;
justify-content: center;
flex: 1 1 auto;
}
.p-steps-item .p-menuitem-link {
display: inline-flex;
flex-direction: column;
align-items: center;
overflow: hidden;
text-decoration: none;
}
.p-steps.p-steps-readonly .p-steps-item {
cursor: auto;
}
.p-steps-item.p-steps-current .p-menuitem-link {
cursor: default;
}
.p-steps-title {
white-space: nowrap;
}
.p-steps-number {
display: flex;
align-items: center;
justify-content: center;
}
.p-steps-title {
display: block;
}
</style>