Refactor #3965 - For Splitter

primefaces · May 24, 2023 · 6b3fe54 · 6b3fe54
1 parent b752ba6
commit 6b3fe54
Show file tree

Hide file tree

Showing 6 changed files with 180 additions and 113 deletions.
diff --git a/components/lib/splitter/BaseSplitter.vue b/components/lib/splitter/BaseSplitter.vue
@@ -0,0 +1,103 @@
+<script>
+import BaseComponent from 'primevue/basecomponent';
+import { useStyle } from 'primevue/usestyle';
+
+const styles = `
+.p-splitter {
+    display: flex;
+    flex-wrap: nowrap;
+}
+
+.p-splitter-vertical {
+    flex-direction: column;
+}
+
+.p-splitter-gutter {
+    flex-grow: 0;
+    flex-shrink: 0;
+    display: flex;
+    align-items: center;
+    justify-content: center;
+    cursor: col-resize;
+}
+
+.p-splitter-horizontal.p-splitter-resizing {
+    cursor: col-resize;
+    user-select: none;
+}
+
+.p-splitter-horizontal > .p-splitter-gutter > .p-splitter-gutter-handle {
+    height: 24px;
+    width: 100%;
+}
+
+.p-splitter-horizontal > .p-splitter-gutter {
+    cursor: col-resize;
+}
+
+.p-splitter-vertical.p-splitter-resizing {
+    cursor: row-resize;
+    user-select: none;
+}
+
+.p-splitter-vertical > .p-splitter-gutter {
+    cursor: row-resize;
+}
+
+.p-splitter-vertical > .p-splitter-gutter > .p-splitter-gutter-handle {
+    width: 24px;
+    height: 100%;
+}
+`;
+
+const classes = {
+    root: ({ props }) => ['p-splitter p-component', 'p-splitter-' + props.layout],
+    gutter: 'p-splitter-gutter',
+    gutterHandler: 'p-splitter-gutter-handle'
+};
+
+const inlineStyles = {
+    root: ({ props }) => [{ display: 'flex', 'flex-wrap': 'nowrap' }, props.layout === 'vertical' ? { 'flex-direction': 'column' } : '']
+};
+
+const { load: loadStyle, unload: unloadStyle } = useStyle(styles, { id: 'primevue_splitter_style', manual: true });
+
+export default {
+    name: 'BaseSplitter',
+    extends: BaseComponent,
+    props: {
+        layout: {
+            type: String,
+            default: 'horizontal'
+        },
+        gutterSize: {
+            type: Number,
+            default: 4
+        },
+        stateKey: {
+            type: String,
+            default: null
+        },
+        stateStorage: {
+            type: String,
+            default: 'session'
+        },
+        step: {
+            type: Number,
+            default: 5
+        }
+    },
+    css: {
+        classes,
+        inlineStyles
+    },
+    watch: {
+        isUnstyled: {
+            immediate: true,
+            handler(newValue) {
+                !newValue && loadStyle();
+            }
+        }
+    }
+};
+</script>
diff --git a/components/lib/splitter/Splitter.d.ts b/components/lib/splitter/Splitter.d.ts
@@ -119,6 +119,11 @@ export interface SplitterProps {
      * @type {SplitterPassThroughOptions}
      */
     pt?: SplitterPassThroughOptions;
+    /**
+     * When enabled, it removes component related styles in the core.
+     * @defaultValue false
+     */
+    unstyled?: boolean;
 }
 
 /**

diff --git a/components/lib/splitter/Splitter.vue b/components/lib/splitter/Splitter.vue
@@ -1,54 +1,34 @@
 <template>
-    <div :class="containerClass" v-bind="ptm('root')">
+    <div :class="cx('root')" :style="sx('root')" :data-p-resizing="false" v-bind="ptm('root')">
         <template v-for="(panel, i) of panels" :key="i">
             <component :is="panel" tabindex="-1"></component>
             <div
                 v-if="i !== panels.length - 1"
-                class="p-splitter-gutter"
+                ref="gutter"
+                :class="cx('gutter')"
                 role="separator"
                 tabindex="-1"
                 @mousedown="onGutterMouseDown($event, i)"
                 @touchstart="onGutterTouchStart($event, i)"
                 @touchmove="onGutterTouchMove($event, i)"
                 @touchend="onGutterTouchEnd($event, i)"
+                :data-p-gutter-resizing="false"
                 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 :class="cx('gutterHandler')" tabindex="0" :style="[gutterStyle]" :aria-orientation="layout" :aria-valuenow="prevSize" @keyup="onGutterKeyUp" @keydown="onGutterKeyDown($event, i)" v-bind="ptm('gutterHandler')"></div>
             </div>
         </template>
     </div>
 </template>
 
 <script>
-import BaseComponent from 'primevue/basecomponent';
 import { DomHandler, ObjectUtils } from 'primevue/utils';
+import BaseSplitter from './BaseSplitter.vue';
 
 export default {
     name: 'Splitter',
-    extends: BaseComponent,
+    extends: BaseSplitter,
     emits: ['resizestart', 'resizeend'],
-    props: {
-        layout: {
-            type: String,
-            default: 'horizontal'
-        },
-        gutterSize: {
-            type: Number,
-            default: 4
-        },
-        stateKey: {
-            type: String,
-            default: null
-        },
-        stateStorage: {
-            type: String,
-            default: 'session'
-        },
-        step: {
-            type: Number,
-            default: 5
-        }
-    },
     dragging: false,
     mouseMoveListener: null,
     mouseUpListener: null,
@@ -78,7 +58,7 @@ export default {
             }
 
             if (!initialized) {
-                let children = [...this.$el.children].filter((child) => DomHandler.hasClass(child, 'p-splitter-panel'));
+                let children = [...this.$el.children].filter((child) => child.getAttribute('data-pc-name') === 'splitterpanel');
                 let _panelSizes = [];
 
                 this.panels.map((panel, i) => {
@@ -124,8 +104,8 @@ export default {
 
             this.prevPanelIndex = index;
             this.$emit('resizestart', { originalEvent: event, sizes: this.panelSizes });
-            DomHandler.addClass(this.gutterElement, 'p-splitter-gutter-resizing');
-            DomHandler.addClass(this.$el, 'p-splitter-resizing');
+            this.$refs.gutter[index].setAttribute('data-p-gutter-resizing', true);
+            this.$el.setAttribute('data-p-resizing', true);
         },
         onResize(event, step, isKeyDown) {
             let newPos, newPrevPanelSize, newNextPanelSize;
@@ -161,8 +141,8 @@ export default {
             }
 
             this.$emit('resizeend', { originalEvent: event, sizes: this.panelSizes });
-            DomHandler.removeClass(this.gutterElement, 'p-splitter-gutter-resizing');
-            DomHandler.removeClass(this.$el, 'p-splitter-resizing');
+            this.$refs.gutter.forEach((gutter) => gutter.setAttribute('data-p-gutter-resizing', false));
+            this.$el.setAttribute('data-p-resizing', false);
             this.clear();
         },
         repeat(event, index, step) {
@@ -347,7 +327,7 @@ export default {
 
             if (stateString) {
                 this.panelSizes = JSON.parse(stateString);
-                let children = [...this.$el.children].filter((child) => DomHandler.hasClass(child, 'p-splitter-panel'));
+                let children = [...this.$el.children].filter((child) => child.getAttribute('data-pc-name') === 'splitterpanel');
 
                 children.forEach((child, i) => {
                     child.style.flexBasis = 'calc(' + this.panelSizes[i] + '% - ' + (this.panels.length - 1) * this.gutterSize + 'px)';
@@ -360,9 +340,6 @@ export default {
         }
     },
     computed: {
-        containerClass() {
-            return ['p-splitter p-component', 'p-splitter-' + this.layout];
-        },
         panels() {
             const panels = [];
 
@@ -390,64 +367,3 @@ export default {
     }
 };
 </script>
-
-<style>
-.p-splitter {
-    display: flex;
-    flex-wrap: nowrap;
-}
-
-.p-splitter-vertical {
-    flex-direction: column;
-}
-
-.p-splitter-panel {
-    flex-grow: 1;
-}
-
-.p-splitter-panel-nested {
-    display: flex;
-}
-
-.p-splitter-panel .p-splitter {
-    flex-grow: 1;
-    border: 0 none;
-}
-
-.p-splitter-gutter {
-    flex-grow: 0;
-    flex-shrink: 0;
-    display: flex;
-    align-items: center;
-    justify-content: center;
-    cursor: col-resize;
-}
-
-.p-splitter-horizontal.p-splitter-resizing {
-    cursor: col-resize;
-    user-select: none;
-}
-
-.p-splitter-horizontal > .p-splitter-gutter > .p-splitter-gutter-handle {
-    height: 24px;
-    width: 100%;
-}
-
-.p-splitter-horizontal > .p-splitter-gutter {
-    cursor: col-resize;
-}
-
-.p-splitter-vertical.p-splitter-resizing {
-    cursor: row-resize;
-    user-select: none;
-}
-
-.p-splitter-vertical > .p-splitter-gutter {
-    cursor: row-resize;
-}
-
-.p-splitter-vertical > .p-splitter-gutter > .p-splitter-gutter-handle {
-    width: 24px;
-    height: 100%;
-}
-</style>
diff --git a/components/lib/splitterpanel/BaseSplitterPanel.vue b/components/lib/splitterpanel/BaseSplitterPanel.vue
@@ -0,0 +1,51 @@
+<script>
+import BaseComponent from 'primevue/basecomponent';
+import { useStyle } from 'primevue/usestyle';
+
+const styles = `
+.p-splitter-panel {
+    flex-grow: 1;
+}
+
+.p-splitter-panel-nested {
+    display: flex;
+}
+
+.p-splitter-panel .p-splitter {
+    flex-grow: 1;
+    border: 0 none;
+}
+`;
+
+const classes = {
+    root: ({ instance }) => ['p-splitter-panel', { 'p-splitter-panel-nested': instance.isNested }]
+};
+
+const { load: loadStyle, unload: unloadStyle } = useStyle(styles, { id: 'primevue_splitterpanel_style', manual: true });
+
+export default {
+    name: 'BaseSplitterPanel',
+    extends: BaseComponent,
+    props: {
+        size: {
+            type: Number,
+            default: null
+        },
+        minSize: {
+            type: Number,
+            default: null
+        }
+    },
+    css: {
+        classes
+    },
+    watch: {
+        isUnstyled: {
+            immediate: true,
+            handler(newValue) {
+                !newValue && loadStyle();
+            }
+        }
+    }
+};
+</script>
diff --git a/components/lib/splitterpanel/SplitterPanel.d.ts b/components/lib/splitterpanel/SplitterPanel.d.ts
@@ -54,6 +54,11 @@ export interface SplitterPanelProps {
      * @type {SplitterPanelPassThroughOptions}
      */
     pt?: SplitterPanelPassThroughOptions;
+    /**
+     * When enabled, it removes component related styles in the core.
+     * @defaultValue false
+     */
+    unstyled?: boolean;
 }
 
 /**

diff --git a/components/lib/splitterpanel/SplitterPanel.vue b/components/lib/splitterpanel/SplitterPanel.vue
@@ -1,29 +1,16 @@
 <template>
-    <div ref="container" :class="containerClass" v-bind="ptm('root')">
+    <div ref="container" :class="cx('root')" data-pc-name="splitterpanel" v-bind="ptm('root')">
         <slot></slot>
     </div>
 </template>
 
 <script>
-import BaseComponent from 'primevue/basecomponent';
+import BaseSplitterPanel from './BaseSplitterPanel.vue';
 
 export default {
     name: 'SplitterPanel',
-    extends: BaseComponent,
-    props: {
-        size: {
-            type: Number,
-            default: null
-        },
-        minSize: {
-            type: Number,
-            default: null
-        }
-    },
+    extends: BaseSplitterPanel,
     computed: {
-        containerClass() {
-            return ['p-splitter-panel', { 'p-splitter-panel-nested': this.isNested }];
-        },
         isNested() {
             return this.$slots.default().some((child) => {
                 return child.type.name === 'Splitter';