@shopify/react-hooks - npm Package Compare versions

Comparing version 1.6.1 to 1.7.0

CHANGELOG.md

@@ -8,4 +8,8 @@ # Changelog
 
-<!-- ## [Unreleased] -->
+## [Unreleased]
 
+### Added
+
+- Added `useDebouncedValue` hook ([#1354](https://github.com/Shopify/quilt/pull/1354))
+
 ## [1.6.1] - 2020-04-07
@@ -12,0 +16,0 @@

dist/src/hooks/index.d.ts

@@ -0,1 +1,2 @@
+export { useDebouncedValue } from './debounced';
 export { useInterval } from './interval';
@@ -2,0 +3,0 @@ export { useLazyRef } from './lazy-ref';

dist/src/hooks/index.js

 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+var debounced_1 = require("./debounced");
+exports.useDebouncedValue = debounced_1.useDebouncedValue;
 var interval_1 = require("./interval");
@@ -4,0 +6,0 @@ exports.useInterval = interval_1.useInterval;

package.json

 {
   "name": "@shopify/react-hooks",
-  "version": "1.6.1",
+  "version": "1.7.0",
   "license": "MIT",
@@ -5,0 +5,0 @@ "description": "A collection of primitive React hooks.",

README.md

@@ -16,2 +16,23 @@ # `@shopify/react-hooks`
 
+### `useDebouncedValue()`
+
+This hook provide a debounced value.
+
+```tsx
+function MyComponent() {
+  const [searchValue, setSearchValue] = useState('');
+  const debouncedSearch = useDebouncedValue(searchValue);
+  const {data, loading} = useQuery(SomeQuery, {
+    variables: {
+      query: debouncedSearch,
+    },
+  });
+
+  function handleSearchTextChange(evt: React.KeyboardEvent) {
+    setSearchValue(evt.currentTarget.value);
+  }
+
+  return (<input onChange={handleSearchTextChange} />);
+```
+
 ### `useOnValueChange()`
@@ -18,0 +39,0 @@

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

18317

increased by12.73%

Number of package files

33

increased by10%

Lines of code

196

increased by19.51%

Number of lines in readme file

187

increased by12.65%

No dependency changes