Skip to content

Commit adeb425

Browse files
jordondjordond
committed
add starter documentation for autocomplete
1 parent 22e99e0 commit adeb425

File tree

7 files changed

+70
-17
lines changed

7 files changed

+70
-17
lines changed

Diff for: ‎docs/SUMMARY.md

+7
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,13 @@
2626
* [📱 Android / iOS](geolocation/android-ios.md)
2727
* [🖥️ Browser](geolocation/browser.md)
2828

29+
## Autocomplete
30+
31+
* [🔍 Autocomplete Overview](autocomplete/overview.md)
32+
* [🌎 Via Geocoding](autocomplete/via-geocoding.md)
33+
* [📱Android / iOS](autocomplete/geocoding/android-ios.md)
34+
* [📈 Web API Service](autocomplete/geocoding/web-api-service.md)
35+
2936
## Misc
3037

3138
* [📲 Demo](misc/demo.md)

Diff for: ‎docs/autocomplete/geocoding/android-ios.md

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
# 📱Android / iOS

Diff for: ‎docs/autocomplete/geocoding/web-api-service.md

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
# 📈 Web API Service

Diff for: ‎docs/autocomplete/overview.md

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
# 🔍 Overview

Diff for: ‎docs/autocomplete/via-geocoding.md

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
# 🌎 Via Geocoding

Diff for: ‎docs/roadmap.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -4,4 +4,4 @@ These items are in no particular order.
44

55
* Add support for different languages
66
* Currently only English is supported
7-
* Geolocation for browser
7+
* Autocomplete support from third party APIs like Google's Places API

Diff for: ‎docs/setup/add-dependencies.md

