Skip to content

Latest commit

 

History

History

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

README.md

React Kata Documentation

Welcome to the documentation for React Kata! This file provides a simple overview of the available hooks and their usage.

Table of Contents


Installation

npm install react-kata

Available Hooks

  • useDebounce
  • useThrottle
  • useInterval
  • useTimeout
  • useLocalStorage
  • useSessionStorage
  • usePrevious
  • useClickOutside
  • useToggle
  • useUpdateEffect
  • useMediaQuery
  • useWindowSize
  • useScrollPosition
  • useKeyPress
  • useOnKeyPressed
  • useFetch
  • useFocus
  • useHovered
  • useEventListener
  • useOnScreen
  • useOnScreenAdvanced
  • useWhyDidYouUpdate
  • useMount
  • useUnmount
  • useCopyToClipboard
  • useIdle
  • useTheme
  • usePrefersReducedMotion
  • useGeolocation
  • useReload
  • useCookie
  • useElementReplace
  • useScriptLoader
  • useFocusTrap
  • useElementSize
  • useElementPosition
  • useKeySequence
  • useQueue
  • useShimmer
  • useImagePreload

Usage Examples

import { useDebounce, useThrottle, useLocalStorage } from 'react-kata';

const debouncedValue = useDebounce(value, 300, '');
const throttledValue = useThrottle(value, 500, '');
const [stored, setStored] = useLocalStorage('key', 'default');

See the README for more detailed examples of each hook.


Hook Documentation Index

Below is a clickable index of all available hooks. Click any hook to view its documentation:

Hook Link
useClickOutside useClickOutside.md
useCookie useCookie.md
useCopyToClipboard useCopyToClipboard.md
useDebounce useDebounce.md
useDocumentTitle useDocumentTitle.md
useElementPosition useElementPosition.md
useElementReplace useElementReplace.md
useElementSize useElementSize.md
useEventListener useEventListener.md
useFetch useFetch.md
useFocus useFocus.md
useFocusTrap useFocusTrap.md
useGeolocation useGeolocation.md
useHover useHover.md
useIdle useIdle.md
useImagePreload useImagePreload.md
useInterval useInterval.md
useKeyPress useKeyPress.md
useKeySequence useKeySequence.md
useLocalStorage useLocalStorage.md
useMediaQuery useMediaQuery.md
useMount useMount.md
useOnKeyPressed useOnKeyPressed.md
useOnScreen useOnScreen.md
useOnScreenAdvanced useOnScreenAdvanced.md
usePrefersReducedMotion usePrefersReducedMotion.md
usePrevious usePrevious.md
useQueue useQueue.md
useReload useReload.md
useScriptLoader useScriptLoader.md
useScrollPosition useScrollPosition.md
useSessionStorage useSessionStorage.md
useShimmer useShimmer.md
useTheme useTheme.md
useThrottle useThrottle.md
useTimeout useTimeout.md
useToggle useToggle.md
useUnmount useUnmount.md
useUpdateEffect useUpdateEffect.md
useWhyDidYouUpdate useWhyDidYouUpdate.md
useWindowFocus useWindowFocus.md
useWindowSize useWindowSize.md