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 摘要。