Skip to content

Commit 1e3772a

Browse files
committed
chore: update docs
1 parent 05f851f commit 1e3772a

File tree

1 file changed

+41
-3
lines changed

1 file changed

+41
-3
lines changed

README.md

Lines changed: 41 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12,9 +12,47 @@ Globally and safely persist a value, implemented with `ManuallyDrop`.
1212
`Cargo.toml`
1313

1414
```toml
15-
react-sys = "1"
15+
react-sys = "1.0.0-alpha.4"
1616
```
1717

18-
# Docs
18+
Though the version is at `1.x-alpha`,
19+
this crate is NOT ready for production
20+
and under heavy development.
21+
This crate is used by [`frender`](https://github.com/frender-rs/frender), which provides a friendly and safe api to use React in rust.
1922

20-
Please see [docs.rs](https://docs.rs/react-sys)
23+
# TODO
24+
25+
- Hooks
26+
27+
- [x] `React.useState`
28+
- [x] `React.useRef`
29+
- [x] `React.useEffect` `unsafe`
30+
- [ ] `React.useContext`
31+
- [ ] `useLayoutEffect`
32+
33+
- [ ] Can we implement the following hooks in rust ?
34+
35+
- [ ] `React.useMemo`
36+
- [ ] `React.useCallback`
37+
38+
Maybe we should implement a `use_closure` hook in rust.
39+
40+
- [ ] Do we need the following hooks in rust ?
41+
42+
- [ ] `React.useReducer`
43+
- [ ] `React.useImperativeHandle`
44+
- [ ] `useDebugValue`
45+
46+
- [ ] `ErrorBoundary`
47+
- [ ] `React.memo`
48+
49+
- [ ] `Component`
50+
51+
- [ ] html
52+
- [ ] functional component with hooks
53+
54+
- [ ] `Element`
55+
56+
- [x] `React.createElement`
57+
- [ ] `React.Element` cast between js and rust wasm
58+
- [ ] `jsx` like syntax to create element

0 commit comments

Comments
 (0)