aromalanil / usecustomhooks Goto Github PK

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

Move the documentation for the custom hooks from README

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.

Include useDarkMode hook

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>
}

Hook to get the latitude and longitude

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>
  );
}