jlengrand/compose-multiplatform
1
0
Fork 0
mirror of https://github.com/jlengrand/compose-multiplatform.git synced 2026-05-17 08:11:21 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update compose-web examples and readme about effects (#2395)

Browse Source 
Co-authored-by: Oleksandr Karpovich <oleksandr.karpovich@jetbrains.com>
This commit is contained in:
Oleksandr Karpovich
2022-10-12 11:01:32 +02:00
committed by GitHub
parent 597010706c
commit 5936fd8063
3 changed files with 29 additions and 18 deletions
Download Patch File Download Diff File Expand all files Collapse all files

20
tutorials/Web/Using_Effects/README.md
View File

@@ -28,8 +28,18 @@ Only one `ref` can be used per element. Calling it more than once will dismiss e
For example, `ref` can be used to add and remove some event listeners not provided by compose-web from the box.
### DisposableRefEffect
### DisposableRefEffect (deprecated)
**Deprecated:**
Consider using `DisposableEffect`. Its scope provides `scopeElement` - a reference to the underlying HTML element:
``` kotlin
DisposableEffect(key) {
scopeElement.innerText = key
onDispose { scopeElement.innerText = "" }
}
```
---
Under the hood, `DisposableRefEffect` uses [DisposableEffect](https://developer.android.com/jetpack/compose/side-effects#disposableeffect)
`DisposableRefEffect` is similar to `ref`, since it also provides a reference to an element. At the same time it has few differences.
@@ -65,8 +75,14 @@ Div {
}
```
### DomSideEffect
### DomSideEffect (deprecated)
**Deprecated:**
Consider using [SideEffect](https://developer.android.com/jetpack/compose/side-effects#sideeffect-publish).
If a reference to an underlying HTML element is needed, consider using `DisposableEffect` and `scopeElement` within its scope.
---
Under the hood, `DomSideEffect` uses [SideEffect](https://developer.android.com/jetpack/compose/side-effects#sideeffect-publish)
`DomSideEffect` as well as `DisposableRefEffect` can be used with a key and without it.