@jetbrains/ring-ui 4.1.5 → 5.0.0-beta.2

package/components/shortcuts/core.js

@@ -1,232 +1,191 @@
 import Combokeys from 'combokeys';
-
 import sniffr from '../global/sniffer';
-
 class Shortcuts {
-  ALLOW_SHORTCUTS_SELECTOR = '.ring-js-shortcuts';
-  ROOT_SCOPE = {
-    scopeId: 'ROOT',
-    options: {}
-  };
-
-  _scopes = {};
-
-  combokeys = new Combokeys(document.documentElement);
-  trigger = combo => this.combokeys.trigger(combo);
-
-  constructor() {
-    this.setFilter();
-    this.setScope();
-  }
-
-  _dispatcher = (e, key) => {
-    let currentScope;
-
-    for (let i = this._scopeChain.length - 1; i >= 0; i--) {
-      const scopeInChain = this._scopeChain[i];
-      currentScope = this._scopes[scopeInChain.scopeId];
-
-      if (currentScope && currentScope[key]) {
-        const ret = currentScope[key](e, key, scopeInChain.scopeId);
-
-        // Fall down in chain when returning true
-        if (ret !== true) {
-          return ret;
+    ALLOW_SHORTCUTS_SELECTOR = '.ring-js-shortcuts';
+    ROOT_SCOPE = {
+        scopeId: 'ROOT',
+        options: {}
+    };
+    _scopes = {};
+    _scopeChain = [];
+    combokeys = new Combokeys(document.documentElement);
+    trigger = (combo) => this.combokeys.trigger(combo);
+    constructor() {
+        this.setFilter();
+        this.setScope();
+    }
+    _dispatcher = (e, key) => {
+        let currentScope;
+        for (let i = this._scopeChain.length - 1; i >= 0; i--) {
+            const scopeInChain = this._scopeChain[i];
+            currentScope = this._scopes[scopeInChain.scopeId];
+            if (currentScope && key != null && currentScope[key]) {
+                const ret = currentScope[key](e, key, scopeInChain.scopeId);
+                // Fall down in chain when returning true
+                if (ret !== true) {
+                    return ret;
+                }
+            }
+            if (scopeInChain.options.modal) {
+                return true;
+            }
+        }
+        return undefined;
+    };
+    /**
+     * 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) {
+        if (!(params instanceof Object) || typeof params.handler !== 'function') {
+            throw new Error('Shortcut handler should exist');
+        }
+        if (!params.scope) {
+            params.scope = this.ROOT_SCOPE.scopeId;
+        }
+        if (Array.isArray(params.key)) {
+            for (let i = 0; i < params.key.length; i++) {
+                this.bind(Object.assign({}, params, { key: params.key[i] }));
+            }
+            return;
+        }
+        if (typeof params.key !== 'string') {
+            throw new Error('Shortcut key should exist');
+        }
+        let scope = this._scopes[params.scope];
+        if (!scope) {
+            scope = this._scopes[params.scope] = {};
+        }
+        scope[params.key] = params.handler;
+        this.combokeys.bind(params.key, this._dispatcher, this._getKeyboardEventType(params));
+    }
+    /**
+     * 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, options) {
+        if (!(map instanceof Object)) {
+            throw new Error('Shortcuts map shouldn\'t be empty');
+        }
+        for (const key in map) {
+            if (map.hasOwnProperty(key)) {
+                this.bind(Object.assign({}, options || {}, { key, handler: map[key] }));
+            }
+        }
+    }
+    unbindScope(scope) {
+        this._scopes[scope] = null;
+    }
+    getScope() {
+        return this._scopeChain.slice(1);
+    }
+    hasScope(scopeId) {
+        return this.indexOfScope(scopeId) !== -1;
+    }
+    /**
+     * 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, options = {}) {
+        if (scopeId) {
+            const position = this.indexOfScope(scopeId);
+            if (position !== -1) {
+                this._scopeChain.splice(position, 1);
+            }
+            this._scopeChain.push(this.wrapScope(scopeId, options));
+        }
+    }
+    popScope(scopeId) {
+        if (scopeId) {
+            const position = this.indexOfScope(scopeId);
+            if (position !== -1) {
+                return this._scopeChain.splice(position, this._scopeChain.length - 1);
+            }
+        }
+        return undefined;
+    }
+    spliceScope(scopeId) {
+        if (scopeId) {
+            const position = this.indexOfScope(scopeId);
+            if (position !== -1) {
+                this._scopeChain.splice(position, 1);
+            }
+        }
+    }
+    setScope(scope) {
+        if (scope) {
+            let scopeChain;
+            if (typeof scope === 'string' || (!Array.isArray(scope) && typeof scope === 'object' && scope !== null)) {
+                scopeChain = [scope];
+            }
+            else {
+                scopeChain = scope;
+            }
+            if (!Array.isArray(scopeChain)) {
+                return;
+            }
+            const scopes = scopeChain.map(scopeItem => {
+                const isScopeId = typeof scopeItem === 'string';
+                return isScopeId ? this.wrapScope(scopeItem) : scopeItem;
+            });
+            this._scopeChain = [this.ROOT_SCOPE].concat(scopes);
+        }
+        else {
+            this._scopeChain = [this.ROOT_SCOPE];
         }
-      }
-
-      if (scopeInChain.options.modal) {
-        return true;
-      }
-    }
-
-    return undefined;
-  };
-
-  /**
-   * 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) {
-    if (!(params instanceof Object) || typeof params.handler !== 'function') {
-      throw new Error('Shortcut handler should exist');
-    }
-
-    if (!params.scope) {
-      params.scope = this.ROOT_SCOPE.scopeId;
-    }
-
-    if (Array.isArray(params.key)) {
-      for (let i = 0; i < params.key.length; i++) {
-        this.bind(Object.assign({}, params, {key: params.key[i]}));
-      }
-
-      return;
-    }
-
-    if (typeof params.key !== 'string') {
-      throw new Error('Shortcut key should exist');
-    }
-
-    if (!this._scopes[params.scope]) {
-      this._scopes[params.scope] = {};
-    }
-    this._scopes[params.scope][params.key] = params.handler;
-
-    this.combokeys.bind(params.key, this._dispatcher, this._getKeyboardEventType(params));
-  }
-
-  /**
-   * 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, options) {
-    if (!(map instanceof Object)) {
-      throw new Error('Shortcuts map shouldn\'t be empty');
-    }
-
-    for (const key in map) {
-      if (map.hasOwnProperty(key)) {
-        this.bind(Object.assign({}, options || {}, {key, handler: map[key]}));
-      }
-    }
-  }
-
-  unbindScope(scope) {
-    this._scopes[scope] = null;
-  }
-
-  getScope() {
-    return this._scopeChain.slice(1);
-  }
-
-  hasScope(scopeId) {
-    return this.indexOfScope(scopeId) !== -1;
-  }
-
-  /**
-   * 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, options = {}) {
-    if (scopeId) {
-      const position = this.indexOfScope(scopeId);
-
-      if (position !== -1) {
-        this._scopeChain.splice(position, 1);
-      }
-
-      this._scopeChain.push(this.wrapScope(scopeId, options));
-    }
-  }
-
-  popScope(scopeId) {
-    if (scopeId) {
-      const position = this.indexOfScope(scopeId);
-
-      if (position !== -1) {
-        return this._scopeChain.splice(position, this._scopeChain.length - 1);
-      }
-    }
-
-    return undefined;
-  }
-
-  spliceScope(scopeId) {
-    if (scopeId) {
-      const position = this.indexOfScope(scopeId);
-
-      if (position !== -1) {
-        this._scopeChain.splice(position, 1);
-      }
-    }
-  }
-
-  setScope(scope) {
-    if (scope) {
-      let scopeChain;
-
-      if (typeof scope === 'string' || (!Array.isArray(scope) && typeof scope === 'object' && scope !== null)) {
-        scopeChain = [scope];
-      } else {
-        scopeChain = scope;
-      }
-
-      if (!Array.isArray(scopeChain)) {
-        return;
-      }
-
-      scopeChain = scopeChain.map(scopeItem => {
-        const isScopeId = typeof scopeItem === 'string';
-        return isScopeId ? this.wrapScope(scopeItem) : scopeItem;
-      });
-
-      this._scopeChain = [this.ROOT_SCOPE].concat(scopeChain);
-    } else {
-      this._scopeChain = [this.ROOT_SCOPE];
-    }
-  }
-
-  wrapScope(scopeId, options = {}) {
-    return {scopeId, options};
-  }
-
-  hasKey(key, scope) {
-    return !!(this._scopes[scope] && this._scopes[scope][key]);
-  }
-
-  _defaultFilter = (e, element, key) => {
-    // if the element or its parents have the class "ring-js-shortcuts" then no need to stop
-    if (
-      element === document ||
-      element.matches(this.ALLOW_SHORTCUTS_SELECTOR) ||
-      (element.dataset.enabledShortcuts != null
-        ? element.dataset.enabledShortcuts.split(',').includes(key)
-        : element.closest(this.ALLOW_SHORTCUTS_SELECTOR) != null)
-    ) {
-      return false;
-    }
-
-    // stop for input, select, and textarea
-    return element.matches('input,select,textarea') || (element.contentEditable && element.contentEditable === 'true');
-  };
-
-  _getKeyboardEventType(params) {
-    if (!params.type && sniffr.os.name === 'windows') {
-      const isSystemShortcut = params.key.match(/ctrl/i) && params.key.match(/shift/i) && params.key.match(/[0-9]/);
-      /**
-       * Windows system shortcuts (ctrl+shift+[0-9] are caught by the OS on 'keydown', so let's use 'keyup'
-       */
-      if (isSystemShortcut) {
-        return 'keyup';
-      }
-    }
-    return params.type;
-  }
-
-  setFilter(fn) {
-    this.combokeys.stopCallback = typeof fn === 'function' ? fn : this._defaultFilter;
-  }
-
-  indexOfScope(scopeId) {
-    return this._scopeChain.findIndex(scope => scope.scopeId === scopeId);
-  }
-
-  reset() {
-    this._scopes = {};
-    this.setScope();
-    this.combokeys.reset();
-  }
+    }
+    wrapScope(scopeId, options = {}) {
+        return { scopeId, options };
+    }
+    hasKey(key, scope) {
+        return !!(this._scopes[scope]?.[key]);
+    }
+    _defaultFilter = (e, element, key) => {
+        // if the element or its parents have the class "ring-js-shortcuts" then no need to stop
+        if (element === document ||
+            !(element instanceof HTMLElement) ||
+            key == null ||
+            element.matches(this.ALLOW_SHORTCUTS_SELECTOR) ||
+            (element.dataset.enabledShortcuts != null
+                ? element.dataset.enabledShortcuts.split(',').includes(key)
+                : element.closest(this.ALLOW_SHORTCUTS_SELECTOR) != null)) {
+            return false;
+        }
+        // stop for input, select, and textarea
+        return element.matches('input,select,textarea') || (element.contentEditable === 'true');
+    };
+    _getKeyboardEventType(params) {
+        if (!params.type && sniffr.os.name === 'windows') {
+            const isSystemShortcut = typeof params.key === 'string' && params.key.match(/ctrl/i) && params.key.match(/shift/i) && params.key.match(/[0-9]/);
+            /**
+             * Windows system shortcuts (ctrl+shift+[0-9] are caught by the OS on 'keydown', so let's use 'keyup'
+             */
+            if (isSystemShortcut) {
+                return 'keyup';
+            }
+        }
+        return params.type;
+    }
+    setFilter(fn) {
+        this.combokeys.stopCallback = typeof fn === 'function' ? fn : this._defaultFilter;
+    }
+    indexOfScope(scopeId) {
+        return this._scopeChain.findIndex(scope => scope.scopeId === scopeId);
+    }
+    reset() {
+        this._scopes = {};
+        this.setScope();
+        this.combokeys.reset();
+    }
 }
-
 export default new Shortcuts();

package/components/shortcuts/shortcut-title.d.ts

@@ -0,0 +1 @@
+export declare function getShortcutTitle(shortcut: string): string;

package/components/shortcuts/shortcut-title.js

@@ -1,56 +1,50 @@
 import sniffer from '../global/sniffer';
-
 const macSymbolsMap = {
-  enter: '⏎',
-  shift: '⇧',
-  meta: '⌘',
-  mod: '⌘',
-  alt: '⌥',
-  ctrl: '⌃',
-  backspace: '⌫',
-  esc: 'Esc',
-  tab: 'Tab',
-  del: 'Del',
-  home: 'Home',
-  end: 'End',
-  space: 'Space',
-  ins: 'Insert',
-
-  left: '←',
-  up: '↑',
-  right: '→',
-  down: '↓'
+    enter: '⏎',
+    shift: '⇧',
+    meta: '⌘',
+    mod: '⌘',
+    alt: '⌥',
+    ctrl: '⌃',
+    backspace: '⌫',
+    esc: 'Esc',
+    tab: 'Tab',
+    del: 'Del',
+    home: 'Home',
+    end: 'End',
+    space: 'Space',
+    ins: 'Insert',
+    left: '←',
+    up: '↑',
+    right: '→',
+    down: '↓'
 };
-
 const winSymbolsMap = {
-  enter: 'Enter',
-  shift: 'Shift',
-  meta: 'Ctrl',
-  mod: 'Ctrl',
-  alt: 'Alt',
-  ctrl: 'Ctrl',
-  backspace: 'Backspace',
-  esc: 'Esc',
-  tab: 'Tab',
-  del: 'Delete',
-  home: 'Home',
-  end: 'End',
-  space: 'Space',
-  ins: 'Insert',
-
-  left: '←',
-  up: '↑',
-  right: '→',
-  down: '↓'
+    enter: 'Enter',
+    shift: 'Shift',
+    meta: 'Ctrl',
+    mod: 'Ctrl',
+    alt: 'Alt',
+    ctrl: 'Ctrl',
+    backspace: 'Backspace',
+    esc: 'Esc',
+    tab: 'Tab',
+    del: 'Delete',
+    home: 'Home',
+    end: 'End',
+    space: 'Space',
+    ins: 'Insert',
+    left: '←',
+    up: '↑',
+    right: '→',
+    down: '↓'
 };
-
 export function getShortcutTitle(shortcut) {
-  const MAC_OS = sniffer.os.name === 'macos';
-  const KEY_SEPARATOR = MAC_OS ? '' : '+';
-  const symbolsMap = MAC_OS ? macSymbolsMap : winSymbolsMap;
-
-  return shortcut.
-    split(/\+/g).
-    map(symbol => symbolsMap[symbol] || symbol.toUpperCase()).
-    join(KEY_SEPARATOR);
+    const MAC_OS = sniffer.os.name === 'macos';
+    const KEY_SEPARATOR = MAC_OS ? '' : '+';
+    const symbolsMap = MAC_OS ? macSymbolsMap : winSymbolsMap;
+    return shortcut.
+        split(/\+/g).
+        map(symbol => symbolsMap[symbol] || symbol.toUpperCase()).
+        join(KEY_SEPARATOR);
 }

package/components/shortcuts/shortcuts-hoc.d.ts

@@ -0,0 +1,69 @@
+import React, { ComponentType } from 'react';
+import PropTypes from 'prop-types';
+import { ShortcutsMap, ShortcutsScopeOptions } from './core';
+export interface ShortcutsHOCOptions extends ShortcutsScopeOptions {
+    disabled?: boolean | null | undefined;
+}
+export interface ShortcutsHOCProps {
+    rgShortcutsOptions: ShortcutsHOCOptions;
+    rgShortcutsMap: ShortcutsMap;
+}
+export default function shortcutsHOC<P>(ComposedComponent: ComponentType<P> | string): {
+    new (props: (P & ShortcutsHOCProps) | Readonly<P & ShortcutsHOCProps>): {
+        _shortcutsScopeUid: string;
+        render(): JSX.Element;
+        context: any;
+        setState<K extends never>(state: {} | ((prevState: Readonly<{}>, props: Readonly<P & ShortcutsHOCProps>) => {} | Pick<{}, K> | null) | Pick<{}, K> | null, callback?: (() => void) | undefined): void;
+        forceUpdate(callback?: (() => void) | undefined): void;
+        readonly props: Readonly<P & ShortcutsHOCProps> & Readonly<{
+            children?: React.ReactNode;
+        }>;
+        state: Readonly<{}>;
+        refs: {
+            [key: string]: React.ReactInstance;
+        };
+        componentDidMount?(): void;
+        shouldComponentUpdate?(nextProps: Readonly<P & ShortcutsHOCProps>, nextState: Readonly<{}>, nextContext: any): boolean;
+        componentWillUnmount?(): void;
+        componentDidCatch?(error: Error, errorInfo: React.ErrorInfo): void;
+        getSnapshotBeforeUpdate?(prevProps: Readonly<P & ShortcutsHOCProps>, prevState: Readonly<{}>): any;
+        componentDidUpdate?(prevProps: Readonly<P & ShortcutsHOCProps>, prevState: Readonly<{}>, snapshot?: any): void;
+        componentWillMount?(): void;
+        UNSAFE_componentWillMount?(): void;
+        componentWillReceiveProps?(nextProps: Readonly<P & ShortcutsHOCProps>, nextContext: any): void;
+        UNSAFE_componentWillReceiveProps?(nextProps: Readonly<P & ShortcutsHOCProps>, nextContext: any): void;
+        componentWillUpdate?(nextProps: Readonly<P & ShortcutsHOCProps>, nextState: Readonly<{}>, nextContext: any): void;
+        UNSAFE_componentWillUpdate?(nextProps: Readonly<P & ShortcutsHOCProps>, nextState: Readonly<{}>, nextContext: any): void;
+    };
+    new (props: P & ShortcutsHOCProps, context: any): {
+        _shortcutsScopeUid: string;
+        render(): JSX.Element;
+        context: any;
+        setState<K extends never>(state: {} | ((prevState: Readonly<{}>, props: Readonly<P & ShortcutsHOCProps>) => {} | Pick<{}, K> | null) | Pick<{}, K> | null, callback?: (() => void) | undefined): void;
+        forceUpdate(callback?: (() => void) | undefined): void;
+        readonly props: Readonly<P & ShortcutsHOCProps> & Readonly<{
+            children?: React.ReactNode;
+        }>;
+        state: Readonly<{}>;
+        refs: {
+            [key: string]: React.ReactInstance;
+        };
+        componentDidMount?(): void;
+        shouldComponentUpdate?(nextProps: Readonly<P & ShortcutsHOCProps>, nextState: Readonly<{}>, nextContext: any): boolean;
+        componentWillUnmount?(): void;
+        componentDidCatch?(error: Error, errorInfo: React.ErrorInfo): void;
+        getSnapshotBeforeUpdate?(prevProps: Readonly<P & ShortcutsHOCProps>, prevState: Readonly<{}>): any;
+        componentDidUpdate?(prevProps: Readonly<P & ShortcutsHOCProps>, prevState: Readonly<{}>, snapshot?: any): void;
+        componentWillMount?(): void;
+        UNSAFE_componentWillMount?(): void;
+        componentWillReceiveProps?(nextProps: Readonly<P & ShortcutsHOCProps>, nextContext: any): void;
+        UNSAFE_componentWillReceiveProps?(nextProps: Readonly<P & ShortcutsHOCProps>, nextContext: any): void;
+        componentWillUpdate?(nextProps: Readonly<P & ShortcutsHOCProps>, nextState: Readonly<{}>, nextContext: any): void;
+        UNSAFE_componentWillUpdate?(nextProps: Readonly<P & ShortcutsHOCProps>, nextState: Readonly<{}>, nextContext: any): void;
+    };
+    propTypes: {
+        rgShortcutsOptions: PropTypes.Requireable<object>;
+        rgShortcutsMap: PropTypes.Requireable<object>;
+    };
+    contextType?: React.Context<any> | undefined;
+};

package/components/shortcuts/shortcuts-hoc.jsx

@@ -0,0 +1,19 @@
+import React from 'react';
+import PropTypes from 'prop-types';
+import getUID from '../global/get-uid';
+import Shortcuts from './shortcuts';
+export default function shortcutsHOC(ComposedComponent) {
+    return class WithShortcuts extends React.Component {
+        static propTypes = {
+            rgShortcutsOptions: PropTypes.object,
+            rgShortcutsMap: PropTypes.object
+        };
+        _shortcutsScopeUid = getUID('rg-shortcuts-');
+        render() {
+            const { rgShortcutsOptions, rgShortcutsMap, ...props } = this.props;
+            return (<Shortcuts scope={this._shortcutsScopeUid} map={rgShortcutsMap} options={rgShortcutsOptions} disabled={rgShortcutsOptions.disabled}>
+          <ComposedComponent {...props}/>
+        </Shortcuts>);
+        }
+    };
+}

package/components/shortcuts/shortcuts.d.ts

@@ -0,0 +1,28 @@
+import { PureComponent } from 'react';
+import PropTypes from 'prop-types';
+import { ShortcutsMap, ShortcutsScopeOptions } from './core';
+export interface ShortcutsProps {
+    map: ShortcutsMap;
+    scope: string;
+    options: ShortcutsScopeOptions;
+    children?: React.ReactNode;
+    disabled?: boolean | null | undefined;
+}
+export default class Shortcuts extends PureComponent<ShortcutsProps> {
+    static propTypes: {
+        map: PropTypes.Validator<object>;
+        scope: PropTypes.Validator<string>;
+        options: PropTypes.Requireable<object>;
+        disabled: PropTypes.Requireable<boolean>;
+        children: PropTypes.Requireable<PropTypes.ReactNodeLike>;
+    };
+    static defaultProps: {
+        options: {};
+    };
+    componentDidMount(): void;
+    componentDidUpdate(prevProps: ShortcutsProps): void;
+    componentWillUnmount(): void;
+    turnShorcutsOn(): void;
+    turnShorcutsOff(): void;
+    render(): {} | null;
+}