Go Headless

Build Apps

Client

API Preview

Ricos

Develop Websites

REST

Velo

GraphQL (Alpha)

title

string

message

actions

Actions

Creates and opens an alert modal on your mobile app.

![developer preview tag](https://user-images.githubusercontent.com/89579857/213133550-2b4fa3e8-e8fc-4513-a733-00abcc70925c.png)  

 When an app user selects an action button in the alert modal, the `showAlert()` function returns a Promise that resolves to the alert's result. 

 Customize the alert modal's title and message, and choose which actions an app user can take when the modal appears.

import wixMobile from 'wix-mobile';

/* Sample title value: 'Save changes?'
 *
 * Sample message value: 'Your message has not been saved'
 *
 * Sample actions value:
 * {
 *   positive: {
 *     "label": "Save Now",
 *     "key": "save"
 *   },
 *   negative: {
 *     "label": "Discard",
 *     "key": "discard",
 *     "destructive": true
 *   },
 *   neutral: {
 *     "label": "Remind Me Later",
 *     "key": "remind"
 *   }
 * }
 */

wixMobile.showAlert(title, message, actions)
  .then((alertResult) => {
    const actionKey = alertResult.key;

    if (actionKey === 'remind') {
        console.log('REMIND ME LATER')
    }

    if (actionKey === 'discard') {
        console.log('DISCARD')
    }

    return alertResult;
  })
  .catch((error) => {
    console.error(error);
    // Handle the error
  });

/* Promise resolves to:
 * {
 *   "key" : "remind"
 * }
 */

Create and open an alert modal

showAlert

AlertResult

# Introduction
<blockquote class="important">

__Important:__
+ This API is only relevant for custom widgets in [Branded Apps](https://www.wix.com/app-builder).
+ Custom widgets are not yet available to all users. 
+ This API is in [Developer Preview](https://www.wix.com/velo/reference/api-overview/developer-preview) and is subject to change. 

</blockquote>


 The Wix Mobile API contains functionality for working with your mobile app.

 To use the Wix Mobile API, import `wixMobile` from `wix-mobile` module:

   ```javascript
   import wixMobile from 'wix-mobile';
   ```

velo_wix-mobile

negative

NegativeAction

Neutral alert action.  **Note:** This parameter only works if you use it in conjunction with both the `positive` and `negative` parameters.

neutral

NeutralAction

positive

PositiveAction

Unique key for identifying the selected action.

**For iOs only.** Whether the action is classified as destructive. If `true`, the app user should carefully consider whether to press the action button.

destructive

boolean

Unique key for identifying a negative action. For example, 'delete'.

The negative action button's label. For example, 'Delete'.

label

Unique key for identifying a neutral action. For example, 'later'.

The neutral action button's label. For example, 'Remind Me Later'.

Unique key for identifying a positive action. For example, 'save'.

The positive action button's label. For example, 'Save Now'.

showAlert( )