diff --git a/README.md b/README.md index b203f213..54f41efa 100644 --- a/README.md +++ b/README.md @@ -59,54 +59,54 @@ import { useMountEffect } from "@react-hookz/web/esnext"; - #### Callback - - [`useDebounceCallback`](https://react-hookz.github.io/web/?path=/docs/callback-usedebouncecallback) + - [**`useDebounceCallback`**](https://react-hookz.github.io/web/?path=/docs/callback-usedebouncecallback) — Makes passed function debounced, otherwise acts like `useCallback`. - #### Lifecycle - - [`useConditionalEffect`](https://react-hookz.github.io/web/?path=/docs/lifecycle-useconditionaleffect) + - [**`useConditionalEffect`**](https://react-hookz.github.io/web/?path=/docs/lifecycle-useconditionaleffect) — Like `useEffect` but callback invoked only if conditions match predicate. - - [`useConditionalUpdateEffect`](https://react-hookz.github.io/web/?path=/docs/lifecycle-useconditionalupdateeffect) + - [**`useConditionalUpdateEffect`**](https://react-hookz.github.io/web/?path=/docs/lifecycle-useconditionalupdateeffect) — Like `useUpdateEffect` but callback invoked only if conditions match predicate. - - [`useFirstMountState`](https://react-hookz.github.io/web/?path=/docs/lifecycle-usefirstmountstate) + - [**`useFirstMountState`**](https://react-hookz.github.io/web/?path=/docs/lifecycle-usefirstmountstate) — Return boolean that is `true` only on first render. - - [`useIsMounted`](https://react-hookz.github.io/web/?path=/docs/lifecycle-useismounted) + - [**`useIsMounted`**](https://react-hookz.github.io/web/?path=/docs/lifecycle-useismounted) — Returns function that yields current mount state. - - [`useMountEffect`](https://react-hookz.github.io/web/?path=/docs/lifecycle-usemounteffect) + - [**`useMountEffect`**](https://react-hookz.github.io/web/?path=/docs/lifecycle-usemounteffect) — Run effect only when component is first mounted. - - [`useRerender`](https://react-hookz.github.io/web/?path=/docs/lifecycle-usererender) + - [**`useRerender`**](https://react-hookz.github.io/web/?path=/docs/lifecycle-usererender) — Return callback that re-renders component. - - [`useUnmountEffect`](https://react-hookz.github.io/web/?path=/docs/lifecycle-useunmounteffect) + - [**`useUnmountEffect`**](https://react-hookz.github.io/web/?path=/docs/lifecycle-useunmounteffect) — Run effect only when component is unmounted. - - [`useUpdateEffect`](https://react-hookz.github.io/web/?path=/docs/lifecycle-useupdateeffect) + - [**`useUpdateEffect`**](https://react-hookz.github.io/web/?path=/docs/lifecycle-useupdateeffect) — Effect hook that ignores the first render (not invoked on mount). - - [`useIsomorphicLayoutEffect`](https://react-hookz.github.io/?path=/docs/lifecycle-useisomorphiclayouteffect) + - [**`useIsomorphicLayoutEffect`**](https://react-hookz.github.io/?path=/docs/lifecycle-useisomorphiclayouteffect) — `useLayoutEffect` for browser with fallback to `useEffect` for SSR. - #### State - - [`useMediatedState`](https://react-hookz.github.io/web/?path=/docs/state-usemediatedstate) + - [**`useMediatedState`**](https://react-hookz.github.io/web/?path=/docs/state-usemediatedstate) — Like `useState`, but every value set is passed through a mediator function. - - [`usePrevious`](https://react-hookz.github.io/web/?path=/docs/state-useprevious) + - [**`usePrevious`**](https://react-hookz.github.io/web/?path=/docs/state-useprevious) — Returns the value passed to the hook on previous render. - - [`useSafeState`](https://react-hookz.github.io/web/?path=/docs/state-usesafestate) + - [**`useSafeState`**](https://react-hookz.github.io/web/?path=/docs/state-usesafestate) — Like `useState`, but its state setter is guarded against sets on unmounted component. - - [`useToggle`](https://react-hookz.github.io/web/?path=/docs/state-usetoggle) + - [**`useToggle`**](https://react-hookz.github.io/web/?path=/docs/state-usetoggle) — Like `useState`, but can only become `true` or `false`. - #### Navigator - - [`useNetworkState`](https://react-hookz.github.io/?path=/docs/navigator-usenetwork) + - [**`useNetworkState`**](https://react-hookz.github.io/?path=/docs/navigator-usenetwork) — Tracks the state of browser's network connection. - #### Miscellaneous - - [`useSyncedRef`](https://react-hookz.github.io/?path=/docs/miscellaneous-usesyncedref) + - [**`useSyncedRef`**](https://react-hookz.github.io/?path=/docs/miscellaneous-usesyncedref) — Like `useRef`, but it returns immutable ref that contains actual value. - #### Side-effects - - [`useLocalStorageValue`](https://react-hookz.github.io/?path=/docs/side-effects-uselocalstoragevalue) + - [**`useLocalStorageValue`**](https://react-hookz.github.io/?path=/docs/side-effects-uselocalstoragevalue) — Manages a single LocalStorage key. - - [`useSessionStorageValue`](https://react-hookz.github.io/?path=/docs/side-effects-usesessionstoragevalue) + - [**`useSessionStorageValue`**](https://react-hookz.github.io/?path=/docs/side-effects-usesessionstoragevalue) — Manages a single SessionStorage key.