mapbox / mapbox-maps-flutter

Interactive, thoroughly customizable maps for Flutter powered by Mapbox Maps SDK
https://www.mapbox.com/mobile-maps-sdk
Other
279 stars 110 forks source link

[CONTRIBUTING] How to use pigeon to generate native code wrappers #208

Open srmncnk opened 1 year ago

srmncnk commented 1 year ago

I want to contribute by adding / exposing some additional functionality, already present in the native SDK but not exposed by the flutter wrapper.

Looking at the project, I understand that platform channel communication is done via pigeon. But I don't know how to generate the code (from .dart files or maybe .orig files?) to expose native functionality.

Please provide some documentation (or maybe just point me in the right direction here and I'll add the docs myself) on how to use pigeon, which files to use for the interface and which paths to use.

srmncnk commented 1 year ago

Maybe @yunikkk, @LjubiTech-Maxko or @kiryldz have some pointers?.

yunikkk commented 1 year ago

Hey @srmncnk, thanks for the suggestion! You are right about the pigeon use to generate the bindings. The setup is partially private at the moment (as we generate the pigeon templates themselves also), but we plan to expose it to enable community to add or enhance the bindings. No timeline for this however for now, we'll post the updates in the ticket when it's available.

srmncnk commented 1 year ago

@yunikkk Thanks for the update. Please mention it here when it becomes available. We're very interested in contributing.