Skip to content

Latest commit

 

History

History
204 lines (139 loc) · 9.11 KB

README.md

File metadata and controls

204 lines (139 loc) · 9.11 KB
Raw

Yandex Mapkit Light

Fork of yandex_mapkit library, but lightweight and more appropriate for the majority of the apps.

Made by Surf 🏄‍♂️🏄‍♂️🏄‍♂️

Build Status Pub Version Pub Likes Pub popularity Flutter Platform License: MIT

yandex mapkit logo

Overview

  • 🌍 Map overview - enables to view the map of the world, with which user can interact with any convenient way, usually in order to demonstrate the location of some place
  • 🏠 Custom map objects - enables for developers to add custom map objects in order to indicate some place on the map
  • 🎮 Convenient map controls - there is an API for straight-to-point map controls through the code - from zooming and moving to limiting user scroll and controlling the speed
  • 🍃 App bundle size reduction - noticeable app bundle size reduction comparing to projects with original package
  • ✨ Recommended for use if you don't need anything but basic map

Usage

Generate your API Key

Before you can use MapKit SDK in your application, you need the API key.

  1. Go to the Developer Dashboard.

  2. Log in to your Yandex account or create a new one.

  3. Click Connect APIs and choose MapKit Mobile SDK.

  4. Enter information about yourself and your project, select a pricing plan, and click Continue.

  5. After your API key is successfully created, it will be available in the API Interfaces → MapKit Mobile SDK tab.

Installation

Add yandex_mapkit_lite to your pubspec.yaml file:

dependencies:
  yandex_mapkit_lite: $currentVersion$

Setup for iOS

Specify your API key and locale in ios/Runner/AppDelegate.swift. It should be similar to the following

import UIKit
import Flutter
import YandexMapsMobile

@UIApplicationMain
@objc class AppDelegate: FlutterAppDelegate {
  override func application(
    _ application: UIApplication,
    didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey: Any]?
  ) -> Bool {
    YMKMapKit.setLocale("YOUR_LOCALE") // Your preferred language. Not required, defaults to system language
    YMKMapKit.setApiKey("YOUR_API_KEY") // Your generated API key
    GeneratedPluginRegistrant.register(with: self)
    return super.application(application, didFinishLaunchingWithOptions: launchOptions)
  }
}

Uncomment platform :ios, '9.0' in ios/Podfile and change to platform :ios, '12.0'

# Uncomment this line to define a global platform for your project
platform :ios, '12.0'

Setup for Android

Add dependency implementation 'com.yandex.android:maps.mobile:4.4.0-lite' to android/app/build.gradle

dependencies {
    implementation 'com.yandex.android:maps.mobile:4.4.0-lite'
}

Specify your API key and locale in your custom application class. If you don't have one the you can create it like so

android/app/src/main/.../MainApplication.java

import android.app.Application;

import com.yandex.mapkit.MapKitFactory;

public class MainApplication extends Application {
    @Override
    public void onCreate() {
        super.onCreate();
        MapKitFactory.setLocale("YOUR_LOCALE"); // Your preferred language. Not required, defaults to system language
        MapKitFactory.setApiKey("YOUR_API_KEY"); // Your generated API key
    }
}

android/app/src/main/.../MainApplication.kt

import android.app.Application

import com.yandex.mapkit.MapKitFactory

class MainApplication: Application() {
  override fun onCreate() {
    super.onCreate()
    MapKitFactory.setLocale("YOUR_LOCALE") // Your preferred language. Not required, defaults to system language
    MapKitFactory.setApiKey("YOUR_API_KEY") // Your generated API key
  }
}

In your android/app/src/main/AndroidManifest.xml Add necessary permissions:

<uses-permission android:name="android.permission.INTERNET"/>
<uses-permission android:name="android.permission.ACCESS_FINE_LOCATION" />

Comparison with the full version

It is recommended to take into account the drawbacks of this mapkit version.

For app bundle size optimization purposes, the original package was moved to lite version, so some functionality will not be included:

Full version Lite version
Map ✅ ✅
Traffic layer ✅ ✅
Offline maps ✅ ✅
Location manager ✅ ✅
User location layer ✅ ✅
Custom clusterization ❌ ✅ - see the example project
Search, hints, geocoding ✅ ❌ - consider using yandex_geocoder
Automobile, bicycle, and pedestrian routing ✅ ❌
Routing taking into account public transport ✅ ❌
Panorama display ✅ ❌

If your app needs functionality mentioned upper, that is not supported in lite version, consider using full version.

Issues

Minimal versions

There is OS version and platform restrictions for this package. The table for supported platforms and versions of their OS is presented lower:

Android iOS
Support SDK 21+ iOS 12+

Localizations

Mapkit can be used with one language only at the same time.

Due to native constraints after the application is launched language can't be changed.

Android

Example

Example project is soon to be refactored.

Hybrid Composition

By default android views are rendered using Hybrid Composition. In order to render the YandexMap widget on Android using Virtual Display (old composition), set [AndroidYandexMap.useAndroidViewSurface] to false before using YandexMap widget.

AndroidYandexMap.useAndroidViewSurface = false;

Terms of use

Disclaimer: This project uses Yandex Mapkit which belongs to Yandex. When using Mapkit refer to these terms of use.

Credits to Unact.

Contribute

To report your issues, submit them directly in the Issues section.

If you would like to contribute to the package (e.g. by improving the documentation, fixing a bug or adding a cool new feature), please read our contribution guide first and send us your pull request.

Your PRs are always welcome.

How to reach us

Please feel free to ask any questions about this package. Join our community chat on Telegram. We speak English and Russian. Telegram