Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/scarmuega/react-callforward
Like a callback, but forward :)
https://github.com/scarmuega/react-callforward
react react-hooks
Last synced: 4 months ago
JSON representation
Like a callback, but forward :)
- Host: GitHub
- URL: https://github.com/scarmuega/react-callforward
- Owner: scarmuega
- License: mit
- Created: 2020-02-16T23:27:51.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2023-01-07T14:55:06.000Z (about 2 years ago)
- Last Synced: 2024-05-30T18:50:54.871Z (8 months ago)
- Topics: react, react-hooks
- Language: TypeScript
- Size: 1.5 MB
- Stars: 4
- Watchers: 1
- Forks: 0
- Open Issues: 16
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://www.npmjs.com/package/react-callforward) [](./LICENSE)
react-callforward
=================
We all know about callbacks in react, they provide a way for a parent component to provide the implementation of a function that is triggered by a nested component. What happens when you need the opposite? How do you trigger a command that is implemented in a nested component?
Problem
-------
For example, lets say that you have the following app that displays a video:
```
+----------------------------------------------------+
|Root |
| |
| +------------+ +---------------------------------+ |
| |Sidebar | | Content | |
| | | | | |
| | | | +---------------------------+ | |
| | +------+ | | | | | |
| | |play | | | | video player | | |
| | |button| | | | | | |
| | +------+ | | | | | |
| | | | +---------------------------+ | |
| | | | | |
| +------------+ +---------------------------------+ |
+----------------------------------------------------+
```
The `Sidebar` and the `Content` components are independent, they are oblivious of the existence of each other. The sidebar has a "play" button that needs to trigger the `video.play()` method that exists within the scope of the `Content` component. How would you solve that?
- **alternative #1, using state**: The `Root` component has an `isPlaying` flag in the state, listens to the click callback of the play button and then propagates the state down to the nested `Content` component using props. The `Content` component would compare changes in the props and call the `play()` method accordingly. It works, but you loose the "imperative" nature of just calling a function; and you'll trigger an, otherwise unnecessary, render of the `Root` component.
- **alternative #2, using refs**: The `Content` component bubbles up a ref of the video player onto the `Root` component. The `Root` component creates an `onClick` handler that triggers the `play()` inside the ref and then it passes the handler into the `onClick` callback of the `Sidebar` component. It also works, but bubbling things up goes against the "composite" nature of our react components.
If you're happy with either of the above solutions, close this README and stop procrastinating, your app won't write itself.
Solution
--------
The basic idea of a `callforward` is to divide a method call into two parts: the _trigger_ and the _placeholder_. The trigger is just a proxy of the actual method call. The placeholder is an empty wrapper that needs to be "implemented" by some other child component.
Take the above video app example, this is how you would solve the problem using a `callforward`:
```jsx
function Root() {
const [onPlay, doPlay] = useCallForward();
return (
)
}
function Sidebar({ onClick }) {
return play
}
function Content({ doPlay }) {
const videoEl = useRef();
useCallHolder(() => {
videoEl.current.play();
}, doPlay);
return
}
```
The above example has been simplified for brevity. To see a running example, check the following codesandbox:
[](https://codesandbox.io/s/call-forward-example-upqk5?fontsize=14&hidenavigation=1&theme=dark)
Potential
---------
I imagine several use cases where components could be stripped away of opinionated control UI (buttons, inputs, etc), but still provide the "logic" to execute such actions:
- a simple "video" component providing play, pause, scrubbing methods
- any type of "data list" component providing a "refresh" method
- dialogs and popup components providing an imperative "open" / "close" method (thus, hiding the open/close state within the component itself)
- long text components providing "scrolling" (eg: "go to top") methods
Installation
------------
to install the library, do as usual:
```
npm install --save react-callforward
```