Confirm Location Action

A reference page in my new Starlight docs site.


The confirmLocation action prompts the user to confirm their location or make a selection related to location based product.

Useful for scenarios where you need the user to explicitly confirm their preferred location.

Basic Usage

  • To use the confirmLocation action, include it in your component configuration. For example:

    {
      {
          "type": "container",
          "className": "confirmLocation-container"
          "sections": {
              "pinIcn": {
                  "type": "image",
                  "url": "{{themeUrl}}/img/common/locationPinGray.svg",
                  "className": "pinIcon"
              },
              "locationTxt": {
                  "type": "container",
                  "sections": {
                      "title": {
                          "type": "text",
                          "text": "{{locationSuggestion.locationTitle}}",
                          "className": "locationTitle"
                      },
                      "subtitle": {
                          "type": "text",
                          "text": "{{locationSuggestion.locationSubTitle}}",
                          "className": "locationSubTitle"
                      }
                  },
                  "order": [
                      "title",
                      "subtitle"
                  ]
              }
          },
          "action": "confirmLocation"
       }
    }
    
  • In this example, the user will see the provided location suggestion (locationTitle text and locationSubTitle text) and can confirm their preferred location.