Page tree
Skip to end of metadata
Go to start of metadata

Widget Use

Displays articles in list format, allowing for a list title and icon, as well as other configuration options such as a toggles and content hyperlinks.

 

Example of Widget Use

Following is an example of the widget in use:

Article List with HyperlinksArticle List with Toggle

 

 

Where can the Widget be placed?

The widget can be used in the following templates:

  • Article List Page Template
  • Custom pages

 

Widget Options

OptionUseCommentsAvailable from Version
DescriptionA short description of the widget's use.We recommended this field be updated so the widget's purpose is clear at a glance from the template page.All
LayerThe layer the widget is valid for.

The layering technology allows for the content to be shown to specific audiences.

This is handy if the content is only valid for a certain type of user, or if the same widget is required for more than one audience, but different configuration is needed.

The widget can be added to the zone more than once and the layer feature can determine which audience can see each widget. 

All
List TitleThe heading text displayed at the top of the article list. All
Title IconThe icon displayed to the left of the List Title. All
Max Number Of ArticlesThe maximum number of articles to display in the article list.Default is: 5All
Article Type FilterThe article 'type' this widget will display. You assign every article a 'type' when you create it. This drop-down list will be populated with all available article Types on your site, so you can select which type to display with this widget.

 

All
Order By Field

Determines which article field is used to sort the articles in the list. Choices are:

  • Article Page Type
  • Description
  • Expiry Date
  • Posted Date
  • Start Date
Default is: Posted DateAll
Order By DirectionDetermines which direction the articles are ordered by - ascending or descending.Default is: DescendingAll
Image PositionDetermines the side that the image will be displayed on. This option will also move the summary and the 'Read Full Article' button to the far left in place of where the image is by default.Default is: LeftAll
Show Read Article ButtonDetermines whether the 'Read Full Article' button is displayed for each article. (The user can navigate to the full article page if this option is unticked by clicking on the article title.)

Default is: ticked

Untick to disable

All
Article Route Prefix

The prefix inserted between the main site URL and the article title. Used for SEO purposes.

For example, in the following URL, 'blog' is the route prefix: http://www.commercevision.com.au/blog/back-to-the-future 

Default is: article

All
Show Article DateDetermines whether the article date is displayed. If not, the Article summary text is shifted up in place of the date text.

Default is: ticked

Untick to disable

3.83
Enable Article Toggle

Determines whether article content can be expanded and collapsed. When enabled, the article Title will display, but content will be hidden until the user toggles to expand. This functionality replaces the hyperlink (which redirects the user to a new page to display article content).

Note - If Article Toggle is enabled, please disable Article Hyperlink (they are incompatible).

Default is: unticked

Tick to enable (and ensure 'Enable Article Hyperlink' is not ticked)

3.86
Enable Article HyperlinkAllows the user to navigate to the full article page by clicking on the news article heading. Disabling this option removes the hyperlink on the article heading.

Default is: ticked

Untick to disable

3.83

 

 

Other Widgets

  • Page:
    Account Payment Detail Widget Renders the payment detail information in the body of the various Account Payment confirmation emails. Information includes (but is not limited to) the order number, account number, invoice, and amount paid.
  • Page:
    Dashboard Recent Invoices Widget — Displays the logged in user's 5 most recent invoices, with a link to each invoice in detail, as well as a 'View All' option.
  • Page:
    Dashboard Account Status Widget — Displays a list of the user's customer account status, including balance owing and payment terms, as well as links to statements and the account payment page.
  • Page:
    Dashboard Articles Widget — Displays a list of the site's news articles, with an image, title, a 'read more' link, and the article expiry date.
  • Page:
    Dashboard Product Favourites Widget — Displays a list of the user's top 5 favourite products, with links to each product page, as well as an add to cart button.
  • Page:
    Dashboard Back Orders Widget — Displays a list of the user's backorders with links to the order detail page.
  • Page:
    Social Sharing Plugin Widget — Acts as a placeholder to output customised javascript based on content from Add This (social network Share buttons, for example).
  • Page:
    Return Lines Widget Where product Returns functionality is in use, renders the return order lines (product, quantity, price, etc.) on the return entry page.
  • Page:
    Return Information Widget — Where product Returns functionality is in use, renders the details input section (reason, number of parcels) on the returns entry page.
  • Page:
    Return Confirmation Summary and Lines Static Widget Where product Returns functionality is in use, renders the return order lines (product, quantity, price, etc.) on the confirmation page after the user submits their return request.
  • Page:
    Return Confirmation Return Info Widget Where product Returns functionality is in use, renders the return details (reason, number of parcels) on the confirmation page after the user submits their return request.
  • Page:
    Return Confirmation Address Widget Where product Returns functionality is in use, renders the pickup address details on the confirmation page after the user submits their return request.
  • Page:
    Return Confirmation Message Widget Where product Returns functionality is in use, renders messages to the user on the confirmation page to advise that their return is in progress + next steps.
  • Page:
    APR Verification Required Widget Where Auto Part (B2B) Registration + automatic approval functionality is in use, renders the message content to the new user, advising that they must verify their email address in order to be approved.
  • Page:
    APR Auto Approval Notification Widget Where Auto Part (B2B) Registration + automatic approval functionality is in use, renders the message content to the admin to advise that a new user is in the process of being automatically approved.