Practical use of scoped slots with GoogleMaps

Base Example

There are situations when you want the template inside the slot to be able to access data from the child component that is responsible for rendering the slot content. This is particularly useful when you need freedom in creating custom templates that use the child component’s data properties. That is a typical use case for scoped slots.

Imagine a component that configures and prepares an external API to be used in another component, but is not tightly coupled with any specific template. Such a component could then be reused in multiple places rendering different templates but using the same base object with specific API.

We’ll create a component (GoogleMapLoader.vue) that:

  • Initializes the Google Maps API
  • Creates google and map objects
  • Exposes those objects to the parent component in which the GoogleMapLoader is usedBelow is an example of how this can be achieved. We will analyze the code piece-by-piece and see what is actually happening in the next section.

Let’s first establish our GoogleMapLoader.vue template:

  1. <template>
  2.   <div>
  3.     <div class="google-map" ref="googleMap"></div>
  4.     <template v-if="Boolean(this.google) && Boolean(this.map)">
  5.       <slot
  6.         :google="google"
  7.         :map="map"
  8.       />
  9.     </template>
  10.   </div>
  11. </template>

Now, our script needs to pass some props to the component which allows us to set the Google Maps API and Map object:

  1. import GoogleMapsApiLoader from 'google-maps-api-loader'
  3. export default {
  4.   props: {
  5.     mapConfig: Object,
  6.     apiKey: String,
  7.   },
  9.   data() {
  10.     return {
  11.       google: null,
  12.       map: null
  13.     }
  14.   },
  16.   async mounted() {
  17.     const googleMapApi = await GoogleMapsApiLoader({
  18.       apiKey: this.apiKey
  19.     })
  20.     this.google = googleMapApi
  21.     this.initializeMap()
  22.   },
  24.   methods: {
  25.     initializeMap() {
  26.       const mapContainer = this.$refs.googleMap
  27.       this.map = new this.google.maps.Map(
  28.         mapContainer, this.mapConfig
  29.       )
  30.     }
  31.   }
  32. }

This is just part of a working example, you can find the whole example in the Codesandbox below.

Real-World Example: Creating a Google Map Loader component

1. Create a component that initializes our map

GoogleMapLoader.vue

In the template, we create a container for the map which will be used to mount the Map object extracted from the Google Maps API.

  1. <template>
  2.   <div>
  3.     <div class="google-map" ref="googleMap"></div>
  4.   </div>
  5. </template>

Next up, our script needs to receive props from the parent component which will allow us to set the Google Map. Those props consist of:

  • mapConfig: Google Maps config object
  • apiKey: Our personal api key required by Google Maps
  1. import GoogleMapsApiLoader from 'google-maps-api-loader'
  3. export default {
  4.   props: {
  5.     mapConfig: Object,
  6.     apiKey: String,
  7.   },

Then, we set the initial values of google and map to null:

  1. data() {
  2.   return {
  3.     google: null,
  4.     map: null
  5.   }
  6. },

On mounted hook we instantiate a googleMapApi and Map objects from the GoogleMapsApi and we set the values of google and map to the created instances:

  1.   async mounted() {
  2.     const googleMapApi = await GoogleMapsApiLoader({
  3.       apiKey: this.apiKey
  4.     })
  5.     this.google = googleMapApi
  6.     this.initializeMap()
  7.   },
  9.   methods: {
  10.     initializeMap() {
  11.       const mapContainer = this.$refs.googleMap
  12.       this.map = new this.google.maps.Map(mapContainer, this.mapConfig)
  13.     }
  14.   }
  15. }

So far, so good. With all that done, we could continue adding the other objects to the map (Markers, Polylines, etc.) and use it as an ordinary map component.

But, we want to use our GoogleMapLoader component only as a loader that prepares the map — we don’t want to render anything on it.

To achieve that, we need to allow the parent component that will use our GoogleMapLoader to access this.google and this.map that are set inside the GoogleMapLoader component. That’s where scoped slots really shine. Scoped slots allow us to expose the properties set in a child component to the parent component. It may sound like Inception, but bear with me one more minute as we break that down further.

2. Create component that uses our initializer component.

TravelMap.vue

In the template, we render the GoogleMapLoader component and pass props that are required to initialize the map.

  1. <template>
  2.   <GoogleMapLoader
  3.     :mapConfig="mapConfig"
  4.     apiKey="yourApiKey"
  5.   />
  6. </template>

Our script tag will look like this:

  1. <script>
  2. import GoogleMapLoader from './GoogleMapLoader'
  3. import { mapSettings } from '@/constants/mapSettings'
  5. export default {
  6.   components: {
  7.     GoogleMapLoader
  8.   },
  10.   computed: {
  11.     mapConfig () {
  12.       return {
  13.         ...mapSettings,
  14.         center: { lat: 0, lng: 0 }
  15.       }
  16.     },
  17.   },
  18. }
  19. </script>

Still no scoped slots, so let’s add one.

3. Expose google and map properties to the parent component by adding a scoped slot.

Finally, we can add a scoped slot that will do the job and allow us to access the child component props in the parent component. We do that by adding the <slot> tag in the child component and passing the props that we want to expose (using v-bind directive or :propName shorthand). It does not differ from passing the props down to the child component, but doing it in the <slot> tag will reverse the direction of data flow.

GoogleMapLoader.vue

  1. <template>
  2.   <div>
  3.     <div class="google-map" ref="googleMap"></div>
  4.     <template v-if="Boolean(this.google) && Boolean(this.map)">
  5.       <slot
  6.         :google="google"
  7.         :map="map"
  8.       />
  9.     </template>
  10.   </div>
  11. </template>

