flutter_location 0.0.4

  • README.md
  • CHANGELOG.md
  • Example
  • Installing
  • Versions
  • 66

Flutter Location Plugin #

A Flutter plugin to provide native location.

WARN: This plugin was written in swift/kotlin to be able to use it, you should have create the project with:

    flutter create -i swift -a kotlin project_name

Getting Started #

For help getting started with Flutter, view our online documentation. For help on editing plugin code, view the documentation.

Add the dependency to your pubspec.yaml file.

dependencies:
  flutter_location: ^0.0.4

In order to be able to receive location information from an iOS device, you need to modify the Info.plist, and add:

<key>NSLocationWhenInUseUsageDescription</key>
<string>This message will be display to the user</string>

Then import the publin in your code:

import 'package:flutter_location/flutter_location.dart'; // Plugin
import 'package:flutter_location/permission.dart'; // Return type
import 'package:flutter_location/location.dart'; // Return type

Look into the example for utilisation, but a basic implementation can be done like this for a one time location:

Location _location;
Location _currentLocation;
@override
void initState() {
    super.initState();
    initLocation();
}
Future<void> initLocation() async {
    try {
      await _initLocation();
    } on PlatformException catch (e) {
      print('Location initialization errror: ${e.message}');
    }
}
Future<void> _initLocation() async {
    Permission locationPermission;
    //  FlutterLocation.permissionLevel can throw PlatformException
    locationPermission = await FlutterLocation.permissionLevel;
    if (locationPermission == Permission.NOT_DETERMINED) {
      // Waiting for the user to authorized or denied permission
      return await Future.delayed(_waitForUser, _initLocation);
    }
    if (locationPermission == Permission.DENIED || !mounted) {
      // nothing to do here
      return;
    }
    Location location = await FlutterLocation.location;
    setState(() => _location = location);
    FlutterLocation.onLocationChanged.listen(
      (location) {
        print('Current location changes to: $location');
        setState(() => _currentLocation = location);
      },
    );
}

For more examples checkout:

API #

MethodsDescription
Future<Permission> permissionLevelGet the level of permission the user has granted to the app (NOT_DETERMINED, DENIED, AUTHORIZED).
Future<Location> locationGet the location of the user.
Stream<Location> onLocationChangedGet the stream of the user's location.

Model #

Permission: #

  • NOT_DETERMINED: Permission not specified
  • DENIED: The user rejected the authorization
  • AUTHORIZED: The user granted permission to use location

Location { #

  • double latitude
  • double longitude
  • double accuracy, right now set it to horizontal accuracy
  • double altitude
  • double speed

0.0.1 #

Initial commit

0.0.2 #

Adds iOS support

0.0.3 #

Bug fixing

0.0.4 #

Now Location is a class instead of generic Map<String, double> Documentation is improved

example/README.md

flutter_location_example #

Demonstrates how to use the flutter_location plugin.

Getting Started #

For help getting started with Flutter, view our online documentation.

Use this package as a library

1. Depend on it

Add this to your package's pubspec.yaml file:


dependencies:
  flutter_location: ^0.0.4

2. Install it

You can install packages from the command line:

with Flutter:


$ flutter packages get

Alternatively, your editor might support flutter packages get. Check the docs for your editor to learn more.

3. Import it

Now in your Dart code, you can use:


import 'package:flutter_location/flutter_location.dart';
  
Version Uploaded Documentation Archive
0.0.6 Nov 1, 2018 Go to the documentation of flutter_location 0.0.6 Download flutter_location 0.0.6 archive
0.0.5 Nov 1, 2018 Go to the documentation of flutter_location 0.0.5 Download flutter_location 0.0.5 archive
0.0.4 Oct 27, 2018 Go to the documentation of flutter_location 0.0.4 Download flutter_location 0.0.4 archive
0.0.3 Oct 25, 2018 Go to the documentation of flutter_location 0.0.3 Download flutter_location 0.0.3 archive
0.0.2 Oct 25, 2018 Go to the documentation of flutter_location 0.0.2 Download flutter_location 0.0.2 archive
0.0.1 Oct 25, 2018 Go to the documentation of flutter_location 0.0.1 Download flutter_location 0.0.1 archive
Popularity:
Describes how popular the package is relative to other packages. [more]
44
Health:
Code health derived from static analysis. [more]
99
Maintenance:
Reflects how tidy and up-to-date the package is. [more]
70
Overall:
Weighted score of the above. [more]
66
Learn more about scoring.

We analyzed this package on Feb 14, 2019, and provided a score, details, and suggestions below. Analysis was completed with status completed using:

  • Dart: 2.1.0
  • pana: 0.12.13
  • Flutter: 1.2.0

Platforms

Detected platforms: Flutter

References Flutter, and has no conflicting libraries.

Health issues and suggestions

Document public APIs. (-1 points)

29 out of 29 API elements have no dartdoc comment.Providing good documentation for libraries, classes, functions, and other API elements improves code readability and helps developers find and use your API.

Maintenance suggestions

The package description is too short. (-20 points)

Add more detail to the description field of pubspec.yaml. Use 60 to 180 characters to describe the package, what it does, and its target use case.

Package is pre-v0.1 release. (-10 points)

While nothing is inherently wrong with versions of 0.0.*, it might mean that the author is still experimenting with the general direction of the API.

Dependencies

Package Constraint Resolved Available
Direct dependencies
Dart SDK >=2.0.0-dev.68.0 <3.0.0
flutter 0.0.0
Transitive dependencies
collection 1.14.11
meta 1.1.6 1.1.7
sky_engine 0.0.99
typed_data 1.1.6
vector_math 2.0.8