docs: update plugin development guide #1421
Merged
Conversation
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
dpogue
reviewed
Jul 4, 2025
| @implementation Echo | ||
| ### Supporting Swift Package Manager (SPM) | ||
|
|
||
| Starting from Cordova-iOS 8 and greater, support for the Swift Package Manager (SPM) has been implemented. To start using SPM with your plugin, a `Package.swift` file will need to be created in the plugin's root directory and a couple of things needs to be set and made aware in the `plugin.xml`. |
There was a problem hiding this comment.
Should mention in here the package="swift" attribute in plugin.xml
| interface. If your plugin requires a great deal of processing or | ||
| requires a blocking call, you should use a background thread. For | ||
| example: | ||
| Plugin methods ordinarily execute in the same thread as the main interface. If your plugin requires a great deal of processing or requires a blocking call, you should use a background thread. |
There was a problem hiding this comment.
Worth mentioning that certain operations involving UI stuff (showing alerts, changing colours, etc.) can only run on the main thread
| For additional reference, see the following classes: | ||
|
|
||
| - [CDVPlugin.h][CDVPlugin.h] | ||
| - [CDVPlugin.m][CDVPlugin.m] |
There was a problem hiding this comment.
Would be nice to link to https://apache.github.io/cordova-ios/documentation/cordova/cdvplugin here
|
|
||
| ## CDVPluginResult Message Types | ||
|
|
||
| You can use `CDVPluginResult` to return a variety of result types back to the JavaScript callbacks, using class methods that follow this pattern: |
There was a problem hiding this comment.
Would be nice to link to https://apache.github.io/cordova-ios/documentation/cordova/cdvpluginresult around here
(and then also improve the comments in the ObjC code so that documentation is more useful)
dpogue
approved these changes
Jul 7, 2025
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.
Motivation, Context & Description
Update and improve the plugin development guide including the iOS portion of the guide.
Closes #974
Testing
n/a
Checklist
(platform)if this change only applies to one platform (e.g.(android))