{"id":18909855,"url":"https://github.com/map-ir/mapir-flutter-map-sdk","last_synced_at":"2025-10-14T04:26:35.855Z","repository":{"id":56834410,"uuid":"231224521","full_name":"map-ir/mapir-flutter-map-sdk","owner":"map-ir","description":"Map.ir Flutter plugin for interactive map based on Mapbox-GL","archived":false,"fork":false,"pushed_at":"2020-01-04T07:02:45.000Z","size":815,"stargazers_count":5,"open_issues_count":6,"forks_count":2,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-03-28T17:06:51.878Z","etag":null,"topics":["dart","flutter","flutter-plugin","map","mapir"],"latest_commit_sha":null,"homepage":"https://support.map.ir/developers/flutter/","language":"Dart","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/map-ir.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2020-01-01T14:13:17.000Z","updated_at":"2023-07-30T12:49:55.000Z","dependencies_parsed_at":"2022-09-05T03:00:53.505Z","dependency_job_id":null,"html_url":"https://github.com/map-ir/mapir-flutter-map-sdk","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/map-ir%2Fmapir-flutter-map-sdk","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/map-ir%2Fmapir-flutter-map-sdk/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/map-ir%2Fmapir-flutter-map-sdk/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/map-ir%2Fmapir-flutter-map-sdk/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/map-ir","download_url":"https://codeload.github.com/map-ir/mapir-flutter-map-sdk/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":249020644,"owners_count":21199592,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["dart","flutter","flutter-plugin","map","mapir"],"created_at":"2024-11-08T09:35:25.206Z","updated_at":"2025-10-14T04:26:30.793Z","avatar_url":"https://github.com/map-ir.png","language":"Dart","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Map.ir Flutter Plugin based on Mapbox GL\n\nThis Flutter plugin for [Map.ir Map SDKs](https://github.com/map-ir) enables\nembedded interactive and customizable vector maps inside a Flutter widget by embedding Android and iOS views.\n\n![screenshot.png](https://support.map.ir/wp-content/uploads/2020/01/FlutterBasicMapScreenShot-e1578121281391.jpg)\n\n## Install\nThis project is available on [pub.dartlang](https://pub.dartlang.org/packages/mapir_gl), follow the [instructions](https://flutter.dev/docs/development/packages-and-plugins/using-packages#adding-a-package-dependency-to-an-app) to integrate a package into your flutter application.\n\n### Running example app\n\n- Install [Flutter](https://flutter.io/get-started/) and validate its installation with `flutter doctor`\n- Clone this repository with `git clone git@github.com:map-ir/mapir-flutter-map-sdk.git`\n- Run the app with `cd mapir-flutter-map-sdk/example \u0026\u0026 flutter run`\n\n#### Mpair Access Token\n\nThis project uses Map.ir vector tiles, which requires a Map.ir account and an API key. Obtain a free access token on [Map.ir App Registration](https://corp.map.ir/registration).\n\n##### Android\nAdd Mapi.ir read token value in the application manifest ```android/app/src/main/AndroidManifest.xml:```\n\n```\u003cmanifest ...\n  \u003capplication ...\n    \u003cmeta-data android:name=\"ir.map.apikey\" android:value=\"YOUR_TOKEN_HERE\" /\u003e\n```\n\n#### iOS\nAdd these lines to your Info.plist\n\n```plist\n\u003ckey\u003eio.flutter.embedded_views_preview\u003c/key\u003e\n\u003ctrue/\u003e\n\u003ckey\u003eMapirAPIKey\u003c/key\u003e\n\u003cstring\u003eYOUR_TOKEN_HERE\u003c/string\u003e\n```\n\n## Supported API\n\n| Feature | Android | iOS |\n| ------ | ------ | ----- |\n| Style | :white_check_mark:   | :white_check_mark: |\n| Camera | :white_check_mark:   | :white_check_mark: |\n| Gesture | :white_check_mark:   | :white_check_mark: |\n| User Location | :white_check_mark: | :white_check_mark: |\n| Symbol | :white_check_mark:   | :white_check_mark: |\n| Circle | :white_check_mark:   | :white_check_mark: |\n| Line | :white_check_mark:   | :white_check_mark: |\n| Fill |   |  |\n\n## Offline Sideloading\n\nSupport for offline maps is available by *\"side loading\"* the required map tiles and including them in your `assets` folder.\n\n* Place the tiles.db file generated in step one in your assets directory and add a reference to it in your `pubspec.yml` file.\n\n```\n   assets:\n     - assets/cache.db\n```\n\n* Call `installOfflineMapTiles` when your application starts to copy your tiles into the location where Mapbox can access them.  **NOTE:** This method should be called **before** the Map widget is loaded to prevent collisions when copying the files into place.\n \n```\n    try {\n      await installOfflineMapTiles(join(\"assets\", \"cache.db\"));\n    } catch (err) {\n      print(err);\n    }\n```\n\n## Documentation\n\nPlease visit [Map.ir Support](https://support.map.ir/developers/flutter/) for this flutter plugin, [iOS Maps SDK docs](https://support.map.ir/developers/ios/) and [Android Maps SDK docs](https://support.map.ir/developers/android/) for more info about native SDKs.\n\nVisit [mapbox.com/android-docs](https://www.mapbox.com/android-docs/) if you'd like more information about the Mapbox Maps SDK for Android and [mapbox.com/ios-sdk](https://www.mapbox.com/ios-sdk/) for more information about the Mapbox Maps SDK for iOS.\n\n## Getting Help\n\n- **Need help with your code?**: Look for previous questions on the [#mapbox tag](https://stackoverflow.com/questions/tagged/mapbox+android) — or [ask a new question](https://stackoverflow.com/questions/tagged/mapbox+android).\n- **Have a bug to report?** [Open an issue](https://github.com/map-ir/mapir-flutter-map-sdk/issues/new). If possible, include a full log and information which shows the issue.\n- **Have a feature request?** [Open an issue](https://github.com/map-ir/mapir-flutter-map-sdk/issues/new). Tell us what the feature should do and why you want the feature.\n\n## Sample code\n\n[This repository's example library](https://github.com/map-ir/mapir-flutter-map-sdk/tree/master/example/lib) is currently the best place for you to find reference code for this project. See other samples at [Flutter docs](https://support.map.ir/developers/flutter/examples).\n\n\u003c!--\n## Contributing\n\nWe welcome contributions to this repository!\n\nIf you're interested in helping build this Mapbox/Flutter integration, please read [the contribution guide](https://github.com/tobrun/flutter-mapbox-gl/blob/master/CONTRIBUTING.md) to learn how to get started.\n--\u003e\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmap-ir%2Fmapir-flutter-map-sdk","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmap-ir%2Fmapir-flutter-map-sdk","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmap-ir%2Fmapir-flutter-map-sdk/lists"}