Visual UGC Docs
Search
⌃K

REST API Reference Widgets style and config

Widget Style and Config

This area provides detail around each of the available Styles for widget.

style Properties

Field
Type
Value
POST
PUT
Definition
click_through_url
string
[EXPAND]
​
​
Click through URL
layout_mode
string
square
​
​
Layout mode. The value will need to be one of the following: square
margin
interger
10
​
​
Size of margin between tile
name
string
Gallery
​
​
Name of widget
rows
interger
3
​
​
Size of margin between tile
show_powered_by_stackla
boolean
true
​
​
Whether to show the Powered by Visual UGC icon
tile_size
string
medium
​
​
Tile size. The value will need to be one of the following: small
widget_background
string
transparent
​
​
Hex code of color

config Properties

config.lightbox properties

Field
Type
Value
POST
PUT
Definition
apply_custom_sharing_title_on_miss_title
boolean
false
​
​
Custom title for sharing
disable_short_url
boolean
false
​
​
​
layout
string
portrait
​
​
Lightbox layout style. The value will need to be one of the following: portrait
sharing_text
string
​
​
​
​
sharing_title
string
​
​
​
​
show_additional_info
boolean
true
​
​
Toggle to show and hide additional info
show_comments
boolean
false
​
​
Toggle to show and hide comments
show_sharing
boolean
false
​
​
Toggle to show and hide sharing
show_shopspots
boolean
false
​
​
Toggle to show and hide sharing in inline tile
show_tags
boolean
false
​
​
Toggle to show and hide tags

Waterfall (base_waterfall)

style Properties

Hex code of color
Field
Type
Value
POST
PUT
Definition
auto_refresh
boolean
false
​
​
​
click_through_url
string
[EXPAND]
​
​
Click through URL
domain
string
​
​
​
​
enable_custom_tiles_per_page
integer
false
​
​
Number of tile per page load
enable_doublecolumnspan
boolean
false
​
​
​
load_more_type
string
button
​
​
Load more type. The value will need to be one of the following: scroll
enable_typekit
boolean
false
​
​
Flag to enable typekit
margin
interger
0
​
​
Size of margin between tile
max_tile_width
interger
365
​
​
Maximum tile width
name
string
Waterfall
​
​
Name of widget
parent_page_ext_username
boolean
false
​
​
​
parent_page_permission
boolean
false
​
​
​
parent_page_secret_key
string
​
​
​
​
polling_frequency
integer
30
​
​
The frequency of polling contents in seconds
row_per_page
integer
3
​
​
Number of rows per page load
style
string
base_waterfall
​
​
Widget style type.
text_tile_background
string
ffffff
​
​
Hex code of color
text_tile_font_color
string
666666
​
​
Hex code of color
text_tile_font_size
integer
24
​
​
Font size for text
text_tile_user_handle_font_color
string
333333
​
​
Hex code of color
text_tile_user_handle_font_size
integer
18
​
​
Font size for text
text_tile_user_name_font_color
string
333333
​
​
Hex code of color
text_tile_user_name_font_size
integer
18
​
​
Font size for text
tiles_per_page
integer
15
​
​
Number of tiles per load
type
string
fluid
​
​
Widget type
widget_background
string
​
​
​
​
widget_loading_image
string
http://sdp-media.dev/images/widget/loading.gif
​
​
URL of the widget loading image

config Properties

Field
Type
Value
POST
PUT
Definition
tile_options
​object​
​
​
​
​
lightbox
​object​
​
​
​
​
claim_config
​object​
​
​
​
​

config.tile_options properties

Field
Type
Value
POST
PUT
Definition
show_comments
boolean
false
​
​
Toggle to show and hide tags in inline tile
show_dislikes
boolean
false
​
​
Toggle to show and hide dislike in inline tile
show_likes
boolean
false
​
​
Toggle to show and hide like in inline tile
show_sharing
boolean
false
​
​
Toggle to show and hide sharing in inline tile
show_shopspots
boolean
false
​
​
Toggle to show and hide sharing in inline tile
show_tags
boolean
false
​
​
Toggle to show and hide tags in inline tile
show_votes
boolean
false
​
​
Toggle to show and hide votes in inline tile

config.lightbox properties

Field
Type
Value
POST
PUT
Definition
apply_custom_sharing_title_on_miss_title
boolean
false
​
​
Custom title for sharing
disable_short_url
boolean
false
​
​
​
layout
string
portrait
​
​
Lightbox layout style. The value will need to be one of the following: portrait
post_comments
boolean
false
​
​
Toggle to allow user to add comment in lightbox
sharing_text
string
​
​
​
​
sharing_title
string
​
​
​
​
show_additional_info
boolean
true
​
​
Toggle to show and hide additional info
show_comments
boolean
false
​
​
Toggle to show and hide comments
show_dislikes
boolean
false
​
​
Toggle to show and hide dislike
show_likes
boolean
false
​
​
Toggle to show and hide likes
show_nav
boolean
false
​
​
Toggle to show and hide navigation
show_sharing
boolean
false
​
​
Toggle to show and hide sharing
show_shopspots
boolean
false
​
​
Toggle to show and hide sharing in inline tile
show_tags
boolean
false
​
​
Toggle to show and hide tags
show_votes
boolean
false
​
​
Toggle to show and hide votes

config.claim_config properties

Field
Type
Value
POST
PUT
Definition
show_claim_button
boolean
false
​
​
toggle to show and hide claim button
show_content_toggle
boolean
false
​
​
toggle to show and hide content toggle

style Properties

Number of rows per page load Hex code of color Hex code of color
Field
Type
Value
POST
PUT
Definition
click_through_url
string
[EXPAND]
​
​
Click through URL
enable_custom_tiles_per_page
string
​
​
​
​
load_more_type
string
static
​
​
Load more type. The value will need to be one of the following: button
margin
integer
7
​
​
Tile margin
name
string
Carousel
​
​
Widget name
parent_page_secret_key
string
​
​
​
​
polling_frequency
integer
30
​
​
The frequency of polling contents in seconds
row_per_page
string
​
​
​
​
style
string
base_carousel
​
​
Widget style type.
text_tile_background
string
​
​
​
​
text_tile_font_color
string
666666
​
​
Hex code of color
text_tile_source_color
string
333333
​
​
Hex code of color
tiles_per_page
integer
15
​
​
Number of tile per page load
type
string
fluid
​
​
​
widget_background
string
​
​
​
​
widget_height
integer
300
​
​
Widget height
widget_loading_image
string
http://sdp-media.dev/images/widget/loading.gif
​
​
URL of the widget loading image

config Properties

Field
Type
Value
POST
PUT
Definition
tile_options
​object​
​
​
​
​
lightbox
​object​
​
​
​
​
claim_config
​object​
​
​
​
​

config.tile_options properties

Field
Type
Value
POST
PUT
Definition
show_comments
boolean
false
​
​
Toggle to show and hide tags in inline tile
show_dislikes
boolean
false
​
​
Toggle to show and hide dislike in inline tile
show_likes
boolean
false
​
​
Toggle to show and hide like in inline tile
show_sharing
boolean
false
​
​
Toggle to show and hide sharing in inline tile
show_shopspots
boolean
false
​
​
Toggle to show and hide sharing in inline tile
show_tags
boolean
false
​
​
Toggle to show and hide tags in inline tile
show_votes
boolean
false
​
​
Toggle to show and hide votes in inline tile

config.lightbox