Portal Banner widget JSON parameters

  • Release version: Xanadu
  • Updated August 1, 2024
  • 1 minute to read

    • JSON parameters define aspects of the Portal Quick Links widget on the Portal Banner widget.

    Note:
    This information assumes that you’re familiar with the JSON code format.
    Table 1. JSON parameters
    Parameter Description
    widget_title Required title of the widget. The default text is Quick Links.
    The available configurations are:
    • value: The string value of the displayValue parameter.
    • displayValue: Name of the widget_title field to appear in the presentation section. The default text is Title.
    card_display_style The style of a card tile for quick links inside the Portal Banner widget.
    The available options are:
    • Thumbnail
    • Icon on top
    • Icon on left
    • Title & description only
    • Title only

    The default display style is Thumbnail.

    Note:
    Currently, if you select None, the style is set to Thumbnail.
    show_carousel Option to switch between carousel view and grid view.
    The available configurations are:
    • value: The string value of the displayValue parameter.
    • displayValue: Name of the show_carousel field to appear in the presentation section. The default text is Show Carousel.
    quick_links Name of the field in the presentation section. The default text is Quick Links.

    value: The reference value from a table from which the catalog items, knowledge articles, or URL are shown as quick links on the widget. By default, this field is set to the Quick Links [sn_ex_sp_quick_link] table.