tauri-apps / tauri-apps/tauri-docs
Rewrite/Improve Events guide
Open
Nobody has claimed this yet.
enhancement
good first issue
- Dominant language
- MDX
- Stars
- 1.1k
- Forks
- 887
- Avg merge
- 2d 8h
- Merged PRs (30d)
- 48
Description
Also related: #486.
If possible we should look into improving it before the new docs are there. The guide causes too much confusion.
I will try to expand this list every time i see people having issues related to the guide or events.
- It emits events in the setup hook without some kind of condition. (New) users will therefore often encounter timing issues (emitting events before the js side starts to listen to them)
- Usage of
unlisten()right after listening to it - idk if it's caused by mindless copy-paste but this was a problem in peoples apps wayyy too often. - no mention of the need to unlisten in js when something like component unmounting happens.
- no docs on rust to rust communication -> talking about the
triggermethods
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the Events guide and related issue #486. Review the setup-hook event timing, JavaScript unlisten usage and cleanup, and Rust-to-Rust trigger methods described in the issue. Done means the guide addresses each listed source of confusion and explains the relevant event lifecycle clearly.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript, rust, tauri
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Quiet
- Clarity
- Mostly clear
- Newbie friendliness
- 55/100