Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add resize event to splitter #4526

Merged
merged 4 commits into from
Oct 6, 2023
Merged

Add resize event to splitter #4526

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
d04840d
Add resizing event to splitter component
Ice-Hazymoon Sep 30, 2023
ebc3c9e
doc
Ice-Hazymoon Sep 30, 2023
665faac
'resize' instead of 'resizing'
Ice-Hazymoon Oct 5, 2023
4d9ff99
'resize' instead of 'resizing'
Ice-Hazymoon Oct 6, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 20 additions & 0 deletions components/lib/splitter/Splitter.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,6 +55,21 @@ export interface SplitterResizeStartEvent {
sizes: number[];
}

/**
* Custom resizing event.
* @see {@link SplitterEmits.resizing}
*/
export interface SplitterResizeEvent {
/**
* Browser event
*/
originalEvent: Event;
/**
* Sizes of the panels
*/
sizes: number[];
}

/**
* Custom resize end event.
* @see {@link SplitterEmits.resizeend}
Expand Down Expand Up @@ -185,6 +200,11 @@ export interface SplitterEmits {
* @param {SplitterResizeStartEvent} event - Custom resize start event.
*/
resizestart(event: SplitterResizeStartEvent): void;
/**
* Callback to invoke when resizing.
* @param {SplitterResizeEvent} event - Custom resizing event.
*/
resizing(event: SplitterResizeEvent): void;
Ice-Hazymoon marked this conversation as resolved.
Show resolved Hide resolved
/**
* Callback to invoke when resize ends.
* @param {SplitterResizeEndEvent} event - Custom resize end event.
Expand Down
4 changes: 3 additions & 1 deletion components/lib/splitter/Splitter.vue
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ import BaseSplitter from './BaseSplitter.vue';
export default {
name: 'Splitter',
extends: BaseSplitter,
emits: ['resizestart', 'resizeend'],
emits: ['resizestart', 'resizeend', 'resize'],
dragging: false,
mouseMoveListener: null,
mouseUpListener: null,
Expand Down Expand Up @@ -141,6 +141,8 @@ export default {
this.panelSizes[this.prevPanelIndex] = newPrevPanelSize;
this.panelSizes[this.prevPanelIndex + 1] = newNextPanelSize;
}

this.$emit('resize', { originalEvent: event, sizes: this.panelSizes });
},
onResizeEnd(event) {
if (this.isStateful()) {
Expand Down
21 changes: 17 additions & 4 deletions doc/common/apidoc/index.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40427,9 +40427,9 @@
],
"methods": []
},
"SplitterResizeEndEvent": {
"description": "Custom resize end event.",
"relatedProp": "SplitterEmits.resizeend",
"SplitterResizeEvent": {
"description": "Custom resize event.",
"relatedProp": "SplitterEmits.resize",
"props": [
{
"name": "originalEvent",
Expand All @@ -40445,7 +40445,7 @@
"readonly": false,
"type": "number[]",
"default": "",
"description": "Sizes of the panels"
"description": "Sizes of the panels during resize"
}
],
"methods": []
Expand Down Expand Up @@ -40634,6 +40634,19 @@
"returnType": "void",
"description": "Callback to invoke when resize starts."
},
{
"name": "resize",
"parameters": [
{
"name": "event",
"optional": false,
"type": "SplitterResizeEvent",
"description": "Custom resize event."
}
],
"returnType": "void",
"description": "Callback to invoke during the resizing process."
},
{
"name": "resizeend",
"parameters": [
Expand Down