@shopify/react-shortcuts v5.2.0
@shopify/react-shortcuts
Declarative and performant library for matching shortcut combinations in React applications.
Installation
yarn add @shopify/react-shortcuts
Usage
The library exposes three main parts, <ShortcutProvider />
, <Shortcut />
and ShortcutManager
.
ShortcutProvider
Wrapping your application in a <ShortcutProvider />
allows you to use <Shortcut />
components anywhere in your application, internally sharing a single ShortcutManager
instance to minimize listeners and collisions.
// App.ts
import React from 'react';
import {ShortcutProvider} from '@shopify/react-shortcuts';
export default function App() {
<ShortcutProvider>{/* the rest of your app */}</ShortcutProvider>;
}
Shortcut
Shortcut is used to register a new keyboard shortcut to ShortcutManager
. It can be triggered globally or only when a node is focused.
Note: a <Shortcut />
must have a <ShortcutProvider />
somewhere above it in the tree.
API
export interface Props {
/*
keys that, when pressed sequentially, will trigger `onMatch`
*/
ordered: Key[];
/*
modifier keys that need to be kept pressed along with `keys` to trigger `onMatch`
*/
held?: HeldKey;
/*
a callback that will trigger when the key combination is pressed
*/
onMatch(matched: {ordered: Key[]; held?: ModifierKey[]}): void;
/*
a node that, when supplied, will be used to only fire `onMatch` when it is focused
*/
node?: HTMLElement | null;
/*
a boolean that lets you temporarily disable the shortcut
*/
ignoreInput?: boolean;
/*
a boolean that lets you opt out of swallowing the key event and let it propagate
*/
allowDefault?: boolean;
/*
an array of DefaultIgnoredTag allowing you to flag which default ignored tags you want to bypass (textarea, input, select)
*/
acceptedDefaultIgnoredTags?: DefaultIgnoredTag[];
}
Basic example
// MyComponent.tsx
import React from 'react';
import {Shortcut} from '@shopify/react-shortcuts';
export default function MyComponent() {
return (
<div>
{/* some app markup here */}
<Shortcut ordered={['f', 'o', 'o']} onMatch={() => console.log('foo')} />
</div>
);
}
With modifier keys
// MyComponent.tsx
import React from 'react';
import {Shortcut} from '@shopify/react-shortcuts';
export default function MyComponent() {
return (
<div>
{/* some app markup here */}
<Shortcut
held={['Control', 'Shift']}
ordered={['B']}
onMatch={() => console.log('bar!')}
/>
</div>
);
}
You may also want to provide alternate groupings of held
modifier keys. For example, “undo/redo” key combos are slightly different on Windows vs Mac OS. The below example will register onMatch
if either Control + z
or Meta + z
is pressed simultaneously.
// MyComponent.tsx
import React from 'react';
import {Shortcut} from '@shopify/react-shortcuts';
export default function MyComponent() {
return (
<div>
{/* some app markup here */}
<Shortcut
held={[['Control'], ['Meta']]}
ordered={['z']}
onMatch={() => console.log('undo!')}
/>
</div>
);
}
Some Gotchas
Meta
refers to the “Command” key on Mac keyboards.Fn
andFnLock
keys are not supported because they don't produce events, as mentioned in the spec
On a focused node
Provide a node in the form of a ref
. <Shortcut />
will automatically subscribe to the ShortcutManager
once the node is available.
// MyComponent.tsx
import React from 'react';
import {Shortcut} from '@shopify/react-shortcuts';
class MyComponent extends React.Component {
state = {};
render() {
const {fooNode} = this.state;
return (
<div>
<button ref={(node) => this.setState({fooNode: node})} />
<Shortcut
node={fooNode}
ordered={['f', 'o', 'o']}
onMatch={() => console.log('foo')}
/>
</div>
);
}
}
useShortcut
<Shortcut />
invokes a hook, useShortcut()
, under the hood. This hook is also available for use from this package. It will also register a new keyboard shortcut to the ShortcutManager
and the API is very similar.
API
function useShortcut(
// All inputs are the same as the above definitions for the props to <Shortcut />
ordered: Key[],
onMatch: (matched: {ordered: Key[]; held?: HeldKey}) => void,
options: {
held?: HeldKey;
node?: HTMLElement | null;
ignoreInput?: boolean;
allowDefault?: boolean;
} = {},
);
Basic example
The below example illustrates the same basic functionality as the <Shortcut />
example above. However, it uses the useShortcut()
hook and the component has been removed.
// MyComponent.tsx
import React from 'react';
import {useShortcut} from '@shopify/react-shortcuts';
export default function MyComponent() {
useShortcut(['f', 'o', 'o'], () => console.log('foo'));
return <div>{/* some app markup here */}</div>;
}
ShortcutManager
ShortcutManager
is created by ShortcutProvider
and handles the logic for calling the appropriate shortcut callbacks and avoiding conflicts. You should never need to use it directly in application code, though you may want access to it in tests.
Example jest test
Given a component implementing a <Shortcut />
// MyComponent.tsx
export default function MyComponent() {
return (
<div>
{/* some app markup here */}
<Shortcut ordered={['f', 'o', 'o']} onMatch={() => console.log('foo')} />
</div>
);
}
you might want to add a ShortcutManager
to it's context in an @shopify/react-testing
test to prevent errors
// MyComponent.test.tsx
import React from 'react';
import {mount} from '@shopify/react-testing';
import {ShortcutManager, Shortcut} from '@shopify/react-shortcuts';
import MyComponent from './MyComponent';
describe('my-component', () => {
it('renders a shortcut for f,o,o', () => {
const component = mount(<MyComponent />, {
context: {shortcutManager: new ShortcutManager()},
});
const shortcut = component.find(Shortcut);
expect(shortcut.prop('ordered')).toEqual(['f', 'o', 'o']);
});
});
7 months ago
1 year ago
1 year ago
1 year ago
2 years ago
2 years ago
2 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
6 years ago
6 years ago
6 years ago
6 years ago
6 years ago
6 years ago
6 years ago
6 years ago
6 years ago
6 years ago
6 years ago
6 years ago
6 years ago
6 years ago
6 years ago
6 years ago
7 years ago
7 years ago