Refactor #3797 - Splitter updates

pull/3841/head
Tuğçe Küçükoğlu 2023-03-27 10:13:31 +03:00
parent 094245e2d3
commit c14c2f160e
6 changed files with 115 additions and 4 deletions

View File

@ -28,6 +28,12 @@ const SplitterProps = [
type: 'number', type: 'number',
default: '5', default: '5',
description: 'Step factor to increment/decrement the size of the panels while pressing the arrow keys.' description: 'Step factor to increment/decrement the size of the panels while pressing the arrow keys.'
},
{
name: 'pt',
type: 'any',
default: 'null',
description: 'Uses to pass attributes to DOM elements inside the component.'
} }
]; ];

View File

@ -10,6 +10,12 @@ const SplitterPanelProps = [
type: 'number', type: 'number',
default: 'null', default: 'null',
description: 'Minimum size of the element relative to 100%.' description: 'Minimum size of the element relative to 100%.'
},
{
name: 'pt',
type: 'any',
default: 'null',
description: 'Uses to pass attributes to DOM elements inside the component.'
} }
]; ];

View File

@ -10,6 +10,16 @@
import { VNode } from 'vue'; import { VNode } from 'vue';
import { ClassComponent, GlobalComponentConstructor } from '../ts-helpers'; import { ClassComponent, GlobalComponentConstructor } from '../ts-helpers';
export declare type SplitterPassThroughOptionType = SplitterPassThroughAttributes | ((options: SplitterPassThroughMethodOptions) => SplitterPassThroughAttributes) | null | undefined;
/**
* Custom passthrough(pt) option method.
*/
export interface SplitterPassThroughMethodOptions {
props: SplitterProps;
state: SplitterState;
}
/** /**
* Custom resize start event. * Custom resize start event.
* @see {@link SplitterEmits.resizestar} * @see {@link SplitterEmits.resizestar}
@ -40,6 +50,42 @@ export interface SplitterResizeEndEvent {
sizes: number[]; sizes: number[];
} }
/**
* Custom passthrough(pt) options.
* @see {@link SplitterProps.pt}
*/
export interface SplitterPassThroughOptions {
/**
* Uses to pass attributes to the root's DOM element.
*/
root?: SplitterPassThroughOptionType;
/**
* Uses to pass attributes to the gutter's DOM element.
*/
gutter?: SplitterPassThroughOptionType;
/**
* Uses to pass attributes to the gutter handler's DOM element.
*/
gutterhandler?: SplitterPassThroughOptionType;
}
/**
* Custom passthrough attributes for each DOM elements
*/
export interface SplitterPassThroughAttributes {
[key: string]: any;
}
/**
* Defines current inline state in Panel component.
*/
export interface SplitterState {
/**
* Previous size state as a number.
*/
prevSize: number;
}
/** /**
* Defines valid properties in Splitter component. * Defines valid properties in Splitter component.
*/ */
@ -68,6 +114,11 @@ export interface SplitterProps {
* @defaultValue 1 * @defaultValue 1
*/ */
step?: number | undefined; step?: number | undefined;
/**
* Uses to pass attributes to DOM elements inside the component.
* @type {SplitterPassThroughOptions}
*/
pt?: SplitterPassThroughOptions;
} }
/** /**

View File

@ -1,19 +1,32 @@
<template> <template>
<div :class="containerClass"> <div :class="containerClass" v-bind="ptm('root')">
<template v-for="(panel, i) of panels" :key="i"> <template v-for="(panel, i) of panels" :key="i">
<component :is="panel" tabindex="-1"></component> <component :is="panel" tabindex="-1"></component>
<div v-if="i !== panels.length - 1" class="p-splitter-gutter" @mousedown="onGutterMouseDown($event, i)" @touchstart="onGutterTouchStart($event, i)" @touchmove="onGutterTouchMove($event, i)" @touchend="onGutterTouchEnd($event, i)"> <div
<div class="p-splitter-gutter-handle" tabindex="0" :style="gutterStyle" role="separator" :aria-orientation="layout" :aria-valuenow="prevSize" @keyup="onGutterKeyUp" @keydown="onGutterKeyDown($event, i)"></div> v-if="i !== panels.length - 1"
class="p-splitter-gutter"
role="separator"
tabindex="-1"
@mousedown="onGutterMouseDown($event, i)"
@touchstart="onGutterTouchStart($event, i)"
@touchmove="onGutterTouchMove($event, i)"
@touchend="onGutterTouchEnd($event, i)"
v-bind="ptm('gutter')"
>
<div class="p-splitter-gutter-handle" tabindex="0" :style="gutterStyle" :aria-orientation="layout" :aria-valuenow="prevSize" @keyup="onGutterKeyUp" @keydown="onGutterKeyDown($event, i)" v-bind="ptm('gutterhandler')"></div>
</div> </div>
</template> </template>
</div> </div>
</template> </template>
<script> <script>
import ComponentBase from 'primevue/base';
import { DomHandler, ObjectUtils } from 'primevue/utils'; import { DomHandler, ObjectUtils } from 'primevue/utils';
export default { export default {
name: 'Splitter', name: 'Splitter',
extends: ComponentBase,
emits: ['resizestart', 'resizeend'], emits: ['resizestart', 'resizeend'],
props: { props: {
layout: { layout: {

View File

@ -10,6 +10,33 @@
import { VNode } from 'vue'; import { VNode } from 'vue';
import { ClassComponent, GlobalComponentConstructor } from '../ts-helpers'; import { ClassComponent, GlobalComponentConstructor } from '../ts-helpers';
export declare type SplitterPanelPassThroughOptionType = SplitterPanelPassThroughAttributes | ((options: SplitterPanelPassThroughMethodOptions) => SplitterPanelPassThroughAttributes) | null | undefined;
/**
* Custom passthrough(pt) option method.
*/
export interface SplitterPanelPassThroughMethodOptions {
props: SplitterPanelProps;
}
/**
* Custom passthrough(pt) options.
* @see {@link PanelProps.pt}
*/
export interface SplitterPanelPassThroughOptions {
/**
* Uses to pass attributes to the root's DOM element.
*/
root?: SplitterPanelPassThroughOptionType;
}
/**
* Custom passthrough attributes for each DOM elements
*/
export interface SplitterPanelPassThroughAttributes {
[key: string]: any;
}
/** /**
* Defines valid properties in SplitterPanel component. * Defines valid properties in SplitterPanel component.
*/ */
@ -22,6 +49,11 @@ export interface SplitterPanelProps {
* Minimum size of the element relative to 100%. * Minimum size of the element relative to 100%.
*/ */
minSize?: number | undefined; minSize?: number | undefined;
/**
* Uses to pass attributes to DOM elements inside the component.
* @type {SplitterPanelPassThroughOptions}
*/
pt?: SplitterPanelPassThroughOptions;
} }
/** /**

View File

@ -1,12 +1,15 @@
<template> <template>
<div ref="container" :class="containerClass"> <div ref="container" :class="containerClass" v-bind="ptm('root')">
<slot></slot> <slot></slot>
</div> </div>
</template> </template>
<script> <script>
import ComponentBase from 'primevue/base';
export default { export default {
name: 'SplitterPanel', name: 'SplitterPanel',
extends: ComponentBase,
props: { props: {
size: { size: {
type: Number, type: Number,