@availity/hooks 3.0.7-ts.13 → 3.2.0

package/CHANGELOG.md

@@ -3,6 +3,45 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+# 3.2.0 (2022-02-18)
+
+
+### Features
+
+* **hooks:** add documentation to sidebar, some formatting ([fbd9964](https://github.com/Availity/availity-react/commit/fbd99648c18993394f773d8540c1be023acf6e5b))
+* **hooks:** add useWindowDimensionsHook ([203d9c0](https://github.com/Availity/availity-react/commit/203d9c0a31362ec084c94c4ae50ab4b6efbc876b))
+
+
+
+
+
+## [3.1.2](https://github.com/Availity/availity-react/compare/@availity/hooks@3.1.1...@availity/hooks@3.1.2) (2021-12-20)
+
+**Note:** Version bump only for package @availity/hooks
+
+
+
+
+
+## 3.1.1 (2021-12-14)
+
+**Note:** Version bump only for package @availity/hooks
+
+
+
+
+
+# 3.1.0 (2021-11-15)
+
+
+### Features
+
+* move storybook, stories, and fix hmr ([2f65f71](https://github.com/Availity/availity-react/commit/2f65f71769d2d981e22700b87a09516833588f64))
+
+
+
+
+
 ## [3.0.6](https://github.com/Availity/availity-react/compare/@availity/hooks@3.0.5...@availity/hooks@3.0.6) (2021-10-28)
 
 **Note:** Version bump only for package @availity/hooks

package/README.md

@@ -3,5 +3,23 @@
 > Re-usable hooks for components and apps.
 
 [![Version](https://img.shields.io/npm/v/@availity/hooks.svg?style=for-the-badge)](https://www.npmjs.com/package/@availity/hooks)
+[![NPM Downloads](https://img.shields.io/npm/dt/@availity/hooks.svg?style=for-the-badge)](https://www.npmjs.com/package/@availity/hooks)
+[![Dependecy Status](https://img.shields.io/librariesio/release/npm/@availity/hooks?style=for-the-badge)](https://github.com/Availity/availity-react/blob/master/packages/hooks/package.json)
 
-## [Documentation](https://availity.github.io/availity-react/components/hooks/index)
+## Installation
+
+### NPM
+
+```bash
+npm install @availity/hooks
+```
+
+### Yarn
+
+```bash
+yarn add @availity/hooks
+```
+
+## Documentation
+
+Check out more documentation at [availity.github.io](https://availity.github.io/availity-react/components/hooks/index)

package/index.d.ts

@@ -7,3 +7,4 @@ export { default as useCurrentUser } from './types/useCurrentUser';
 export { default as useProviders } from './types/useProviders';
 export { default as usePermissions } from './types/usePermissions';
 export { default as useOrganizations } from './types/useOrganizations';
+export { default as useWindowDimensions } from './types/useWindowDimensions';

package/index.js

@@ -7,3 +7,4 @@ export { default as useCurrentUser } from './src/useCurrentUser';
 export { default as useProviders } from './src/useProviders';
 export { default as usePermissions } from './src/usePermissions';
 export { default as useOrganizations } from './src/useOrganizations';
+export { default as useWindowDimensions } from './src/useWindowDimensions';

package/package.json

@@ -1,25 +1,25 @@
 {
   "name": "@availity/hooks",
-  "version": "3.0.7-ts.13+2f65f717",
-  "author": "Kyle Gray <kyle.gray@availity.com>",
+  "version": "3.2.0",
   "description": "A group of pre-built hooks that are common in most apps",
-  "main": "index.js",
-  "types": "index.d.ts",
   "keywords": [
     "react",
-    "availity"
+    "availity",
+    "hooks"
   ],
-  "repository": {
-    "type": "git",
-    "url": "https://github.com/Availity/availity-react.git"
-  },
+  "homepage": "https://availity.github.io/availity-react/components/hooks/index",
   "bugs": {
     "url": "https://github.com/Availity/availity-react/issues"
   },
-  "license": "MIT",
-  "publishConfig": {
-    "access": "public"
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/Availity/availity-react.git",
+    "directory": "packages/hooks"
   },
+  "license": "MIT",
+  "author": "Kyle Gray <kyle.gray@availity.com>",
+  "main": "index.js",
+  "types": "index.d.ts",
   "dependencies": {
     "prop-types": "^15.7.2",
     "react-query": "^3.29.0"
@@ -35,5 +35,8 @@
     "axios": "^0.21.1",
     "react": ">=16.8.0"
   },
-  "gitHead": "2f65f71769d2d981e22700b87a09516833588f64"
+  "publishConfig": {
+    "access": "public"
+  },
+  "gitHead": "abf384b83ac5948b55377ccca91cbdb8ea81f753"
 }

package/src/useWindowDimensions.js

@@ -0,0 +1,26 @@
+import { useEffect, useState } from 'react';
+
+const getWindowDimensions = () => {
+  const { innerWidth: width, innerHeight: height } = window;
+  return {
+    width,
+    height,
+  };
+};
+
+const useWindowDimensions = () => {
+  const [windowDimensions, setWindowDimensions] = useState(getWindowDimensions());
+
+  useEffect(() => {
+    const handleResize = () => {
+      setWindowDimensions(getWindowDimensions());
+    };
+
+    window.addEventListener('resize', handleResize);
+    return () => window.removeEventListener('resize', handleResize);
+  }, []);
+
+  return windowDimensions;
+};
+
+export default useWindowDimensions;

package/types/useWindowDimensions.d.ts

@@ -0,0 +1,8 @@
+export type Dimensions = {
+  width: number;
+  height: number;
+};
+
+declare function useWindowDimensions(): Dimensions;
+
+export default useWindowDimensions;