refactor KeyCombo component, add minimal prop for icon-only version (#…

…2256)
palantir · Mar 16, 2018 · 7166b66 · 7166b66
1 parent 2ebe7ba
commit 7166b66
Showing 1 changed file with 34 additions and 29 deletions.
diff --git a/packages/core/src/components/hotkeys/keyCombo.tsx b/packages/core/src/components/hotkeys/keyCombo.tsx
@@ -1,4 +1,4 @@
-/**
+/*
  * Copyright 2016 Palantir Technologies, Inc. All rights reserved.
  *
  * Licensed under the terms of the LICENSE file distributed with this project.
@@ -25,38 +25,43 @@ const KeyIcons: { [key: string]: IconName } = {
 };
 
 export interface IKeyComboProps extends IProps {
-    allowInInput?: boolean;
+    /** The key combo to display, such as `"cmd + s"`. */
     combo: string;
-    disabled?: boolean;
-    preventDefault?: boolean;
-    stopPropagation?: boolean;
+
+    /**
+     * Whether to render in a minimal style.
+     * If `false`, each key in the combo will be rendered inside a `kbd.pt-key`.
+     * If `true`, only the icon or short name of a key will be rendered with no wrapper styles.
+     * @default false
+     */
+    minimal?: boolean;
 }
 
 export class KeyCombo extends React.Component<IKeyComboProps, {}> {
     public render() {
-        const keys = normalizeKeyCombo(this.props.combo);
-        const components = [] as JSX.Element[];
-        const rootClasses = classNames("pt-key-combo", this.props.className);
-        for (let i = 0; i < keys.length; i++) {
-            let key = keys[i];
-            const icon = KeyIcons[key];
-            if (icon != null) {
-                components.push(
-                    <kbd className="pt-key pt-modifier-key" key={`key-${i}`}>
-                        <Icon icon={icon} /> {key}
-                    </kbd>,
-                );
-            } else {
-                if (key.length === 1) {
-                    key = key.toUpperCase();
-                }
-                components.push(
-                    <kbd className="pt-key" key={`key-${i}`}>
-                        {key}
-                    </kbd>,
-                );
-            }
-        }
-        return <span className={rootClasses}>{components}</span>;
+        const { className, combo, minimal } = this.props;
+        const keys = normalizeKeyCombo(combo)
+            .map(key => (key.length === 1 ? key.toUpperCase() : key))
+            .map(minimal ? this.renderMinimalKey : this.renderKey);
+        return <span className={classNames("pt-key-combo", className)}>{keys}</span>;
     }
+
+    private renderKey = (key: string, index: number) => {
+        const icon = KeyIcons[key];
+        const reactKey = `key-${index}`;
+        return icon == null ? (
+            <kbd className="pt-key" key={reactKey}>
+                {key}
+            </kbd>
+        ) : (
+            <kbd className="pt-key pt-modifier-key" key={reactKey}>
+                <Icon icon={icon} /> {key}
+            </kbd>
+        );
+    };
+
+    private renderMinimalKey = (key: string, index: number) => {
+        const icon = KeyIcons[key];
+        return icon == null ? key : <Icon icon={icon} key={`key-${index}`} />;
+    };
 }