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.

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

feat: add useInterval and useTimeout #1462

Merged
merged 3 commits into from
Nov 8, 2019
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
33 changes: 33 additions & 0 deletions packages/rax-use-interval/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
# rax-use-interval

Why `useInterval`? `setInterval` will called even component is unmounted that make error happens, and `useInterval` will auto `clearInterval` before component will mount.

```jsx
import { createElement } from 'rax';
import useInterval from 'rax-use-interval';

function Example() {
const [count, setCount] = useState(0);
useInterval(() => {
setCount(count + 1);
}, 1000);

return <h1>{count}</h1>;
}
```

How to stop or restart timer?
```jsx
function Example() {
const [count, setCount] = useState(0);
const [delay, setDelay] = useState(1000);
useInterval(() => {
setCount(count + 1);
}, delay);

const stopTimer = () => setDelay(null); // Stop
const restartTimer = () => setDelay(1000); // Restart

return <h1 onClick={delay ? stopTimer : restartTimer}>{count}</h1>;
}
```
21 changes: 21 additions & 0 deletions packages/rax-use-interval/package.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
{
"name": "rax-use-interval",
"version": "1.0.0",
"description": "Rax useInterval hook",
"license": "BSD-3-Clause",
"main": "lib/index.js",
"repository": {
"type": "git",
"url": "git+https://github.com/alibaba/rax.git"
},
"bugs": {
"url": "https://github.com/alibaba/rax/issues"
},
"homepage": "https://github.com/alibaba/rax#readme",
"engines": {
"npm": ">=3.0.0"
},
"peerDependencies": {
"rax": "^1.0.0"
}
}
23 changes: 23 additions & 0 deletions packages/rax-use-interval/src/index.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
import { useEffect, useRef } from 'rax';

function clearTimer(id) {
if (id != null) clearInterval(id);
}
Copy link
Collaborator

Choose a reason for hiding this comment

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

其实这里可以不用判断, clearInterval 接受任何类型都不会抛出异常

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

  1. 逻辑上正确 2. clearInterval 还是比较重的行为


export default function useInterval(fn, delay) {
const ref = useRef();

// Update to the latest function.
useEffect(() => {
ref.fn = fn;
}, [fn]);

useEffect(() => {
// Clear before timer if delay time updated
clearTimer(ref.id);
if (typeof delay === 'number') {
ref.id = setInterval(() => ref.fn(), delay);
return () => clearTimer(ref.id);
}
}, [delay]);
}
33 changes: 33 additions & 0 deletions packages/rax-use-timeout/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
# rax-use-timeout

Why `useTimeout`? `setTimeout` will called even component is unmounted that make error happens, and `useTimeout` will auto `clearTimeout` before component will mount.

```jsx
import { createElement } from 'rax';
import useTimeout from 'rax-use-timeout';

function Example() {
const [count, setCount] = useState(0);
useTimeout(() => {
setCount(count + 1);
}, 1000);

return <h1>{count}</h1>;
}
```

How to stop or restart timer?
```jsx
function Example() {
const [count, setCount] = useState(0);
const [delay, setDelay] = useState(1000);
useTimeout(() => {
setCount(count + 1);
}, delay);

const stopTimer = () => setDelay(null); // Stop
const restartTimer = () => setDelay(1000); // Restart

return <h1 onClick={delay ? stopTimer : restartTimer}>{count}</h1>;
}
```
21 changes: 21 additions & 0 deletions packages/rax-use-timeout/package.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
{
"name": "rax-use-timeout",
"version": "1.0.0",
"description": "Rax useTimeout hook",
"license": "BSD-3-Clause",
"main": "lib/index.js",
"repository": {
"type": "git",
"url": "git+https://github.com/alibaba/rax.git"
},
"bugs": {
"url": "https://github.com/alibaba/rax/issues"
},
"homepage": "https://github.com/alibaba/rax#readme",
"engines": {
"npm": ">=3.0.0"
},
"peerDependencies": {
"rax": "^1.0.0"
}
}
23 changes: 23 additions & 0 deletions packages/rax-use-timeout/src/index.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
import { useEffect, useRef } from 'rax';

function clearTimer(id) {
if (id != null) clearTimeout(id);
Copy link
Collaborator

Choose a reason for hiding this comment

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

同上

}

export default function useTimeout(fn, delay) {
const ref = useRef();

// Update to the latest function.
useEffect(() => {
ref.fn = fn;
}, [fn]);

useEffect(() => {
// Clear before timer if delay time updated
clearTimer(ref.id);
if (typeof delay === 'number') {
ref.id = setTimeout(() => ref.fn(), delay);
return () => clearTimer(ref.id);
}
}, [delay]);
}