mirror of
https://github.com/idanoo/GoScrobble.git
synced 2024-11-23 00:45:16 +00:00
29 lines
754 B
TypeScript
29 lines
754 B
TypeScript
|
/**
|
||
|
|
* A convenience hook around `useState` designed to be paired with
|
||
|
|
* the component [callback ref](https://reactjs.org/docs/refs-and-the-dom.html#callback-refs) api.
|
||
|
|
* Callback refs are useful over `useRef()` when you need to respond to the ref being set
|
||
|
|
* instead of lazily accessing it in an effect.
|
||
|
|
*
|
||
|
|
* ```ts
|
||
|
|
* const [element, attachRef] = useCallbackRef<HTMLDivElement>()
|
||
|
|
*
|
||
|
|
* useEffect(() => {
|
||
|
|
* if (!element) return
|
||
|
|
*
|
||
|
|
* const calendar = new FullCalendar.Calendar(element)
|
||
|
|
*
|
||
|
|
* return () => {
|
||
|
|
* calendar.destroy()
|
||
|
|
* }
|
||
|
|
* }, [element])
|
||
|
|
*
|
||
|
|
* return <div ref={attachRef} />
|
||
|
|
* ```
|
||
|
|
*
|
||
|
|
* @category refs
|
||
|
|
*/
|
||
|
|
export default function useCallbackRef<TValue = unknown>(): [
|
||
|
|
TValue | null,
|
||
|
|
(ref: TValue | null) => void
|
||
|
|
];
|