@jetbrains/ring-ui 4.1.3 → 5.0.0-beta.0

package/dist/select/select__filter.d.ts

@@ -0,0 +1,20 @@
+import { Component, RefCallback } from 'react';
+import { InputAttrs } from '../input/input';
+declare function noop(): void;
+declare type SelectFilterProps = InputAttrs & {
+    inputRef: RefCallback<HTMLInputElement | HTMLTextAreaElement>;
+    listId?: string | undefined;
+};
+export default class SelectFilter extends Component<SelectFilterProps> {
+    static defaultProps: {
+        placeholder: string;
+        inputRef: typeof noop;
+    };
+    componentWillUnmount(): void;
+    focus(): void;
+    blur(): void;
+    input?: HTMLInputElement | HTMLTextAreaElement | null;
+    inputRef: (el: HTMLInputElement | HTMLTextAreaElement | null) => void;
+    render(): JSX.Element;
+}
+export {};

package/dist/select/select__filter.js

@@ -8,6 +8,7 @@ import '../list/list.js';
 export { S as default } from '../_helpers/select__filter.js';
 import '@jetbrains/icons/close';
 import '../global/theme.js';
+import '../global/prop-types.js';
 import '../button/button.js';
 import 'focus-visible';
 import '@jetbrains/icons/chevron-10px';
@@ -20,6 +21,7 @@ import '../global/memoize.js';
 import '../link/clickableLink.js';
 import '../_helpers/button__classes.js';
 import '../global/get-uid.js';
+import '../global/composeRefs.js';
 import '../_helpers/input.js';
 import 'sniffr';
 import 'react-virtualized/dist/es/List';

package/dist/select/select__popup.d.ts

