New Case Study:See how Anthropic automated 95% of dependency reviews with Socket.Learn More →
use-resize-observer
Advanced tools
use-resize-observer - npm Package Compare versions
Comparing version 7.0.0-alpha.1 to 7.0.0-alpha.3
122
CHANGELOG.md
@@ -1,118 +0,20 @@ | ||
| # CHANGELOG | ||
| # [7.0.0-alpha.3](https://github.com/ZeeCoder/use-resize-observer/compare/v7.0.0-alpha.2...v7.0.0-alpha.3) (2020-11-11) | ||
| ## 7.0.0-alpha.1 | ||
| - **[BREAKING]** The returned ref is now a RefCallback, not a ref object | ||
| - **[BREAKING]** The returned ref will always be the same RefCallback. | ||
| Previously when a custom ref object was passed, it was returned as well from | ||
| the hook as "ref". | ||
| - **[BREAKING]** Compared to 6.2.0-alpha.1 There's no `callbackRef` return value | ||
| anymore. | ||
| ### Bug Fixes | ||
| ## 6.2.0-alpha.1 | ||
| * semantic release fixes ([5074c0f](https://github.com/ZeeCoder/use-resize-observer/commit/5074c0fefd29e53a8ed9a4672ba043ad3be6d972)) | ||
| - Only instantiating a ResizeObserver instance if there's actually something to | ||
| observe. This for example means that if you pass in `null` or undefined as the | ||
| ref, or if neither the default ref or RefCallback returned from the hook are | ||
| in use, then no ResizeObserver instance will get created until there's an | ||
| actual element to observe. Resolves: #42 | ||
| - The hook now returns `callbackRef`, which can be used in place of the usual | ||
| `ref`. Use this instead of a normal ref, when the observed component is | ||
| mounted with a delay. Resolves: #43, #45 | ||
| - The `ref` option now accepts raw elements as well. | ||
| - Handling custom refs (through options), the default ref and the RefCallback | ||
| has been greatly refactored internally (into the `useResolvedElement` | ||
| hook), to handle more edge cases with the way refs are handled. | ||
| - Tests based on react testing library were refactored to make them much simpler | ||
| and more approachable. | ||
| - Fixed an error where in certain edge cases the hook tried to set state when | ||
| its host component already unmounted. | ||
| - Added [contributing guidelines](./CONTRIBUTING.md) | ||
| - Overall bundle size increased a bit, due to the new features added. | ||
| (With about ~150B or so.) | ||
| # [7.0.0-alpha.2](https://github.com/ZeeCoder/use-resize-observer/compare/v7.0.0-alpha.1...v7.0.0-alpha.2) (2020-11-11) | ||
| ## 6.1.0 | ||
| - Added Semantic Release ([54a83ce](https://github.com/ZeeCoder/use-resize-observer/commit/54a83cede6fcb8dbfa9e0f9a0ea2f1f4557b606f)) | ||
| - No changes, only publishing the next minor. | ||
| ### BREAKING CHANGES | ||
| ## 6.1.0-alpha.3 | ||
| - The returned ref is now a RefCallback, not a ref object | ||
| - Fixed SSR rendering, and added a test to cover it. | ||
| ## 6.1.0-alpha.2 | ||
| - ResizeObserver instances are no longer created unnecessarily when the onResize | ||
| callback changes. (Fixes #32) | ||
| - Written new tests in [react testing library](https://github.com/testing-library/react-testing-library). | ||
| ## 6.1.0-alpha.1 | ||
| - Rewrote the source in TypeScript. (Feedback is welcome.) | ||
| - Rewrote tests in TypeScript as well. (Ensures the types make sense.) | ||
| - Added checks to ensure reasonable bundle size. | ||
| ## 6.0.0 | ||
| - **[BREAKING]** Default width and height can now be set by declaring defaults | ||
| for object destructuring, instead of having custom options for them. | ||
| This means the following options were removed: `defaultWidth`, `defaultHeight`, | ||
| `useDefaults`. | ||
| - **[BREAKING]** Due to the above, the default width and height will be | ||
| `undefined` instead of `1`. | ||
| - Docs were updated to reflect the above changes. | ||
| - Added an `onResize` handler that can report size changes instead of the default | ||
| object return. (This also helps implementing a more performant throttle / | ||
| debounce solution.) | ||
| ## 5.0.0 | ||
| - **[BREAKING]** `#14` Removed the polyfill from the default builds, and shipping | ||
| it instead as as separate module. | ||
| - **[BREAKING]** `#21` Returning an object instead of an array, so that values not | ||
| needed could be omitted. | ||
| - `#18` Added missing copyright notice in the MIT license. | ||
| - Improved ref handling: | ||
| - `#16` You can now pass in your own ref | ||
| - The same hook instance can now be reused with different refs | ||
| - The hook will no longer break if the ref is not immediately filled. | ||
| (Anything other than an object with a `.current` value of an `Element` will | ||
| be ignored.) | ||
| - Made defaults optional with the `useDefaults` option. | ||
| - New `package.json` scripts to ease development | ||
| - Added throttle and debounce guides to the readme | ||
| - More tests | ||
| ## 4.0.0 | ||
| - Added option to pass default width and height. Useful when using the lib with | ||
| SSR. (Thanks [Simon Boudrias](https://github.com/SBoudrias) and | ||
| [Fokke Zandbergen](https://github.com/FokkeZB)) | ||
| - Dep upgrades | ||
| - **[BREAKING]** Removed TS types. See: | ||
| - https://github.com/ZeeCoder/use-resize-observer/issues/12 | ||
| - https://github.com/ZeeCoder/use-resize-observer/pull/13 | ||
| - https://github.com/ZeeCoder/use-resize-observer/pull/8 | ||
| ## 3.1.0 | ||
| - Added Typescript types | ||
| ## 3.0.0 | ||
| - **[BREAKING]** Requires React 16.8.0 or above, which is the first non-alpha | ||
| release that includes hooks | ||
| ## 2.0.1 | ||
| - No real changes, testing travis deployment from master | ||
| ## 2.0.0 | ||
| - **[BREAKING]** Returning a tuple and creating a ref object automatically | ||
| - Using resize-observer-polyfill instead of resize-observer | ||
| - Fixed an issue where resize observer would trigger changes endlessly | ||
| - Added tests using Karma | ||
| ## 1.0.0 | ||
| - Initial release | ||
| - The returned ref will always be the same RefCallback. | ||
| Previously when a custom ref object was passed, it was returned as well from | ||
| the hook as "ref". | ||
| - Compared to 6.2.0-alpha.1 There's no `callbackRef` return value | ||
| anymore. |
| { | ||
| "name": "use-resize-observer", | ||
| "version": "7.0.0-alpha.1", | ||
| "version": "7.0.0-alpha.3", | ||
| "main": "dist/bundle.cjs.js", | ||
@@ -18,3 +18,3 @@ "module": "dist/bundle.esm.js", | ||
| "check:types": "tsc -p tests", | ||
| "test": "run-s 'build' 'check:size' 'check:types' 'test:create:ssr' 'test:headless:*'", | ||
| "test": "run-s 'build' 'check:size' 'check:types' 'test:create:ssr' 'test:bs:*'", | ||
| "test:create:ssr": "node ./tests/ssr/create-ssr-test.js", | ||
@@ -27,3 +27,5 @@ "test:chrome": "KARMA_BROWSERS=Chrome yarn karma:run", | ||
| "karma:watch": "karma start", | ||
| "prepublish": "yarn build" | ||
| "prepublish": "yarn build", | ||
| "test:bs:modern": "yarn karma:run --useBrowserStack", | ||
| "test:bs:ie": "yarn karma:run --useBrowserStack --runIeTests" | ||
| }, | ||
@@ -52,2 +54,8 @@ "husky": { | ||
| "@rollup/plugin-inject": "^4.0.1", | ||
| "@semantic-release/changelog": "^5.0.1", | ||
| "@semantic-release/commit-analyzer": "^8.0.1", | ||
| "@semantic-release/git": "^9.0.0", | ||
| "@semantic-release/github": "^7.1.1", | ||
| "@semantic-release/npm": "^7.0.6", | ||
| "@semantic-release/release-notes-generator": "^9.0.1", | ||
| "@size-limit/preset-small-lib": "^4.4.5", | ||
@@ -63,2 +71,3 @@ "@testing-library/react": "^11.0.4", | ||
| "karma": "^5.0.1", | ||
| "karma-browserstack-launcher": "^1.6.0", | ||
| "karma-chrome-launcher": "^3.0.0", | ||
@@ -74,4 +83,6 @@ "karma-firefox-launcher": "^1.3.0", | ||
| "react": "^16.9.0", | ||
| "react-app-polyfill": "^2.0.0", | ||
| "react-dom": "^16.9.0", | ||
| "rollup": "^2.6.1", | ||
| "semantic-release": "^17.2.2", | ||
| "size-limit": "^4.4.5", | ||
@@ -78,0 +89,0 @@ "typescript": "^4.0.3" |
@@ -14,2 +14,3 @@ # use-resize-observer | ||
| [](https://travis-ci.org/ZeeCoder/use-resize-observer) | ||
| [](https://automate.browserstack.com/public-build/bTAyOUVpa3hENUgwMkJBTVhXcytCQjREangwcTJqT0czUGhRSEZta3ZwYz0tLVRSZ1NhVkdPZ01FMithOEh5ZGxoWHc9PQ==--49d9d8ad43d557894fb270c80fd1c24107a82f51) | ||
@@ -29,3 +30,3 @@ ## Highlights | ||
| - [Throttle / Debounce](#throttle--debounce) | ||
| - **Tested** in real browsers. (Headless Chrome and Firefox). | ||
| - **Tested in real browsers** (Currently latest Chrome, Safari, Firefox and IE 11, sponsored by BrowserStack) | ||
@@ -32,0 +33,0 @@ ## In Action |
No alert changes
Improved metrics
- Total package byte prevSize
- increased by35.31%
48681
- Number of package files
- increased by16.67%
14
- Number of lines in readme file
- increased by0.39%
259
Worsened metrics
- Dev dependency count
- increased by29.03%
40
No dependency changes