[CHORE]: Describe `config.modeBarButtonsToRemove` values in the schema

Offen

#8,063 erstellt am 21.9.2026 0 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

Bewertung

Schwierigkeit: 3/5
Geschätzter Aufwand: 1-2 Tage
Anfängerfreundlichkeit: 76/100

Issue-Typ: Refactoring
Klarheit: Klar beschrieben
Aktivitätsstatus: Aktiv
Tech-Stack: javascript
Bereich: build-system, tooling

Rechercherichtung

Start with the config.modeBarButtonsToRemove definition in src/plot_api/plot_config.js, then inspect src/components/modebar/constants.js and the generator in tasks/generate_schema_types.mjs. Compare the existing declaration in src/types/core/layout.d.ts. Done means the schema lists the accepted button names, generated types provide the union, and the handwritten declaration is removed without runtime changes.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Beschreibung

chore P3 plotly-internal size: 1 task

Description

Replace valType: 'any' on config.modeBarButtonsToRemove with an enumerated list of the button names it accepts.

Why should this change be made?

Its description sends readers to ./components/modebar/buttons.js. The names are already derived as foreButtons in src/components/modebar/constants.js, and layout.modebar.remove interpolates that constant into its own description.

This publishes the 48 names for every language port, and lets the type generator derive the union that ModeBarDefaultButtons in src/types/core/layout.d.ts maintains by hand. Config options are never coerced, so no runtime behavior changes.

Scope

Update src/plot_api/plot_config.js with new info
Update tasks/generate_schema_types.mjs to handle the new type generation
Remove the hand written info from src/types/core/layout.d.ts

Vorherrschende Sprache: JavaScript
Sterne: 18.3k
Forks: 2k
Ø Merge: 2 T. 10 Std.
Gemergte PRs (30 T.): 30

Beitragsleitfaden

Beitragsleitfaden öffnen

Erste Schritte

Lesen Sie das ganze Issue und danach den Beitragsleitfaden des Projekts.
Schreiben Sie ins Issue, dass Sie es übernehmen — das erspart doppelte Arbeit.
Forken Sie das Repository und arbeiten Sie in einem Branch.
Öffnen Sie einen Pull Request, der die Issue-Nummer nennt.

Mehr aus plotly/plotly.js

[CHORE]: Warn on config values that do not match the schema Offen

chore P3 plotly-internal size: 3 task

Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 77/100

plotly/plotly.js#8064 · Erstellt am 21.9.2026
[CHORE]: Change default to `true` for `responsive` config attribute Offen

chore P1 plotly-internal size: 1 task

Schwierigkeit 1/5 Unter einer Stunde Anfängerfreundlichkeit 82/100

plotly/plotly.js#8034 · Erstellt am 10.9.2026
[CHORE]: Deprecate plotly.js-mapbox* npm packages Offen

chore P3 plotly-internal size: 1 task

Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 65/100

plotly/plotly.js#8029 · Erstellt am 08.9.2026
[mkdocs] Update link in Edit this Page button Offen

bug

Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 65/100

plotly/plotly.js#7648 · 3 Kommentare · Erstellt am 18.11.2025
BUILDING.md: minor typo and some Markdown syntax errors Offen

bug infrastructure P2

Schwierigkeit 1/5 Unter einer Stunde Anfängerfreundlichkeit 65/100

plotly/plotly.js#6930 · Erstellt am 15.3.2024

Alle Issues in plotly/plotly.js