@@ -0,0 +1,123 @@
+/**
+ * @description Displays a popup with select's options.
+ */
+import React, { CSSProperties, PureComponent, ReactNode, SyntheticEvent } from 'react';
+import { IconType } from '../icon/icon';
+import Popup from '../popup/popup';
+import { Directions } from '../popup/position';
+import List, { SelectHandlerParams } from '../list/list';
+import Caret from '../caret/caret';
+import { ListDataItem } from '../list/consts';
+import { ShortcutsMap } from '../shortcuts/core';
+import { SelectItem } from './select';
+export declare type FilterFn<T> = (itemToCheck: SelectItem<T>, checkString: string, data: readonly SelectItem<T>[]) => boolean;
+export interface Filter<T = unknown> {
+    fn?: FilterFn<T> | null | undefined;
+    fuzzy?: boolean | null | undefined;
+    value?: string | null | undefined;
+    placeholder?: string | undefined;
+}
+export interface Multiple {
+    label?: string | null | undefined;
+    limit?: number | null | undefined;
+    selectAll?: boolean | null | undefined;
+    removeSelectedItems?: boolean | null | undefined;
+}
+export interface TagsReset {
+    separator?: boolean | null | undefined;
+    label?: string | number | null | undefined;
+    glyph?: IconType | string | null | undefined;
+}
+export interface Tags {
+    reset?: TagsReset | null | undefined;
+}
+export interface SelectPopupProps<T = unknown> {
+    data: readonly ListDataItem<T>[];
+    activeIndex: number | null;
+    toolbar: ReactNode;
+    filter: boolean | Filter<T>;
+    message: string | null;
+    anchorElement: HTMLElement | null;
+    maxHeight: number;
+    minWidth: number;
+    loading: boolean;
+    onSelect: (item: ListDataItem<T>, event: Event, params?: SelectHandlerParams) => void;
+    onCloseAttempt: (e?: Event | SyntheticEvent, isEsc?: boolean | undefined) => void;
+    onFilter: (e: React.ChangeEvent<HTMLInputElement>) => void;
+    onClear: (e: React.MouseEvent<HTMLButtonElement>) => void;
+    onLoadMore: () => void;
+    ringPopupTarget: string | null;
+    onSelectAll: (isSelectAll: boolean) => void;
+    onEmptyPopupEnter: (e: KeyboardEvent) => void;
+    className?: string | null | undefined;
+    compact?: boolean | null | undefined;
+    dir?: 'ltr' | 'rtl' | undefined;
+    directions?: readonly Directions[] | undefined;
+    disabled?: boolean | undefined;
+    disableMoveOverflow?: boolean | null | undefined;
+    disableScrollToActive?: boolean | null | undefined;
+    filterValue?: string | undefined;
+    hidden?: boolean | null | undefined;
+    isInputMode?: boolean | undefined;
+    listId?: string | undefined;
+    left?: number | undefined;
+    renderOptimization?: boolean | undefined;
+    style?: CSSProperties | undefined;
+    top?: number | undefined;
+    multiple: boolean | Multiple;
+    selected: ListDataItem<T> | readonly ListDataItem<T>[] | null;
+    tags: Tags | boolean | null;
+}
+export default class SelectPopup<T = unknown> extends PureComponent<SelectPopupProps<T>> {
+    static defaultProps: SelectPopupProps;
+    state: {
+        popupFilterShortcutsOptions: {
+            modal: boolean;
+            disabled: boolean;
+        };
+        tagsActiveIndex: null;
+    };
+    componentDidMount(): void;
+    componentWillUnmount(): void;
+    isClickingPopup: boolean;
+    filter?: HTMLInputElement | null;
+    focusFilter(): void;
+    isEventTargetFilter(event: Event): boolean;
+    caret?: Caret | null;
+    handleNavigation(event: Event, navigateLeft?: boolean): void;
+    removeTag(tag?: ListDataItem<T>, event?: SyntheticEvent): void;
+    removeSelectedTag(): boolean;
+    handleBackspace(event: Event): boolean;
+    onFilterFocus: () => void;
+    popupFilterOnBlur: () => void;
+    private _togglePopupFilterShortcuts;
+    mouseDownHandler: () => void;
+    mouseUpHandler: () => void;
+    popup?: Popup | null;
+    isVisible(): boolean | null | undefined;
+    onListSelect: (selected: ListDataItem<T>, event?: Event | React.SyntheticEvent<Element, Event> | undefined, opts?: SelectHandlerParams | undefined) => void;
+    tabPress: (event: Event) => void;
+    onClickHandler: () => void | undefined;
+    getFilter(): JSX.Element | null;
+    handleRemoveTag: (arg: ListDataItem<T>) => (event: SyntheticEvent) => void;
+    handleTagClick: (arg: ListDataItem<T>) => () => void;
+    getTags(): false | JSX.Element;
+    getFilterWithTags(): JSX.Element | null;
+    getBottomLine(): "" | JSX.Element | null;
+    handleListResize: () => void;
+    getList(ringPopupTarget: string | undefined): JSX.Element | null;
+    handleSelectAll: () => void;
+    getSelectAll: () => false | JSX.Element;
+    private _adjustListMaxHeight;
+    popupRef: (el: Popup | null) => void;
+    list?: List<T> | null;
+    listRef: (el: List<T> | null) => void;
+    filterRef: (el: HTMLInputElement | null) => void;
+    shortcutsScope: string;
+    shortcutsMap: {
+        tab: (event: Event) => void;
+    };
+    popupFilterShortcutsMap: ShortcutsMap;
+    render(): JSX.Element;
+}
+export declare type SelectPopupAttrs<T = unknown> = JSX.LibraryManagedAttributes<typeof SelectPopup, SelectPopupProps<T>>;

package/dist/select/select__popup.js

@@ -9,7 +9,7 @@ import Popup, { getPopupContainer } from '../popup/popup.js';
 import { maxHeightForDirection } from '../popup/position.js';
 import { PopupTargetContext } from '../popup/popup.target.js';
 import List from '../list/list.js';
