Add hook usage examples as jsdoc/tsdoc
还没有人认领这个 Issue。
评估
- 难度
- 4/5
- 预计耗时
- 3-5 天
- 新手友好度
- 35/100
- Issue 类型
- 文档
- 描述清晰度
- 基本清楚
- 活跃度
- 停滞
- 技术栈
- react, typescript
调研方向
Review the repository's hook source and existing documentation to determine which hooks need examples and where their JSDoc or TSDoc belongs. Add brief usage examples or documentation links so they appear when hovering over each hook in an IDE, then verify the rendered documentation for the covered hooks.
由索引模型根据 Issue 内容生成。
描述
Is your feature request related to a problem? Please describe.
To see examples for usage of a particular hook one needs to come to this repo taking them out of their flow.
Describe the solution you'd like
Examples and brief documentation should be in jsdoc/tsdoc format so that hook usage examples can be viewed in IDE by hovering over the hook.
Describe alternatives you've considered
Alternatively, just provide a link to the documentation for the hook
If I can get approval for this I'm happy to open a PR and contribute this.
- 主要语言
- TypeScript
- 星标
- 44k
- 派生
- 3.3k
- PR 合并指标
- 30 天内没有已合并 PR
环境准备
- 没有 Dockerfile 或 Docker Compose 文件
- 有 Pull Request 模板
- 阅读贡献指南
从这里开始
- 先读完整个 Issue，再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库，在一个分支上完成修改。
- 提交 Pull Request，并在描述里引用这个 Issue 编号。
streamich/react-use 的其他 Issue
-
难度 2/5 1-3 小时 新手友好度 72/100
-
Add Generic Fn for useDebounce可能已有人在做 @itsmejay80 于 192 天前认领。 未关闭
难度 2/5 1-3 小时 新手友好度 68/100
-
难度 2/5 1-3 小时 新手友好度 64/100
-
useVideo.story.tsx - sampleVideo can not be loaded可能重新可做 关联的 PR 已关闭且未合并。 未关闭
难度 1/5 1 小时以内 新手友好度 62/100
-
useSlider: event callbacks are not updated可能已有人在做 @erykpiast 于 1839 天前认领。 未关闭
难度 2/5 1-3 小时 新手友好度 62/100
查看 streamich/react-use 的全部 Issue
相似的 Issue
-
check:passed streams:edit
难度 2/5 1-3 小时 新手友好度 68/100
维护者通常 1 天内回复
-
area:mcp bug has repro platform:vscode regression
难度 2/5 1-3 小时 新手友好度 68/100
anthropics/claude-code#103970 ·
维护者通常 1 天内回复
-
难度 2/5 1-3 小时 新手友好度 78/100
维护者通常 1 天内回复
-
bug
难度 2/5 1-3 小时 新手友好度 84/100
维护者通常 1 天内回复
-
sdk-typescript: unquoted COPY globs in shell form are silently dropped from the image build context未关闭bug javascript
难度 2/5 1-3 小时 新手友好度 78/100
维护者通常 1 天内回复