From 8cade38b2ca7bacb00860e6d5e941a45864195bc Mon Sep 17 00:00:00 2001 From: Akshay Sharma Date: Fri, 2 May 2025 00:57:38 +0530 Subject: [PATCH] docs: updated usage instructions for type imports --- docs/Usage.md | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/docs/Usage.md b/docs/Usage.md index 243e354f88..1b7b6a0994 100644 --- a/docs/Usage.md +++ b/docs/Usage.md @@ -9,7 +9,13 @@ import useToggle from 'react-use/lib/useToggle' or use ES6 named imports (tree shaking recommended) ```js -import {useToggle} from 'react-use' +import { useToggle } from 'react-use' +``` + +For importing types, you should use direct path-based imports + +```js +import GeoLocationSensorState from 'react-use/lib/useGeolocation' ``` Depending on your bundler you might run into a missing dependency error with ES6 named import statements. Some hooks require you to install peer dependencies so we recommend using individual imports. If you want the best of both worlds you can transform the named import statements to individual import statements with [`babel-plugin-import`](https://github.com/ant-design/babel-plugin-import) by adding the following config to your `.babelrc` file: