-
Notifications
You must be signed in to change notification settings - Fork 575
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
🎨 📝 useViewportSpy hook + improved documentation
- Loading branch information
Antonio Russo
committed
Jan 10, 2020
1 parent
7329fa0
commit b4e0eef
Showing
26 changed files
with
343 additions
and
74 deletions.
There are no files selected for viewing
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
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
Large diffs are not rendered by default.
Oops, something went wrong.
File renamed without changes.
This file was deleted.
Oops, something went wrong.
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
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,14 @@ | ||
## Installation | ||
|
||
As simple as the follow: | ||
|
||
by using `npm`: | ||
```bash | ||
$ npm install beautiful-react-hooks | ||
``` | ||
|
||
by using `yarn`: | ||
|
||
```bash | ||
$ yarn add beautiful-react-hooks | ||
``` |
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,42 @@ | ||
# Introduction | ||
[![Build Status](https://travis-ci.org/beautifulinteractions/beautiful-react-hooks.svg?branch=master)](https://travis-ci.org/beautifulinteractions/beautiful-react-hooks) | ||
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT) | ||
![npm](https://img.shields.io/npm/v/beautiful-react-hooks) | ||
![GitHub stars](https://img.shields.io/github/stars/beautifulinteractions/beautiful-react-hooks?style=social) | ||
|
||
Beautiful React Hooks is a collection of beautiful (and hopefully useful) React hooks to speed-up your | ||
components and hooks development. | ||
|
||
|
||
## 💡 Why? | ||
|
||
React custom hooks allow to abstract components' business logic into single reusable functions.<br /> | ||
So far, I've found that most of the hooks I've created and therefore shared between my projects have quite often a | ||
similar gist that involves callback references, events and components' lifecycle. <br /> | ||
For this reason I've tried to sum up that gist into `beautiful-react-hooks`: a collection of (*hopefully*) useful | ||
React hooks to possibly help other developers to speed up their development process.<br /><br /> | ||
Furthermore, I've tried to create a concise yet concrete API having in mind the code readability, focusing | ||
to keep the learning curve as lower as possible so that the it can be used and shared in bigger teams. | ||
|
||
|
||
## ☕️ Features | ||
|
||
* Concise API | ||
* Small and lightweight | ||
* Easy to learn | ||
* Functional approach | ||
* Fully written in JS (although TS types are supported) | ||
|
||
### Credits | ||
|
||
This library is provided and sponsored by: | ||
|
||
<div> | ||
<p> | ||
<a href="https://beautifulinteractions.com/"> | ||
<img src="https://beautifulinteractions.com/img/logo-colorful.svg" alt="Beautiful interactions" width="140px" /> | ||
</a> | ||
</p> | ||
</div> | ||
|
||
As part of our commitment to support and provide the open source community. |
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
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
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
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
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
Oops, something went wrong.