Improve JavaScript components docs
还没有人认领这个 Issue。
评估
- 难度
- 4/5
- 预计耗时
- 3-5 天
- 新手友好度
- 35/100
- Issue 类型
- 文档
- 描述清晰度
- 基本清楚
- 活跃度
- 停滞
- 技术栈
- javascript, python, react
调研方向
Start by locating the existing custom component documentation and its super-simple-chart example. Review how the docs currently explain components, then add coverage for a Hello World example, event handling, JavaScript/Python data exchange, and using a ReactJS component; done means each proposed topic is documented with usable examples.
由索引模型根据 Issue 内容生成。
描述
Current Situation
The current docs are sparse on information, making it hard for new users to develop custom components. In particular, we jump to a relatively complicated example with super-simple-chart without ever showing a "Hello World" example. Also, this example does not demonstrate interactivity.
Proposed Actions
Extend the docs to add the following information
- Simple "Hello World"
- Adding interactivity (event handling)
- Sending arbitrary JS data to Python
- Sending arbitrary Python data to JS
- Using a ReactJS component in a custom component
- 主要语言
- Python
- 星标
- 8.1k
- 派生
- 332
- PR 合并指标
- 30 天内没有已合并 PR
贡献指南
这个仓库没有索引到贡献指南
从这里开始
- 先读完整个 Issue,再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库,在一个分支上完成修改。
- 提交 Pull Request,并在描述里引用这个 Issue 编号。
reactive-python/reactpy 的其他 Issue
-
priority-3-low type-docs
难度 2/5 1-3 小时 新手友好度 65/100
reactive-python/reactpy#1034 ·
-
priority-2-moderate type-revision
难度 5/5 一周以上 新手友好度 25/100
reactive-python/reactpy#1319 ·
-
priority-1-high
难度 5/5 一周以上 新手友好度 25/100
reactive-python/reactpy#1277 ·
-
priority-3-low
难度 5/5 一周以上 新手友好度 35/100
reactive-python/reactpy#1273 · 1 个 reaction ·
-
priority-2-moderate
难度 5/5 一周以上 新手友好度 30/100
reactive-python/reactpy#1272 · 2 个 reaction ·
查看 reactive-python/reactpy 的全部 Issue
相似的 Issue
-
link-check link-check:sphinx-theme
难度 2/5 1-3 小时 新手友好度 72/100
-
难度 2/5 1-3 小时 新手友好度 65/100
qgis/QGIS-Documentation#11275 ·
-
bug priority:normal ready-for-dev
难度 2/5 1-3 小时 新手友好度 88/100
OpenHands/extensions#626 · 1 条评论 ·
-
难度 1/5 1 小时以内 新手友好度 90/100
CSCfi/sd-search-api#39 ·
-
难度 1/5 1 小时以内 新手友好度 90/100