Hey! These docs are for version 7.0, which is no longer officially supported. Click here for the latest version, 9.0!

The OneSignal Slide Prompt displays top-down center of the browser on desktop and bottom-up center on mobile. This is the most attention-grabbing prompt offered by OneSignal and is shown before the required Native Browser Prompt.

This prompt is used to gauge user interest and add [Data Tags](🔗). It cannot replace the [Native Browser Prompt](🔗). <br> <img src="https://files.readme.io/326a605-Slidedown-DesktopMobile.jpg" width="800"/>

  • _Desktop (Firefox/Chrome) and Android Chrome versions of Slide Prompt_

Quick ReferenceDetails
[Slide Prompt Customizations](🔗)Details on how the Slide Prompt works including: - [Add Slide Prompt Icon](🔗) - Text Customizations - [Add Category Tags](🔗) - [Triggering the Prompt](🔗)
[Typical Setup Slide Prompt](🔗)Only Typical Setup has the dashboard editor to setup the Slide Prompt and [Category Slidedown](🔗) prompt without additional code.
[WordPress Setup Slide Prompt](🔗)Slide Prompt Customizations are handled within the OneSignal WordPress plugin. For customizations see [WordPress Plugin Questions](🔗).
[Custom Code Slide Prompt](🔗)Code examples for adding the Slide and Category prompts programmatically. Cannot be used with Typical Setup.
[Slide Prompt FAQ](🔗)Answers to the most common questions about the Slide and Category Prompts.

## Slide Prompt Customizations

[Icon](🔗)Recommended size `256 x 256` pixels
TextCharacter Count: - Action Message: 90 characters - Buttons: 15 characters Text color, size, font and links currently not available.
[Category Tags](🔗)10 Max Categories/Tags. Can be triggered anytime.
[Delayed Prompts](🔗)Set Delay for: - Total Page Views - Time on page Prompts can be [triggered](🔗) programmatically as well for more control.
Color, Size, Font, Add Links, LocalizationComing Soon

### Add Slide Prompt Icon

Set the icon in your OneSignal Dashboard > Settings > All Browsers configuration > Default Icon URL. You can upload an image or paste a URL to the icon file.

