-
Notifications
You must be signed in to change notification settings - Fork 2
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Rewrite code in TypeScript #13
Merged
Merged
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
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.
Context
PR #8 introduced some type definitions, but because this package relies on @envato/react-resize-observer-hook with missing type definitions, there were types missing for some of the things that this package exposes (like
<Provider>
anduseResizeObserver()
).Types were introduced in envato/react-resize-observer-hook#3 to address that.
This PR updates the codebase to be written in TypeScript, rather than JavaScript with a type definition file. Some other optimisations, API changes, and documentation updates have been added.
Changes
<Observe>
now supports render functions throughchildren
(in addition to using therender
prop), giving you the option to use your preferred syntax.useBreakpoints()
now also supports object destructuring:const { widthMatch, heightMatch } = useBreakpoints(options);