[CHORE]: Describe `config.modeBarButtonsToRemove` values in the schema
Maintainers usually reply within 1 day
Nobody has claimed this yet.
Assessment
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Newbie friendliness
- 76/100
- Issue type
- Refactor
- Clarity
- Clearly specified
- Activity status
- Active
- Tech stack
- javascript
- Domain
- build-system, tooling
Research direction
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.
Written by the indexing model from the issue text.
Description
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.jswith new info - Update
tasks/generate_schema_types.mjsto handle the new type generation - Remove the hand written info from
src/types/core/layout.d.ts
- Dominant language
- JavaScript
- Stars
- 18.3k
- Forks
- 2k
- Avg merge
- 1d 21h
- Merged PRs (30d)
- 21
Getting set up
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from plotly/plotly.js
-
chore P3 plotly-internal size: 3 task
Difficulty 2/5 1-3 hours Newbie friendliness 77/100
Maintainers usually reply within 1 day
-
chore P1 plotly-internal size: 1 task
Difficulty 1/5 Under an hour Newbie friendliness 82/100
Maintainers usually reply within 1 day
-
chore P3 plotly-internal size: 1 task
Difficulty 2/5 1-3 hours Newbie friendliness 65/100
Maintainers usually reply within 1 day
-
bug
Difficulty 2/5 1-3 hours Newbie friendliness 65/100
plotly/plotly.js#7648 · 3 comments ·
Maintainers usually reply within 1 day
-
bug infrastructure P2
Difficulty 1/5 Under an hour Newbie friendliness 65/100
Maintainers usually reply within 1 day
All issues in plotly/plotly.js
Similar issues
-
Add: Digi 4K LogoOpencheck:passed logos:add
Difficulty 1/5 Under an hour Newbie friendliness 82/100
Maintainers usually reply within 1 day
-
component/administration domain/framework needs-triage Platform(Default) priority/low
Difficulty 2/5 1-3 hours Newbie friendliness 88/100
Maintainers usually reply within 1 day
-
Difficulty 1/5 Under an hour Newbie friendliness 90/100
semantic-release/gitlab#1032 ·
-
agent/guide documentation hive/hosted-available-lke648397-260827-5n31
Difficulty 1/5 Under an hour Newbie friendliness 92/100
Maintainers usually reply within 1 day
-
agentic-workflows
Difficulty 1/5 Under an hour Newbie friendliness 85/100
githubnext/gh-aw-workshop#3933 ·
Maintainers usually reply within 2 days