Skip to content
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.

Sign up for GitHub

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

Add hooks to events #6

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open

Add hooks to events #6

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
93e7eeb
add hooks(ha) to events
mathdroid Oct 26, 2018
d2d561c
add minimal API docs to readme
mathdroid Oct 26, 2018
60eebcf
remove ui devDep
mathdroid Oct 27, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 17 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,14 +16,29 @@ yarn add @rehooks/online-status
## Usage

```js
import useOnlineStatus from '@rehooks/online-status';
import useOnlineStatus from "@rehooks/online-status";

function MyComponent() {
let onlineStatus = useOnlineStatus();
let onlineStatus = useOnlineStatus({
onStatusChange: online =>
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I feel like this should be implemented as something like <OnlineToaster status={onlineStatus} /> that triggers a toast on prop change rather than introducing a new concept to Hooks

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This isn't really a new concept for hooks useImperativeMethods is basically this.

I think it's fine, but I would assume most of the time you'd use it for setX calls

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@fouad I can see the point you are making here. I added those hooks because I sometimes need to call some function whenever the online status changes. What do you people think? Should this be implemented here or not? 🙏

online
? MyToaster.success("You are now online")
: MyToaster.danger("You are now offline")
});
return (
<div>
<h1>You are {onlineStatus ? "Online" : "Offline"}</h1>
</div>
);
}
```

## API

```js
useOnlineStatus({
onStatusChange: function,
onOnline: function,
onOffline: function,
})
```
9 changes: 8 additions & 1 deletion example.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,9 +1,16 @@
import React from "react";
import { render } from "react-dom";
import { toaster } from "evergreen-ui";

import useOnlineStatus from "./";

function App() {
let onlineStatus = useOnlineStatus();
let onlineStatus = useOnlineStatus({
onStatusChange: online =>
online
? toaster.success("You are now online")
: toaster.danger("you are now offline")
});
return (
<div>
<h1>You are {onlineStatus ? "Online" : "Offline"}</h1>
Expand Down
12 changes: 11 additions & 1 deletion index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,12 +8,22 @@ function getOnlineStatus() {
: true;
}

function useOnlineStatus() {
function noop() {}

function useOnlineStatus({
onStatusChange = noop,
onOnline = noop,
onOffline = noop
}) {
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
}) {
} = {}) {

This change would make the param optional

let [onlineStatus, setOnlineStatus] = useState(getOnlineStatus());
function goOnline() {
onStatusChange(true);
onOnline();
setOnlineStatus(true);
}
function goOffline() {
onStatusChange(false);
onOffline();
setOnlineStatus(false);
}
useEffect(() => {
Expand Down
1 change: 1 addition & 0 deletions package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@
"devDependencies": {
"ava": "^0.25.0",
"browser-env": "^3.2.5",
"evergreen-ui": "^4.2.0",
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Seems a bit overkill to pull in a UI library

"parcel": "^1.10.3",
"raf": "^3.4.0",
"react": "^16.7.0-alpha.0",
Expand Down
Loading