Bump version to 2.1.1, update dependencies, and refactor PlaceAutocom…

…plete component; remove unused language and region props, adjust README for clarity
alexpechkarev · Nov 23, 2024 · 223f905 · 223f905
1 parent ee2aada
commit 223f905
Show file tree

Hide file tree

Showing 5 changed files with 323 additions and 448 deletions.
diff --git a/README.md b/README.md
@@ -42,15 +42,14 @@ npm i [email protected]
 
 ```svelte
 <script>
-	import { PlaceAutocomplete } from 'places-autocomplete-svelte';
+import { PlaceAutocomplete } from 'places-autocomplete-svelte';
 
-	const PUBLIC_GOOGLE_MAPS_API_KEY = '___YOUR_API_KEY___';
+const PUBLIC_GOOGLE_MAPS_API_KEY = '___YOUR_API_KEY___';
 
-	let fullResponse = $state('')
-	let onResponse = (response) => {
-		console.log(response)
-		fullResponse = response;
-	};
+let fullResponse = $state('')
+let onResponse = (response) => {
+	fullResponse = response;
+};
 </script>
 
 <PlaceAutocomplete  {onResponse} {PUBLIC_GOOGLE_MAPS_API_KEY} />
@@ -65,52 +64,52 @@ npm i [email protected]
 - `countries`: Use countries property to refine search by region
 - `placeholder`: Use the placeholder property to customize the input field's placeholder text.
 - `autocomplete`: Use to disable the HTML `<input>` autocomplete attribute. 
-- `requestParams` (autocomplete request):
-	- `language`: Use the language property to set the language of the autocomplete results.
-	- `region`: Use the region property to bias the results toward a particular region. If the countries array is provided the region will be used from the selected country.
-- `fetchFields`: Use to control the Place response 
+- `requestParams` (optional [AutocompleteRequest properties](https://developers.google.com/maps/documentation/javascript/reference/autocomplete-data#AutocompleteRequest) ):
+	- `language`: in which to return results. If ommited defaults to `en-GB`. [See details](https://developers.google.com/maps/documentation/javascript/reference/autocomplete-data#AutocompleteRequest.language)
+	- `region`: the [CLDR two-character format](https://developers.google.com/maps/documentation/javascript/reference/autocomplete-data#AutocompleteRequest). Defaults to `GB`. If the countries array is provided the coutries region overwrites the `region` value in `requestParams`.
+- `fetchFields`: Use to control the Place response. See [types](https://developers.google.com/maps/documentation/javascript/place-class-data-fields) for details. If omitted defaults to `['formattedAddress', 'addressComponents']`
 
 ```svelte
 <script>
-	// ... other imports
-
-	/**
-	 * @type array optional
-	 */
-	let countries = [
-		{ name: 'United Kingdom', region: 'GB'},
-		{ name: 'United States', region: 'US' }
-		// ... more countries
-	];
+// ... other imports
+
+/**
+ * @type array optional
+ */
+let countries = [
+	{ name: 'United Kingdom', region: 'GB'},
+	{ name: 'United States', region: 'US' }
+	// ... more countries
+];
+/**
+ * @type string optional
+ */
+const placeholder = 'Search...';
+/**
+ * @type string optional
+ * The <input> HTML autocomplete attribute.
+ * if ommited defaults to 'off'
+ * */ 
+const autocompete = 'off';
+/**
+ * @type object optional
+ * AutocompleteRequest properties
+ */
+const requestParams = {
 	/**
 	 * @type string optional
 	 */
-	const placeholder = 'Search...';
+	language : 'en-GB',
 	/**
 	 * @type string optional
-	 * The <input> HTML autocomplete attribute.
-	 * if ommited defaults to 'off'
-	 * */ 
-	const autocompete = 'off';
-	/**
-	 * @type object optional
-	 * List of accepted AutocompleteRequest properties
 	 */
-	const requestParams = {
-		/**
-		 * @type string optional
-		 */
-		language : 'en-GB',
-		/**
-		 * @type string optional
-		 */
-		region : 'GB',
-	}
+	region : 'GB',
+}
 
-	/**
-	 * @type array optional
-	 */
-	const fetchFields = ['formattedAddress', 'addressComponents'];
+/**
+ * @type array optional
+ */
+const fetchFields = ['formattedAddress', 'addressComponents'];
 </script>
 
 <PlaceAutocomplete 
@@ -124,11 +123,6 @@ npm i [email protected]
 
 ```
 
-- `region` code follows the [CLDR two-character format](https://developers.google.com/maps/documentation/javascript/reference/autocomplete-data#AutocompleteRequest). The selected country region overwrites the `region` value in `requestParams`
-- `language` in which to return results. If ommited defaults to the browser's language preference. [See details](https://developers.google.com/maps/documentation/javascript/reference/autocomplete-data#AutocompleteRequest.language)
-- `requestParams` list of accepted [AutocompleteRequest properties](https://developers.google.com/maps/documentation/javascript/reference/autocomplete-data#AutocompleteRequest)
-- `fetchFields` the [types](https://developers.google.com/maps/documentation/javascript/place-class-data-fields) of Place data to return when requesting place details. If omitted defaults to `['formattedAddress', 'addressComponents']`
-
 
 ## Component Properties
 | Property                 | Type                                       | Description                                                                                                                                                               | Required | Default Value                               |