98 lines
3.2 KiB
Plaintext
98 lines
3.2 KiB
Plaintext
/*
|
|
* Copyright 2020 Adobe. All rights reserved.
|
|
* This file is licensed to you under the Apache License, Version 2.0 (the "License");
|
|
* you may not use this file except in compliance with the License. You may obtain a copy
|
|
* of the License at http://www.apache.org/licenses/LICENSE-2.0
|
|
*
|
|
* Unless required by applicable law or agreed to in writing, software distributed under
|
|
* the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS
|
|
* OF ANY KIND, either express or implied. See the License for the specific language
|
|
* governing permissions and limitations under the License.
|
|
*/
|
|
|
|
import {DOMAttributes, FocusableDOMProps, FocusableElement, FocusableProps, RefObject} from '@react-types/shared';
|
|
import {focusSafely} from './';
|
|
import {mergeProps, useObjectRef, useSyncRef} from '@react-aria/utils';
|
|
import React, {ForwardedRef, MutableRefObject, ReactNode, useContext, useEffect, useRef} from 'react';
|
|
import {useFocus, useKeyboard} from '@react-aria/interactions';
|
|
|
|
export interface FocusableOptions<T = FocusableElement> extends FocusableProps<T>, FocusableDOMProps {
|
|
/** Whether focus should be disabled. */
|
|
isDisabled?: boolean
|
|
}
|
|
|
|
export interface FocusableProviderProps extends DOMAttributes {
|
|
/** The child element to provide DOM props to. */
|
|
children?: ReactNode
|
|
}
|
|
|
|
interface FocusableContextValue extends FocusableProviderProps {
|
|
ref?: MutableRefObject<FocusableElement | null>
|
|
}
|
|
|
|
let FocusableContext = React.createContext<FocusableContextValue | null>(null);
|
|
|
|
function useFocusableContext(ref: RefObject<FocusableElement | null>): FocusableContextValue {
|
|
let context = useContext(FocusableContext) || {};
|
|
useSyncRef(context, ref);
|
|
|
|
// eslint-disable-next-line
|
|
let {ref: _, ...otherProps} = context;
|
|
return otherProps;
|
|
}
|
|
|
|
/**
|
|
* Provides DOM props to the nearest focusable child.
|
|
*/
|
|
function FocusableProvider(props: FocusableProviderProps, ref: ForwardedRef<FocusableElement>) {
|
|
let {children, ...otherProps} = props;
|
|
let objRef = useObjectRef(ref);
|
|
let context = {
|
|
...otherProps,
|
|
ref: objRef
|
|
};
|
|
|
|
return (
|
|
<FocusableContext.Provider value={context}>
|
|
{children}
|
|
</FocusableContext.Provider>
|
|
);
|
|
}
|
|
|
|
let _FocusableProvider = React.forwardRef(FocusableProvider);
|
|
export {_FocusableProvider as FocusableProvider};
|
|
|
|
export interface FocusableAria {
|
|
/** Props for the focusable element. */
|
|
focusableProps: DOMAttributes
|
|
}
|
|
|
|
/**
|
|
* Used to make an element focusable and capable of auto focus.
|
|
*/
|
|
export function useFocusable<T extends FocusableElement = FocusableElement>(props: FocusableOptions<T>, domRef: RefObject<FocusableElement | null>): FocusableAria {
|
|
let {focusProps} = useFocus(props);
|
|
let {keyboardProps} = useKeyboard(props);
|
|
let interactions = mergeProps(focusProps, keyboardProps);
|
|
let domProps = useFocusableContext(domRef);
|
|
let interactionProps = props.isDisabled ? {} : domProps;
|
|
let autoFocusRef = useRef(props.autoFocus);
|
|
|
|
useEffect(() => {
|
|
if (autoFocusRef.current && domRef.current) {
|
|
focusSafely(domRef.current);
|
|
}
|
|
autoFocusRef.current = false;
|
|
}, [domRef]);
|
|
|
|
return {
|
|
focusableProps: mergeProps(
|
|
{
|
|
...interactions,
|
|
tabIndex: props.excludeFromTabOrder && !props.isDisabled ? -1 : undefined
|
|
},
|
|
interactionProps
|
|
)
|
|
};
|
|
}
|