Managing Widget Versions

Goals and Outcomes

Widget Version History lets you preview and install a previous version of your on-site widget. This is useful when you want to test widget updates in a development environment, complete internal QA, or continue using an earlier widget version before adopting a newer release.

In this article, you'll learn how to access Widget Version History, preview previous widget versions, and install an older version.

About Widget Version History

Widget Version History allows you to browse, preview, and install previously released widget versions directly from the widget editor.

With Widget Version History, you can:

• Preview any widget version released within the last 60 days.

• Search for a version by Version ID or timestamp.

• See which version is currently installed.

• Identify the latest available widget version.

• Switch to an earlier widget version after reviewing it.

Widget Version History is available for all widgets in the widget library.

Before You Begin

Important

To use Widget Version History, Auto-update widgets must be turned off. When automatic version updates are enabled, Widget Version History is not displayed.

To turn off automatic version upgrades:

1. Open Widget settings.

2. Turn off Auto-update widgets.

3. Click Save.

Good to know

• Widget Version History includes widget versions released within the last 60 days.

• All versions released during this period, including minor and patch versions, are available.

New Widget Version

When a new widget version is available, a notification banner appears at the top of the widget editor. The banner lets you review the latest version before deciding whether to install it.

From the notification banner, you can:

• Click Preview version to review the latest widget version before installing it.

• Click Skip this version to dismiss the notification for the current version.

If you skip a version, the notification won't appear again until a newer widget version is released.

If you click Preview version:

1. Review the confirmation message.

2. Click Open preview.

The latest widget version opens in preview mode.

While previewing the latest version:

• Your currently installed widget remains unchanged.

• The preview uses example data to help you review the latest widget version.

• Editing, saving changes, and publishing are unavailable.

• Click Install version to install the latest version.

• Click Exit preview to return to your currently installed version.

To install the latest version:

1. Click Install version.

2. Review the confirmation message.

3. Click Update now.

After the installation completes, the selected version becomes the live version on your site.

Preview a Previous Widget Version

1. Open the widget you want to manage.

2. Click Edit.

3. In the widget editor, click Version History.

   The Version History panel displays:

   • Available widget versions from the past 60 days.

   • The currently installed version, labeled Current.

   • The newest available version, labeled Latest.

   • A search field that lets you search by Version ID or timestamp.

4. Click on the version you want to preview.

5. In the confirmation dialog, click Preview version.

The selected version opens in preview mode. The same preview workflow is used whether you're previewing a newer widget version from the notification banner or previewing an older version from Version History.

While previewing a version:

• Your currently installed widget remains unchanged.

• The preview uses example data to help you review the selected widget version.

• Editing, saving changes, and publishing are unavailable.

• You can click Install version to select the version or Exit Preview to return to your current version.

Install a Previous Widget Version

After reviewing the selected version:

1. Click Install version.

2. Review the confirmation message.

3. Click Switch version.

After you click Switch version and the installation completes, the selected version becomes the live version on your site.

Things to Know

• Widget Version History is displayed only when Auto-update widgets is turned off.

• Widget Version History is available for all widgets in the widget library.

• You can select any widget version released within the last 60 days.

• All versions released during this period, including minor and patch versions, are displayed.

• The currently installed version is labeled Current.

• The newest available version is labeled Latest.

• Previewing a version does not change your installed or live widget.

• While preview mode is active, editing, saving changes, and publishing are unavailable.

• If you exit preview without installing the selected version, your current widget version remains unchanged.

• Clicking Switch version installs the selected widget version and immediately applies it to your live site.

• No additional publishing is required after the installation completes.

• If you turn Auto-update widgets back on while a newer version is already available, your widget remains on its current version.

• The automatic upgrade is triggered when the next widget version is released.