Skip to content

React Pair Reference

Coverage License NPM Version Open Issues Size

🖇️ Util to help with the paired hook pattern.

Usage

📦 Node

Install react-pair as a dependency:

Terminal window
pnpm add react-pair
# or
npm install react-pair
# or
yarn add react-pair

Import it and use it:

import { useState } from "react";
import { pair } from "react-pair";
const useCount = initialCount => {
const [count, setCount] = useState(initialCount);
return { onClick: () => setCount(count + 1), children: count };
};
const PairedCount = pair(useCount);
const Component = ({ array = [] }) => (
<ul>
{array.map(key => (
<PairedCount key={key}>
{usePairedCount => {
const props = usePairedCount(key);
return (
<li>
<button type="button" {...props} />
</li>
);
}}
</PairedCount>
))}
</ul>
);

🦕 Deno

Import react-pair using the npm: prefix, and use it directly:

import { useState } from "npm:react";
import { pair } from "npm:react-pair";
const useCount = initialCount => {
const [count, setCount] = useState(initialCount);
return { onClick: () => setCount(count + 1), children: count };
};
const PairedCount = pair(useCount);
const Component = ({ array = [] }) => (
<ul>
{array.map(key => (
<PairedCount key={key}>
{usePairedCount => {
const props = usePairedCount(key);
return (
<li>
<button type="button" {...props} />
</li>
);
}}
</PairedCount>
))}
</ul>
);

🌎 Browser

Import react-pair using esm.sh, and use it directly:

<script type="module">
import { createElement, useState } from "https://esm.sh/react";
import { pair } from "https://esm.sh/react-pair";
const useCount = initialCount => {
const [count, setCount] = useState(initialCount);
return { onClick: () => setCount(count + 1), children: count };
};
const PairedCount = pair(useCount);
const Component = ({ array = [] }) => (
<ul>
{array.map(key =>
createElement(PairedCount, { key }, usePairedCount => {
const props = usePairedCount(key);
return createElement(
"li",
null,
createElement("button", props),
);
}),
)}
</ul>
);
</script>

Internal

PairedComponentProperties

Ƭ PairedComponentProperties<Hook>: Object

Paired component properties (just children with the paired hook render function).

Type parameters

NameType
Hookextends Function

Type declaration

NameTypeDescription
childrenPairedRenderFunction<Hook>Children has to be a function, and the argument is the paired hook.

View source


PairedRenderFunction

Ƭ PairedRenderFunction<Hook>: Unary<Hook, ReturnType<typeof createElement>>

Function that receives the paired hook and must return a ReactElement.

Type parameters

NameType
Hookextends Function

View source

Other

pair

pair<Hook>(hook): FunctionComponent<PairedComponentProperties<Hook>>

Creates a component with a function children that has the given hook in context.

Type parameters

NameType
Hookextends Function

Parameters

NameTypeDescription
hookHookHook to be paired.

Returns

FunctionComponent<PairedComponentProperties<Hook>>

Component that expects a function as children with the paired hook.

Example

const useCount = initialCount => {
const [count, setCount] = useState(initialCount);
return { onClick: () => setCount(count + 1), children: count };
};
const PairedCount = pair(useCount);
const Component = ({ array = [] }) => (
<ul>
{array.map(key => (
<PairedCount key={key}>
{usePairedCount => {
const props = usePairedCount(key);
return (
<li>
<button type="button" {...props} />
</li>
);
}}
</PairedCount>
))}
</ul>
);

View source