Document why use this wrapper?

未关闭
#291 2 条评论 3 个 reaction 已指派 0 人 在 GitHub 查看

还没有人认领这个 Issue。

评估

难度
2/5
预计耗时
1-3 小时
新手友好度
45/100
Issue 类型
文档
描述清晰度
基本清楚
活跃度
停滞
技术栈
javascript, react
领域
documentation

调研方向

从仓库的 README 开始,将其中对 wrapper 的说明与 issue 中直接使用 Plotly.newPlot(..) 和 useEffect 的示例进行比较。确定 React 组件提供了什么区别,然后更新 README,使其用途以及适用场景相较于直接使用基础库更加清晰。

由索引模型根据 Issue 内容生成。

描述

I get that this is a thin wrapper and I don't want to nitpick but why exactly is it necessary? Could the readme introduce the use for it?

I just created a component, made a div called "graph", and plopped Plotly.newPlot(..) in a useEffect and it gave me a beautiful plot with all features working in this demo:

https://codepen.io/plotly/pen/edZXdj

Of course, this is a trivial example. What am I missing here? It's nice to know these things because I'm also seeing some of the animations features aren't fully implemented in this repo so one naturally wonders is it easier to just use the base library?

主要语言
JavaScript
星标
1.1k
派生
138
PR 合并指标
30 天内没有已合并 PR

环境准备

这个项目没有提供开发容器、Dockerfile 或贡献指南,环境需要你自己搭建:先看它的 README,通用步骤见我们的新手贡献指南。

从这里开始

  1. 先读完整个 Issue,再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库,在一个分支上完成修改。
  4. 提交 Pull Request,并在描述里引用这个 Issue 编号。

plotly/react-plotly.js 的其他 Issue

查看 plotly/react-plotly.js 的全部 Issue

相似的 Issue

更多 JavaScript Issue

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。