primevue-mirror/components/lib/tabview/TabView.vue

446 lines
14 KiB
Vue
Raw Normal View History

2022-09-06 12:03:37 +00:00
<template>
<div :class="contentClasses">
<div class="p-tabview-nav-container">
2022-09-14 11:26:01 +00:00
<button
v-if="scrollable && !isPrevButtonDisabled"
ref="prevBtn"
v-ripple
type="button"
class="p-tabview-nav-prev p-tabview-nav-btn p-link"
:tabindex="tabindex"
:aria-label="prevButtonAriaLabel"
@click="onPrevButtonClick"
v-bind="previousButtonProps"
>
<span class="pi pi-chevron-left" aria-hidden="true"></span>
</button>
2022-09-06 12:03:37 +00:00
<div ref="content" class="p-tabview-nav-content" @scroll="onScroll">
<ul ref="nav" class="p-tabview-nav" role="tablist">
2022-09-14 11:26:01 +00:00
<li v-for="(tab, i) of tabs" :key="getKey(tab, i)" :style="getTabProp(tab, 'headerStyle')" :class="getTabHeaderClass(tab, i)" role="presentation" :data-index="i" v-bind="getTabProp(tab, 'headerProps')">
<a
:id="getTabHeaderActionId(i)"
v-ripple
class="p-tabview-nav-link p-tabview-header-action"
:tabindex="getTabProp(tab, 'disabled') || !isTabActive(i) ? -1 : tabindex"
role="tab"
:aria-disabled="getTabProp(tab, 'disabled')"
:aria-selected="isTabActive(i)"
:aria-controls="getTabContentId(i)"
@click="onTabClick($event, tab, i)"
@keydown="onTabKeyDown($event, tab, i)"
v-bind="getTabProp(tab, 'headerActionProps')"
>
<span v-if="tab.props && tab.props.header" class="p-tabview-title">{{ tab.props.header }}</span>
<component v-if="tab.children && tab.children.header" :is="tab.children.header"></component>
2022-09-06 12:03:37 +00:00
</a>
</li>
2022-09-14 11:26:01 +00:00
<li ref="inkbar" class="p-tabview-ink-bar" role="presentation" aria-hidden="true"></li>
2022-09-06 12:03:37 +00:00
</ul>
</div>
2022-09-14 11:26:01 +00:00
<button
v-if="scrollable && !isNextButtonDisabled"
ref="nextBtn"
v-ripple
type="button"
class="p-tabview-nav-next p-tabview-nav-btn p-link"
:tabindex="tabindex"
:aria-label="nextButtonAriaLabel"
@click="onNextButtonClick"
v-bind="nextButtonProps"
>
<span class="pi pi-chevron-right" aria-hidden="true"></span>
</button>
2022-09-06 12:03:37 +00:00
</div>
<div class="p-tabview-panels">
2022-09-14 11:26:01 +00:00
<template v-for="(tab, i) of tabs" :key="getKey(tab, i)">
<div
v-if="lazy ? isTabActive(i) : true"
v-show="lazy ? true : isTabActive(i)"
:style="getTabProp(tab, 'contentStyle')"
:class="getTabContentClass(tab)"
role="tabpanel"
:aria-labelledby="getTabHeaderActionId(i)"
v-bind="getTabProp(tab, 'contentProps')"
>
2022-09-06 12:03:37 +00:00
<component :is="tab"></component>
</div>
</template>
</div>
</div>
</template>
<script>
import Ripple from 'primevue/ripple';
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: 'TabView',
emits: ['update:activeIndex', 'tab-change', 'tab-click'],
props: {
activeIndex: {
type: Number,
default: 0
},
lazy: {
type: Boolean,
default: false
},
scrollable: {
type: Boolean,
default: false
2022-09-14 11:26:01 +00:00
},
tabindex: {
type: Number,
default: 0
},
selectOnFocus: {
type: Boolean,
default: false
},
2022-12-08 11:04:25 +00:00
previousButtonProps: {
type: null,
2022-12-29 13:16:58 +00:00
default: null
2022-12-08 11:04:25 +00:00
},
nextButtonProps: {
type: null,
2022-12-29 13:16:58 +00:00
default: null
2022-12-08 11:04:25 +00:00
}
2022-09-06 12:03:37 +00:00
},
data() {
return {
id: this.$attrs.id,
2022-09-06 12:03:37 +00:00
d_activeIndex: this.activeIndex,
2022-09-14 11:26:01 +00:00
isPrevButtonDisabled: true,
isNextButtonDisabled: false
};
2022-09-06 12:03:37 +00:00
},
watch: {
'$attrs.id': function (newValue) {
this.id = newValue || UniqueComponentId();
},
2022-09-06 12:03:37 +00:00
activeIndex(newValue) {
this.d_activeIndex = newValue;
2022-09-14 11:26:01 +00:00
this.scrollInView({ index: newValue });
2022-09-06 12:03:37 +00:00
}
},
2022-09-14 11:26:01 +00:00
mounted() {
this.id = this.id || UniqueComponentId();
2022-09-06 12:03:37 +00:00
this.updateInkBar();
2022-12-08 11:04:25 +00:00
this.scrollable && this.updateButtonState();
2022-09-06 12:03:37 +00:00
},
2022-09-14 11:26:01 +00:00
updated() {
2022-09-06 12:03:37 +00:00
this.updateInkBar();
},
methods: {
2022-09-14 11:26:01 +00:00
isTabPanel(child) {
return child.type.name === 'TabPanel';
2022-09-06 12:03:37 +00:00
},
2022-09-14 11:26:01 +00:00
isTabActive(index) {
return this.d_activeIndex === index;
2022-09-06 12:03:37 +00:00
},
2022-09-14 11:26:01 +00:00
getTabProp(tab, name) {
return tab.props ? tab.props[name] : undefined;
2022-09-06 12:03:37 +00:00
},
2022-09-14 11:26:01 +00:00
getKey(tab, index) {
return this.getTabProp(tab, 'header') || index;
2022-09-06 12:03:37 +00:00
},
2022-09-14 11:26:01 +00:00
getTabHeaderActionId(index) {
return `${this.id}_${index}_header_action`;
2022-09-06 12:03:37 +00:00
},
2022-09-14 11:26:01 +00:00
getTabContentId(index) {
return `${this.id}_${index}_content`;
2022-09-06 12:03:37 +00:00
},
onScroll(event) {
this.scrollable && this.updateButtonState();
event.preventDefault();
},
2022-09-14 11:26:01 +00:00
onPrevButtonClick() {
2022-09-06 12:03:37 +00:00
const content = this.$refs.content;
const width = DomHandler.getWidth(content) - this.getVisibleButtonWidths();
const pos = content.scrollLeft - width;
2022-09-14 11:26:01 +00:00
2022-09-06 12:03:37 +00:00
content.scrollLeft = pos <= 0 ? 0 : pos;
},
2022-09-14 11:26:01 +00:00
onNextButtonClick() {
2022-09-06 12:03:37 +00:00
const content = this.$refs.content;
const width = DomHandler.getWidth(content) - this.getVisibleButtonWidths();
const pos = content.scrollLeft + width;
const lastPos = content.scrollWidth - width;
content.scrollLeft = pos >= lastPos ? lastPos : pos;
2022-09-14 11:26:01 +00:00
},
onTabClick(event, tab, index) {
this.changeActiveIndex(event, tab, index);
this.$emit('tab-click', { originalEvent: event, index });
},
onTabKeyDown(event, tab, index) {
switch (event.code) {
case 'ArrowLeft':
this.onTabArrowLeftKey(event);
break;
case 'ArrowRight':
this.onTabArrowRightKey(event);
break;
case 'Home':
this.onTabHomeKey(event);
break;
case 'End':
this.onTabEndKey(event);
break;
case 'PageDown':
this.onPageDownKey(event);
break;
case 'PageUp':
this.onPageUpKey(event);
break;
case 'Enter':
case 'Space':
this.onTabEnterKey(event, tab, index);
break;
default:
break;
}
},
onTabArrowRightKey(event) {
const nextHeaderAction = this.findNextHeaderAction(event.target.parentElement);
nextHeaderAction ? this.changeFocusedTab(event, nextHeaderAction) : this.onTabHomeKey(event);
event.preventDefault();
},
onTabArrowLeftKey(event) {
const prevHeaderAction = this.findPrevHeaderAction(event.target.parentElement);
prevHeaderAction ? this.changeFocusedTab(event, prevHeaderAction) : this.onTabEndKey(event);
event.preventDefault();
},
onTabHomeKey(event) {
const firstHeaderAction = this.findFirstHeaderAction();
this.changeFocusedTab(event, firstHeaderAction);
event.preventDefault();
},
onTabEndKey(event) {
const lastHeaderAction = this.findLastHeaderAction();
this.changeFocusedTab(event, lastHeaderAction);
event.preventDefault();
},
onPageDownKey(event) {
this.scrollInView({ index: this.$refs.nav.children.length - 2 });
event.preventDefault();
},
onPageUpKey(event) {
this.scrollInView({ index: 0 });
event.preventDefault();
},
onTabEnterKey(event, tab, index) {
this.changeActiveIndex(event, tab, index);
event.preventDefault();
},
findNextHeaderAction(tabElement, selfCheck = false) {
const headerElement = selfCheck ? tabElement : tabElement.nextElementSibling;
return headerElement
? DomHandler.hasClass(headerElement, 'p-disabled') || DomHandler.hasClass(headerElement, 'p-tabview-ink-bar')
? this.findNextHeaderAction(headerElement)
: DomHandler.findSingle(headerElement, '.p-tabview-header-action')
: null;
},
findPrevHeaderAction(tabElement, selfCheck = false) {
const headerElement = selfCheck ? tabElement : tabElement.previousElementSibling;
return headerElement
? DomHandler.hasClass(headerElement, 'p-disabled') || DomHandler.hasClass(headerElement, 'p-tabview-ink-bar')
? this.findPrevHeaderAction(headerElement)
: DomHandler.findSingle(headerElement, '.p-tabview-header-action')
: null;
},
findFirstHeaderAction() {
return this.findNextHeaderAction(this.$refs.nav.firstElementChild, true);
},
findLastHeaderAction() {
return this.findPrevHeaderAction(this.$refs.nav.lastElementChild, true);
},
changeActiveIndex(event, tab, index) {
if (!this.getTabProp(tab, 'disabled') && this.d_activeIndex !== index) {
this.d_activeIndex = index;
this.$emit('update:activeIndex', index);
this.$emit('tab-change', { originalEvent: event, index });
this.scrollInView({ index });
}
},
changeFocusedTab(event, element) {
if (element) {
DomHandler.focus(element);
this.scrollInView({ element });
if (this.selectOnFocus) {
const index = parseInt(element.parentElement.dataset.index, 10);
const tab = this.tabs[index];
this.changeActiveIndex(event, tab, index);
}
}
},
scrollInView({ element, index = -1 }) {
const currentElement = element || this.$refs.nav.children[index];
if (currentElement) {
currentElement.scrollIntoView && currentElement.scrollIntoView({ block: 'nearest' });
}
},
updateInkBar() {
let tabHeader = this.$refs.nav.children[this.d_activeIndex];
this.$refs.inkbar.style.width = DomHandler.getWidth(tabHeader) + 'px';
this.$refs.inkbar.style.left = DomHandler.getOffset(tabHeader).left - DomHandler.getOffset(this.$refs.nav).left + 'px';
},
updateButtonState() {
const content = this.$refs.content;
const { scrollLeft, scrollWidth } = content;
const width = DomHandler.getWidth(content);
this.isPrevButtonDisabled = scrollLeft === 0;
this.isNextButtonDisabled = parseInt(scrollLeft) === scrollWidth - width;
},
getVisibleButtonWidths() {
const { prevBtn, nextBtn } = this.$refs;
return [prevBtn, nextBtn].reduce((acc, el) => (el ? acc + DomHandler.getWidth(el) : acc), 0);
},
getTabHeaderClass(tab, i) {
return [
'p-tabview-header',
this.getTabProp(tab, 'headerClass'),
{
'p-highlight': this.d_activeIndex === i,
'p-disabled': this.getTabProp(tab, 'disabled')
}
];
},
getTabContentClass(tab) {
return ['p-tabview-panel', this.getTabProp(tab, 'contentClass')];
2022-09-06 12:03:37 +00:00
}
},
computed: {
contentClasses() {
2022-09-14 11:26:01 +00:00
return [
'p-tabview p-component',
{
'p-tabview-scrollable': this.scrollable
}
];
2022-09-06 12:03:37 +00:00
},
tabs() {
2022-09-14 11:26:01 +00:00
return this.$slots.default().reduce((tabs, child) => {
if (this.isTabPanel(child)) {
tabs.push(child);
} else if (child.children && child.children instanceof Array) {
child.children.forEach((nestedChild) => {
if (this.isTabPanel(nestedChild)) {
tabs.push(nestedChild);
}
});
2022-09-06 12:03:37 +00:00
}
2022-09-14 11:26:01 +00:00
return tabs;
}, []);
},
prevButtonAriaLabel() {
return this.$primevue.config.locale.aria ? this.$primevue.config.locale.aria.previous : undefined;
},
nextButtonAriaLabel() {
return this.$primevue.config.locale.aria ? this.$primevue.config.locale.aria.next : undefined;
2022-09-06 12:03:37 +00:00
}
},
directives: {
2022-09-14 11:26:01 +00:00
ripple: Ripple
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-tabview-nav-container {
position: relative;
}
.p-tabview-scrollable .p-tabview-nav-container {
overflow: hidden;
}
.p-tabview-nav-content {
overflow-x: auto;
overflow-y: hidden;
scroll-behavior: smooth;
scrollbar-width: none;
overscroll-behavior: contain auto;
}
.p-tabview-nav {
display: flex;
margin: 0;
padding: 0;
list-style-type: none;
flex: 1 1 auto;
}
2022-09-14 11:26:01 +00:00
.p-tabview-header-action {
2022-09-06 12:03:37 +00:00
cursor: pointer;
user-select: none;
display: flex;
align-items: center;
position: relative;
text-decoration: none;
overflow: hidden;
}
.p-tabview-ink-bar {
display: none;
z-index: 1;
}
2022-09-14 11:26:01 +00:00
.p-tabview-header-action:focus {
2022-09-06 12:03:37 +00:00
z-index: 1;
}
.p-tabview-title {
line-height: 1;
white-space: nowrap;
}
.p-tabview-nav-btn {
position: absolute;
top: 0;
z-index: 2;
height: 100%;
display: flex;
align-items: center;
justify-content: center;
}
.p-tabview-nav-prev {
left: 0;
}
.p-tabview-nav-next {
right: 0;
}
.p-tabview-nav-content::-webkit-scrollbar {
display: none;
}
</style>