Skip to content

Commit

Permalink
chore(docs): Update changelog and docs
Browse files Browse the repository at this point in the history
  • Loading branch information
@imbhargav5
imbhargav5 committed May 20, 2022
1 parent 6ac36e1 commit b4ba478
Show file tree
Hide file tree
Showing 79 changed files with 6,262 additions and 3 deletions.
9 changes: 9 additions & 0 deletions .all-contributorsrc
View file
Original file line number Diff line number Diff line change
Expand Up @@ -444,6 +444,15 @@
"contributions": [
"code"
]
},
{
"login": "nlswtlr",
"name": "Nils Wittler",
"avatar_url": "https://avatars.githubusercontent.com/u/1405318?v=4",
"profile": "https://nilsw.io/",
"contributions": [
"code"
]
}
],
"contributorsPerLine": 7
Expand Down
85 changes: 85 additions & 0 deletions CHANGELOG.md
View file
Original file line number Diff line number Diff line change
@@ -1,3 +1,88 @@
## <small>5.11.1 (2022-05-20)</small>

* fix(types): change useFullscreen hook return type (it never returns undefined) (#1006) ([6ac36e1](https://github.com/imbhargav5/rooks/commit/6ac36e1)), closes [#1006](https://github.com/imbhargav5/rooks/issues/1006)
* chore(deps-dev): bump @babel/cli from 7.17.6 to 7.17.10 ([0096642](https://github.com/imbhargav5/rooks/commit/0096642))
* chore(deps-dev): bump @babel/core from 7.17.10 to 7.17.12 ([7eb8979](https://github.com/imbhargav5/rooks/commit/7eb8979))
* chore(deps-dev): bump @babel/core from 7.17.8 to 7.17.9 ([a05728d](https://github.com/imbhargav5/rooks/commit/a05728d))
* chore(deps-dev): bump @babel/core from 7.17.9 to 7.17.10 ([0248261](https://github.com/imbhargav5/rooks/commit/0248261))
* chore(deps-dev): bump @babel/plugin-proposal-export-default-from ([0311156](https://github.com/imbhargav5/rooks/commit/0311156))
* chore(deps-dev): bump @babel/preset-env from 7.16.11 to 7.17.10 ([ab44540](https://github.com/imbhargav5/rooks/commit/ab44540))
* chore(deps-dev): bump @docusaurus/core ([118d466](https://github.com/imbhargav5/rooks/commit/118d466))
* chore(deps-dev): bump @docusaurus/core ([12377c2](https://github.com/imbhargav5/rooks/commit/12377c2))
* chore(deps-dev): bump @docusaurus/plugin-client-redirects ([f0bfc88](https://github.com/imbhargav5/rooks/commit/f0bfc88))
* chore(deps-dev): bump @docusaurus/plugin-client-redirects ([0e62f7c](https://github.com/imbhargav5/rooks/commit/0e62f7c))
* chore(deps-dev): bump @docusaurus/preset-classic ([eb76386](https://github.com/imbhargav5/rooks/commit/eb76386))
* chore(deps-dev): bump @docusaurus/preset-classic ([8b8d4b4](https://github.com/imbhargav5/rooks/commit/8b8d4b4))
* chore(deps-dev): bump @rollup/plugin-typescript from 8.3.1 to 8.3.2 ([3e39488](https://github.com/imbhargav5/rooks/commit/3e39488))
* chore(deps-dev): bump @testing-library/jest-dom from 5.16.3 to 5.16.4 ([fb47994](https://github.com/imbhargav5/rooks/commit/fb47994))
* chore(deps-dev): bump @types/jest from 27.4.1 to 27.5.0 ([e968701](https://github.com/imbhargav5/rooks/commit/e968701))
* chore(deps-dev): bump @types/lodash.debounce from 4.0.6 to 4.0.7 ([fd31cdb](https://github.com/imbhargav5/rooks/commit/fd31cdb))
* chore(deps-dev): bump @types/react from 17.0.43 to 18.0.0 ([f0e2086](https://github.com/imbhargav5/rooks/commit/f0e2086))
* chore(deps-dev): bump @types/react from 18.0.0 to 18.0.1 ([3791c88](https://github.com/imbhargav5/rooks/commit/3791c88))
* chore(deps-dev): bump @types/react from 18.0.1 to 18.0.2 ([a3f499a](https://github.com/imbhargav5/rooks/commit/a3f499a))
* chore(deps-dev): bump @types/react from 18.0.2 to 18.0.3 ([befa511](https://github.com/imbhargav5/rooks/commit/befa511))
* chore(deps-dev): bump @types/react from 18.0.3 to 18.0.5 ([40f6d60](https://github.com/imbhargav5/rooks/commit/40f6d60))
* chore(deps-dev): bump @types/react from 18.0.5 to 18.0.6 ([1d1801c](https://github.com/imbhargav5/rooks/commit/1d1801c))
* chore(deps-dev): bump @types/react from 18.0.6 to 18.0.7 ([00b9283](https://github.com/imbhargav5/rooks/commit/00b9283))
* chore(deps-dev): bump @types/react from 18.0.7 to 18.0.8 ([ffb4e40](https://github.com/imbhargav5/rooks/commit/ffb4e40))
* chore(deps-dev): bump @types/react from 18.0.8 to 18.0.9 ([36eb6e5](https://github.com/imbhargav5/rooks/commit/36eb6e5))
* chore(deps-dev): bump @types/react-dom from 17.0.14 to 18.0.0 ([23bae01](https://github.com/imbhargav5/rooks/commit/23bae01))
* chore(deps-dev): bump @types/react-dom from 18.0.0 to 18.0.1 ([e1432fa](https://github.com/imbhargav5/rooks/commit/e1432fa))
* chore(deps-dev): bump @types/react-dom from 18.0.1 to 18.0.2 ([46d73e2](https://github.com/imbhargav5/rooks/commit/46d73e2))
* chore(deps-dev): bump @types/react-dom from 18.0.2 to 18.0.3 ([e779e19](https://github.com/imbhargav5/rooks/commit/e779e19))
* chore(deps-dev): bump @types/react-dom from 18.0.3 to 18.0.4 ([3cb4725](https://github.com/imbhargav5/rooks/commit/3cb4725))
* chore(deps-dev): bump @widgetbot/react-embed from 1.4.0 to 1.4.1 ([52c7b24](https://github.com/imbhargav5/rooks/commit/52c7b24))
* chore(deps-dev): bump babel-loader from 8.2.4 to 8.2.5 ([7d57147](https://github.com/imbhargav5/rooks/commit/7d57147))
* chore(deps-dev): bump babel-preset-minify from 0.5.1 to 0.5.2 ([3d0912d](https://github.com/imbhargav5/rooks/commit/3d0912d))
* chore(deps-dev): bump esbuild from 0.14.29 to 0.14.31 ([d1be9fd](https://github.com/imbhargav5/rooks/commit/d1be9fd))
* chore(deps-dev): bump esbuild from 0.14.31 to 0.14.32 ([9375a83](https://github.com/imbhargav5/rooks/commit/9375a83))
* chore(deps-dev): bump esbuild from 0.14.32 to 0.14.34 ([08f10fb](https://github.com/imbhargav5/rooks/commit/08f10fb))
* chore(deps-dev): bump esbuild from 0.14.34 to 0.14.36 ([848d8f1](https://github.com/imbhargav5/rooks/commit/848d8f1))
* chore(deps-dev): bump esbuild from 0.14.36 to 0.14.37 ([43f2b18](https://github.com/imbhargav5/rooks/commit/43f2b18))
* chore(deps-dev): bump esbuild from 0.14.37 to 0.14.38 ([47afba7](https://github.com/imbhargav5/rooks/commit/47afba7))
* chore(deps-dev): bump esbuild from 0.14.38 to 0.14.39 ([1a29023](https://github.com/imbhargav5/rooks/commit/1a29023))
* chore(deps-dev): bump eslint from 7.32.0 to 8.14.0 ([642b42b](https://github.com/imbhargav5/rooks/commit/642b42b))
* chore(deps-dev): bump eslint from 8.14.0 to 8.15.0 ([37f191e](https://github.com/imbhargav5/rooks/commit/37f191e))
* chore(deps-dev): bump eslint-config-canonical from 25.9.1 to 34.2.1 ([5efb0fb](https://github.com/imbhargav5/rooks/commit/5efb0fb))
* chore(deps-dev): bump eslint-config-canonical from 34.2.1 to 35.0.0 ([bbc21a9](https://github.com/imbhargav5/rooks/commit/bbc21a9))
* chore(deps-dev): bump eslint-plugin-testing-library from 5.1.0 to 5.2.0 ([d5c200b](https://github.com/imbhargav5/rooks/commit/d5c200b))
* chore(deps-dev): bump eslint-plugin-testing-library from 5.2.0 to 5.2.1 ([5044850](https://github.com/imbhargav5/rooks/commit/5044850))
* chore(deps-dev): bump eslint-plugin-testing-library from 5.2.1 to 5.3.1 ([cd71b57](https://github.com/imbhargav5/rooks/commit/cd71b57))
* chore(deps-dev): bump eslint-plugin-testing-library from 5.3.1 to 5.4.0 ([51a5a50](https://github.com/imbhargav5/rooks/commit/51a5a50))
* chore(deps-dev): bump eslint-plugin-testing-library from 5.4.0 to 5.5.0 ([1e5bda3](https://github.com/imbhargav5/rooks/commit/1e5bda3))
* chore(deps-dev): bump fs-extra from 10.0.1 to 10.1.0 ([bfcb71c](https://github.com/imbhargav5/rooks/commit/bfcb71c))
* chore(deps-dev): bump glob from 7.2.0 to 8.0.1 ([775527a](https://github.com/imbhargav5/rooks/commit/775527a))
* chore(deps-dev): bump glob from 8.0.1 to 8.0.2 ([9caf6df](https://github.com/imbhargav5/rooks/commit/9caf6df))
* chore(deps-dev): bump glob from 8.0.2 to 8.0.3 ([20369f9](https://github.com/imbhargav5/rooks/commit/20369f9))
* chore(deps-dev): bump husky from 7.0.4 to 8.0.1 ([4696ad5](https://github.com/imbhargav5/rooks/commit/4696ad5))
* chore(deps-dev): bump inquirer from 8.2.2 to 8.2.4 ([1de13cf](https://github.com/imbhargav5/rooks/commit/1de13cf))
* chore(deps-dev): bump jest-localstorage-mock from 2.4.19 to 2.4.21 ([c3786f3](https://github.com/imbhargav5/rooks/commit/c3786f3))
* chore(deps-dev): bump lint-staged from 12.3.7 to 12.3.8 ([da43a5a](https://github.com/imbhargav5/rooks/commit/da43a5a))
* chore(deps-dev): bump lint-staged from 12.3.8 to 12.4.0 ([f142da9](https://github.com/imbhargav5/rooks/commit/f142da9))
* chore(deps-dev): bump lint-staged from 12.4.0 to 12.4.1 ([706930e](https://github.com/imbhargav5/rooks/commit/706930e))
* chore(deps-dev): bump prettier from 2.6.1 to 2.6.2 ([d4fdae3](https://github.com/imbhargav5/rooks/commit/d4fdae3))
* chore(deps-dev): bump react from 18.0.0 to 18.1.0 ([ab5a9c2](https://github.com/imbhargav5/rooks/commit/ab5a9c2))
* chore(deps-dev): bump react-dom from 18.0.0 to 18.1.0 ([a764647](https://github.com/imbhargav5/rooks/commit/a764647))
* chore(deps-dev): bump react-test-renderer from 18.0.0 to 18.1.0 ([e7e364f](https://github.com/imbhargav5/rooks/commit/e7e364f))
* chore(deps-dev): bump rollup-plugin-esbuild from 4.8.2 to 4.9.1 ([beb956b](https://github.com/imbhargav5/rooks/commit/beb956b))
* chore(deps-dev): bump terser from 5.12.1 to 5.13.0 ([c32a672](https://github.com/imbhargav5/rooks/commit/c32a672))
* chore(deps-dev): bump terser from 5.13.0 to 5.13.1 ([2b89532](https://github.com/imbhargav5/rooks/commit/2b89532))
* chore(deps-dev): bump tslib from 2.3.1 to 2.4.0 ([cb21624](https://github.com/imbhargav5/rooks/commit/cb21624))
* chore(deps-dev): bump typescript from 4.6.2 to 4.6.3 ([4d0c1db](https://github.com/imbhargav5/rooks/commit/4d0c1db))
* chore(deps-dev): bump typescript from 4.6.3 to 4.6.4 ([f31b76f](https://github.com/imbhargav5/rooks/commit/f31b76f))
* chore(deps-dev): bump webpack from 5.70.0 to 5.71.0 ([2979d4d](https://github.com/imbhargav5/rooks/commit/2979d4d))
* chore(deps-dev): bump webpack from 5.71.0 to 5.72.0 ([3144090](https://github.com/imbhargav5/rooks/commit/3144090))
* chore(deps-dev): bump webpack from 5.72.0 to 5.72.1 ([589167c](https://github.com/imbhargav5/rooks/commit/589167c))
* chore(deps-dev): bump yargs from 17.4.0 to 17.4.1 ([1f6951c](https://github.com/imbhargav5/rooks/commit/1f6951c))
* chore(deps-dev): bump yargs from 17.4.1 to 17.5.0 ([0822773](https://github.com/imbhargav5/rooks/commit/0822773))
* chore(deps-dev): bump yargs from 17.5.0 to 17.5.1 ([0b7dcf2](https://github.com/imbhargav5/rooks/commit/0b7dcf2))
* chore(deps): bump async from 2.6.3 to 2.6.4 ([7565af1](https://github.com/imbhargav5/rooks/commit/7565af1))
* chore(deps): bump cross-fetch from 3.1.4 to 3.1.5 ([cec1dcd](https://github.com/imbhargav5/rooks/commit/cec1dcd))
* chore(docs): Update changelog and docs ([3fb9f45](https://github.com/imbhargav5/rooks/commit/3fb9f45))
* docs(usePreviousImmediate): fix import in docs (#993) ([799e2b0](https://github.com/imbhargav5/rooks/commit/799e2b0)), closes [#993](https://github.com/imbhargav5/rooks/issues/993)



## 5.11.0 (2022-03-30)

* feat(react): support v18 (#917) ([06b5b2c](https://github.com/imbhargav5/rooks/commit/06b5b2c)), closes [#917](https://github.com/imbhargav5/rooks/issues/917)
Expand Down
3 changes: 2 additions & 1 deletion README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -136,7 +136,7 @@ MIT
## Contributors ✨

<!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->
[![All Contributors](https://img.shields.io/badge/all_contributors-48-orange.svg?style=flat-square)](#contributors-)
[![All Contributors](https://img.shields.io/badge/all_contributors-49-orange.svg?style=flat-square)](#contributors-)
<!-- ALL-CONTRIBUTORS-BADGE:END -->

Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):
Expand Down Expand Up @@ -206,6 +206,7 @@ Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/d
<td align="center"><a href="http://staffordwilliams.com/"><img src="https://avatars.githubusercontent.com/u/6289998?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Stafford Williams</b></sub></a><br /><a href="https://github.com/imbhargav5/rooks/commits?author=staff0rd" title="Code">💻</a></td>
<td align="center"><a href="https://github.com/superLipbalm"><img src="https://avatars.githubusercontent.com/u/77329061?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Chanhee Kim</b></sub></a><br /><a href="https://github.com/imbhargav5/rooks/commits?author=superLipbalm" title="Code">💻</a></td>
<td align="center"><a href="https://github.com/hooriza"><img src="https://avatars.githubusercontent.com/u/507927?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Hooriza</b></sub></a><br /><a href="https://github.com/imbhargav5/rooks/commits?author=hooriza" title="Code">💻</a></td>
<td align="center"><a href="https://nilsw.io/"><img src="https://avatars.githubusercontent.com/u/1405318?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Nils Wittler</b></sub></a><br /><a href="https://github.com/imbhargav5/rooks/commits?author=nlswtlr" title="Code">💻</a></td>
</tr>
</table>

Expand Down
2 changes: 1 addition & 1 deletion package.json
View file
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "rooks",
"version": "5.11.0",
"version": "5.11.1",
"description": "Essential React custom hooks ⚓ to super charge your components!",
"main": "dist/cjs/index.js",
"module": "dist/esm/index.js",
Expand Down
3 changes: 2 additions & 1 deletion src/pages/_CONTRIBUTORS.md
View file
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@

<!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->
[![All Contributors](https://img.shields.io/badge/all_contributors-48-orange.svg?style=flat-square)](#contributors-)
[![All Contributors](https://img.shields.io/badge/all_contributors-49-orange.svg?style=flat-square)](#contributors-)
<!-- ALL-CONTRIBUTORS-BADGE:END -->
## Contributors ✨

Expand Down Expand Up @@ -71,6 +71,7 @@ Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/d
<td align="center"><a href="http://staffordwilliams.com/"><img src="https://avatars.githubusercontent.com/u/6289998?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Stafford Williams</b></sub></a><br /><a href="https://github.com/imbhargav5/rooks/commits?author=staff0rd" title="Code">💻</a></td>
<td align="center"><a href="https://github.com/superLipbalm"><img src="https://avatars.githubusercontent.com/u/77329061?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Chanhee Kim</b></sub></a><br /><a href="https://github.com/imbhargav5/rooks/commits?author=superLipbalm" title="Code">💻</a></td>
<td align="center"><a href="https://github.com/hooriza"><img src="https://avatars.githubusercontent.com/u/507927?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Hooriza</b></sub></a><br /><a href="https://github.com/imbhargav5/rooks/commits?author=hooriza" title="Code">💻</a></td>
<td align="center"><a href="https://nilsw.io/"><img src="https://avatars.githubusercontent.com/u/1405318?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Nils Wittler</b></sub></a><br /><a href="https://github.com/imbhargav5/rooks/commits?author=nlswtlr" title="Code">💻</a></td>
</tr>
</table>

Expand Down
35 changes: 35 additions & 0 deletions versioned_docs/version-5.11.1/getting-started.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
---
id: getting-started
title: Getting Started
sidebar_label: Getting Started
---

<!---->

### Installation

npm i -s rooks

### Importing the hooks

Import any hook from "rooks" and start using them!

```jsx
import { useDidMount } from "rooks";
```

### Usage

```jsx
function App() {
useDidMount(() => {
alert("mounted");
});
return (
<div className="App">
<h1>Hello CodeSandbox</h1>
<h2>Start editing to see some magic happen!</h2>
</div>
);
}
```
12 changes: 12 additions & 0 deletions versioned_docs/version-5.11.1/home-sandbox.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
<iframe src="https://codesandbox.io/embed/dawn-bush-z4kgg?fontsize=18&hidenavigation=1&module=%2Fsrc%2FRooks.js&theme=dark&editorsize=60"
style={{
width: "100%",
height: 500,
border: 0,
borderRadius: 4,
overflow: "hidden"
}}
title="dawn-bush-z4kgg"
allow="accelerometer; ambient-light-sensor; camera; encrypted-media; geolocation; gyroscope; hid; microphone; midi; payment; usb; vr; xr-spatial-tracking"
sandbox="allow-forms allow-modals allow-popups allow-presentation allow-same-origin allow-scripts"
></iframe>
Loading

0 comments on commit b4ba478

Please sign in to comment.