Component library for Android that uses Google Maps and returns a latitude, longitude and an address based on the location picked with the Activity provided.
Features | Download | Permissions | Usage | Localization | Customization | Tracking | Extra | Who Made This | Apps using Leku | Contribute | Bugs and Feedback | License
- Search by voice
- Search by text
- Geo Location by GPS, network
- Google Places (optional)
- Google Time Zone API (optional)
- Pick locations using "touch" gestures on the map
- Customization (Theme and layout)
- Events Tracking
- Multi-language support (English, Spanish and Vietnamese supported by default)
- RTL (Right-To-Left) layout support
minSdkVersion >= 21
Google Play Services = 18.1.0
AndroidX
Include the mavenCentral repository in your top build.gradle:
Enabled by default on AndroidStudio projects
allprojects {
mavenCentral()
}Include the dependency in your app build.gradle:
dependencies {
implementation 'com.adevinta.android:leku:11.1.4'
}Alternatively, if you are using a different version of Google Play Services and AndroidX use this instead:
implementation ('com.adevinta.android:leku:11.1.4') {
exclude group: 'com.google.android.gms'
exclude group: 'androidx.appcompat'
}If you find this issue:
Execution failed for task ':app:transformClassesWithMultidexlistForDebug'. com.android.build.api.transform.TransformException: Error while generating the main dex list: Error while merging dex archives: Program type already present: com.google.common.util.concurrent.ListenableFuture Learn how to resolve the issue at https://developer.android.com/studio/build/dependencies#duplicate_classes.
The workaround for this is:
// Add this to your app build.gradle file
configurations.all {
// this is a workaround for the issue:
// https://stackoverflow.com/questions/52521302/how-to-solve-program-type-already-present-com-google-common-util-concurrent-lis
exclude group: 'com.google.guava', module: 'listenablefuture'
}You must add the following permissions in order to use the Google Maps Android API:
-
android.permission.INTERNET Used by the API to download map tiles from Google Maps servers.
-
android.permission.ACCESS_NETWORK_STATE Allows the API to check the connection status in order to determine whether data can be downloaded.
The following permissions are not required to use Google Maps Android API v2, but are recommended.
-
android.permission.ACCESS_COARSE_LOCATION Allows the API to use WiFi or mobile cell data (or both) to determine the device's location. The API returns the location with an accuracy approximately equivalent to a city block.
-
android.permission.ACCESS_FINE_LOCATION Allows the API to determine as precise a location as possible from the available location providers, including the Global Positioning System (GPS) as well as WiFi and mobile cell data.
-
android.permission.WRITE_EXTERNAL_STORAGE Allows the API to cache map tile data in the device's external storage area.
<uses-permission android:name="android.permission.INTERNET" />
<uses-permission android:name="android.permission.ACCESS_NETWORK_STATE"/>
<uses-permission android:name="android.permission.WRITE_EXTERNAL_STORAGE"/>
<uses-permission android:name="android.permission.ACCESS_FINE_LOCATION" />
<uses-permission android:name="android.permission.ACCESS_COARSE_LOCATION" />
<uses-feature android:name="android.hardware.location.network" android:required="false" />
<uses-feature android:name="android.hardware.location.gps" android:required="false" />You must also explicitly declare that your app uses the android.hardware.location.network or android.hardware.location.gps hardware features if your app targets Android 5.0 (API level 21) or higher and uses the ACCESS_COARSE_LOCATION or ACCESS_FINE_LOCATION permission in order to receive location updates from the network or a GPS, respectively.
Note: It supports runtime permissions for Android 6 (Marshmallow). You don't need to do anything, it will ask for permissions if needed.
To use the LocationPickerActivity first you need to add these lines to your AndroidManifest file:
<activity
android:name="com.adevinta.leku.LocationPickerActivity"
android:label="@string/leku_title_activity_location_picker"
android:theme="@style/Theme.MaterialComponents.Light.NoActionBar"
android:windowSoftInputMode="adjustPan"
android:parentActivityName=".MainActivity">
<intent-filter>
<action android:name="android.intent.action.SEARCH" />
</intent-filter>
<meta-data android:name="android.app.searchable"
android:resource="@xml/leku_searchable" />
<meta-data
android:name="android.support.PARENT_ACTIVITY"
android:value=".MainActivity" />
</activity>Then you have setup the call to start this activity wherever you like, always as a ActivityResultLauncher. You can set a default location, search zone and other customizable parameters to load when you start the activity. You only need to use the Builder setters like:
val lekuActivityResultLauncher =
registerForActivityResult(ActivityResultContracts.StartActivityForResult()) { result: ActivityResult ->
if (result.resultCode == Activity.RESULT_OK) {
Log.d("RESULT****", "OK")
val latitude = data?.getDoubleExtra(LATITUDE, 0.0)
Log.d("LATITUDE****", latitude.toString())
val longitude = data?.getDoubleExtra(LONGITUDE, 0.0)
Log.d("LONGITUDE****", longitude.toString())
val address = data?.getStringExtra(LOCATION_ADDRESS)
Log.d("ADDRESS****", address.toString())
val postalcode = data?.getStringExtra(ZIPCODE)
Log.d("POSTALCODE****", postalcode.toString())
val bundle = data?.getBundleExtra(TRANSITION_BUNDLE)
Log.d("BUNDLE TEXT****", bundle?.getString("test").toString())
val fullAddress = data?.getParcelableExtra<Address>(ADDRESS)
if (fullAddress != null) {
Log.d("FULL ADDRESS****", fullAddress.toString())
}
val timeZoneId = data?.getStringExtra(TIME_ZONE_ID)
if (timeZoneId != null) {
Log.d("TIME ZONE ID****", timeZoneId)
}
val timeZoneDisplayName = data?.getStringExtra(TIME_ZONE_DISPLAY_NAME)
if (timeZoneDisplayName != null) {
Log.d("TIME ZONE NAME****", timeZoneDisplayName)
}
} else {
Log.d("RESULT****", "CANCELLED")
}
}
val activity = context as MainActivity
val locationPickerIntent = LocationPickerActivity.Builder(applicationContext)
.withLocation(41.4036299, 2.1743558)
.withGeolocApiKey("<PUT API KEY HERE>")
.withGooglePlacesApiKey("<PUT API KEY HERE>")
.withSearchZone("es_ES")
.withSearchZone(SearchZoneRect(LatLng(26.525467, -18.910366), LatLng(43.906271, 5.394197)))
.withDefaultLocaleSearchZone()
.shouldReturnOkOnBackPressed()
.withStreetHidden()
.withCityHidden()
.withZipCodeHidden()
.withSatelliteViewHidden()
.withGooglePlacesEnabled()
.withGoogleTimeZoneEnabled()
.withVoiceSearchHidden()
.withUnnamedRoadHidden()
.withSearchBarHidden()
.build()
activity.lekuActivityResultLauncher.launch(locationPickerIntent)That's all folks!
Leku now supports Google Places queries using the search box. If you want to enable it these are the steps you need to follow:
-
Enable Google Places API for Android on your google developer console.
-
Add the key to the location picker builder
val locationPickerIntent = LocationPickerActivity.Builder(context)
.withGooglePlacesApiKey("<PUT API KEY HERE>")If you set up the same credential for both APIs (Geo - Places) you don't need this step
And you are good to go. :)
If you would like to add more language translations the only thing you have to do is:
- Crate a new strings resource folder and file for your language like "/values-ru".
- Add all text translations for those strings:
<string name="leku_title_activity_location_picker">Location Picker</string>
<string name="leku_load_location_error">Something went wrong. Please try again.</string>
<string name="leku_no_search_results">There are no results for your search</string>
<string name="leku_unknown_location">unknown location</string>
<string name="leku_voice_search_promp">Search by voice…</string>
<string name="leku_voice_search_extra_language">en-EN</string>
<string name="leku_toolbar_action_voice_title">Voice</string>
<string name="leku_search_hint">Search</string>Note that you have the voice_search_extra_language that is used for the language of the voice recognition. Replace it with the allowed voice recognition locale for your language.
We encourage you to add these languages to this component, please fork this project and submit new languages with a PR. Thanks!
If you need to send and receive a param through the LocationPickerActivity you can do it. You only need to add an "Extra" param to the intent like:
locationPickerIntent.putExtra("test", "this is a test")And parse it on onActivityResult callback:
val bundle = data.getBundleExtra(LocationPickerActivity.TRANSITION_BUNDLE)
val test = bundle.getString("test")This library uses material components, so should use Theme.MaterialComponents or descendant in manifest.
<item name="colorPrimary">#E91E63</item>
<item name="colorPrimaryDark">#C51162</item>
<item name="colorAccent">#FBC02D</item>
<item name="colorControlActivated">#E91E63</item>
colorControlActivatedis used to colorize Street title, if not set, it uses colorAccent by default
If you need to change theme colors for new activity map, you can do it with the below keys:
<color name="leku_ic_close">#000000</color>
<color name="leku_ic_gps">#000000</color>
<color name="leku_ic_satellite">#000000</color>
<color name="leku_ic_maps">#000000</color>
<color name="leku_location_accept_button_bg">#000000</color>To customize map, use:
.withMapStyle(R.raw.map_style_retro)Theme creator here: https://mapstyle.withgoogle.com/
It's possible to hide or show some of the information shown after selecting a location. Using tha bundle parameter LocationPickerActivity.LAYOUTS_TO_HIDE you can change the visibility of the street, city or the zipcode.
intent.putExtra(LocationPickerActivity.LAYOUTS_TO_HIDE, "street|city|zipcode")
If you want to use the old Leku layout design you need to add this line to the builder:
val locationPickerIntent = LocationPickerActivity.Builder(context)
.withLegacyLayout()By default the search will be restricted to a zone determined by your default locale. If you want to force the search zone you can do it by adding this line with the locale preferred:
intent.putExtra(LocationPickerActivity.SEARCH_ZONE, "es_ES")If you want to force the search zone you can do it by adding this line with the lower left and upper right rect locations:
intent.putExtra(LocationPickerActivity.SEARCH_ZONE_RECT, SearchZoneRect(LatLng(26.525467, -18.910366), LatLng(43.906271, 5.394197)))If you want to be able to search with the default device locale, you can do it by adding this line:
intent.putExtra(LocationPickerActivity.SEARCH_ZONE_DEFAULT_LOCALE, true)Note: If you don't specify any search zone it will not search using any default search zone. It will search on all around the world.
If you want to force that when the user clicks on back button it returns the location you can use this parameter (note: is only enabled if you don't provide a location):
intent.putExtra(LocationPickerActivity.BACK_PRESSED_RETURN_OK, true)If you want to disable the satellite view button you can use this parameter (note: the satellite view is enabled by default):
intent.putExtra(LocationPickerActivity.ENABLE_SATELLITE_VIEW, false)If you want to disable asking for location permissions (and prevent any location requests)
intent.putExtra(LocationPickerActivity.ENABLE_LOCATION_PERMISSION_REQUEST, false)Now you can hide the voice search option on the search view
intent.putExtra(LocationPickerActivity.ENABLE_VOICE_SEARCH, false)Now you can hide or show the text returned by the google service with "Unnamed Road" when no road name available
intent.putExtra(LocationPickerActivity.UNNAMED_ROAD_VISIBILITY, false)Now you can hide or show the search bar that helps you to search for locations
intent.putExtra(LocationPickerActivity.SEARCH_BAR_HIDDEN, false)You can define your custom autocomplete results adapter.
class SearchViewHolder(
val textView: TextView,
) : LekuViewHolder(textView)
class CustomLocationsAdapter : SuggestSearchAdapter<SearchViewHolder>() {
override fun onCreateViewHolder(
parent: ViewGroup,
viewType: Int
): SearchViewHolder {
val view = LayoutInflater
.from(parent.context)
.inflate(
R.layout.leku_search_list_item,
parent,
false
) as TextView
return SearchViewHolder(view)
}
override fun onBindViewHolder(holder: SearchViewHolder, position: Int) {
super.onBindViewHolder(holder, position)
holder.textView.text = items[position].description
}
}val locationPickerIntent = LocationPickerActivity.Builder(context)
...
.withAdapter(CustomLocationsAdapter())
.build(requireContext())You can define your custom data source. By default there are 2 DataSources which ask for information based on the user input, but you can add a third one.
Leku will priories your data source looking for information. If no result is provided, Leku data sources will complete the information.
This implementation shows how to only implement the Place API resolution. You can omit your repository from performing any query by returning
nulloremptyList().
class LocationDataSource(val locationRepository: LocationRepository) : GeocoderDataSourceInterface {
override suspend fun autoCompleteFromLocationName(query: String): List<PlaceSuggestion> {
return locationRepository.autoComplete(query)
}
override suspend fun getAddressFromPlaceId(placeId: String): Address? = try {
locationRepository.geocode(placeId)
} catch (e: Exception) {
null
}
override suspend fun getFromLocation(latitude: Double, longitude: Double): List<Address> {
return emptyList()
}
override suspend fun getFromLocationName(query: String): List<Address> {
return emptyList()
}
override suspend fun getFromLocationName(
query: String,
lowerLeft: LatLng,
upperRight: LatLng
): List<Address> {
return emptyList()
}
}val locationPickerIntent = LocationPickerActivity.Builder(context)
...
.withDataSource(LocationDataSource(myLocationRepository))
.build(requireContext())Optionally, you can set a tracking events listener. Implement LocationPickerTracker interface, and set it in your Application class as follows:
LocationPicker.tracker = <<YourOwnTracker implementing LocationPickerTracker>>()Available tracking events are:
| TAG | Message |
|---|---|
| GOOGLE_API_CONNECTION_FAILED | Connection Failed |
| START_VOICE_RECOGNITION_ACTIVITY_FAILED | Start Voice Recognition Activity Failed |
| ON_LOAD_LOCATION_PICKER | Location Picker |
| ON_SEARCH_LOCATIONS | Click on search for locations |
| ON_LOCALIZED_ME | Click on localize me |
| ON_LOCALIZED_BY_POI | Long click on map |
| SIMPLE_ON_LOCALIZE_BY_POI | Click on map |
| SIMPLE_ON_LOCALIZE_BY_LEKU_POI | Click on POI |
| RESULT_OK | Return location |
| CANCEL | Return without location |
In few cases, the geocoding service from Android fails due to an issue with the NetworkLocator. The only way of fixing this is rebooting the device.
In order to cover these cases, you can instruct Leku to use the Geocoding API. To enable it, just use the method '''withGeolocApiKey''' when invoking the LocationPicker.
You should provide your Server Key as parameter. Keep in mind that the free tier only allows 2,500 requests per day. You can track how many times is it used in the Developer Console from Google.
If you would like to use the Geocoder presenter (MVP) used for this use case you are free to use it! GeocoderPresenter has three methods:
-
getLastKnownLocation: Which obviously returns the last known user location as a Location object.
-
getFromLocationName(String query): Returns a List
<Address>for the text introduced. -
getFromLocationName(String query, LatLng lowerLeft, LatLng upperRight): Returns a List
<Address>for the text and the Rectangle introduced. -
getDebouncedFromLocationName(String query, int debounceTime): Returns a List
<Address>for the text introduced. Useful if you want to implement your own search view with auto-complete. -
getDebouncedFromLocationName(String query, LatLng lowerLeft, LatLng upperRight, int debounceTime): Returns a List
<Address>for the text and the Rectangle introduced. Useful if you want to implement your own search view with auto-complete. -
getInfoFromLocation(double latitude, double longitude): Returns a List
<Address>based on a latitude and a longitude.
To use it first you need to implement the GeocoderViewInterface interface in your class like:
class LocationPickerActivity : AppCompatActivity(), GeocoderViewInterface {Then you need to setup the presenter:
private val geocoderPresenter: GeocoderPresenter
override fun onCreate(savedInstanceState: Bundle?) {
super.onCreate(savedInstanceState)
***
val placesDataSource = GooglePlacesDataSource(Places.getGeoDataClient(this, null))
val geocoder = Geocoder(this, Locale.getDefault())
apiInteractor = GoogleGeocoderDataSource(NetworkClient(), AddressBuilder())
val geocoderRepository = GeocoderRepository(AndroidGeocoderDataSource(geocoder), apiInteractor!!)
val timeZoneDataSource = GoogleTimeZoneDataSource(
GeoApiContext.Builder().apiKey(GoogleTimeZoneDataSource.getApiKey(this)).build())
geocoderPresenter = GeocoderPresenter(
ReactiveLocationProvider(applicationContext), geocoderRepository, placesDataSource, timeZoneDataSource)
geocoderPresenter?.setUI(this)
***
}And besides filling the interface methods you have to add some things to your activity/fragment lifecycle to ensure that there are no leaks.
override fun onStart() {
super.onStart()
geocoderPresenter?.setUI(this)
}
override fun onStop() {
geocoderPresenter?.stop()
super.onStop()
}Note: If you need to execute the Espresso test you will need to add the Google Maps Key into the Tests AndroidManifest.xml
Now you have all you need. :)
Searching using the "SearchView" (geocoder) will be restricted to a zone if you are with a Locale from: US, UK, France, Italy and Spain. If not, the search will return results from all the world.
We provide a sample project which provides runnable code samples that demonstrate their use in Android applications. Note that you need to include your Google Play services key in the sample to be able to test it.
 |
|---|
| Ferran Pons |
 |
 |
 |
 |
 |
 |
|---|---|---|---|---|---|
| Diego Millán | Gerard Pedreny | Marc Serra | Sergio Castillo | Bernat Borras | Cristian García |
The following is a list of some of the public apps using Leku and are published on the Google Play Store.
Want to add your app? Found an app that no longer works or no longer uses Leku? Please submit a pull request on GitHub to update this page!
 |
 |
 |
|---|---|---|
| vibbo | Worksi | Domoticz |
- Create an issue to discuss about your idea
- [Fork it] (https://github.com/AdevintaSpain/leku/fork)
- Create your feature branch (
git checkout -b my-new-feature) - Commit your changes (
git commit -am 'Add some feature') - Push to the branch (
git push origin my-new-feature) - Create a new Pull Request
- Profit! ✅
For bugs, questions and discussions please use the Github Issues.
Copyright 2016-2023 Adevinta Spain S.L.
Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent