Documentation: add a small example of event-driven animation
Nobody has claimed this yet.
- Dominant language
- JavaScript
- Stars
- 17.6k
- Forks
- 4.4k
- PR merge metrics
- No merged PRs in 30d
Description
Hi, I hope you're doing good!
I'm admittedly an uber-noob, but I didn't realize how to fire the custom "animation__somename" animations in https://aframe.io/docs/1.0.0/components/animation.html .
I finally realized I needed to .emit() on the element thanks to https://stackoverflow.com/a/53412175 this kind soul.
Would it be possible to add something along the lines of that SO answer to the documentation?
Thanks a lot in advance, and thanks for the great framework!
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 animation component documentation at https://aframe.io/docs/1.0.0/components/animation.html and compare it with the linked Stack Overflow answer. Add a small example showing how to trigger custom animation__somename animations with emit(); the documentation is done when the event-driven usage is clear to readers.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100