@blueprintjs/core
Version:
Core styles & components
142 lines • 5.24 kB
JavaScript
/*
* Copyright 2016 Palantir Technologies, Inc. All rights reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
/**
* @fileoverview This component is DEPRECATED, and the code is frozen.
* All changes & bugfixes should be made to HotkeysDialog2 instead.
*/
/* eslint-disable deprecation/deprecation */
import classNames from "classnames";
import * as React from "react";
import * as ReactDOM from "react-dom";
import { Classes } from "../common";
import { Dialog, Hotkey, Hotkeys } from "../components";
/**
* The delay before showing or hiding the dialog. Should be long enough to
* allow all registered hotkey listeners to execute first.
*/
const DELAY_IN_MS = 10;
/** @deprecated use HotkeysDialog2 */
class HotkeysDialogLegacy {
componentProps = {
globalHotkeysGroup: "Global hotkeys",
};
container = null;
hotkeysQueue = [];
isDialogShowing = false;
showTimeoutToken;
hideTimeoutToken;
render() {
if (this.container == null) {
this.container = this.getContainer();
}
ReactDOM.render(this.renderComponent(), this.container);
}
unmount() {
if (this.container != null) {
ReactDOM.unmountComponentAtNode(this.container);
this.container.remove();
this.container = null;
}
}
/**
* Because hotkeys can be registered globally and locally and because
* event ordering cannot be guaranteed, we use this debouncing method to
* allow all hotkey listeners to fire and add their hotkeys to the dialog.
*
* 10msec after the last listener adds their hotkeys, we render the dialog
* and clear the queue.
*/
enqueueHotkeysForDisplay(hotkeys) {
this.hotkeysQueue.push(hotkeys);
// reset timeout for debounce
window.clearTimeout(this.showTimeoutToken);
this.showTimeoutToken = window.setTimeout(this.show, DELAY_IN_MS);
}
hideAfterDelay() {
window.clearTimeout(this.hideTimeoutToken);
this.hideTimeoutToken = window.setTimeout(this.hide, DELAY_IN_MS);
}
show = () => {
this.isDialogShowing = true;
this.render();
};
hide = () => {
this.isDialogShowing = false;
this.render();
};
isShowing() {
return this.isDialogShowing;
}
getContainer() {
if (this.container == null) {
this.container = document.createElement("div");
this.container.classList.add(Classes.PORTAL);
document.body.appendChild(this.container);
}
return this.container;
}
renderComponent() {
return (React.createElement(Dialog, { ...this.componentProps, className: classNames(Classes.HOTKEY_DIALOG, this.componentProps.className), isOpen: this.isDialogShowing, onClose: this.hide },
React.createElement("div", { className: Classes.DIALOG_BODY }, this.renderHotkeys())));
}
renderHotkeys() {
const hotkeys = this.emptyHotkeyQueue();
const elements = hotkeys.map((hotkey, index) => {
const group = hotkey.global === true && hotkey.group == null ? this.componentProps.globalHotkeysGroup : hotkey.group;
return React.createElement(Hotkey, { key: index, ...hotkey, group: group });
});
return React.createElement(Hotkeys, null, elements);
}
emptyHotkeyQueue() {
// flatten then empty the hotkeys queue
const hotkeys = this.hotkeysQueue.reduce((arr, queued) => arr.concat(queued), []);
this.hotkeysQueue.length = 0;
return hotkeys;
}
}
// singleton instance
const HOTKEYS_DIALOG = new HotkeysDialogLegacy();
/** @deprecated use HotkeysProvider */
export function isHotkeysDialogShowing() {
return HOTKEYS_DIALOG.isShowing();
}
/** @deprecated use HotkeysProvider */
export function setHotkeysDialogProps(props) {
for (const key in props) {
if (props.hasOwnProperty(key)) {
HOTKEYS_DIALOG.componentProps[key] = props[key];
}
}
}
/** @deprecated use HotkeysProvider */
export function showHotkeysDialog(hotkeys) {
HOTKEYS_DIALOG.enqueueHotkeysForDisplay(hotkeys);
}
/** @deprecated use HotkeysProvider */
export function hideHotkeysDialog() {
HOTKEYS_DIALOG.hide();
}
/**
* Use this function instead of `hideHotkeysDialog` if you need to ensure that all hotkey listeners
* have time to execute with the dialog in a consistent open state. This can avoid flickering the
* dialog between open and closed states as successive listeners fire.
*
* @deprecated use HotkeysProvider
*/
export function hideHotkeysDialogAfterDelay() {
HOTKEYS_DIALOG.hideAfterDelay();
}
//# sourceMappingURL=hotkeysDialogLegacy.js.map