Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve Cordova Plugin documentation #2195

Closed
scriptPilot opened this issue Nov 20, 2019 · 6 comments
Closed

Improve Cordova Plugin documentation #2195

scriptPilot opened this issue Nov 20, 2019 · 6 comments

Comments

@scriptPilot
Copy link

I want to use a Cordova plugin for local badge updates. After reading the documentation, it's still not clear to me how to use the plugin properly in my Capacitor app.

Herewith I kindly ask to update the documentation accordingly and propose a solution.

@dotNetkow
Copy link
Contributor

Thanks for the feedback. In the docs, we have:

npm install cordova-plugin-name
npx cap sync

In this case, the plugin name is "cordova-plugin-badge" so you'd run:

npm install cordova-plugin-badge
npx cap sync

I'm honestly not sure how to make that more clear, but I'd love to know: do you have any suggestions?

@kodemi
Copy link

kodemi commented Nov 22, 2019

Maybe documentation could describe how to manually apply configuration by mapping between the plugin's plugin.xml and required settings on iOS and Android?

@dotNetkow
Copy link
Contributor

@kodemi yes, good catch. On the same page, we have this paragraph that directs you to exactly that.

@scriptPilot
Copy link
Author

@dotNetkow - Maybe I missed something. For me it's not clear how to use the plugin ... window.Cordova is undefined. Do you have an example somewhere?

@jcesarmobile
Copy link
Member

You use the plugin the same way you would use it in a Cordova project.

The plugin uses cordova, not Cordova, case matters.

@ionitron-bot
Copy link

ionitron-bot bot commented Nov 13, 2022

Thanks for the issue! This issue is being locked to prevent comments that are not relevant to the original issue. If this is still an issue with the latest version of Capacitor, please create a new issue and ensure the template is fully filled out.

@ionitron-bot ionitron-bot bot locked and limited conversation to collaborators Nov 13, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

No branches or pull requests

4 participants