plotly / plotly/react-plotly.js

Document why use this wrapper?

Offen
#291 2 Kommentare 3 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

Vorherrschende Sprache
JavaScript
Sterne
1.1k
Forks
138
Ø Merge
3 T. 2 Std.
Gemergte PRs (30 T.)
4

Beschreibung

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?

Beitragsleitfaden

Für dieses Repository ist kein Beitragsleitfaden indexiert

Erste Schritte

  1. Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
  2. Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
  3. Forke das Repository und arbeite in einem Branch.
  4. Öffne einen Pull Request, der die Issue-Nummer nennt.

Rechercherichtung

Beginne mit der README des Repositorys und vergleiche deren Erklärung des Wrappers mit dem direkten Plotly.newPlot(..) und dem useEffect-Beispiel im Issue. Ermittle, welche Unterscheidung die React-Komponente bietet, und aktualisiere anschließend die README, damit ihr Zweck und ihre angemessene Verwendung im Vergleich zur direkten Verwendung der Basibliothek klar sind.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
javascript, react
Bereich
documentation
Issue-Typ
Dokumentation
Schwierigkeit
2/5
Geschätzter Aufwand
1-3 Stunden
Aktivitätsstatus
Veraltet
Klarheit
Größtenteils klar
Anfängerfreundlichkeit
45/100

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.