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

Fix #6000: Improved closeOnEscape handling #6010

Merged
merged 1 commit into from
Feb 19, 2024
Merged

Fix #6000: Improved closeOnEscape handling #6010

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
9 changes: 4 additions & 5 deletions components/lib/confirmpopup/ConfirmPopup.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,15 +57,14 @@ export const ConfirmPopup = React.memo(

const acceptLabel = getPropValue('acceptLabel') || localeOption('accept');
const rejectLabel = getPropValue('rejectLabel') || localeOption('reject');
const displayOrder = useDisplayOrder('dialog', visibleState);
const isCloseOnEscape = props.dismissable && props.closeOnEscape && visibleState;
const displayOrder = useDisplayOrder('dialog', isCloseOnEscape);

useGlobalOnEscapeKey({
callback: () => {
if (props.dismissable && props.closeOnEscape) {
hide('hide');
}
hide('hide');
},
when: visibleState && displayOrder,
when: isCloseOnEscape && displayOrder,
priority: [ESC_KEY_HANDLING_PRIORITIES.DIALOG, displayOrder]
});

Expand Down
9 changes: 4 additions & 5 deletions components/lib/dialog/Dialog.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,8 @@ export const Dialog = React.forwardRef((inProps, ref) => {
const focusElementOnHide = React.useRef(null);
const maximized = props.onMaximize ? props.maximized : maximizedState;
const shouldBlockScroll = visibleState && (props.blockScroll || (props.maximizable && maximized));
const displayOrder = useDisplayOrder('dialog', visibleState);
const isCloseOnEscape = props.closable && props.closeOnEscape && visibleState;
const displayOrder = useDisplayOrder('dialog', isCloseOnEscape);

const { ptm, cx, sx, isUnstyled } = DialogBase.setMetaData({
props,
Expand All @@ -53,11 +54,9 @@ export const Dialog = React.forwardRef((inProps, ref) => {

useGlobalOnEscapeKey({
callback: (event) => {
if (props.closable && props.closeOnEscape) {
onClose(event);
}
onClose(event);
},
when: visibleState && displayOrder,
when: isCloseOnEscape && displayOrder,
priority: [ESC_KEY_HANDLING_PRIORITIES.DIALOG, displayOrder]
});

Expand Down
1 change: 1 addition & 0 deletions components/lib/dialog/DialogBase.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -257,6 +257,7 @@ export const DialogBase = ComponentBase.extend({
closable: true,
closeIcon: null,
closeOnEscape: true,
content: null,
contentClassName: null,
contentStyle: null,
dismissableMask: false,
Expand Down
6 changes: 2 additions & 4 deletions components/lib/image/Image.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,11 +43,9 @@ export const Image = React.memo(

useGlobalOnEscapeKey({
callback: () => {
if (props.closeOnEscape) {
hide();
}
hide();
},
when: maskVisibleState,
when: props.closeOnEscape && maskVisibleState,
priority: [
ESC_KEY_HANDLING_PRIORITIES.IMAGE,
// Assume that there could be only one image mask activated, so it's safe
Expand Down
5 changes: 3 additions & 2 deletions components/lib/menu/Menu.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,13 +33,14 @@ export const Menu = React.memo(
const menuRef = React.useRef(null);
const listRef = React.useRef(null);
const targetRef = React.useRef(null);
const popupMenuDisplayOrder = useDisplayOrder('menu', !!(visibleState && props.popup));
const isCloseOnEscape = !!(visibleState && props.popup && props.closeOnEscape);
const popupMenuDisplayOrder = useDisplayOrder('menu', isCloseOnEscape);

useGlobalOnEscapeKey({
callback: (event) => {
hide(event);
},
when: visibleState && props.popup && props.closeOnEscape && popupMenuDisplayOrder,
when: isCloseOnEscape && popupMenuDisplayOrder,
priority: [ESC_KEY_HANDLING_PRIORITIES.MENU, popupMenuDisplayOrder]
});

Expand Down
5 changes: 3 additions & 2 deletions components/lib/overlaypanel/OverlayPanel.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,13 +54,14 @@ export const OverlayPanel = React.forwardRef((inProps, ref) => {
when: visibleState
});

const overlayPanelDisplayOrder = useDisplayOrder('overlay-panel', visibleState);
const isCloseOnEscape = visibleState && props.closeOnEscape;
const overlayPanelDisplayOrder = useDisplayOrder('overlay-panel', isCloseOnEscape);

useGlobalOnEscapeKey({
callback: () => {
hide();
},
when: visibleState && props.closeOnEscape && overlayPanelDisplayOrder,
when: isCloseOnEscape && overlayPanelDisplayOrder,
priority: [ESC_KEY_HANDLING_PRIORITIES.OVERLAY_PANEL, overlayPanelDisplayOrder]
});

Expand Down
5 changes: 3 additions & 2 deletions components/lib/sidebar/Sidebar.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,13 +28,14 @@ export const Sidebar = React.forwardRef((inProps, ref) => {
const sidebarRef = React.useRef(null);
const maskRef = React.useRef(null);
const closeIconRef = React.useRef(null);
const sidebarDisplayOrder = useDisplayOrder('sidebar', visibleState);
const isCloseOnEscape = visibleState && props.closeOnEscape;
const sidebarDisplayOrder = useDisplayOrder('sidebar', isCloseOnEscape);

useGlobalOnEscapeKey({
callback: (event) => {
onClose(event);
},
when: visibleState && props.closeOnEscape && sidebarDisplayOrder,
when: isCloseOnEscape && sidebarDisplayOrder,
priority: [ESC_KEY_HANDLING_PRIORITIES.SIDEBAR, sidebarDisplayOrder]
});

Expand Down
5 changes: 3 additions & 2 deletions components/lib/slidemenu/SlideMenu.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,13 +34,14 @@ export const SlideMenu = React.memo(
const targetRef = React.useRef(null);
const backward = React.useRef(null);
const slideMenuContent = React.useRef(null);
const slideMenuDisplayOrder = useDisplayOrder('slide-menu', visibleState);
const isCloseOnEscape = visibleState && props.popup && props.closeOnEscape;
const slideMenuDisplayOrder = useDisplayOrder('slide-menu', isCloseOnEscape);

useGlobalOnEscapeKey({
callback: (event) => {
hide(event);
},
when: visibleState && props.popup && props.closeOnEscape && slideMenuDisplayOrder,
when: isCloseOnEscape && slideMenuDisplayOrder,
priority: [ESC_KEY_HANDLING_PRIORITIES.SLIDE_MENU, slideMenuDisplayOrder]
});

Expand Down
Loading