Now, when we have the slot in the child component, we need to receive and consume the exposed props in the parent component.

4. Receive exposed props in the parent component using slot-scope attribute.

To receive the props in the parent component, we declare a template element and use the slot-scope attribute. This attribute has access to the object carrying all the props exposed from the child component. We can grab the whole object or we can de-structure that object and only what we need.

Let’s de-structure this thing to get what we need.

TravelMap.vue

  1. <GoogleMapLoader
  2.   :mapConfig="mapConfig"
  3.   apiKey="yourApiKey"
  4. >
  5.   <template slot-scope="{ google, map }">
  6.       {{ map }}
  7.       {{ google }}
  8.   </template>
  9. </GoogleMapLoader>

Even though the google and map props do not exist in the TravelMap scope, the component has access to them and we can use them in the template.

You might wonder why would we do things like that and what is the use of all that?

Scoped slots allow us to pass a template to the slot instead of a rendered element. It’s called a scoped slot because it will have access to certain child component data even though the template is rendered in the parent component scope. This gives us the freedom to fill the template with custom content from the parent component.

5. Create factory components for Markers and Polylines

Now when we have our map ready we will create two factory components that will be used to add elements to the TravelMap.

GoogleMapMarker.vue

  1. import { POINT_MARKER_ICON_CONFIG } from '@/constants/mapSettings'
  3. export default {
  4.   props: {
  5.     google: {
  6.       type: Object,
  7.       required: true
  8.     },
  9.     map: {
  10.       type: Object,
  11.       required: true
  12.     },
  13.     marker: {
  14.       type: Object,
  15.       required: true
  16.     }
  17.   },
  19.   mounted() {
  20.     new this.google.maps.Marker({
  21.       position: this.marker.position,
  22.       marker: this.marker,
  23.       map: this.map,
  24.       icon: POINT_MARKER_ICON_CONFIG
  25.     })
  26.   }
  27. }

GoogleMapLine.vue

  1. import { LINE_PATH_CONFIG } from '@/constants/mapSettings'
  3. export default {
  4.   props: {
  5.     google: {
  6.       type: Object,
  7.       required: true
  8.     },
  9.     map: {
  10.       type: Object,
  11.       required: true
  12.     },
  13.     path: {
  14.       type: Array,
  15.       required: true
  16.     }
  17.   },
  19.   mounted() {
  20.     new this.google.maps.Polyline({
  21.       path: this.path,
  22.       map: this.map,
  23.       ...LINE_PATH_CONFIG
  24.     })
  25.   }
  26. }

Both of these receive google that we use to extract the required object (Marker or Polyline) as well as map which gives as a reference to the map on which we want to place our element.

Each component also expects an extra prop to create a corresponding element. In this case, we have marker and path, respectively.

On the mounted hook, we create an element (Marker/Polyline) and attach it to our map by passing the map property to the object constructor.

There’s still one more step to go…

6. Add elements to map

Let’s use our factory components to add elements to our map. We must render the factory component and pass the google and map objects so data flows to the right places.

We also need to provide the data that’s required by the element itself. In our case, that’s the marker object with the position of the marker and the path object with Polyline coordinates.

Here we go, integrating the data points directly into the template:

  1. <GoogleMapLoader
  2.   :mapConfig="mapConfig"
  3.   apiKey="yourApiKey"
  4. >
  5.   <template slot-scope="{ google, map }">
  6.     <GoogleMapMarker
  7.       v-for="marker in markers"
  8.       :key="marker.id"
  9.       :marker="marker"
  10.       :google="google"
  11.       :map="map"
  12.     />
  13.     <GoogleMapLine
  14.       v-for="line in lines"
  15.       :key="line.id"
  16.       :path.sync="line.path"
  17.       :google="google"
  18.       :map="map"
  19.     />
  20.   </template>
  21. </GoogleMapLoader>

We need to import the required factory components in our script and set the data that will be passed to the markers and lines:

  1. import { mapSettings } from '@/constants/mapSettings'
  3. export default {
  4.   components: {
  5.     GoogleMapLoader,
  6.     GoogleMapMarker,
  7.     GoogleMapLine
  8.   },
  10.   data () {
  11.     return {
  12.       markers: [
  13.       { id: 'a', position: { lat: 3, lng: 101 } },
  14.       { id: 'b', position: { lat: 5, lng: 99 } },
  15.       { id: 'c', position: { lat: 6, lng: 97 } },
  16.       ],
  17.       lines: [
  18.         { id: '1', path: [{ lat: 3, lng: 101 }, { lat: 5, lng: 99 }] },
  19.         { id: '2', path: [{ lat: 5, lng: 99 }, { lat: 6, lng: 97 }] }
  20.       ],
  21.     }
  22.   },
  24.   computed: {
  25.     mapConfig () {
  26.       return {
  27.         ...mapSettings,
  28.         center: this.mapCenter
  29.       }
  30.     },
  32.     mapCenter () {
  33.       return this.markers[1].position
  34.     }
  35.   },
  36. }

When To Avoid This Pattern

It might be tempting to create a very complex solution based on the example, but at some point we can get to the situation where this abstraction becomes an independent part of the code living in our codebase. If we get to that point it might be worth considering extraction to an add-on.

Wrapping Up

That’s it. With all those bits and pieces created we can now re-use the GoogleMapLoader component as a base for all our maps by passing different templates to each one of them. Imagine that you need to create another map with different Markers or just Markers without Polylines. By using the above pattern it becomes very easy as we just need to pass different content to the GoogleMapLoader component.

This pattern is not strictly connected to Google Maps; it can be used with any library to set the base component and expose the library’s API that might be then used in the component that summoned the base component.