1 | /*
|
2 | * Copyright 2020 Adobe. All rights reserved.
|
3 | * This file is licensed to you under the Apache License, Version 2.0 (the "License");
|
4 | * you may not use this file except in compliance with the License. You may obtain a copy
|
5 | * of the License at http://www.apache.org/licenses/LICENSE-2.0
|
6 | *
|
7 | * Unless required by applicable law or agreed to in writing, software distributed under
|
8 | * the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS
|
9 | * OF ANY KIND, either express or implied. See the License for the specific language
|
10 | * governing permissions and limitations under the License.
|
11 | */
|
12 |
|
13 | import {createEventHandler} from './createEventHandler';
|
14 | import {HTMLAttributes} from 'react';
|
15 | import {KeyboardEvents} from '@react-types/shared';
|
16 |
|
17 | export interface KeyboardProps extends KeyboardEvents {
|
18 | /** Whether the keyboard events should be disabled. */
|
19 | isDisabled?: boolean
|
20 | }
|
21 |
|
22 | interface KeyboardResult {
|
23 | /** Props to spread onto the target element. */
|
24 | keyboardProps: HTMLAttributes<HTMLElement>
|
25 | }
|
26 |
|
27 | /**
|
28 | * Handles keyboard interactions for a focusable element.
|
29 | */
|
30 | export function useKeyboard(props: KeyboardProps): KeyboardResult {
|
31 | return {
|
32 | keyboardProps: props.isDisabled ? {} : {
|
33 | onKeyDown: createEventHandler(props.onKeyDown),
|
34 | onKeyUp: createEventHandler(props.onKeyUp)
|
35 | }
|
36 | };
|
37 | }
|