Press n or j to go to the next uncovered block, b, p or k for the previous block.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 | import React from 'react' import PropTypes from 'prop-types' import Mousetrap from 'mousetrap' import isEqual from 'lodash/isEqual' import { findDOMNode } from 'react-dom' type Keys = string | string[] type KeysWithAction = { keys: Keys action?: string } type Sequence = Keys | KeysWithAction type Callback = (e: KeyboardEvent, combo: string) => any interface SequenceHandler { keys: string | string[] callback: Callback action?: string } interface HotKeyContext { hotKeyParent: HotKeys hotKeyMap: KeyMap, hotKeyChain: HotKeys[], } export interface KeyMap { [key: string]: Sequence } export interface Handlers { [key: string]: Callback } function getSequencesFromMap(hotKeyMap: KeyMap, hotKeyName: string) { const sequences = hotKeyMap[hotKeyName] const result: Array<string | string[] | KeysWithAction> = [] // If no sequence is found with this name we assume // the user is passing a hard-coded sequence as a key // for example: ctrl+q if (!sequences) { return [hotKeyName] } return result.concat(sequences) } interface HotKeysProps { children: React.ReactNode keyMap?: KeyMap focusOnMount?: boolean onFocus?: React.FocusEventHandler onBlur?: React.FocusEventHandler handlers?: Handlers style?: React.CSSProperties className?: string } export class HotKeys extends React.Component<HotKeysProps, {}> { static defaultProps = { focusOnMount: true, } static contextTypes = { hotKeyParent: PropTypes.any, hotKeyMap: PropTypes.object, hotKeyChain: PropTypes.array, } static childContextTypes = { hotKeyParent: PropTypes.any, hotKeyMap: PropTypes.object, hotKeyChain: PropTypes.array, } wrappedComponent: React.ReactInstance | null dom: HTMLElement | null isLast: boolean mounted: boolean hotKeyMap: KeyMap mousetrap: MousetrapInstance constructor(props: HotKeysProps) { super(props) this.wrappedComponent = null this.dom = null this.isLast = true } getChildContext(): HotKeyContext { return { hotKeyParent: this, hotKeyMap: this.hotKeyMap, hotKeyChain: this.context.hotKeyChain ? this.context.hotKeyChain : [this], } } componentWillMount() { this.updateMap() if (this.context.hotKeyChain && this.props.focusOnMount) { this.context.hotKeyChain.push(this) } if (this.context.hotKeyParent) { this.context.hotKeyParent.isLast = false } } componentDidMount() { this.dom = findDOMNode(this) as HTMLElement | null if (this.dom) { this.mousetrap = new Mousetrap(this.dom) } this.updateHotKeys(true) this.mounted = true let lastNodeInChain if (this.context.hotKeyChain) { lastNodeInChain = this.context.hotKeyChain[this.context.hotKeyChain.length - 1] } if (this.props.focusOnMount && (this === lastNodeInChain || this.isLast) && this.dom) { this.dom.focus() } } componentDidUpdate(prevProps: HotKeysProps) { this.updateHotKeys(false, prevProps) } componentWillUnmount() { if (this.mousetrap) { this.mousetrap.reset() } this.mounted = false // remove the current component from hotKeyChain let lastNodeInChain if (this.context.hotKeyChain) { this.context.hotKeyChain.splice(this.context.hotKeyChain.indexOf(this), 1) lastNodeInChain = this.context.hotKeyChain[this.context.hotKeyChain.length - 1] } if (this.context.hotKeyParent) { this.context.hotKeyParent.isLast = true } // focus on last component in the chain if (lastNodeInChain && lastNodeInChain.dom) { lastNodeInChain.dom.focus() } } getMap() { return this.hotKeyMap } buildMap() { const parentMap = this.context.hotKeyMap || {} const thisMap = this.props.keyMap || {} return { ...parentMap, ...thisMap } } updateMap() { const newMap = this.buildMap() if (!isEqual(newMap, this.hotKeyMap)) { this.hotKeyMap = newMap return true } return false } updateHotKeys(force = false, prevProps?: HotKeysProps) { const handlers = this.props.handlers || {} const prevHandlers = prevProps && prevProps.handlers || handlers // Ensure map is up-to-date to begin with // We will only bother continuing if the map was actually updated if (!force && isEqual(handlers, prevHandlers) && !this.updateMap()) { return } const hotKeyMap = this.getMap() let allSequenceHandlers: Array<SequenceHandler | undefined> = [] // Group all our handlers by sequence Object.keys(handlers).forEach(hotKey => { const sequences = getSequencesFromMap(hotKeyMap, hotKey) const handler = handlers[hotKey] const sequenceHandlers: Array<SequenceHandler | undefined> = sequences.map(seq => { let keys, action if (typeof seq === 'string' || Array.isArray(seq)) { keys = seq } else if (seq) { keys = seq.keys action = seq.action } else { return } return { callback: handler, action, keys } }) allSequenceHandlers = allSequenceHandlers.concat(sequenceHandlers) }) this.mousetrap.reset() allSequenceHandlers.forEach(handler => { if (handler) { this.mousetrap.bind(handler.keys, handler.callback, handler.action) } }) } focusTrap = (ref: React.ReactInstance | null) => { if (ref) { this.wrappedComponent = ref } } render() { /* eslint-disable no-unused-vars */ const { children, keyMap, handlers, focusOnMount, ...props } = this.props return ( <div {...props} ref={this.focusTrap} tabIndex={-1}> {children} </div> ) } } |