open-app-settings

Certain features, like location services, require user permissions to function properly. On both iOS and Android operating systems, users are prompted to grant these permissions the first time they are needed. However, if a user denies a permission request, especially on iOS, the app cannot prompt them again directly. For instance, if an iOS device user declines to grant location access when prompted, the system prevents the app from requesting that permission again. The only way to enable it afterward is for the user to manually go into their device’s settings and allow location access for the app.

The open-settings action makes this process easier and more intuitive. The action directs users to the app’s settings page, helping them quickly find and adjust permissions without manually navigating through their device settings.

Configuration options

Some properties are common to all actions, see Common action properties for a list and their configuration options.

Core structure

title

Provide the action button with a title, for example, Go to settings.

Other options

icon

Select an to display when the action is configured as the secondary button or in a header action.

isHidden

true hides the action button, false shows the action button. Default setting is false.

style

isDanger - Styles the action button in red or your brand's designated danger color.

  • isDisabled - Displays the action button as greyed out.

  • isPrimary - Styles the action button in blue or your brand's designated primary color.

  • isSecondary - Sets the action as a secondary button, accessible via the ellipsis. The icon property can be used when the action button is displayed as a secondary button.

Examples and code snippets

Open-app settings

This example shows how to set up the open-app-settings action for cases where the app doesn’t have the necessary permissions. Tapping the action button takes you to the device’s settings to grant the required permissions. Afterwards, you can return to the app and continue where you left off. The action is configured to appear when permissions are not granted and to hide once the necessary permissions are in place.

Open app settings
Open app settings
title: Open app settings
description: Use the device's location tracking permissions to show the location or a message. 
type: jig.default

children:
  - type: component.location
    instanceId: geofencing
    when: [email protected] = 'granted'
    options:
      viewPoint:
        address: [email protected][2].address
        zoomLevel: 12
        isFollowUserLocationEnabled: true
      markers:
        data: [email protected][2]
        item:
          type: component.marker-item
          options:
            radius:
              isEnabled: true
              value: 0.2
              unit: kilometers
              color: color12
            latitude: [email protected]
            longitude: [email protected]
            children:
              type: component.icon
              options:
                icon: [email protected]
                
  - type: component.entity
    options:
      children: 
        - type: component.entity-field
          options:
            label: Permission Status
            value: [email protected] 
        - type: component.entity-field
          options:
            label: Permission granted?
            value: [email protected]   
                       
placeholders:
  - title: You need to grant permissions in the device settings. 
    when: [email protected] = false
    icon: missing-data
# Add an action to open the device’s app settings,
# allowing the user to grant location permissions.
actions:
  - numberOfVisibleActions: 1
    children:
      - type: action.open-app-settings
        # Use the when property,
        # to execute the action if permissions are not granted.
        when: [email protected] = false
        options:
         # Hide the action when permissions are granted.
         isHidden: [email protected] = true
         title: Go to settings

Last updated

Was this helpful?