README fix
All checks were successful
Lint / lint (push) Successful in 11s
Test build / test-build (pull_request) Successful in 42s

This commit is contained in:
Julien Valverdé
2025-08-23 01:14:59 +02:00
parent 33c6e7e19c
commit adf9c1a992
2 changed files with 21 additions and 16 deletions

View File

@@ -4,4 +4,4 @@
This monorepo contains: This monorepo contains:
- [The `effect-fc` library](packages/effect-fc) - [The `effect-fc` library](packages/effect-fc)
- [An example project](packges/example) - [An example project](packages/example)

View File

@@ -11,25 +11,26 @@ Documentation is currently being written. In the meantime, you can take a look a
- `react` & `@types/react` 19+ - `react` & `@types/react` 19+
## Known issues ## Known issues
- React Refresh replacement doesn't work for Effect FC's yet. Page reload is required to view changes. Regular React components are unaffected. - React Refresh doesn't work for Effect FC's yet. Page reload is required to view changes. Regular React components are unaffected.
## What writing components looks like ## What writing components looks like
```typescript ```typescript
import { Component, Hook, Memoized } from "effect-fc" import { Component } from "effect-fc"
import { useOnce, useSubscribe } from "effect-fc/hooks"
import { Todo } from "./Todo" import { Todo } from "./Todo"
import { TodosState } from "./TodosState.service" import { TodosState } from "./TodosState.service"
import { runtime } from "@/runtime"
class Todos extends Component.make(function* Todos() {
export class Todos extends Component.makeUntraced(function* Todos() {
const state = yield* TodosState const state = yield* TodosState
const [todos] = yield* Hook.useSubscribeRefs(state.ref) const [todos] = yield* useSubscribe(state.ref)
yield* Hook.useOnce(() => Effect.andThen( yield* useOnce(() => Effect.andThen(
Console.log("Todos mounted"), Console.log("Todos mounted"),
Effect.addFinalizer(() => Console.log("Todos unmounted")), Effect.addFinalizer(() => Console.log("Todos unmounted")),
)) ))
const TodoFC = yield* Component.useFC(Todo) const TodoFC = yield* Todo
return ( return (
<Container> <Container>
@@ -38,22 +39,26 @@ class Todos extends Component.make(function* Todos() {
<Flex direction="column" align="stretch" gap="2" mt="2"> <Flex direction="column" align="stretch" gap="2" mt="2">
<TodoFC _tag="new" /> <TodoFC _tag="new" />
{Chunk.map(todos, (v, k) => {Chunk.map(todos, todo =>
<TodoFC key={v.id} _tag="edit" index={k} /> <TodoFC key={todo.id} _tag="edit" id={todo.id} />
)} )}
</Flex> </Flex>
</Container> </Container>
) )
}).pipe( }) {}
Memoized.memo
) {}
const TodosEntrypoint = Component.make(function* TodosEntrypoint() { const TodosStateLive = TodosState.Default("todos")
const context = yield* Hook.useContext(TodosState.Default, { finalizerExecutionMode: "fork" })
const TodosFC = yield* Effect.provide(Component.useFC(Todos), context) const Index = Component.makeUntraced(function* Index() {
const context = yield* useContext(TodosStateLive, { finalizerExecutionMode: "fork" })
const TodosFC = yield* Effect.provide(Todos, context)
return <TodosFC /> return <TodosFC />
}).pipe( }).pipe(
Component.withRuntime(runtime.context) Component.withRuntime(runtime.context)
) )
export const Route = createFileRoute("/")({
component: Index
})
``` ```