Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: don't suggest shallowReactive since it is not working #2013

Merged
merged 1 commit into from
Sep 4, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 1 addition & 2 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -109,14 +109,13 @@ classes reactive then the app may fail with

AeSdk and Contract classes doesn’t have a state intended to be tracked using reactivity. Therefore
to solve this issue we suggest to avoid making their instances reactive. One of the ways is to use
Vue's integrated utilities: [shallowRef], [shallowReactive]. The idea is to make reactive only the
Vue's integrated utility: [shallowRef]. The idea is to make reactive only the
root variable, to don't make it reactive in deep. You can find it implementation in the
[æpp example].

[based on]: https://vuejs.org/guide/extras/reactivity-in-depth.html#how-reactivity-works-in-vue
[not compatible]: https://github.com/tc39/proposal-class-fields/issues/106
[shallowRef]: https://vuejs.org/api/reactivity-advanced.html#shallowref
[shallowReactive]: https://vuejs.org/api/reactivity-advanced.html#shallowreactive
[æpp example]: https://github.com/aeternity/aepp-sdk-js/tree/71da12b5df56b41f7317d1fb064e44e8ea118d6c/examples/browser/aepp

## Command Line Interface (CLI)
Expand Down