Locus-Android
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.
See Wiki for more information and configuration!
Read blog here: The Legendary Task of Retrieving Location in Just 3 lines of code.
Features
- 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 Relation Dialog configuration
- Custom Permission Blocked Dialog configuration
IMPORTANT: Deprecation from v3.2.0
Text Customizations using Locus.configure{} block is deprecated in v3.2.0. That means rationaleText, rationaleTitle, blockedTitle, blockedText, resolutionTitle, and resolutionText are deprecated. Migration would be to customize/override them from strings.xml.
It is deprecated in v3.2.0 and will be removed completely in next release.
Before
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."
}
Now
strings.xml
<string name="locus_rationale_title">Rationale Titlestring>
<string name="locus_rationale_message">This is a rationale message.string>
<string name="locus_permission_blocked_title">Permission Blocked Titlestring>
<string name="locus_permission_blocked_message">This is a permission blocked message.string>
<string name="locus_location_resolution_title">Permission Resolution Titlestring>
<string name="locus_location_resolution_message">This is a permission resolution message.string>
checkout strings.xml.
Gradle Dependency
- Add the JitPack repository to your project's build.gradle file
allprojects {
repositories {
...
maven { url 'https://jitpack.io' }
}
}
- 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'
}
Usage
See Wiki on how to get started with Locus.
Pull Request
To generate a pull request, please consider following Pull Request Template.
Issues
To submit an issue, please check the Issue Template.
Code of Conduct
Contribution
You are most welcome to contribute to this project!
Please have a look at Contributing Guidelines, before contributing and proposing a change.
License
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.
ce
19 Feb 14, 2022
1.5k Dec 30, 2022
3 Jun 23, 2022
1 Feb 1, 2022
5 Dec 12, 2022
289 Nov 15, 2022
994 Dec 28, 2022
1 Jul 5, 2022
55 Dec 10, 2022
5 Nov 30, 2022
4 May 3, 2022
23 Nov 23, 2022
0 Oct 31, 2021
0 Dec 26, 2021
68 Nov 23, 2022
218 Dec 30, 2022
0 Jan 20, 2022
29 Dec 26, 2022
508 Jan 3, 2023