Edit preferences widget

circle-check

A preferences widget is the customizable end-user facing form that your organization surfaces to collect the end-users preferences as defined in your organization's configuration tree. In this article, we will cover how to manage the preferences widget configuration flow to edit an existing preferences widget.

To start, click Preference Management on the left-hand panel and ensure the Widgets tab is selected on the subsequent page.

Navigate to a preferences widget on the list and click the Edit icon inline with the preferences widget name.


Save preferences widget edits

Edit the various components of the preferences widget using the tabs of the preferences widget configuration flow. Save your progress at any point by clicking the Save icon in the upper right-hand corner.

Review the table below for information on how saving your preferences widget edits impacts the publication status of the widget:

Original Publication Status

Draft

Saved edits will have no impact on the publication status of the preferences widget and the status will remain Draft.

Published

Saved edits to a published preferences widget will change the publication status to Unpublished Changes. The preferences widget will need to be re-published for the changes to appear on websites where the widget was deployed/embedded. Note: Re-publishing the preferences widget will create a new version of the widget with its new edits that can be tracked in the widget's version history.

Preferences widget name

Edit the preferences widget name by clicking the Edit icon inline with preferences widget name. Use the provided field to edit the name.

Purposes & preferences

The Purposes & preferences tab of the preferences widget configuration flow allows your organization to configure the specific purposes, preferences, and preference value options that will be surfaced via the preferences widget.

Use the tools in the right-hand panel to customize your organization's purposes, preferences, and/or preference value options for this particular widget. Refer to the table below for specific actions that can be taken on each component:

Component
Actions

Purpose

Click the ellipsis inline with the purpose name to customize the purpose.

  • Show/hide purpose and its associated preferences (Display section toggle)

  • Collect consent for the purpose (Display the consent request toggle)

  • Reorder purposes (arrows)

Preference

  • Hide preference (will need to hide all preference value options for the preference)

  • Reorder preferences (arrows)

Preference value

  • Show/hide preference value option (toggle)

  • Reorder value option for preference (arrows)

circle-info

To hide a preference completely, your organization will need to hide all preference value options for the preference

Look & feel

The Look & feel tab of the preferences widget configuration flow allows your organization to customize the design of the preferences widget. Use the right-hand panel to select:

  • Shape of the widget and its components (selection will apply to cards, containers and buttons)

  • Color scheme (either preset themes or customized colors per element using hexadecimal)

circle-info

For increased design and behavior flexibility your organization can also configure the preferences widget to be a Headless widget via the Advanced tab (available for Single purpose and Multi purpose preferences widgets only). Click herearrow-up-right to learn more about customizing your preferences widget as a headless widget.

Content editor

The Content editor tab of the preferences widget configuration flow allows your organization to edit the copy and translations for your selected purposes and preferences on a per-widget basis. Any edits to the copy for your purposes, preferences, and preference value options performed within the preferences widget will not alter the original copy of these elements in the preference library and/or data manager.

In this section, we will provide an overview of how to navigate the content editor of a preferences widget.

circle-info

Click here for detailed information on how to manage language translations for your preferences widget's purposes, preferences, and preference value options.

Click on an element in the preferences widget preview and use the provided fields in the right-hand panel to edit the title, description, value content, etc... for that element in the specified language.

In addition to editing the content of your selected purposes and/or preferences, your organization can also edit the following elements for each preferences widget format:

Element
Single purpose widget
Multi purpose widget
Preference center

Purpose and/or preference

Save card

Browser tab

Header

Footer

Publish preferences widget

Click Published when satisfied with the edits performed to the preferences widget and ready to embed the widget to a website.

A subsequent modal will confirm when the single purpose or multi purpose widget has been published. Click Continue.

circle-info

A new version of the preferences widget with its current edits will be available in the preferences widget's version history.

You will be redirected to the Embedding tab of the preferences widget configuration flow. Click here for detailed instructions on how to embed the necessary code on your website.

Last updated