Locus is a tiny kotlin library for android which makes it super very easy to retrieve location with just few lines of code. Everything including permission model and Location settings resolution is handled internally which removes a lot of boilerplate code any developer have to write every time.
Its been a long time since I moved away from native Android development so I am finding it hard to keep up with the latest changes with the location
permissions in newever Android versions and fix issues reported here. I'd love someone to actively maintain this library and look into the issues. If you are interested and up to the task, drop a mail at [email protected] or comment on this issue. Thanks!
See Wiki for more information and configuration!
- Android R support (Please report if any issue is found)
- Completely written in Kotlin
- Easy Initialization
- Handles Permission Model
- No Boilerplate
- Built on Kotlin DSL
- Manifest Permission Check
- Life-Cycle Aware Location Updates
- Location Settings Check
- Location Settings Request
- Custom Location Options Configuration
- Custom Rationale Dialog configuration
- Custom Permission Blocked Dialog configuration
Text Customizations using
Locus.configure{}block which were deprecated inv3.2.0have been now removed completely. This meansrationaleText,rationaleTitle,blockedTitle,blockedText,resolutionTitle, andresolutionTextno longer exist onLocus.configure{}. Migration would be to customize/override them fromstrings.xml.
Locus.configure {
rationaleTitle = "Rationale Title"
rationaleTitle = "This is a rationale message."
blockedTitle = "Permission Blocked Title"
blockedText = "This is a permission blocked message."
resolutionTitle = "Permission Resolution Title"
resolutionText = "This is a permission resolution message."
}strings.xml
<string name="locus_rationale_title">Rationale Title</string>
<string name="locus_rationale_message">This is a rationale message.</string>
<string name="locus_permission_blocked_title">Permission Blocked Title</string>
<string name="locus_permission_blocked_message">This is a permission blocked message.</string>
<string name="locus_location_resolution_title">Permission Resolution Title</string>
<string name="locus_location_resolution_message">This is a permission resolution message.</string>
<string name="grant">Grant</string>
<string name="deny">Deny</string>checkout strings.xml.
It has been brought to my attention recently that this library includes background location permission in its AndroidManifest.xml file. This could cause a problem when publishing app on Google Play Store in a case where your does not actually request or use background location. If that happens then this is what you need to do.
Just add this line in your app's AndroidManifest.xml file and you should be good to go.
<uses-permission tools:node="remove" android:name="android.permission.ACCESS_BACKGROUND_LOCATION" />Feel free to re-open #53 issue or file a new one if this does not work for you.
- Add the JitPack repository.
For Classic Android Project:
Add this in your project's build.gradle file.
allprojects {
repositories {
...
maven { url 'https://jitpack.io' } // add this line only
}
}
For Compose Android Project:
Add this in your project's settings.gradle file.
dependencyResolutionManagement {
repositoriesMode.set(RepositoriesMode.FAIL_ON_PROJECT_REPOS)
repositories {
...
maven { url 'https://jitpack.io' } // add this line only
}
}
- Add the dependency in your app's build.gradle file
dependencies {
implementation 'com.github.BirjuVachhani:locus-android:latest-version'
implementation 'com.google.android.gms:play-services-location:latest-version'
}
See Wiki on how to get started with Locus.
This package adds background location permission to the manifest file regardless whether you are using it or not. If you are not requesting background location permission and you are not planning to use it in future, consider adding this line into your manifest file. This is only required when you publish your app to Google Playstore because they might reject your app because of this. See realted issue #53.
<uses-permission tools:node="remove" android:name="android.permission.ACCESS_BACKGROUND_LOCATION" />To generate a pull request, please consider following Pull Request Template.
To submit an issue, please check the Issue Template.
You are most welcome to contribute to this project!
Please have a look at Contributing Guidelines, before contributing and proposing a change.
Copyright © 2019 BirjuVachhani
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