831a808568
Co-authored-by: Julien Valverdé <julien.valverde@mailo.com> Reviewed-on: https://gitea:3000/Thilawyn/effect-fc/pulls/4
65 lines
2.0 KiB
Markdown
65 lines
2.0 KiB
Markdown
# Effect FC
|
|
|
|
[Effect-TS](https://effect.website/) integration for React 19+ that allows you to write function components using Effect generators.
|
|
|
|
This library is in early development. While it is (almost) feature complete and mostly usable, expect bugs and quirks. Things are still being ironed out, so ideas and criticisms are more than welcome.
|
|
|
|
Documentation is currently being written. In the meantime, you can take a look at the `packages/example` directory.
|
|
|
|
## Peer dependencies
|
|
- `effect` 3.15+
|
|
- `react` & `@types/react` 19+
|
|
|
|
## Known issues
|
|
- 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
|
|
```typescript
|
|
import { Component } from "effect-fc"
|
|
import { useOnce, useSubscribe } from "effect-fc/hooks"
|
|
import { Todo } from "./Todo"
|
|
import { TodosState } from "./TodosState.service"
|
|
|
|
|
|
export class Todos extends Component.makeUntraced(function* Todos() {
|
|
const state = yield* TodosState
|
|
const [todos] = yield* useSubscribe(state.ref)
|
|
|
|
yield* useOnce(() => Effect.andThen(
|
|
Console.log("Todos mounted"),
|
|
Effect.addFinalizer(() => Console.log("Todos unmounted")),
|
|
))
|
|
|
|
const TodoFC = yield* Todo
|
|
|
|
return (
|
|
<Container>
|
|
<Heading align="center">Todos</Heading>
|
|
|
|
<Flex direction="column" align="stretch" gap="2" mt="2">
|
|
<TodoFC _tag="new" />
|
|
|
|
{Chunk.map(todos, todo =>
|
|
<TodoFC key={todo.id} _tag="edit" id={todo.id} />
|
|
)}
|
|
</Flex>
|
|
</Container>
|
|
)
|
|
}) {}
|
|
|
|
const TodosStateLive = TodosState.Default("todos")
|
|
|
|
const Index = Component.makeUntraced(function* Index() {
|
|
const context = yield* useContext(TodosStateLive, { finalizerExecutionMode: "fork" })
|
|
const TodosFC = yield* Effect.provide(Todos, context)
|
|
|
|
return <TodosFC />
|
|
}).pipe(
|
|
Component.withRuntime(runtime.context)
|
|
)
|
|
|
|
export const Route = createFileRoute("/")({
|
|
component: Index
|
|
})
|
|
```
|