@lyonph/preact-hooks/src/useReactiveRef.ts

Collection of useful Preact Hooks

/**
 * @license
 * MIT License
 *
 * Copyright (c) 2021 Lyon Software Technologies, Inc.
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in all
 * copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 *
 *
 * @author Lyon Software Technologies, Inc.
 * @copyright Lyon Software Technologies, Inc. 2021
 */
import { MutableRef, useDebugValue } from 'preact/hooks';
import useConstant from './useConstant';
import useForceUpdate from './useForceUpdate';
import useLazyRef from './useLazyRef';

export default function useReactiveRef<T>(supplier: () => T): MutableRef<T> {
  const forceUpdate = useForceUpdate();

  const ref = useLazyRef(supplier);

  const proxyObject = useConstant(() => ({
    get current() {
      return ref.current;
    },
    set current(value) {
      if (!Object.is(value, ref.current)) {
        ref.current = value;
        forceUpdate();
      }
    },
  }));

  useDebugValue(proxyObject);

  return proxyObject;
}