docs: add section about extending plugin API#6397
Merged
chenjiahan merged 2 commits intomainfrom Oct 21, 2025
Merged
Conversation
✅ Deploy Preview for rsbuild ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR adds documentation for extending the Rsbuild plugin API by exposing custom methods from the Rsbuild instance to plugins. The documentation explains how to use rsbuild.expose() to share custom functionality and api.useExposed() to access it from within plugins.
- Adds new section "Extending the Plugin API" to plugin development documentation
- Provides code examples demonstrating the expose/useExposed pattern for sharing state and methods
- Includes both English and Chinese translations
Reviewed Changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| website/docs/zh/plugins/dev/index.mdx | Added Chinese documentation for extending plugin API with rsbuild.expose() and api.useExposed() |
| website/docs/en/plugins/dev/index.mdx | Added English documentation for extending plugin API with rsbuild.expose() and api.useExposed() |
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.

Summary
Add documentation for exposing custom methods to Rsbuild plugins using
rsbuild.expose()and accessing them viaapi.useExposed().Checklist