@sanity/google-maps-input 4.1.1 → 4.2.1

package/README.md

@@ -6,11 +6,11 @@
 
 Plugin for [Sanity Studio](https://www.sanity.io) providing input handlers for geo-related input types using Google Maps.
 
-This plugin will replace the default `geopoint` input component.
+This plugin will replace the default `geopoint` input component and adds support for `geopointRadius` fields with circle visualization.
 
 ![Google maps input](assets/google-maps-input.png)
 
-## Know issues in Studio V3
+## Known issues in Studio V3
 
 - Diff-preview is not implemented.
 
@@ -34,6 +34,9 @@ yarn add @sanity/google-maps-input
 
 Add it as a plugin in sanity.config.ts (or .js), with a valid [Google Maps API key](https://developers.google.com/maps/documentation/javascript/get-api-key):
 
+> [!WARNING]
+> This plugin will replace the default `geopoint` input component.
+
 ```js
 import {googleMapsInput} from '@sanity/google-maps-input'
 
@@ -55,7 +58,62 @@ Ensure that the key has access to:
 
 And that the key allows web-access from the Studio URL(s) you are using the plugin in.
 
-Note: This plugin will replace the default `geopoint` input component.
+### Configuration Options
+
+You can also configure additional options:
+
+```js
+import {googleMapsInput} from '@sanity/google-maps-input'
+
+export default defineConfig({
+  // ...
+  plugins: [
+    googleMapsInput({
+      apiKey: 'my-api-key',
+      defaultZoom: 8,
+      defaultRadiusZoom: 15, // zoom level for radius editing
+      defaultLocation: {lat: 59.91273, lng: 10.74609},
+      defaultRadius: 1000, // for geopointRadius fields
+    }),
+  ],
+})
+```
+
+### Field Types
+
+#### Basic Geopoint Field
+
+![Google maps input](assets/google-maps-input.png)
+
+```typescript
+// In your schema
+export default {
+  name: 'location',
+  title: 'Location',
+  type: 'geopoint',
+}
+```
+
+#### Geopoint Radius Field
+
+![Google maps input](assets/google-maps-radius-input.png)
+
+```typescript
+// In your schema
+export default {
+  name: 'serviceArea',
+  title: 'Service Area',
+  type: 'geopointRadius',
+}
+```
+
+The `geopointRadius` field type extends the basic geopoint with:
+
+- A radius property (in meters)
+- Visual circle overlay on the map
+- Editable radius input field
+- Draggable circle for radius adjustment
+- Enhanced diff visualization showing radius changes
 
 ## Stuck? Get help