Skip to content

docs(api): document toolbox feature extensions - #524

Open
DaZuiZui wants to merge 1 commit into
apache:masterfrom
DaZuiZui:codex/toolbox-feature-extension-docs
Open

docs(api): document toolbox feature extensions#524
DaZuiZui wants to merge 1 commit into
apache:masterfrom
DaZuiZui:codex/toolbox-feature-extension-docs

Conversation

@DaZuiZui

Copy link
Copy Markdown

Summary

Documents the toolbox-feature extension API introduced by apache/echarts#21709.

  • Adds English and Chinese API examples for registerToolboxFeature.
  • Documents the public ToolboxFeature and extension-installer types exported from echarts/core.
  • Clarifies that registration is opt-in per chart: it does not add a button to every chart, and the feature's show option controls whether the button is displayed.
  • Clarifies the difference between option-only my* custom tools and features registered by an extension package.

Validation

  • npm run build:site
  • npm run build

Both English and Chinese API/option documents were generated successfully.

Related implementation: apache/echarts#21709
Related feature request: apache/echarts#21693

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant