Introduce react-utils package #627
+173
−15
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,5 @@ | ||
| --- | ||
| "@preact/signals-react": minor | ||
| --- | ||
|
|
||
| Add a `@preact/signals-react/utils` entrypoint containing common Signal utilities |
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,26 @@ | ||
| { | ||
| "name": "@preact/signals-react-runtime", | ||
| "description": "Sub package for @preact/signals-react that contains some useful utilities", | ||
| "private": true, | ||
| "amdName": "reactSignalsutils", | ||
| "main": "dist/utils.js", | ||
| "module": "dist/utils.module.js", | ||
| "unpkg": "dist/utils.min.js", | ||
| "types": "dist/index.d.ts", | ||
| "source": "src/index.ts", | ||
| "mangle": "../../../mangle.json", | ||
| "exports": { | ||
| ".": { | ||
| "types": "./dist/index.d.ts", | ||
| "browser": "./dist/utils.module.js", | ||
| "import": "./dist/utils.mjs", | ||
| "require": "./dist/utils.js" | ||
| } | ||
| }, | ||
| "dependencies": { | ||
| "@preact/signals-core": "workspace:^1.3.0" | ||
| }, | ||
| "peerDependencies": { | ||
| "react": "^16.14.0 || 17.x || 18.x || 19.x" | ||
| } | ||
| } |
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,45 @@ | ||
| import { ReadonlySignal, Signal } from "@preact/signals-core"; | ||
| import { useSignal } from "@preact/signals-react"; | ||
| import { useSignals } from "@preact/signals-react/runtime"; | ||
| import { Fragment, createElement, useMemo } from "react"; | ||
|
|
||
| interface ShowProps<T = boolean> { | ||
| when: Signal<T> | ReadonlySignal<T>; | ||
| fallback?: JSX.Element; | ||
| children: JSX.Element | ((value: T) => JSX.Element); | ||
| } | ||
|
|
||
| export function Show<T = boolean>(props: ShowProps<T>): JSX.Element | null { | ||
| useSignals(); | ||
| const value = props.when.value; | ||
| if (!value) return props.fallback || null; | ||
| return typeof props.children === "function" | ||
| ? props.children(value) | ||
| : props.children; | ||
| } | ||
|
|
||
| interface ForProps<T> { | ||
| each: Signal<Array<T>> | ReadonlySignal<Array<T>>; | ||
| fallback?: JSX.Element; | ||
| children: (value: T, index: number) => JSX.Element; | ||
| } | ||
|
|
||
| export function For<T>(props: ForProps<T>): JSX.Element | null { | ||
| useSignals(); | ||
| const cache = useMemo(() => new Map(), []); | ||
|
There was a problem hiding this comment. We might need to switch this to a WeakMap when we see the first item being an object or leverage JSON.stringify on objects |
||
| const list = props.each.value; | ||
| if (!list.length) return props.fallback || null; | ||
| const items = list.map((value, key) => { | ||
| if (!cache.has(value)) { | ||
| cache.set(value, props.children(value, key)); | ||
| } | ||
| return cache.get(value); | ||
| }); | ||
| return createElement(Fragment, { children: items }); | ||
| } | ||
|
|
||
| export function useLiveSignal<T>(value: Signal<T> | ReadonlySignal<T>) { | ||
| const s = useSignal(value); | ||
| if (s.peek() !== value) s.value = value; | ||
| return s; | ||
| } | ||
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,69 @@ | ||
| import { For, Show } from "../../src"; | ||
| import { | ||
| act, | ||
| checkHangingAct, | ||
| createRoot, | ||
| Root, | ||
| } from "../../../test/shared/utils"; | ||
| import { signal } from "@preact/signals-react"; | ||
| import { createElement } from "react"; | ||
|
|
||
| describe("@preact/signals-react-utils", () => { | ||
| let scratch: HTMLDivElement; | ||
| let root: Root; | ||
| async function render(element: Parameters<Root["render"]>[0]) { | ||
| await act(() => root.render(element)); | ||
| } | ||
|
|
||
| beforeEach(async () => { | ||
| scratch = document.createElement("div"); | ||
| document.body.appendChild(scratch); | ||
| root = await createRoot(scratch); | ||
| }); | ||
|
|
||
| afterEach(async () => { | ||
| checkHangingAct(); | ||
| await act(() => root.unmount()); | ||
| scratch.remove(); | ||
| }); | ||
|
|
||
| describe("<Show />", () => { | ||
| it("Should reactively show an element", () => { | ||
| const toggle = signal(false)!; | ||
| const Paragraph = (p: any) => <p>{p.children}</p>; | ||
| act(() => { | ||
| render( | ||
| <Show when={toggle} fallback={<Paragraph>Hiding</Paragraph>}> | ||
| <Paragraph>Showing</Paragraph> | ||
| </Show> | ||
| ); | ||
| }); | ||
| expect(scratch.innerHTML).to.eq("<p>Hiding</p>"); | ||
|
|
||
| act(() => { | ||
| toggle.value = true; | ||
| }); | ||
| expect(scratch.innerHTML).to.eq("<p>Showing</p>"); | ||
| }); | ||
| }); | ||
|
|
||
| describe("<For />", () => { | ||
| it("Should iterate over a list of signals", () => { | ||
| const list = signal<Array<string>>([])!; | ||
| const Paragraph = (p: any) => <p>{p.children}</p>; | ||
| act(() => { | ||
| render( | ||
| <For each={list} fallback={<Paragraph>No items</Paragraph>}> | ||
| {item => <Paragraph key={item}>{item}</Paragraph>} | ||
| </For> | ||
| ); | ||
| }); | ||
| expect(scratch.innerHTML).to.eq("<p>No items</p>"); | ||
|
|
||
| act(() => { | ||
| list.value = ["foo", "bar"]; | ||
| }); | ||
| expect(scratch.innerHTML).to.eq("<p>foo</p><p>bar</p>"); | ||
| }); | ||
| }); | ||
| }); |
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.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think we need to switch to importing
JSX, it's (finally!) no longer a global in React 19 AFAIK. It should exist on the React namespace back to 16.