Add selector and equality support to Atom React hooks

[SandroMaglione]

Type

• Refactor
• Feature
• Bug Fix
• Optimization
• Documentation Update

Description

Added support for select and equality to useAtomSuspense, and equality support to useAtomValue.

This allows to re-render based on a custom equality check, and add select support also to useAtomSuspense (which was already available in useAtomValue).

Related

Related to @typeonce/effect-machine for adding custom equality to machine atom hooks (reference PR):

const makeAuthMachine = MachineAtoms.factory(authMachine);

function AuthCard({ input }: { input: AuthMachineInput }) {
  const machine = useMachineAtom(() => makeAuthMachine(input));

  const passwordMode = useAtomSuspense(
    AtomMachine.matches(machine, "Editing.Password")
  ).value;

  const email = useAtomSuspense(
    AtomMachine.select(machine, "Editing"),
    {
      // 👇
      select: Option.map(({ email }) => email),
    }
  ).value;

}

[changeset-bot]

🦋 Changeset detected

Latest commit: 9cda8d1

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 30 packages

Name	Type
@effect/atom-react	Patch
effect	Patch
@effect/opentelemetry	Patch
@effect/vitest	Patch
@effect/ai-anthropic	Patch
@effect/ai-openai-compat	Patch
@effect/ai-openai	Patch
@effect/ai-openrouter	Patch
@effect/atom-solid	Patch
@effect/atom-vue	Patch
@effect/platform-browser	Patch
@effect/platform-bun	Patch
@effect/platform-deno	Patch
@effect/platform-node-shared	Patch
@effect/platform-node	Patch
@effect/sql-clickhouse	Patch
@effect/sql-d1	Patch
@effect/sql-libsql	Patch
@effect/sql-mssql	Patch
@effect/sql-mysql2	Patch
@effect/sql-pg	Patch
@effect/sql-pglite	Patch
@effect/sql-sqlite-bun	Patch
@effect/sql-sqlite-do	Patch
@effect/sql-sqlite-node	Patch
@effect/sql-sqlite-react-native	Patch
@effect/sql-sqlite-wasm	Patch
@effect/docgen	Patch
@effect/doctest	Patch
@effect/openapi-generator	Patch

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

[github-actions]

Bundle Size Analysis

Generated from PR build output; treat the content below as untrusted.

File Name	Current Size	Previous Size	Difference
arbitrary-combinators.ts	33.76 KB	33.76 KB	0.00 KB (0.00%)
basic.ts	7.00 KB	7.00 KB	0.00 KB (0.00%)
batching.ts	9.87 KB	9.87 KB	0.00 KB (0.00%)
brand.ts	6.56 KB	6.56 KB	0.00 KB (0.00%)
cache.ts	10.74 KB	10.74 KB	0.00 KB (0.00%)
config.ts	21.45 KB	21.45 KB	0.00 KB (0.00%)
differ.ts	20.32 KB	20.32 KB	0.00 KB (0.00%)
http-client.ts	21.76 KB	21.76 KB	0.00 KB (0.00%)
logger.ts	10.94 KB	10.94 KB	0.00 KB (0.00%)
metric.ts	8.98 KB	8.98 KB	0.00 KB (0.00%)
optic.ts	6.73 KB	6.73 KB	0.00 KB (0.00%)
pubsub.ts	15.12 KB	15.12 KB	0.00 KB (0.00%)
queue.ts	11.84 KB	11.84 KB	0.00 KB (0.00%)
schedule.ts	10.86 KB	10.86 KB	0.00 KB (0.00%)
schema-binary.ts	39.42 KB	39.42 KB	0.00 KB (0.00%)
schema-class.ts	20.07 KB	20.07 KB	0.00 KB (0.00%)
schema-fromJsonSchemaDocument.ts	31.02 KB	31.02 KB	0.00 KB (0.00%)
schema-representation-roundtrip.ts	26.21 KB	26.21 KB	0.00 KB (0.00%)
schema-string-transformation.ts	13.66 KB	13.66 KB	0.00 KB (0.00%)
schema-string.ts	11.18 KB	11.18 KB	0.00 KB (0.00%)
schema-template-literal.ts	15.47 KB	15.47 KB	0.00 KB (0.00%)
schema-toArbitrary.ts	33.31 KB	33.31 KB	0.00 KB (0.00%)
schema-toCodeDocument.ts	24.51 KB	24.51 KB	0.00 KB (0.00%)
schema-toCodecJson.ts	19.29 KB	19.29 KB	0.00 KB (0.00%)
schema-toEquivalence.ts	19.42 KB	19.42 KB	0.00 KB (0.00%)
schema-toFormatter.ts	19.51 KB	19.51 KB	0.00 KB (0.00%)
schema-toJsonSchemaDocument.ts	23.45 KB	23.45 KB	0.00 KB (0.00%)
schema-toRepresentation.ts	19.56 KB	19.56 KB	0.00 KB (0.00%)
schema.ts	19.28 KB	19.28 KB	0.00 KB (0.00%)
stm.ts	12.74 KB	12.74 KB	0.00 KB (0.00%)
stream.ts	9.83 KB	9.83 KB	0.00 KB (0.00%)

[tim-smart]

Any reason to not do it on the atoms themselves? They already support custom equality etc

[SandroMaglione]

@tim-smart refactored so selection and equality are now applied to an internally derived atom rather than through a React-specific snapshot/selection cache (follows the existing useAtomValue pattern)