Add custom hook -> use-preview #39
Closed
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
aromalanil
reviewed
Oct 19, 2020
| @@ -53,6 +53,7 @@ yarn add use-custom-hooks | |||
| - [useGeoLocation](https://github.com/aromalanil/useCustomHooks/tree/master/docs#-usegeolocation) | |||
| - [useLocalStorage](https://github.com/aromalanil/useCustomHooks/tree/master/docs#-uselocalstorage) | |||
| - [useMousePosition](https://github.com/aromalanil/useCustomHooks/tree/master/docs#-usemouseposition) | |||
| - [useViewport](https://github.com/aromalanil/useCustomHooks/tree/master/docs#-usepreview) | |||
There was a problem hiding this comment.
Suggested change
| - [useViewport](https://github.com/aromalanil/useCustomHooks/tree/master/docs#-usepreview) | |
| - [useViewport](https://github.com/aromalanil/useCustomHooks/tree/master/docs#-useviewport) |
aromalanil
reviewed
Oct 19, 2020
| import { useViewport, MOBILE, TABLET } from "use-custom-hooks"; | ||
|
|
||
| const Screen = () => { | ||
| const { viewport } = useViewport(); |
There was a problem hiding this comment.
The viewport is not in the object, I think you meant this.
Suggested change
| const { viewport } = useViewport(); | |
| const { device } = useViewport(); |
aromalanil
reviewed
Oct 19, 2020
| const Screen = () => { | ||
| const { viewport } = useViewport(); | ||
| /* | ||
| Using Object destructuring we can get width and device |
There was a problem hiding this comment.
Suggested change
| Using Object destructuring we can get width and device | |
| Using Object destructuring we can get the width and device type |
aromalanil
reviewed
Oct 19, 2020
| * @constant | ||
| * @type {string} | ||
| */ | ||
| export const MOBILE = 'MOBILE'; |
There was a problem hiding this comment.
These constants need not be exported
aromalanil
reviewed
Oct 19, 2020
| * Returns one of three possible values depending of the screen's current width. | ||
| * | ||
| * @param {number} width | ||
| * @returns {*} The constant corresponding the screen size. |
There was a problem hiding this comment.
Suggested change
| * @returns {*} The constant corresponding the screen size. | |
| * @returns {String} The device type corresponding the screen size. |
aromalanil
reviewed
Oct 19, 2020
| * Custom useState hook which listens to resize events and | ||
| * manage the viewport of the user's device. | ||
| * | ||
| * @returns {Object} viewport An object with the width of the user's viewport and the device type. |
There was a problem hiding this comment.
You should define the type of this object refer this code
aromalanil
reviewed
Oct 19, 2020
| }; | ||
| }, []); | ||
|
|
||
| return { viewport }; |
There was a problem hiding this comment.
You are returning a nested object here. Since viewport is an object you should change this
Suggested change
| return { viewport }; | |
| return viewport; |
aromalanil
reviewed
Oct 19, 2020
| * @returns {Object} viewport An object with the width of the user's viewport and the device type. | ||
| */ | ||
| function useViewport() { | ||
| const [viewport, setViewport] = useState({ |
There was a problem hiding this comment.
Only save width in the state. Change only the width on resizing. Also, find the device type in the return statement.
|
@Rafajrg21 Thanks for the PR. |
|
I think |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Proposed Changes
Added new hook, usePreview.
Types of changes
Checklist:
Further Comments
I didn't create a new Issue because I'm adding a hook as stated in #1. If I need to do something else, correct something or I missed a step, please let me know.