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

未关闭

#8,063 创建于 2026年9月21日 0 条评论 0 个 reaction 已指派 0 人在 GitHub 查看

还没有人认领这个 Issue。

评估

难度: 3/5
预计耗时: 1-2 天
新手友好度: 76/100

Issue 类型: 重构
描述清晰度: 描述清楚
活跃度: 活跃
技术栈: javascript
领域: build-system, tooling

调研方向

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.

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

描述

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

主要语言: JavaScript
星标: 18.3k
派生: 2k
平均合并: 2 天 10 小时
30 天内合并 PR: 30

贡献指南

打开贡献指南

从这里开始

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

plotly/plotly.js 的其他 Issue

[CHORE]: Warn on config values that do not match the schema 未关闭

chore P3 plotly-internal size: 3 task

难度 2/5 1-3 小时新手友好度 77/100

plotly/plotly.js#8064 · 2026年9月21日创建
[CHORE]: Change default to `true` for `responsive` config attribute 未关闭

chore P1 plotly-internal size: 1 task

难度 1/5 1 小时以内新手友好度 82/100

plotly/plotly.js#8034 · 2026年9月10日创建
[CHORE]: Deprecate plotly.js-mapbox* npm packages 未关闭

chore P3 plotly-internal size: 1 task

难度 2/5 1-3 小时新手友好度 65/100

plotly/plotly.js#8029 · 2026年9月8日创建
[mkdocs] Update link in Edit this Page button 未关闭

bug

难度 2/5 1-3 小时新手友好度 65/100

plotly/plotly.js#7648 · 3 条评论 · 2025年11月18日创建
BUILDING.md: minor typo and some Markdown syntax errors 未关闭

bug infrastructure P2

难度 1/5 1 小时以内新手友好度 65/100

plotly/plotly.js#6930 · 2024年3月15日创建

查看 plotly/plotly.js 的全部 Issue

相似的 Issue

P4 FR: Add one-click copy-to-clipboard button to code snippets in static workshop HTML 未关闭

难度 2/5 1-3 小时新手友好度 75/100

palladius/rails8-app-on-gcp#145 · 2026年9月23日创建
Disable auto-cloaking not working 未关闭

难度 2/5 1-3 小时新手友好度 65/100

dotenvx/dotenv-vscode#139 · 2026年9月23日创建
Remove sw.https.window.html and sw-416.https.window.html from Interop 2026 fetch 未关闭

test-change-proposal

难度 2/5 1-3 小时新手友好度 65/100

web-platform-tests/interop#1455 · 2026年9月23日创建
Missing security headers on corsair.dev (CSP, X-Frame-Options, etc.) 未关闭

难度 2/5 1-3 小时新手友好度 75/100

corsairdev/corsair#1764 · 2026年9月23日创建
Empty .ts route file is scaffolded with JSX, breaking all route generation 未关闭

难度 2/5 1-3 小时新手友好度 75/100

TanStack/router#8480 · 2026年9月23日创建

更多 JavaScript Issue