+58-16
Original file line numberDiff line numberDiff line change
@@ -36,14 +36,20 @@ dependencyResolutionManagement {
3636
compass = "1.0.0"
3737

3838
[libraries]
39-
compass-geocoder = { module = "dev.jordond.compass:compass-geocoder", version.ref = "compass" }
40-
compass-geocoder-mobile = { module = "dev.jordond.compass:compass-geocoder-mobile", version.ref = "compass" }
41-
compass-geocoder-web = { module = "dev.jordond.compass:compass-geocoder-web", version.ref = "compass" }
42-
compass-geocoder-web-googlemaps = { module = "dev.jordond.compass:compass-geocoder-web-googlemaps", version.ref = "compass" }
43-
compass-geocoder-web-mapbox = { module = "dev.jordond.compass:compass-geocoder-web-mapbox", version.ref = "compass" }
44-
compass-geolocation = { module = "dev.jordond.compass:compass-geolocation", version.ref = "compass" }
45-
compass-geolocation-mobile = { module = "dev.jordond.compass:compass-geolocation-mobile", version.ref = "compass" }
46-
compass-geolocation-browser = { module = "dev.jordond.compass:compass-geolocation-browser", version.ref = "compass" }
39+
compass-autocomplete = { module = "dev.jordond.compass:autocomplete", version.ref = "compass" }
40+
compass-autocomplete-mobile = { module = "dev.jordond.compass:autocomplete-mobile", version.ref = "compass" }
41+
compass-autocomplete-web = { module = "dev.jordond.compass:autocomplete-web", version.ref = "compass" }
42+
compass-autocomplete-geocoder-googlemaps = { module = "dev.jordond.compass:autocomplete-geocoder-googlemaps", version.ref = "compass" }
43+
compass-autocomplete-geocoder-mapbox = { module = "dev.jordond.compass:autocomplete-geocoder-mapbox", version.ref = "compass" }
44+
compass-geocoder = { module = "dev.jordond.compass:geocoder", version.ref = "compass" }
45+
compass-geocoder-mobile = { module = "dev.jordond.compass:geocoder-mobile", version.ref = "compass" }
46+
compass-geocoder-web = { module = "dev.jordond.compass:geocoder-web", version.ref = "compass" }
47+
compass-geocoder-web-googlemaps = { module = "dev.jordond.compass:geocoder-web-googlemaps", version.ref = "compass" }
48+
compass-geocoder-web-mapbox = { module = "dev.jordond.compass:geocoder-web-mapbox", version.ref = "compass" }
49+
compass-geolocation = { module = "dev.jordond.compass:geolocation", version.ref = "compass" }
50+
compass-geolocation-mobile = { module = "dev.jordond.compass:geolocation-mobile", version.ref = "compass" }
51+
compass-geolocation-browser = { module = "dev.jordond.compass:geolocation-browser", version.ref = "compass" }
52+
compass-permissions-mobile = { module = "dev.jordond.compass:permissions-mobile", version.ref = "compass" }
4753
```
4854
{% endcode %}
4955

@@ -72,12 +78,30 @@ kotlin {
7278

7379
// Geolocation
7480
implementation(libs.compass.geolocation)
81+
82+
// To use geolocation you need to use one or more of the following
7583

7684
// Optional - Geolocation support for only iOS and Android
7785
implementation(libs.compass.geolocation.mobile)
7886

7987
// Optional - Geolocation support for JS/WASM Browser Geolocation API
8088
implementation(libs.compass.geolocation.browser)
89+
90+
// Autocomplete
91+
implementation(libs.compass.autocomplete)
92+
93+
// Optional - Autocomplete support for only iOS and Android using native Geocoder
94+
implementation(libs.compass.autocomplete.mobile)
95+
96+
// Optional - Autocomplete support for all platforms, using services Geocoder APIs
97+
implementation(libs.compass.autocomplete.geocoder.googlemaps)
98+
implementation(libs.compass.autocomplete.geocoder.mapbox)
99+
100+
// Optional - If you want to create your own geocoder implementation
101+
implementation(libs.compass.autocomplete.web)
102+
103+
// Optional - Location permissions for mobile
104+
implementation(libs.compass.permissions.mobile)
81105
}
82106
}
83107
}
@@ -95,28 +119,46 @@ kotlin {
95119
val compassVersion = "1.0.0"
96120

97121
// Geocoding
98-
implementation("dev.jordond.compass:compass-geocoder:$compassVersion")
122+
implementation("dev.jordond.compass:geocoder:$compassVersion")
99123

100124
// To use geocoding you need to use one or more of the following
101125

102126
// Optional - Geocoder support for only iOS and Android
103-
implementation("dev.jordond.compass:compass-geocoder-mobile:$compassVersion")
127+
implementation("dev.jordond.compass:geocoder-mobile:$compassVersion")
104128

105129
// Optional - Geocoder support for all platforms, but requires an API key from the service
106-
implementation("dev.jordond.compass:compass-geocoder-web-googlemaps:$compassVersion")
107-
implementation("dev.jordond.compass:compass-geocoder-web-mapbox:$compassVersion")
130+
implementation("dev.jordond.compass:geocoder-web-googlemaps:$compassVersion")
131+
implementation("dev.jordond.compass:geocoder-web-mapbox:$compassVersion")
108132

109133
// Optional - If you want to create your own geocoder implementation
110-
implementation("dev.jordond.compass:compass-geocoder-web:$compassVersion")
134+
implementation("dev.jordond.compass:geocoder-web:$compassVersion")
111135

112136
// Geolocation
113-
implementation("dev.jordond.compass:compass-geolocation:$compassVersion")
137+
implementation("dev.jordond.compass:geolocation:$compassVersion")
138+
139+
// To use geolocation you need to use one or more of the following
114140

115141
// Optional - Geolocation support for only iOS and Android
116-
implementation("dev.jordond.compass:compass-geolocation-mobile:$compassVersion")
142+
implementation("dev.jordond.compass:geolocation-mobile:$compassVersion")
117143

118144
// Optional - Geolocation support for JS/WASM Browser Geolocation API
119-
implementation("dev.jordond.compass:compass-geolocation-browser:$compassVersion")
145+
implementation("dev.jordond.compass:geolocation-browser:$compassVersion")
146+
147+
// Autocomplete
148+
implementation("dev.jordond.compass:autocomplete:$compassVersion")
149+
150+
// Optional - Autocomplete support for only iOS and Android using native Geocoder
151+
implementation("dev.jordond.compass:autocomplete-mobile:$compassVersion")
152+
153+
// Optional - Autocomplete support for all platforms, using services Geocoder APIs
154+
implementation("dev.jordond.compass:autocomplete-geocoder-googlemaps:$compassVersion")
155+
implementation("dev.jordond.compass:autocomplete-geocoder-mapbox:$compassVersion")
156+
157+
// Optional - If you want to create your own geocoder implementation
158+
implementation("dev.jordond.compass:autocomplete-web:$compassVersion")
159+
160+
// Optional - Location permissions for mobile (Android/iOS)
161+
implementation("dev.jordond.compass:permissions-mobile:$compassVersion")
120162
}
121163
}
122164
}

0 commit comments

Comments
 (0)