Hacktoberfest 2026:維護者為十月標記出來的 issue,仍然開放、適合新手。 瀏覽 Hacktoberfest issue

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

未關閉
#8,063 0 則留言 0 個 reaction 已指派 0 人 在 GitHub 檢視

還沒有人認領這個 Issue。

評估

難度
3/5
預估耗時
1-2 天
新手友好度
76/100
Issue 類型
重構
描述清晰度
描述清楚
活躍度
活躍
技術堆疊
javascript

研究方向

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

貢獻指南

開啟貢獻指南

從這裡開始

  1. 先讀完整個 Issue,再讀專案的貢獻指南。
  2. 在 Issue 下留言說明你要接手 —— 這能避免兩個人做同樣的事。
  3. Fork 儲存庫,在一個分支上完成修改。
  4. 送出 Pull Request,並在描述裡引用這個 Issue 編號。

plotly/plotly.js 的其他 Issue

查看 plotly/plotly.js 的全部 Issue

相似的 Issue

更多 JavaScript Issue

把新 issue 寄到你的電子郵件信箱

精選適合新手參與的 GitHub issue 摘要。