Go Headless

Build Apps

Client

API Preview

Ricos

Develop Websites

REST

Velo

GraphQL (Alpha)

wix-mobile

Wix Mobile 1 0 0

# 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

Creates and opens a list of selectable actions on a mobile app.

![developer preview tag](https://user-images.githubusercontent.com/89579857/213133550-2b4fa3e8-e8fc-4513-a733-00abcc70925c.png)  

This method displays an action sheet to the app user. Action sheets are commonly used in app development to present a choice of actions for an app user to choose from. Typically, these actions are related to the current context.

 When an app user selects an action in the action sheet, `showActionSheet()` returns a promise that resolves to the action sheet's result.

showActionSheet

Creates and opens an alert modal on a 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. 

 You can customize the alert modal's title and message, and choose which actions an app user can take when the modal appears.

showAlert

Opens a file picker that allows an app user to upload media to the app's [media manager](https://support.wix.com/en/article/wix-media-about-the-media-manager).

![developer preview tag](https://user-images.githubusercontent.com/89579857/213133550-2b4fa3e8-e8fc-4513-a733-00abcc70925c.png) 

This method allows app users to select files or capture media from their camera to upload to the application. Files are uploaded to the app's media manager, which is shared across your app and site. 

 Customize the file picker to limit the maximum number of files that can be uploaded or where the app user can upload media from.

showFileUploadPicker

Displays an in-app notification.

![developer preview tag](https://user-images.githubusercontent.com/89579857/213133550-2b4fa3e8-e8fc-4513-a733-00abcc70925c.png)  

Use in-app notifications to provide real-time updates and alerts without interrupting the app user's experience. In-app notifications are displayed at the top of the app, and are often used to inform app users of new information.

showInAppNotification

Displays a toast notification for a mobile app.

![developer preview tag](https://user-images.githubusercontent.com/89579857/213133550-2b4fa3e8-e8fc-4513-a733-00abcc70925c.png)  

Use toast notifications to provide app users with brief messages without interrupting the workflow. You can also choose to add an action button that the user can press. For example, "Undo".

Toast notifications are often used to confirm actions or inform app users of new information.

showToastNotification

# 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 App Framework API contains functionality for working with a mobile app.

 To use the Wix App Framework API, import `appFramework` from `wix-mobile` module:

   ```javascript
   import { appFramework } from 'wix-mobile';
   ```

AppFramework

Actions

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

AlertResult

Unique key for identifying the selected action.

string

ActionSheetActions

subtitle

title

Type of action. The supported values are found in the `ActionSheetActionsType` property in `appFramework`. Supported values:
- `appFramework.ActionSheetActionTypes.DEFAULT`: Standard options styled in a neutral way.
- `appFramework.ActionSheetActionTypes.PROMINENT`: Typically used for the most important option. It is styled to stand out visually.
- `appFramework.ActionSheetActionTypes.DESTRUCTIVE`: Typically used for options that may cause significant changes, such as "delete". Only one action can be `destructive`.
- `appFramework.ActionSheetActionTypes.CANCEL`: Used to dismiss the action sheet without selecting an action.

Default: `appFramework.ActionSheetActionTypes.DEFAULT`

type

ActionSheetResult

Key of the selected action. Only defined if `result` is `actionSelected`.

actionKey

Supported values:
- `actionSelected`: The app user selected an action. 
- `dismissed`: The notification was dismissed by the app user swiping it.

result

File

fileType

name

sizeInBytes

number

Wix media URL. If the files isn't uploaded, this property is undefined.

FilePickerOptions

Maximum number of files that can be uploaded.

fileLimit

Whether to allow the app user to use the device's camera to provide files. If neither `showCamera` nor `showDeviceMedia` is defined as `true`, `showDeviceMedia` defaults to `true` and `showCamera` defaults to `false`.

showCamera

boolean

Whether to allow the app user to use the device's media to provide files. If neither `showCamera` nor `showDeviceMedia` is defined as `true`, `showDeviceMedia` defaults to `true` and `showCamera` defaults to `false`.

showDeviceMedia

HeaderOptions

InAppNotificationOptions

Wix Media URL of an [image](https://dev.wix.com/docs/velo/api-reference/$w/image/introduction) to display in the notification, cropped to a circle. If `image` and `avatarImage` are both defined, `image` is used.

avatarImage

Wix Media URL of an [image](https://dev.wix.com/docs/velo/api-reference/$w/image/introduction) to display in the notification. If `image` and `avatarImage` are both defined, `image` is used.

image

InAppNotificationResult

Supported values:
- `pressed`: The notification was pressed.
- `dismissed`: The notification was dismissed by the app user swiping it.

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

destructive

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'.

ToastNotificationResult

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

showActionSheet( )