Conversation
This branch has not been deployed
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.
Description
Adds a
plugins.<PluginName>.disabledconfig option to prevent a native Capacitor plugin from being registered and loaded:The setting is read from the native
capacitor.config.jsongenerated bynpx cap sync.Bridge.registerPlugin()andBridge.registerPluginInstance()check the plugin configuration before creating aPluginHandle.CapacitorBridge.loadPlugin(type:)checks the configuration before loading, registering, and exporting the plugin to JavaScript.Change Type
Rationale / Problems Fixed
There is currently no runtime configuration mechanism to prevent an installed native plugin from loading. This makes it difficult to selectively disable a plugin while retaining it as a project dependency or while sharing configuration across builds.
disabledis intentionally separate fromenabled, because plugins such asCapacitorHttpandCapacitorCookiesalready useenabledwith plugin-specific behavior.Nothing changes unless
plugins.<PluginName>.disabledis set totrue. Plugins remain enabled by default.Tests or Reproductions
npm run build --workspace @capacitor/clicompletes successfully.plugins.<PluginName>.disabled.Platforms Affected
Notes / Comments
A disabled plugin is not registered, instantiated, loaded, or exported through the native bridge. Therefore, it is not exposed through native plugin headers and
Capacitor.isPluginAvailable('MyPlugin')returnsfalse.