Skip to content

Commit

Permalink
Prepare for 4.0.0 (#366)
Browse files Browse the repository at this point in the history
  • Loading branch information
shawnmcknight authored May 15, 2021
1 parent b483605 commit 55a73e6
Show file tree
Hide file tree
Showing 4 changed files with 8 additions and 5 deletions.
5 changes: 5 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,10 @@
## HEAD

## 4.0.0
###### _2021_05_15_
**BREAKING CHANGE**
- Deprecated the legacy component syntax in favor of the custom hook syntax introduced in [#263](https://github.com/shawnmcknight/react-scrollbar-size/pull/263). The custom hook is now the default export from the library. See the [README](https://github.com/shawnmcknight/react-scrollbar-size/blob/main/README.md) for information on how to use the custom hook syntax. ([#309](https://github.com/shawnmcknight/react-scrollbar-size/pull/309) by [@shawnmcknight](https://github.com/shawnmcknight))

## 4.0.0-rc.0
###### _2021_04_04_
**BREAKING CHANGE**
Expand Down
4 changes: 1 addition & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,10 +24,8 @@ It will also detect when the size of the scrollbars change, such as when the use
## Installation
React-Scrollbar-Size is available as an [npm package](https://www.npmjs.com/package/react-scrollbar-size):

:information_source: The examples referenced here relate to the 4.0.0 release candidate, which can be installed using the `rc` tag. Earlier versions of the custom hook syntax can be viewed [here](https://github.com/shawnmcknight/react-scrollbar-size/blob/3.2.0/README.md). Earlier versions of the legacy component syntax can be viewed [here](https://github.com/shawnmcknight/react-scrollbar-size/blob/3.1.1/README.md).

```sh
$ npm install react-scrollbar-size@rc
$ npm install react-scrollbar-size
```

## Usage
Expand Down
2 changes: 1 addition & 1 deletion package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "react-scrollbar-size",
"private": true,
"version": "4.0.0-rc.0",
"version": "4.0.0",
"description": "React hook to calculate the size of browser scrollbars",
"main": "index.js",
"scripts": {
Expand Down

0 comments on commit 55a73e6

Please sign in to comment.