REST API Reference Widgets style and config
Widget Style and Config
This area provides detail around each of the available Styles for widget.
Gallery (base_gallery)
style Properties
style Properties| Field | Type | Value | POST | PUT | Definition |
|---|---|---|---|---|---|
click_through_url | string | [EXPAND] | Click through URL | ||
layout_mode | string |
| Layout mode. The value will need to be one of the following: | ||
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 Nosto's UGC icon | ||
tile_size | string | medium | Tile size. The value will need to be one of the following: | ||
widget_background | string | transparent | Hex code of color |
config Properties
config Propertiesconfig.lightbox 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: | ||
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
style PropertiesHex 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 |
| Load more type. The value will need to be one of the following: | ||
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
config Propertiesconfig.tile_options properties
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
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: | ||
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
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 |
Carousel (base_carousel)
style Properties
style PropertiesNumber 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 |
| Load more type. The value will need to be one of the following: | ||
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
config Propertiesconfig.tile_options properties
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
config.lightbox properties| Field | Type | Value | POST | PUT | Definition |
|---|---|---|---|---|---|
disable_short_url | boolean | false | |||
layout | string | portrait | Lightbox layout style. The value will need to be one of the following: | ||
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_product | 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
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 |
Slideshow (base_slideshow)
style Properties
style PropertiesNumber of columns for tile Name of widget
| Field | Type | Value | POST | PUT | Definition |
|---|---|---|---|---|---|
arrow_color | string | ffffff | Hex code of color | ||
arrow_foreground | string | 333333 | Hex code of color | ||
auto_scroll | boolean | true | Flag to enable auto scroll | ||
click_through_url | string | [NONE] | Click through URL | ||
columns | 1 | ||||
height | integer | 640 | Widget height | ||
image_tile_background | string | ffffff | Hex code of color | ||
image_tile_font_color | string | ffffff | Hex code of color | ||
image_tile_font_size | integer | 24 | Font size for text | ||
margin | integer | 0 | Tile margin | ||
name | string | ||||
polling_frequency | integer | 30 | The frequency of polling contents in seconds | ||
row | integer | 1 | Number of rows in widget | ||
style | string | base_slideshow | 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 | 666666 | Hex code of color | ||
text_tile_user_handle_font_size | integer | 20 | Font size for text | ||
text_tile_user_name_font_color | string | 666666 | Hex code of color | ||
text_tile_user_name_font_size | integer | 24 | Font size for text | ||
tileHeight | integer | 640 | Tile height | ||
tileWidth | integer | 640 | Tile width | ||
tiles_per_page | integer | 15 | Number of tile per page load | ||
type | string | fixed | |||
widget_background | string | ffffff | Hex code of color | ||
widget_loading_image | string | http://sdp-media.dev/images/widget/loading.gif | URL of the widget loading image | ||
width | integer | 640 | Widget width |
Billboard (base_billboard)
style Properties
style PropertiesHex code of color
| Field | Type | Value | POST | PUT | Definition |
|---|---|---|---|---|---|
arrow_color | string | ffffff | Hex code of color | ||
click_through_url | string | [NONE] | Click through URL | ||
columns | integer | 3 | Number of columns for tile | ||
height | integer | 300 | Widget height | ||
image_tile_background | string | ffffff | Hex code of color | ||
image_tile_font_color | string | ffffff | Hex code of color | ||
image_tile_font_size | integer | 17 | Font size for text | ||
margin | integer | 7 | Tile margin | ||
name | string | Billboard | Name of widget | ||
navigation | string | click | |||
polling_frequency | integer | 30 | The frequency of polling contents in seconds | ||
row | integer | 10 | Number of rows in widget | ||
style | string | base_billboard | 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 | 17 | Font size for text | ||
text_tile_user_handle_font_color | string | 666666 | Hex code of color | ||
text_tile_user_handle_font_size | integer | 13 | Font size for text | ||
text_tile_user_name_font_color | string | 666666 | Hex code of color | ||
text_tile_user_name_font_size | integer | 16 | Font size for text | ||
tileHeight | integer | 300 | Tile height | ||
tileWidth | integer | 300 | Tile width | ||
tiles_per_page | integer | 9 | Number of tile per page load | ||
type | string | fixed | |||
widget_background | string | ||||
widget_loading_image | string | http://sdp-media.dev/images/widget/loading.gif | URL of the widget loading image | ||
width | integer | 970 | Widget width |
Feed (base_feed)
style Properties
style Properties| Field | Type | Value | POST | PUT | Definition |
|---|---|---|---|---|---|
arrow_color | string | 000000 | Hex code of color | ||
click_through_url | string | [NONE] | Click through URL | ||
columns | integer | 3 | Number of columns for tile | ||
height | integer | 600 | Widget height | ||
image_tile_background | string | ffffff | Hex code of color | ||
image_tile_font_color | string | 666666 | Hex code of color | ||
image_tile_font_size | integer | 18 | Font size for text | ||
margin | integer | 15 | Tile margin | ||
name | string | Feed | Name of widget | ||
navigation | string | click | |||
polling_frequency | integer | 30 | The frequency of polling contents in seconds | ||
row | integer | 3 | Number of rows in widget | ||
style | string | base_feed | 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 | 18 | Font size for text | ||
text_tile_user_handle_font_color | string | 666666 | Hex code of color | ||
text_tile_user_handle_font_size | integer | 13 | Font size for text | ||
text_tile_user_name_font_color | string | 666666 | Hex code of color | ||
text_tile_user_name_font_size | integer | 16 | Font size for text | ||
tileHeight | integer | 253 | Tile height | ||
tileWidth | integer | 253 | Tile width | ||
tiles_per_page | integer | 9 | Number of tile per page load | ||
type | string | fixed | |||
widget_background | string | ffffff | Hex code of color | ||
widget_loading_image | string | http://sdp-media.dev/images/widget/loading.gif | URL of the widget loading image | ||
width | integer | 800 | Widget width |
Blank Canvas (base_blankcanvas)
style Properties
style Properties| Field | Type | Value | POST | PUT | Definition |
|---|---|---|---|---|---|
name | string | Blank Canvas | Name of widget | ||
style | string | base_blankcanvas | Widget style type. | ||
tiles_per_page | integer | 30 | Number of tile per page load | ||
type | string | fluid |
Map Leaflet (base_map_leaflet)
style Properties
style Properties| Field | Type | Value | POST | PUT | Definition |
|---|---|---|---|---|---|
defaultZoom | integer | 1 | |||
center | string | -33.8,151.2 | |||
minZoom | integer | 1 | |||
maxZoom | integer | 19 | |||
name | string | Map | Name of widget | ||
providerLayer | string | OpenStreetMap.Mapnik | |||
pinColor | string | b53f35 | Hex code of color | ||
pinTextColor | string | ffffff | Hex code of color | ||
style | string | base_map_leaflet | Widget style type. | ||
type | string | fluid |