address_search_text_field 1.3.5

An address search box that gets nearby addresses by typing a reference, returns an object with place primary data. The object can also find an address using coordinates.

Address Search Text Field

A text field that displays an address search box that finds a location by typing a reference and gets nearby addresses. Selecting the desired address returns an object with the latitude, longitude, and full address of the place. It uses location, geolocator, geocoder plugins.

Getting Started

To use this plugin, add address_search_text_field as a dependency in your pubspec.yaml file. For example:

dependencies:
  address_search_text_field: ^1.3.5

Android

NOTE: As plugins switched to the AndroidX version of the Android Support Libraries. This means you need to make sure your Android project is also upgraded to support AndroidX. Detailed instructions can be found here.

1. Add the following to your "gradle.properties" file:

android.useAndroidX=true
android.enableJetifier=true

2. Make sure you set the compileSdkVersion in your "android/app/build.gradle" file to 28:

android {
  compileSdkVersion 28

  ...
}

Permissions

Android

On Android you'll need to add either the ACCESS_COARSE_LOCATION or the ACCESS_FINE_LOCATION permission to your Android Manifest file (located under android/app/src/main). To do so add one of the following two lines as direct children of the <manifest> tag:

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

Also you should add internet permission

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

iOS

On iOS you'll need to add the NSLocationWhenInUseUsageDescription to your Info.plist file (located under ios/Runner) in order to access the device's location. Simply open your Info.plist file and add the following:

<key>NSLocationWhenInUseUsageDescription</key>
<string>Permission to get your location</string>

Usage

Import the package:

import 'package:address_search_text_field/address_search_text_field.dart';

NOTE: coordForRef parameter will set the first data in the list of found addresses to point in OnDone function if user select their reference like an address.

Widget addressSearchTextField = AddressSearchTextField(
  controller: TextEditingController(),
  decoration: InputDecoration(),
  style: TextStyle(),
  barrierDismissible: bool,
  country: String,
  city: String,
  hintText: String,
  noResultsText: String,
  exceptions: <String>[],
  coordForRef: bool,
  onDone: (AddressPoint point) {},
  onCleaned: () {},
);

Parameters	Description
controller	TextEditingController (optional)
decoration	InputDecoration (optional)
style	TextStyle (optional)
barrierDismissible	bool (optional)
country	String (Not Null) (required)
city	String (optional)
hintText	String (required)
noResultsText	String (required)
exceptions	List < String > (optional)
coordForRef	bool (optional)
onDone	Function(AddressPoint) (optional)
onCleaned	Function() (optional)

Widget addressSearchBox = AddressSearchBox(
  controller: TextEditingController(),
  country: String,
  city: String,
  hintText: String,
  noResultText: String,
  exceptions: <String>[],
  coordForRef: bool,
  onDone: (AddressPoint point) {},
  onCleaned: () {},
);

Parameters	Description
controller	TextEditingController (optional)
country	String (Not Null) (required)
city	String (optional)
hintText	String (required)
noResultsText	String (required)
exceptions	List < String > (optional)
coordForRef	bool (optional)
onDone	Function(AddressPoint) (optional)
onCleaned	Function() (optional)

At onDone function you get an AddressPoint object with confirmation if place has been found (in found method), full address and coordinates. Example

This plugin also has a LocationService class with an async static function called init to check and ask for location permissions, and a static variable called controller to use the Location Package methods anywhere in your code.

Example

() async => await LocationService.init();

LocationService.controller.getLocation();

Outcomes

onDone: (AddressPoint point) {
  print(point.toString());
}

There are three possible outcomes:

1. If no search has been performed then the object will have null values ​​in its address, latitude and longitude variables.
2. If a place has been found from the reference, all the variables will be initialized.
3. If the desired location has not been found and the reference entered by the user is selected, there will be no latitude and longitude values ​​and the address will be the user's reference since nothing was found.

License

MIT License