Update template refs documentation
Nobody has claimed this yet.
- Dominant language
- Vue
- Stars
- 3.2k
- Forks
- 5k
- Avg merge
- 14d 17h
- Merged PRs (30d)
- 1
Description
Docs pages
https://vuejs.org/guide/typescript/composition-api.html#typing-component-template-refs
https://vuejs.org/guide/essentials/template-refs.html#function-refs
Improvement
These pages needs these improvements:
- add method example, not only inline function
- add typescript version with types of that method (parameters, return type)
Without these changes its really hard to find out correct types for this.
Contributor guide
No contributing guide indexed for this repository
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 by reading the two linked sections: Typing Component Template Refs in the TypeScript guide and Function Refs in the essentials guide. Compare their inline-function examples and add method-based examples, including a TypeScript version that shows parameter and return types. Done means both pages explain these forms clearly and render correctly in the documentation site.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- typescript
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 68/100