Using Widgets

Widgets are loaded through SitePages.config to add a focused storefront experience to a page. The control configuration identifies the widget file and can supply the options supported by that widget.

Add a widget to a page

Add LoadWidgetControl.ascx to the appropriate page placeholder. Set FileLocation to the widget file that the page should load.

<Control src="LoadWidgetControl.ascx"
    FileLocation="Cart_QuickOrder.html" />

The widget file name, control source, and property names must match the installed CyberStore configuration. See The SitePages.config File for the page, placeholder, and control structure.

Configure widget options

Set widget options in the control’s Options attribute as comma-separated name and value pairs. Each widget page identifies the options it supports.

<Control src="LoadWidgetControl.ascx"
    FileLocation="Cart_QuickOrder.html"
    Options="ShowColumnHeader: true,
        AutoCompleteSearchMode: 'StartsWith'" />

Do not copy an option from one widget to another. A property is valid only when the selected widget supports it.

Control shopper access

Use RequireLogin="true" when the widget is available only to signed-in shoppers.

<Control src="LoadWidgetControl.ascx"
    FileLocation="Cart_QuickOrder.html"
    RequireLogin="true" />

Test the configured page with the shopper types that can access it. Confirm the page loads, the widget accepts its options, and the shopper can complete the supported task.

Use a site-specific widget file

To provide a site-specific version of a default widget, place a same-named file in the site’s Widgets folder. The CyberStore page engine uses the site file instead of the default widget source.