HOOK_DOCUMENTATION_TEMPLATE.md

useYourHookName

A hook that [...]

💡 Why?

• why this hook is necessary and what it does

Basic Usage:

import { yourHook } from 'beautiful-react-hooks';

const YourExample = () => {
  /* Your code goes here */

  return null;
};

<YourExample />

Use cases

description of the use case

import { yourHook } from 'beautiful-react-hooks';

const YourUseCase = () => {
  /* Your code goes here */

  return null;
};

<YourUseCase />

Mastering the hooks

✅ When to use

• When it's good to use

🛑 When not to use

• When it's not good to use