Skip to main content

Choose Which Screen Your Sleekplan Widget Opens On

In this article, you’ll learn two ways to set a “home” screen for the widget when it initially opens

Updated yesterday

When you use the Sleekplan app widget on your website, you might want it to open on a specific screen instead of the default home screen. For example, you may want users to see your Changelog first, or jump straight into submitting Feedback.

There are two main ways to configure this:

Option 1: Set the Widget Home Screen in the Admin Dashboard

You can define a default home screen for your widget directly from the Sleekplan admin interface. This is the easiest, no-code way to set where the widget should open.

  1. Log in to your Sleekplan admin dashboard.

  2. Go to Settings > Widget > Widget Settings

3.In Widget Settings look for the Home Screen tab and select the home screen for your widget

⚡From now on, whenever someone opens the Sleekplan widget, it will start on the screen you just selected—unless you override it programmatically using the SDK (see next option).

Option 2: Open a Specific View Using the Sleekplan SDK

If you want more control—for example, opening the widget to different screens depending on where the user is on your site—you can use the Sleekplan JavaScript SDK and the  $sleek.open()  function.

sleek.open(view, callback)  opens the Sleekplan widget on your website.

  • If you do not specify a  view , the widget will open on the default home screen (as configured in your Widget Settings).

  • If you do specify a  view , the widget will open directly on that specific screen.

👉Here are the available view parameters for the function :

View

Description

home

Is displayed by default. Loads the list of all new feedback items

feedback.add

Opens the feedback form

feedback.{ID}

Opens a specific feedback item, replace the {ID} with the actual ID of the feedback item

changelog

Opens the changelog

notifications

Opens the notification list for the current user

Did this answer your question?