Icon file must be `.png` or `.jpg` and at least `80x80` pixels (**Recommended** size is `256x256` pixels for Safari's requirements).

If you do not have a Default Notification Icon URL set, OneSignal will show a generic bell icon. This can always be changed later


### Category Tags

The Category Slidedown works just like the regular Slide Prompt except it also allows subscribers to opt-in or out of notification categories set as [Data Tags](🔗).

There is a maximum 10 categories/tags that can be set within the prompt. Users will be opted-in to all categories by default unless they uncheck the appropriate boxes. Unchecking certain boxes by default is not currently supported.


Upon subscription all checked categories will be set as tags on the device with the tag key provided and a value of `1` for checked and `0` for unchecked. See [Segments](🔗) for details on creating segments for these categories with the User Tag filter.

**Category Slidedown configuration**

  • [Typical Site Slide Prompt Setup](🔗) - add the slide prompt through the OneSignal Dashboard. Cannot be used with WordPress or Custom Code setup.

  • WordPress and Custom Code Setup can add the Category Slide Prompt programmatically. See [Category Slide Prompt With Custom Code](🔗) for details.

### Triggering the Prompt

The Slide and Category Prompts can be shown to users automatically with [Delayed Prompts](🔗).

You can also trigger these prompts programmatically if you want more control of when they are shown.

To trigger these prompts programmatically, toggle off the **Auto-prompt** switch in Typical Setup or remove the delay code from Custom Code Setup. Then use the following functions to show the prompts:

[Show Slidedown Prompt method](🔗)`OneSignal.showSlidedownPrompt()`
[Show Category Slidedown method](🔗)`OneSignal.showCategorySlidedown()`

#### How to show the category slidedown to users already subscribed?

The category slide prompt, will tag the user with a `key` you of your choice and value of `1` if user checks or `0` if unchecked.

For example, if you set `breaking_news` as a tag and the user selects it, the tag will be `breaking_news`: `1`. If they uncheck it, they will have `breaking_news`: `0`.

In either case, if the user is subscribed and selects or does not select this category/tag, it will be active on the device.

Using this knowledge with the OneSignal `getTags` method, we can detect if the device has any of these categories and present the prompt if not. Using the `breaking_news` tag for example:

### Using the Tags set from the Prompt

The category slide prompt, will tag the user with a key you set and value of `1` or `0` depending on if they check the category or not.

Within [Segments](🔗) you can create a segment using the **User Tag** filter is `1`.

This will target all users interested in the category.

## Typical Setup Slide Prompt

Customizations set within **Settings > All Browsers Configuration > Step 3 Permission Prompt Setup > Slide Prompt**.


Customizable options for Slide Prompt.

**Customize slide prompt text**Allows editing the message and button text. Not currently supported: Changing Font, Bold, Italicize, Color, adding links.
**Auto-prompt**Show the prompt without additional code. Adds a delay on showing the prompt based on both time and/or number of page views.
**Page Views**Amount of times the user visits a URL of your site with the OneSignal code. `0` or `1` page view is the first time they visit the site.
**Seconds**Amount of time that needs to pass while the user is on the page of your site with the OneSignal code for the prompt to show. `0` seconds means show as soon as possible (after the site loads). `300` seconds means show after 5 minutes.
**Categories**Turns on Category Slidedown feature

You can combine **Page Views** and **Seconds** together. For example, if your common user visits your home page, another page and a 3rd page, you can set: `3` page views and `30` seconds. The prompt will show on the 3rd page and after `30` seconds has passed.

### Typical Setup Category Slidedown


You can add up to 10 Categories/tags and a unique message for triggering the Category Slidedown manually. See above [Category Tags](🔗) for more details on how Category Tags work.

To trigger the slide or category prompt, see above on [Triggering the Prompt](🔗).

Save Settings!

When finished, press **Save** and **Save** again on the next page to see this go into effect.

You may need to wait a minute and clear page cookies to see changes go into effect.

## WordPress Slide Prompt

The OneSignal WordPress Plugin handles text customizations through the plugin. For updating the icon, see above [Add Slide Prompt Icon](🔗).

To enable the Slide Prompt upon visiting the site, go to "Prompt Settings & Subscription Bell" and enable:

**Automatically prompt new site visitors with OneSignal Slide Prompt before Native Browser Prompt (recommended)**

Don't forget to press "Save" at the bottom of the plugin.


To customize the Slide prompt text, in the plugin go to "Prompt Customization".

Select "Customize the Prompt text" and add your Action Message, Accept Button Text and Cancel Button Text, then press save at the bottom of the plugin.


If you would like to add a delay or custom tags to this prompt, it will require adding some additional setup. Please see the [WordPress Delayed Prompts and Category Slidedown Code](🔗) for more.

(Script tags will be stripped)

## Custom Code Setup Slide Prompt

The Custom Code Setup is for integrating OneSignal with your own custom Javascript. It is recommended to use the [Typical Setup](🔗).

The Custom Code Slidedown option schema is changing

As we add new slidedown types, we want you to be able to customize each prompt individually. Moving forward, you will have the ability to set text and delays for each specific prompt.

Note that previous schemas will always remain backwards compatible.

Slidedown configuration is now passed in via an array of options named `prompts`. Each element in the array corresponds to a specific slidedown type:

If you list multiple options of the same type, the first one in the array of that type will be used.

Slide Prompt Options:

### Category Slidedown with Custom Code

You can activate the Category Slidedown via custom code by passing in a special parameter `categories` to the slidedown option object. This parameter should be an array of objects containing `tag` and `label` parameters. Note: make sure the prompt option type is set to `"category"`.

There are three special `text` parameters used solely with the Category Slidedown. These are used in the case that the Category Slidedown is reshown (e.g: to allow for the updating of preferences).

`text` parametertypedescription
`updateMessage``string`**Optional** This is the message shown whenever the Category Slidedown is re-shown (the user is already subscribed). Limit: 90 chars Default: "Update your push notification subscription preferences."
`positiveUpdateButton``string`**Optional** This is the text that will be displayed on the positive button whenever the Category Slidedown is re-shown (the user is already subscribed). Limit: 15 chars Default: "Save Preferences"
`negativeUpdateButton``string`**Optional** This is the text that will be displayed on the negative button whenever the Category Slidedown is re-shown (the user is already subscribed). Limit: 15 chars Default: "Cancel"

You can trigger the Slide Prompt anytime via the the [showSlidedownPrompt method](🔗).

You can trigger the Category Slidedown anytime via the the [showCategorySlidedown method](🔗).


See examples for [Adding a Prompt Delay](🔗).

## Slide Prompt FAQ

### How many times does the slide prompt show?

Please [follow this link for more details](🔗).

### How do I show the prompt in different languages?

This will require the [Custom Code Setup](🔗). When you detect the browser language with your own setup code, you can initialize OneSignal with the language you want to show.

### Why isn't my Slide Prompt showing up?

Even if you trigger `showSlidedownPrompt()`, it may not always show the message. The message will not be shown if any of the following are true:

  • The user previously dismissed the message by clicking the "No Thanks" button

  • HTTP sites: The user has blocked notifications for your-label.os.tc

  • The user is already successfully subscribed to notifications

  • You have manually opted out the user via our `setSubscription(false)` method

    • If you've intentionally disabled a user's permissions by calling setSubscription(false), you must manually opt the user back in by calling `setSubscription(true)` our drop-down prompt will not show.

If the prompt is not shown, the `showSlidedownPrompt()` method returns a Promise that resolves to a string value briefly describing the reason the prompt was not shown. You may also enable debug logging for the SDK via `OneSignal.log.setLevel('trace');` to see explanations of why the prompt is not shown.

### How to track Slide Prompt Events?

The OneSignal Web SDK has the [Slide Prompt Event Methods](🔗) to detect when it shows on the screen, when it is closed, and the "Allow" or "Cancel" action.