Image Carousel¶
The Image Carousel Web Part can be used to display a dashboard of images, with title, description and links, powered by a SharePoint Image List.
Options¶
This web part provides various options to control the display of the feed.
| Setting | Description |
|---|---|
| Web Part Title | Optionally show a title above the web part on the page. |
| List Settings | |
| Site URL (Optional) | URL of the site collection to target. When not provided uses the current site. |
| Select List | Select an existing Image Carousel list. |
| Create a new List | Create a new List for Mercury Image Carousel. |
| News Settings | |
| Search text | Allows a user to search for news articles based on the value entered |
| All | Access all news within the Tenant. |
| Hub | Only news from the hub and associated sites will show. |
| Site | Only news from this particular site will be visible. |
| Result Source | Go to site settings and find a appropriate result source. Then input the GUID details which can be found within the URL into the below box in the panel. Eg of GUID shown in below screenshot (Blue text). |
| Multi Geo | Enable searching across multiple geo locations configured for the tenant. Only available for tenants configured with multiple geo locations and when All Sites is selected. |
| Managed Properties for Tags | List of Managed Properties, once selected items will display as tags on news tiles. |
| Limit Results | Limit the number of articles returned by search. |
| Select property to sort by | Choose how the results are sorted. |
| Sort Direction | Set to sort the results by the specified property in ascending or descending order. |
| View Settings | |
| View | List of display options for carousel items. |
| Hide Summary | Toggle to show the description when 'View' is set to Simple. |
| Friendly Date | Toggle to display news dates as friendly (todays date will display as 'Today'). |
Note
In order to sort the results by Article Date, your tenant's search schema must include a RefinableDate managed property mapped to a property on an article, such as Article Date (ows_MercuryArticleDate) or Modified, and have the alias MercuryArticleDate.
Note
If you set a Result Source, then the Sort Property and Direction set here are ignored. You must set your sorting criteria in the Result Source.
Slick Settings
| Setting | Description | Default |
|---|---|---|
| Autoplay | Enable or Disable Autoplay of images. | Default: On |
| Dots | Enable or Disable Dots to navigate on images. | Default: On |
| Infinite | Enable or Disable Infinite to navigate from first to last image and from last to first. | Default: On |
| Arrows | Enable or Disable Arrows to navigate between images. | Default: On |
| Speed (in seconds) | Define how fast images should change when Autoplay is enabled. | Default: 5 |
| Slides to show | Use this to set how many individual posts will be shown at any one time. | Default: 1 |
| Slides to scroll | This sets how many posts are scrolled past on each click of the arrows, or whenever the Auto Play scrolls to the next post. | Default: 1 |
Picture Library (Image Carousel List)¶
Creating a new List¶
Image Carousel List can be created from the properties by clicking the 'Create a new List' button and adding the custom name.
The newly created List will automatically populate the "Select a List" dropdown.
If the list doesn't have any images in the library, the information will be shown, that the list is empty.
Upload images¶
To upload images navigate to 'Site Contents' and select the newly created list. Then drag & drop or click the Upload button to add pictures to the library. Next select 'Edit in grid view' And edit current view to show extra columns to enable extra functionality of Mercury Image Carousel The values that should be selected are: Title, Carousel Description, Carousel Link and Carousel Order Add information to be shown in the Mercury Image Carousel. All of the above values are not required.
Config Repository¶
This web part supports use of the config repository, to allow users to save and load configurations of web parts with ease.
Loading a config file will populate the web part properties with properties from the incoming file.
SharePoint¶
Saving to SharePoint allows collaboration between users in a tenant.
The path the file is saved to is tenant-name/Site Assets/Mercury Assets/webpart-name.json.
Permissions¶
To save a file to SharePoint, edit permissions are required on the root Site Assets library.
To load a file from SharePoint, read permissions are required on the root Site Assets library.
OneDrive¶
Saving to OneDrive allows a user to save a file locally, this is the best option when a user does not have the required permissions to save to SharePoint.
The path the file is saved to is Mercury Assets/webpartname.json.