@snorreeb/google-maps-input v3.0.1-studio-v3.3
@sanity/google-maps-input
NOTE
This is the Sanity Studio v3 version of @sanity/google-maps-input.
For the v2 version, please refer to the v2-branch.
What is it?
Plugin for Sanity Studio providing input handlers for geo-related input types using Google Maps.
This plugin will replace the default geopoint
input component.
Installation
In your studio folder, run:
npm install --save @sanity/google-maps-input@studio-v3
or
yarn add @sanity/google-maps-input@studio-v3
Usage
Add it as a plugin in sanity.config.ts (or .js), with a valid Google Maps API key:
import { googleMapsInput } from "@sanity/google-maps-input";
export default createConfig({
// ...
plugins: [
googleMapsInput({
apiKey: "my-api-key"
})
]
})
Ensure that the key has access to:
- Google Maps JavaScript API
- Google Places API Web Service
- Google Static Maps API
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.
Stuck? Get help
Join Sanity’s developer community or ping us on twitter.
License
MIT-licensed. See LICENSE.
Develop & test
Make sure to run npm run build
once, then run
npm run link-watch
In another shell, cd
to your test studio and run:
npx yalc add @sanity/google-maps-input --link && yarn install
Now, changes in this repo will be automatically built and pushed to the studio, triggering hotreload. Yalc avoids issues with react-hooks that are typical when using yarn/npm link.
About build & watch
This plugin uses @sanity/plugin-sdk with default configuration for build & watch scripts.
2 years ago
2 years ago