Screen resizing v1.0.0 🚀

Author: atidele

.gitignore

@@ -21,3 +21,6 @@
 npm-debug.log*
 yarn-debug.log*
 yarn-error.log*
+
+.idea/
+dist

README.md

@@ -1,70 +1,86 @@
-# Getting Started with Create React App
-
-This project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app).
-
-## Available Scripts
-
-In the project directory, you can run:
-
-### `npm start`
-
-Runs the app in the development mode.\
-Open [http://localhost:3000](http://localhost:3000) to view it in the browser.
-
-The page will reload if you make edits.\
-You will also see any lint errors in the console.
-
-### `npm test`
-
-Launches the test runner in the interactive watch mode.\
-See the section about [running tests](https://facebook.github.io/create-react-app/docs/running-tests) for more information.
-
-### `npm run build`
-
-Builds the app for production to the `build` folder.\
-It correctly bundles React in production mode and optimizes the build for the best performance.
-
-The build is minified and the filenames include the hashes.\
-Your app is ready to be deployed!
-
-See the section about [deployment](https://facebook.github.io/create-react-app/docs/deployment) for more information.
-
-### `npm run eject`
-
-**Note: this is a one-way operation. Once you `eject`, you can’t go back!**
-
-If you aren’t satisfied with the build tool and configuration choices, you can `eject` at any time. This command will remove the single build dependency from your project.
-
-Instead, it will copy all the configuration files and the transitive dependencies (webpack, Babel, ESLint, etc) right into your project so you have full control over them. All of the commands except `eject` will still work, but they will point to the copied scripts so you can tweak them. At this point you’re on your own.
-
-You don’t have to ever use `eject`. The curated feature set is suitable for small and middle deployments, and you shouldn’t feel obligated to use this feature. However we understand that this tool wouldn’t be useful if you couldn’t customize it when you are ready for it.
-
-## Learn More
-
-You can learn more in the [Create React App documentation](https://facebook.github.io/create-react-app/docs/getting-started).
-
-To learn React, check out the [React documentation](https://reactjs.org/).
-
-### Code Splitting
-
-This section has moved here: [https://facebook.github.io/create-react-app/docs/code-splitting](https://facebook.github.io/create-react-app/docs/code-splitting)
-
-### Analyzing the Bundle Size
-
-This section has moved here: [https://facebook.github.io/create-react-app/docs/analyzing-the-bundle-size](https://facebook.github.io/create-react-app/docs/analyzing-the-bundle-size)
-
-### Making a Progressive Web App
-
-This section has moved here: [https://facebook.github.io/create-react-app/docs/making-a-progressive-web-app](https://facebook.github.io/create-react-app/docs/making-a-progressive-web-app)
-
-### Advanced Configuration
-
-This section has moved here: [https://facebook.github.io/create-react-app/docs/advanced-configuration](https://facebook.github.io/create-react-app/docs/advanced-configuration)
-
-### Deployment
-
-This section has moved here: [https://facebook.github.io/create-react-app/docs/deployment](https://facebook.github.io/create-react-app/docs/deployment)
-
-### `npm run build` fails to minify
-
-This section has moved here: [https://facebook.github.io/create-react-app/docs/troubleshooting#npm-run-build-fails-to-minify](https://facebook.github.io/create-react-app/docs/troubleshooting#npm-run-build-fails-to-minify)
+# screen-resizing
+> **use-screen-resizing** is a custom hook that provides information about the device viewport.
+
+![React](https://img.shields.io/badge/-React-20232a?logo=react&style=for-the-badge)
+
+## Installation 🖥
+
+```bash
+npm i -S use-device-react
+```
+
+## Usage 💻
+Example of simple usage
+
+```jsx
+import { useScreenResizing } from "screen-resizing";
+
+const Component = () => {
+    const { isMiniMobile, isMobile, isTablet, isNotebook, isScreen } = useScreenResizing();
+
+    return (<div>
+        {isMiniMobile && ...}
+        {isMobile && ...}
+        {isTablet && ...}
+        {isNotebook && ...}
+        {isScreen && ...}
+    </div>);
+};
+```
+
+## Breakpoints 🔮
+You can pass an object as parameter to override default values
+
+```jsx
+import { useScreenResizing } from "screen-resizing";
+
+const Component = () => {
+    const { isMobile, isTablet, isScreen } = useScreenResizing({ mobile: 350 });
+
+    return (<div>
+        {isMobile && ...}
+        {isTablet && ...}
+        {isScreen && ...}
+    </div>);
+};
+```
+
+The default values are:
+```bash
+  {
+    miniMobile: 320,
+    mobile: 576,
+    tablet: 960,
+    screen: 1200,
+  }
+```
+> **MiniMobile** -> width < 320
+>
+> **Mobile** -> width >= 320 && width < 576
+>
+> **Tablet** -> width >= 576 && width < 960
+>
+> **Notebook** -> width >= 960 && width < 1200
+>
+> **Screen** -> width >= 1200
+
+## Features 🔥
+- Screen greater than: Function than receives a screen value parameter and compares if it's greater than the viewport width screen.
+- Screen greater or equal than: Function than receives a screen value parameter and compares if it's greater or equal than the viewport width screen.
+- Screen lesser than: Function than receives a screen value parameter and compares if it's lesser than the viewport width screen.
+- Screen lesser or equal than: Function than receives a screen value parameter and compares if it's lesser or equal than the viewport width screen.
+- Width: The viewport realtime width size.
+- Height: The viewport realtime height size.
+
+```jsx
+import { useScreenResizing } from "screen-resizing";
+
+const Component = () => {
+    const { screenGT,screenGTE, screenLT, screenLTE, width, height } = useScreenResizing({ mobile: 350 });
+
+    return (<div>...</div>);
+};
+```
+
+## License 🧙🏻‍♂️
+MIT © [AleTid5](https://github.com/AleTid5)