# Kiosk

**What is the MapsIndoors Kiosk?**

Our MapsIndoors Kiosk is an extension of new features built on top of our [Map Template](https://docs.mapsindoors.com/products/fast-track-maptemplate) repository. It enables you to only in a few steps add the Kiosk mode to your solution, and in this guide we will walk you through how you can easily get started right away.

<figure><img src="https://2554025873-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FYZLXDaaclvaSK6Q7eigW%2Fuploads%2Fgit-blob-800c0816513671900d4ae2b8c8f44a702b14dd3d%2FKiosk%20GIF%20compress.gif?alt=media" alt=""><figcaption></figcaption></figure>

The MapsIndoors Kiosk builds on top of the design we have designed for Map Template. The kiosk is of course compatible with both Mapbox and Google Maps.\
With our Kiosk you can enable different features as you like to customize your Kiosk, through different Query Parameters.

In Kiosk mode the key features are:

* [UI design optimization for a Kiosk](#ui-design)
* [Directions](#directions)
* [QR code](#create-a-qr-code-to-share-directions)
* [On-screen Keyboard](#on-screen-keyboard)
* [Time-out](#timeout)

### **Enabling the kiosk mode**

In order to enable the Kiosk mode you can use query parameters and properties to configure your app.

A new property has now been added to the list, which is `kioskOriginLocationId`. This property enables the kiosk mode on the Map Template.

We have three simple ways to use the `kioskOriginLocationId` property, however it is important that the `kioskOriginLocationId` must belong to the correct solution (`apiKey`) in order to be displayed on the map.

#### Using query parameters:

```
https://map.mapsindoors.com/?apiKey=02c329e6777d431a88480a09&kioskOriginLocationId=b47a973a8450439598c0189c
```

#### Using the web component:

```
<mapsindoors-map
    api-key="02c329e6777d431a88480a09"
    kiosk-origin-location-id="b47a973a8450439598c0189c">
</mapsindoors-map>
```

#### Using the React component:

```
<MapsIndoorsMap
    apiKey="02c329e6777d431a88480a09"
    kioskOriginLocationId="b47a973a8450439598c0189c"/>
```

### **UI design optimization for a Kiosk** <a href="#ui-design" id="ui-design"></a>

With the kiosk mode enabled, your app will use our UI design for a Kiosk. Building upon the design of Map Template components, the MapsIndoors Kiosk delivers a seamless and intuitive user experience optimised the user of experience of interaction with a large screen Kiosk. The design is specifically crafted to ensure effortless navigation and interaction, even for individuals who may be unfamiliar with the technology.\
\
Specifically, **here are the additional UI components we've added:**

<figure><img src="https://2554025873-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FYZLXDaaclvaSK6Q7eigW%2Fuploads%2Fgit-blob-bd3f90375c3e679c92948bdf23429bf44554acc2%2FCleanShot%202024-03-12%20at%2012.51%201.png?alt=media" alt=""><figcaption><p>"Open information modal" button</p></figcaption></figure>

<figure><img src="https://2554025873-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FYZLXDaaclvaSK6Q7eigW%2Fuploads%2Fgit-blob-ef73f7817d7595b46d68de58721772e8c9e032ed%2FCleanShot%202024-03-12%20at%2012.50%203.png?alt=media" alt=""><figcaption><p>Information modal</p></figcaption></figure>

<figure><img src="https://2554025873-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FYZLXDaaclvaSK6Q7eigW%2Fuploads%2Fgit-blob-61b3b3366a93596840019838db5d1fa54ea2e906%2FCleanShot%202024-03-12%20at%2012.50%202.png?alt=media" alt=""><figcaption><p>On-screen keyboard and scroll buttons</p></figcaption></figure>

<div data-full-width="false"><figure><img src="https://2554025873-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FYZLXDaaclvaSK6Q7eigW%2Fuploads%2Fgit-blob-42333bfb4457e3b2c0e79ec810b253f6ef981273%2FCleanShot%202024-03-12%20at%2012.49%201.png?alt=media" alt=""><figcaption><p>"Scan QR" for directions button</p></figcaption></figure></div>

<div align="center" data-full-width="false"><figure><img src="https://2554025873-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FYZLXDaaclvaSK6Q7eigW%2Fuploads%2Fgit-blob-4388ce0587b50100ed758ba030c083302155614c%2FCleanShot%202024-03-12%20at%2012.50%201.png?alt=media" alt=""><figcaption><p>"Scan QR" modal</p></figcaption></figure></div>

### **Instant directions in Kiosk mode** <a href="#directions" id="directions"></a>

For a smooth user experience when interacting with the kiosk, you can now select any location on the map to instantly get directions.

<figure><img src="https://2554025873-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FYZLXDaaclvaSK6Q7eigW%2Fuploads%2Fgit-blob-c21279b758fec54a878012f9c4a5ccb722ac46e5%2Fdirections-next-step.gif?alt=media" alt=""><figcaption></figcaption></figure>

You can change the accessibility if needed, and you can also scan the QR code for an easier view of the route on your mobile device . The QR code feature is further described in this article.

### Reset view button

If you ever get lost while navigating your web app in kiosk mode, you can use the **Reset View** button located in the bottom-right corner of the map. This will smoothly pan the view back to the location specified by the `kioskOriginLocationId` property.

<figure><img src="https://2554025873-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FYZLXDaaclvaSK6Q7eigW%2Fuploads%2Fgit-blob-5cbf0e461e03257844c3a8ca3ccce37bf85da748%2FScreen%20Recording%202025-10-07%20at%2009.48.18.gif?alt=media" alt=""><figcaption></figcaption></figure>

### Create a QR code to share directions

What’s worse than being in a huge airport and not being able to remember, how to find your way to the gate?

No problem! We solved that by having a QR code functionality in your app.

When getting directions, you can now click on the `Scan QR code` button. All you need to do is take your phone, scan the QR code on the screen and open it up in your browser. That will open up the app on your phone, with the directions ready for you. Click `Go!` and you will be able to get the directions to your preferred route!

<figure><img src="https://2554025873-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FYZLXDaaclvaSK6Q7eigW%2Fuploads%2Fgit-blob-6c847f6194a85df1313bb98d9a8afd8366bba4df%2Fdirections-qr-code.gif?alt=media" alt=""><figcaption></figcaption></figure>

Read more about the QR code configuration [here](https://docs.mapsindoors.com/products/fast-track-maptemplate/kiosk/qr-code-configuration).

### **On-screen keyboard**

Is your kiosk screen missing a built in virtual keyboard? No worries, we’ve got you covered!

You can now set the `useKeyboard` boolean property to `true`, and a virtual keyboard will show up when interacting with the input fields.

Just like the `kioskOriginLocationId` property described above, the `useKeyboard` can be used as a URL parameter, as a property on the React component - or as an attribute on the web component.

```
https://map.mapsindoors.com/?apiKey=02c329e6777d431a88480a09&kioskOriginLocationId=b47a973a8450439598c0189c&useKeyboard=true
```

Simply click on the search field to display the virtual keyboard.

<figure><img src="https://2554025873-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FYZLXDaaclvaSK6Q7eigW%2Fuploads%2Fgit-blob-49ac484443544e889d225fd8c753c7bb93790b64%2Fimage.png?alt=media" alt=""><figcaption></figcaption></figure>

### **Timeout**

If you want the Kiosk to reset the map position and the UI elements to the initial state after some time of inactivity, use this property to specify inactivity in seconds before resetting.

```
https://map.mapsindoors.com/?apiKey=02c329e6777d431a88480a09&kioskOriginLocationId=b47a973a8450439598c0189c&timeout=10
```

<figure><img src="https://2554025873-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FYZLXDaaclvaSK6Q7eigW%2Fuploads%2Fgit-blob-52af60734435167c328679a971714a0f89ee140b%2Ftimeout.gif?alt=media" alt=""><figcaption></figcaption></figure>

### Information Modal

In the Kiosk you can add an information modal which is a modal that can contain any preferred content you would like to show on the location.

The info legend can be configured in the CMS by clicking on the location which you selected to be the `kioskOriginLocationId` and going to the `Custom Properties` section.

<figure><img src="https://2554025873-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FYZLXDaaclvaSK6Q7eigW%2Fuploads%2Fgit-blob-a68321026cf8469850e28fa823b39a47f4090e23%2Fimage.png?alt=media" alt=""><figcaption></figcaption></figure>

In order to add content on the legend info you need to use pre-defined custom properties: `1LegendHeading, 1LegendContent, 2LegendHeading, 2LegendContent etc` as keys and add a value that you want to be displayed in the legend. (i.e. title, phone number, opening hours, information about the kiosk etc)

<figure><img src="https://2554025873-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FYZLXDaaclvaSK6Q7eigW%2Fuploads%2Fgit-blob-dcca4108c34086c9081da7e0c6f96a9da70b6191%2Fimage.png?alt=media" alt=""><figcaption></figcaption></figure>

In the Kiosk the information modal button will be presented in on the left side of the search field, as shown below:

<figure><img src="https://2554025873-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FYZLXDaaclvaSK6Q7eigW%2Fuploads%2Fgit-blob-7633d9a15590a275311adf1dc3efa62231db7b01%2Fimage.png?alt=media" alt=""><figcaption></figcaption></figure>

Clicking on the information modal button will open up the modal containing all the information added above.

<figure><img src="https://2554025873-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FYZLXDaaclvaSK6Q7eigW%2Fuploads%2Fgit-blob-90679a0f976bc73ac47b1b3d3505bd8e425fbc92%2Fkiosk-legend.gif?alt=media" alt=""><figcaption></figcaption></figure>

### URL parameters in combinations with Kiosk mode

You can of course use any other combination of our URL parameters (listed [here](https://docs.mapsindoors.com/products/fast-track-maptemplate/configuration/query-parameters)) in combination with our Kiosk.

You can also use the `pitch`, `bearing` and `startZoomLevel` or any other properties you want to configure as the starting point of the Kiosk. Read more about all the properties here.

If you want your kiosk to be displayed in a different language than English, make sure you check out the language options listed on the link above, under the \`language\` query parameter. The currently supported languages are English, German, French, Danish, Italian, Spanish and Dutch.

You can find an example [here](https://map.mapsindoors.com/?apiKey=02c329e6777d431a88480a09\&kioskOriginLocationId=b47a973a8450439598c0189c\&useKeyboard=true\&pitch=50\&bearing=180\&timeout=10), of our own-pre-built web app with the Kiosk mode, pitch and bearing set to set the angle of our virtual Kiosk on the map.

**Minimum viewport dimensions**

*Please note:* The minimum viewport dimensions for the Kiosk are 1920px x 1080px.

###


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.mapsindoors.com/products/fast-track-maptemplate/kiosk.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
