UNPKG

1.08 kBPlain TextView Raw
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
13import {MutableRefObject, RefObject} from 'react';
14import {useLayoutEffect} from './';
15
16interface ContextValue<T> {
17 ref?: MutableRefObject<T>
18}
19
20// Syncs ref from context with ref passed to hook
21export function useSyncRef<T>(context: ContextValue<T>, ref: RefObject<T>) {
22 useLayoutEffect(() => {
23 if (context && context.ref && ref) {
24 context.ref.current = ref.current;
25 return () => {
26 context.ref.current = null;
27 };
28 }
29 });
30}