-import LoaderInline from '../loader-inline/loader-inline.js';
+import ThemedLoaderInline from '../loader-inline/loader-inline.js';
 import shortcutsHOC from '../shortcuts/shortcuts-hoc.js';
 import { getStyles } from '../global/dom.js';
 import getUID from '../global/get-uid.js';
@@ -17,7 +17,7 @@ import memoize from '../global/memoize.js';
 import TagsList from '../tags-list/tags-list.js';
 import Caret from '../caret/caret.js';
 import Shortcuts from '../shortcuts/shortcuts.js';
-import Button from '../button/button.js';
+import ThemedButton from '../button/button.js';
 import Text from '../text/text.js';
 import { DEFAULT_DIRECTIONS } from '../popup/popup.consts.js';
 import { S as SelectFilter, m as modules_b607bec2 } from '../_helpers/select__filter.js';
@@ -70,6 +70,8 @@ import '@jetbrains/icons/close';
 import '@jetbrains/icons/chevron-10px';
 import '../_helpers/button__classes.js';
 import '../input/input.js';
+import '../global/prop-types.js';
+import '../global/composeRefs.js';
 import '../_helpers/input.js';
 
 const INPUT_MARGIN_COMPENSATION = -14;
@@ -93,6 +95,10 @@ class SelectPopup extends PureComponent {
 
     _defineProperty(this, "isClickingPopup", false);
 
+    _defineProperty(this, "filter", void 0);
+
+    _defineProperty(this, "caret", void 0);
+
     _defineProperty(this, "onFilterFocus", () => {
       this._togglePopupFilterShortcuts(false);
 
@@ -115,16 +121,14 @@ class SelectPopup extends PureComponent {
       this.isClickingPopup = false;
     });
 
+    _defineProperty(this, "popup", void 0);
+
     _defineProperty(this, "onListSelect", (selected, event, opts) => {
       const getSelectItemEvent = () => {
-        let customEvent;
-
-        if (document.createEvent) {
-          customEvent = document.createEvent('Event');
-          customEvent.initEvent('select', true, false);
-        }
+        const customEvent = document.createEvent('Event');
+        customEvent.initEvent('select', true, false);
 
-        if (event && event.persist) {
+        if (event && 'persist' in event) {
           event.persist();
         }
 
@@ -139,27 +143,37 @@ class SelectPopup extends PureComponent {
       this.props.onCloseAttempt(event, true);
     });
 
-    _defineProperty(this, "onClickHandler", () => this.filter.focus());
+    _defineProperty(this, "onClickHandler", () => {
+      var _this$filter;
+
+      return (_this$filter = this.filter) === null || _this$filter === void 0 ? void 0 : _this$filter.focus();
+    });
 
     _defineProperty(this, "handleRemoveTag", memoize(tag => event => this.removeTag(tag, event)));
 
     _defineProperty(this, "handleTagClick", memoize(tag => () => {
-      this.setState({
-        tagsActiveIndex: this.props.selected.indexOf(tag)
-      });
+      if (Array.isArray(this.props.selected)) {
+        this.setState({
+          tagsActiveIndex: this.props.selected.indexOf(tag)
+        });
+      }
     }));
 
     _defineProperty(this, "handleListResize", () => {
       this.forceUpdate();
     });
 
-    _defineProperty(this, "handleSelectAll", () => this.props.onSelectAll(this.props.data.filter(item => !item.disabled).length !== this.props.selected.length));
+    _defineProperty(this, "handleSelectAll", () => {
+      if (Array.isArray(this.props.selected)) {
+        this.props.onSelectAll(this.props.data.filter(item => !item.disabled).length !== this.props.selected.length);
+      }
+    });
 
     _defineProperty(this, "getSelectAll", () => {
       const activeFilters = this.props.data.filter(item => !item.disabled);
-      return /*#__PURE__*/React.createElement("div", {
+      return Array.isArray(this.props.selected) && /*#__PURE__*/React.createElement("div", {
         className: modules_b607bec2.selectAll
-      }, activeFilters.length === 0 ? /*#__PURE__*/React.createElement("span", null) : /*#__PURE__*/React.createElement(Button, {
+      }, activeFilters.length === 0 ? /*#__PURE__*/React.createElement("span", null) : /*#__PURE__*/React.createElement(ThemedButton, {
         text: true,
         inline: true,
         onClick: this.handleSelectAll
@@ -183,20 +197,26 @@ class SelectPopup extends PureComponent {
 
       const anchorNode = this.props.anchorElement;
       const containerNode = getPopupContainer(ringPopupTarget) || document.documentElement;
-      return Math.min(directions.reduce((maxHeight, direction) => Math.max(maxHeight, maxHeightForDirection(direction, anchorNode, getStyles(containerNode).position !== 'static' ? containerNode : null)), minMaxHeight), userDefinedMaxHeight);
+      return anchorNode != null ? Math.min(directions.reduce((maxHeight, direction) => {
+        var _maxHeightForDirectio;
+
+        return Math.max(maxHeight, (_maxHeightForDirectio = maxHeightForDirection(direction, anchorNode, getStyles(containerNode).position !== 'static' ? containerNode : null)) !== null && _maxHeightForDirectio !== void 0 ? _maxHeightForDirectio : 0);
+      }, minMaxHeight), userDefinedMaxHeight) : userDefinedMaxHeight;
     }));
 
     _defineProperty(this, "popupRef", el => {
       this.popup = el;
     });
 
+    _defineProperty(this, "list", void 0);
+
     _defineProperty(this, "listRef", el => {
       this.list = el;
     });
 
     _defineProperty(this, "filterRef", el => {
       this.filter = el;
-      this.caret = new Caret(this.filter);
+      this.caret = el && new Caret(el);
     });
 
     _defineProperty(this, "shortcutsScope", getUID('select-popup-'));
@@ -205,20 +225,18 @@ class SelectPopup extends PureComponent {
       tab: this.tabPress
     });
 
-    _defineProperty(this, "popupFilterShortcuts", {
-      map: {
-        up: event => this.list && this.list.upHandler(event),
-        down: event => this.list && this.list.downHandler(event),
-        home: event => this.list && this.list.homeHandler(event),
-        end: event => this.list && this.list.endHandler(event),
-        enter: event => this.list ? this.list.enterHandler(event) : this.props.onEmptyPopupEnter(event),
-        esc: event => this.props.onCloseAttempt(event, true),
-        tab: event => this.tabPress(event),
-        backspace: event => this.handleBackspace(event),
-        del: () => this.removeSelectedTag(),
-        left: () => this.handleNavigation(true),
-        right: () => this.handleNavigation()
-      }
+    _defineProperty(this, "popupFilterShortcutsMap", {
+      up: event => this.list && this.list.upHandler(event),
+      down: event => this.list && this.list.downHandler(event),
+      home: event => this.list && this.list.homeHandler(event),
+      end: event => this.list && this.list.endHandler(event),
+      enter: event => this.list ? this.list.enterHandler(event) : this.props.onEmptyPopupEnter(event),
+      esc: event => this.props.onCloseAttempt(event, true),
+      tab: event => this.tabPress(event),
+      backspace: event => this.handleBackspace(event),
+      del: () => this.removeSelectedTag(),
+      left: event => this.handleNavigation(event, true),
+      right: event => this.handleNavigation(event)
     });
   }
 
@@ -230,17 +248,20 @@ class SelectPopup extends PureComponent {
     window.document.removeEventListener('mouseup', this.mouseUpHandler);
   }
 
-  // This flag is set to true while an item in the popup is being clicked
   focusFilter() {
-    setTimeout(() => this.filter.focus());
+    setTimeout(() => {
+      var _this$filter2;
+
+      return (_this$filter2 = this.filter) === null || _this$filter2 === void 0 ? void 0 : _this$filter2.focus();
+    });
   }
 
   isEventTargetFilter(event) {
-    return event.target && event.target.matches('input,textarea');
+    return event.target instanceof Element && event.target.matches('input,textarea');
   }
 
-  handleNavigation(navigateLeft) {
-    if (this.isEventTargetFilter(event) && this.caret.getPosition() > 0) {
+  handleNavigation(event, navigateLeft) {
+    if (this.isEventTargetFilter(event) && this.caret != null && this.caret.getPosition() > 0 || !Array.isArray(this.props.selected)) {
       return;
     }
 
@@ -263,6 +284,10 @@ class SelectPopup extends PureComponent {
   }
 
   removeTag(tag, event) {
+    if (!Array.isArray(this.props.selected)) {
+      return;
+    }
+
     const _tag = tag || this.props.selected.slice(0)[this.props.selected.length - 1];
 
     if (_tag) {
@@ -277,7 +302,7 @@ class SelectPopup extends PureComponent {
   }
 
   removeSelectedTag() {
-    if (this.state.tagsActiveIndex != null) {
+    if (Array.isArray(this.props.selected) && this.state.tagsActiveIndex != null) {
       this.removeTag(this.props.selected[this.state.tagsActiveIndex]);
       return false;
     }
@@ -295,7 +320,7 @@ class SelectPopup extends PureComponent {
       return false;
     }
 
-    if (!event.target.value) {
+    if ((event.target instanceof HTMLInputElement || event.target instanceof HTMLTextAreaElement) && !event.target.value) {
       this.removeTag();
       return false;
     }
@@ -327,19 +352,19 @@ class SelectPopup extends PureComponent {
         "data-test-custom": "ring-select-popup-filter-icon"
       }), /*#__PURE__*/React.createElement(FilterWithShortcuts, {
         rgShortcutsOptions: this.state.popupFilterShortcutsOptions,
-        rgShortcutsMap: this.popupFilterShortcuts.map,
+        rgShortcutsMap: this.popupFilterShortcutsMap,
         value: this.props.filterValue,
         inputRef: this.filterRef,
         onBlur: this.popupFilterOnBlur,
         onFocus: this.onFilterFocus,
         className: "ring-js-shortcuts",
-        placeholder: this.props.filter.placeholder,
+        placeholder: typeof this.props.filter === 'object' ? this.props.filter.placeholder : undefined,
         onChange: this.props.onFilter,
         onClick: this.onClickHandler,
         onClear: this.props.onClear,
         "data-test-custom": "ring-select-popup-filter-input",
         listId: this.props.listId,
-        enableShortcuts: Object.keys(this.popupFilterShortcuts.map)
+        enableShortcuts: Object.keys(this.popupFilterShortcutsMap)
       }));
     }
 
@@ -347,7 +372,7 @@ class SelectPopup extends PureComponent {
   }
 
   getTags() {
-    return /*#__PURE__*/React.createElement("div", null, /*#__PURE__*/React.createElement(TagsList, {
+    return Array.isArray(this.props.selected) && /*#__PURE__*/React.createElement("div", null, /*#__PURE__*/React.createElement(TagsList, {
       tags: this.props.selected,
       activeIndex: this.state.tagsActiveIndex,
       handleRemove: this.handleRemoveTag,
@@ -376,7 +401,7 @@ class SelectPopup extends PureComponent {
     } = this.props;
     return (loading || message) && /*#__PURE__*/React.createElement("div", {
       className: modules_b607bec2.bottomLine
-    }, loading && /*#__PURE__*/React.createElement(LoaderInline, null), message && /*#__PURE__*/React.createElement("div", {
+    }, loading && /*#__PURE__*/React.createElement(ThemedLoaderInline, null), message && /*#__PURE__*/React.createElement("div", {
       className: modules_b607bec2.message
     }, message));
   }
@@ -443,7 +468,7 @@ class SelectPopup extends PureComponent {
     const classes = classNames(modules_b607bec2.popup, className);
     return /*#__PURE__*/React.createElement(PopupTargetContext.Consumer, null, ringPopupTarget => {
       const filterWithTags = this.getFilterWithTags();
-      const selectAll = multiple && !multiple.limit && multiple.selectAll && this.getSelectAll();
+      const selectAll = multiple && typeof multiple === 'object' && !multiple.limit && multiple.selectAll && this.getSelectAll();
       const list = this.getList(this.props.ringPopupTarget || ringPopupTarget);
       const bottomLine = this.getBottomLine();
       const hasContent = filterWithTags || selectAll || list || bottomLine || toolbar;
@@ -458,7 +483,7 @@ class SelectPopup extends PureComponent {
         minWidth: minWidth,
         onCloseAttempt: onCloseAttempt,
         directions: directions,
-        top: top || (isInputMode ? INPUT_MARGIN_COMPENSATION : null),
+        top: top || (isInputMode ? INPUT_MARGIN_COMPENSATION : undefined),
         left: left,
         onMouseDown: this.mouseDownHandler,
         target: this.props.ringPopupTarget,
@@ -475,7 +500,30 @@ class SelectPopup extends PureComponent {
 
 }
 
-_defineProperty(SelectPopup, "propTypes", {
+_defineProperty(SelectPopup, "defaultProps", {
+  data: [],
+  activeIndex: null,
+  toolbar: null,
+  filter: false,
+  multiple: false,
+  message: null,
+  anchorElement: null,
+  maxHeight: 600,
+  minWidth: 240,
+  loading: false,
+  onSelect: noop,
+  onCloseAttempt: noop,
+  onFilter: noop,
+  onClear: noop,
+  onLoadMore: noop,
+  selected: [],
+  tags: null,
+  ringPopupTarget: null,
+  onSelectAll: noop,
+  onEmptyPopupEnter: noop
+});
+
+SelectPopup.propTypes = {
   activeIndex: PropTypes.number,
   anchorElement: PropTypes.instanceOf(HTMLElement),
   className: PropTypes.string,
@@ -502,7 +550,7 @@ _defineProperty(SelectPopup, "propTypes", {
     limit: PropTypes.number,
     selectAll: PropTypes.bool
   })]),
-  left: PropTypes.bool,
+  left: PropTypes.number,
   loading: PropTypes.bool,
   onClear: PropTypes.func,
   onCloseAttempt: PropTypes.func,
@@ -518,29 +566,6 @@ _defineProperty(SelectPopup, "propTypes", {
   tags: PropTypes.object,
   toolbar: PropTypes.node,
   top: PropTypes.number
-});
-
-_defineProperty(SelectPopup, "defaultProps", {
-  data: [],
-  activeIndex: null,
-  toolbar: null,
-  filter: false,
-  multiple: false,
-  message: null,
-  anchorElement: null,
-  maxHeight: 600,
-  minWidth: 240,
-  loading: false,
-  onSelect: noop,
-  onCloseAttempt: noop,
-  onFilter: noop,
-  onClear: noop,
-  onLoadMore: noop,
-  selected: [],
-  tags: null,
-  ringPopupTarget: null,
-  onSelectAll: noop,
-  onEmptyPopupEnter: noop
-});
+};
 
 export { SelectPopup as default };

package/dist/select-ng/select-ng.js

@@ -14,6 +14,7 @@ import '@jetbrains/icons/close';
 import 'deep-equal';
 import '../dropdown/dropdown.js';
 import '../global/data-tests.js';
+import '../global/typescript-utils.js';
 import '../_helpers/anchor.js';
 import '../icon/icon.js';
 import 'util-deprecate';
@@ -64,6 +65,8 @@ import '../list/list__separator.js';
 import '../list/list__hint.js';
 import '../list/consts.js';
 import '../input/input.js';
+import '../global/prop-types.js';
+import '../global/composeRefs.js';
 import '../_helpers/input.js';
 import '../global/rerender-hoc.js';
 import '../global/fuzzy-highlight.js';

package/dist/select-ng/select-ng__lazy.js

@@ -10,6 +10,7 @@ import '@jetbrains/icons/close';
 import 'deep-equal';
 import '../dropdown/dropdown.js';
 import '../global/data-tests.js';
+import '../global/typescript-utils.js';
 import '../_helpers/anchor.js';
 import '../icon/icon.js';
 import 'util-deprecate';
@@ -61,6 +62,8 @@ import '../list/list__separator.js';
 import '../list/list__hint.js';
 import '../list/consts.js';
 import '../input/input.js';
+import '../global/prop-types.js';
+import '../global/composeRefs.js';
 import '../_helpers/input.js';
 import '../global/rerender-hoc.js';
 import '../global/fuzzy-highlight.js';

package/dist/shortcuts/core.d.ts

@@ -0,0 +1,74 @@
+/// <reference types="combokeys" />
+export interface ShortcutsScopeOptions {
+    modal?: boolean | null | undefined;
+}
+export interface ShortcutsScope {
+    scopeId: string;
+    options: ShortcutsScopeOptions;
+}
+declare type ShortcutsHandler = (e: KeyboardEvent, key: string, scopeId: string) => boolean | null | void;
+export interface ShortcutsOptions {
+    scope?: string | null | undefined;
+    type?: string | undefined;
+}
+export interface ShortcutsParams extends ShortcutsOptions {
+    key: string | string[];
+    handler: ShortcutsHandler;
+}
+export declare type ShortcutsMap = Record<string, ShortcutsHandler>;
+declare class Shortcuts {
+    ALLOW_SHORTCUTS_SELECTOR: string;
+    ROOT_SCOPE: {
+        scopeId: string;
+        options: {};
+    };
+    _scopes: Record<string, Record<string, ShortcutsHandler> | null>;
+    private _scopeChain;
+    combokeys: Combokeys.Combokeys;
+    trigger: (combo: string) => void;
+    constructor();
+    private _dispatcher;
+    /**
+     * Binds a handler to a shortcut
+     *
+     * @param params.key {string | Array.<string>) Keys to bind
+     * @param params.handler {Function} Events handle
+     * @param params.scope {string} Scope (optional)
+     * @param params.type {string} Event type, will be passed to Combokeys (optional)
+     */
+    bind(params: ShortcutsParams): void;
+    /**
+     * Binds a map of shortcuts to handlers with common options
+     *
+     * @map {Object) Keys to handlers map
+     * @options.scope {string} Scope (optional)
+     * @options.type {string} Event type, will be passed to Combokeys (optional)
+     */
+    bindMap(map: ShortcutsMap, options?: ShortcutsOptions): void;
+    unbindScope(scope: string): void;
+    getScope(): ShortcutsScope[];
+    hasScope(scopeId: string): boolean;
+    /**
+     * Adds a scope to the chain
+     * @param scopeId id of scope to add
+     * @param options options for pushing scope
+     * @param options.modal whether keys should fall through this scope or not.
+     * Useful for modals or overlays
+     */
+    pushScope(scopeId: string, options?: ShortcutsScopeOptions): void;
+    popScope(scopeId: string): ShortcutsScope[] | undefined;
+    spliceScope(scopeId: string): void;
+    setScope(scope?: ShortcutsScope | string | (ShortcutsScope | string)[] | null | undefined): void;
+    wrapScope(scopeId: string, options?: ShortcutsScopeOptions): {
+        scopeId: string;
+        options: ShortcutsScopeOptions;
+    };
+    hasKey(key: string, scope: string): boolean;
+    private _defaultFilter;
+    private _getKeyboardEventType;
+    setFilter(fn?: (e: Event, element: Element, key?: string) => boolean): void;
+    indexOfScope(scopeId: string): number;
+    reset(): void;
+}
+declare const _default: Shortcuts;
+export default _default;