Describe the hook

A hook which returns the current coordinates of the mouse pointer, as a state.

Add a table in README to feature all the contributors

Describe the hook

A hook which will return a boolean state and a toggle function.
The toggle function should set the state to its negation.

What is the Problem?

The documentation for the hooks are not complete. Only useLocalStorage hook has complete documentation. Other hooks does not contain Parameters and Return values in their documentation

Possible Solution

Add parameters and return values to the docs of all other hooks

What to contribute? How can you help?

• The code for each hook contains corresponding parameters and return values, defined as JSdoc comments.
• You can take the data from there and add it to the documentation

Description

Need to add more custom hooks to this repo.

For Contributors

• Please include an example of how the hook is used.
• Add JSDoc comments to the hook to get IntelliSense for the hook.
• Also consider adding your hook to the Readme file.

Describe the hook

A custom hook which returns a stack, push and pop function.

I am getting an invalid hook call error, can anyone help me to solve this!

error

code

but when I am using it as a separate file, it works

example

Issue Description

Currently, the documentation for every hooks are added to the README file. This can get complex as the number of hooks in the package increases.

Possible Solution

We should move these to a new location. A separate doc section would help. Please share your suggestion on how to solve this.

Describe the hook

A hook which will return a dark state and set dark state function.
The hook should add a class name to the body when dark mode.

Example

import {useDarkMode} from "useDarkMode"

const App = () =>{

 const [darkMode,setDarkMode] = useDarkMode(true,"dark")
 //This should add a class name .dark to the body if it is dark mode.

 return <div></div>
}

Issue Description

The repo currently has 2 templates for issues, but it lacks an issue template for general issues and documentation issues.

Possible Solution

Add templates for PRs and Issues. Also, suggest improvements for the current issue templates.

Describe the hook
A hook to get the latitude and longitude

Additional context
Create a hook to get the current position from the browser.

import React from "react"
import useGeolocalisation from "useGeolocalisation"

const Home = () => {
  /*
  * The hook will return you an object like this: 
  * 
  * {
  *   latitude: 1233234,
  *   longitude: -1234345,
  * }
  * 
  */

  const [geolocalitation] = useGeolocalisation(true);

  return (
    <div>
      {geolocalitation.latitude}
      {geolocalitation.longitude}
    </div>
  );
}

Describe the hook

Since the package already contains a useStack hook, it would be great to have a useQueue hook.

• This hook will be similar to useStack but for Queue data structure.

PRs are welcome 🙂