B
Bonzai 2
Web Parts

Image Link Gallery

Display a responsive grid of clickable images with optional filtering, search/sort, pagination, and per-user favorites. Supports SharePoint List mode and Manual Images mode.

ContentFeature Parity: 85%

Get Image Link Gallery Working in 3 Steps

15-30 minutes

Prerequisites

  • Bonzai 2 package installed on your site
  • Either a SharePoint list with images + links, or Manual Images mode configured in the web part
1

Add the web part

Edit the page and add "Bonzai Image Link Gallery".

2

Choose your data source

Pick SharePoint List mode or Manual Images mode.

3

Configure display + publish

Set items per row, tile height, optional filters/search/favorites, then publish.

When to Use This Web Part

Use this when you need to...

  • Visual "Quick Links" section with image tiles
  • Resource galleries (apps, tools, services) with optional metadata overlays
  • Category/tag filtered galleries where users can narrow results on the page
  • Curated sections with dividers/headers (Manual Images mode)

Best page locations

  • Homepages — visual navigation sections
  • Department pages — resource tiles with quick filtering
  • Hub pages — curated image directories

Consider alternatives when...

  • Hero-style rotating banners — use Slider
  • Complex tile templates and mixed layouts — use Landing
  • Search-first experiences for pages/documents — use Advanced Search / Document Portal

Related web parts:

Landingyou want tile templates and overlay styles beyond a gallery gridAdvanced Linksyou want tiles/list/directory modes for links (with optional image gallery style)

Data Source Modes

  • SharePoint List: Gallery is driven by a list/library and can connect cross-site.
  • Manual Images: Add images directly in the web part settings (supports dividers/section headers).

Image & Link Columns (List mode)

  • Banner image auto-detect: Uses the item's banner image when available (best for Pages/News items). Also falls back to common image column names (Image, ImageUrl, Picture, Photo, Thumbnail).
  • Custom image column: Select a specific column that contains image URLs. Banner image fields are still used as a fallback when an individual item has no value.
  • Link URL Column (optional): Pick the column that holds each tile's link destination, or leave on Auto-detect URL column to try URL, LinkURL, Link, FileRef, and EncodedAbsUrl in order.

Auto-detect is resilient

Custom image columns work with both Hyperlink-type columns and SharePoint Image columns (the service extracts theserverRelativeUrl from Image-column JSON and also constructs attachment-based URLs automatically). If a specific item has no value in your custom column, the gallery quietly falls back to banner / common image fields before giving up and showing the placeholder.

Filtering, Search, Sort & Paging

  • Admin pre-selected values: in the property pane, choose which Category or Tag values are allowed. Items outside those values are filtered out before the page loads.
  • Runtime filter dropdowns: when a Category or Tag filter is enabled and its source column has values, end users see a dropdown above the grid to narrow results.
  • Search: optional debounced search box (300 ms) that matches title, description, category, and both overlay metadata fields.
  • Sort (edit mode only): the Sort dropdown — A-Z, Z-A, or Custom Order — only appears on the web part toolbar while editing the page. Page editors use it to set the default display order for everyone.
  • Pagination: optional Previous / Next paging. Items per page is configurable (3-50, default 12).

Custom Order (Edit Mode)

While editing the page, choosing Custom Order from the Sort dropdown opens an inline reorder panel. Drag items, use the up / down arrow buttons, or pick a position from the per-item dropdown, then click Save Order to persist it. Reset to Default reverts to the list's natural order (typically by the auto-detected SortOrder / Order / ItemOrder column).

  • SharePoint List mode: saves an ordered list of item IDs on the web part instance. The underlying list is not modified.
  • Manual Images mode: rewrites the manual items collection so the new order becomes the saved order.
  • Saving also flips the default sort to Custom Order so end users immediately see the new order.

Favorites (Per User)

When enabled, users can star items and see them in a favorites sidebar. Favorites persist per user in the browser (local storage) and are saved per web part instance.

Favorites are browser-based

Favorites will not roam across browsers/devices and may not persist in private/incognito sessions.

Manual Images Mode

Manual mode is useful when you do not want to maintain a list. Open Manage Images in the property pane to build the collection. Each manual item supports:

  • Type: Image or Divider / Section Header (dividers span the full row and show the title as a section label, or an hr line if the title is blank).
  • Title: required. Shown as the overlay title for images, or as the section label for dividers.
  • Link URL: destination for image items (dividers ignore it).
  • Description: optional overlay text.
  • Image: SPFx file picker (site files, OneDrive, stock images, web search, upload, link) — accepts .gif, .jpg, .jpeg, .png, .webp, and .svg.
  • Open in new tab: per-item toggle that overrides the global "Open Links in New Window" setting.

Recommended List Schema (List mode)

Image Link Gallery can auto-detect common field names, but these columns provide the best experience:

ColumnTypeRequiredNotes
TitleSingle line of textYesOverlay title (can be hidden via the "Show Title on Images" setting).
URL / LinkURL / LinkHyperlink (recommended)RecommendedClick destination. Auto-detected by name; any Hyperlink column also qualifies. You can override via the Link URL Column setting.
BannerImageUrlBuilt-in (Pages/News)NoPrimary source in "Banner auto-detect" mode; also used as a fallback in "Custom image column" mode.
Image / ImageUrl / Picture / Photo / ThumbnailHyperlink or ImageNoAuto-detected by name. Good choices for Custom image column mode; SharePoint Image columns (attachment-based) are supported.
Description / Comments / Body / NotesMultiple lines of textNoOverlay description (shown when the title overlay is enabled). The first matching name is used.
Category / Group / LinkCategoryChoice or TextNoUsed for category filtering and the optional colored category badge.
Tags (chosen column)Choice (multi), Managed Metadata, or TextNoTags are not auto-detected — choose the column explicitly under "Tag Column" when enabling the Tag filter.
SortOrder / Order / ItemOrderNumberNoDefault list ordering. Used as a starting point for the in-page Custom Order editor and as the Reset to Default target.
OpenInNewWindow / NewWindow / TargetYes/NoNoOverrides the global "Open Links in New Window" setting per item.
Metadata 1 / 2 (chosen columns)AnyNoTwo optional overlay metadata lines — pick the columns and custom labels under "Metadata & Badge".

Troubleshooting

Still need help? Contact Bonzai Support


Reference

Key Settings

The property pane is organised into two accordion pages. Page 1 focuses on the data source; Page 2 on layout, appearance, and interactive features.

GroupWhat it controls
Title & NavigationTitle text, optional Title URL (makes the header clickable), icon mode (Fluent UI icon picker — defaults to PhotoCollection — or none), and an optional description.
Data SourceSharePoint List vs Manual Images.
Site Selection (list mode)Connect to another site/subsite via Microsoft Graph site search or by entering the site URL manually.
Source List (list mode)List/library dropdown grouped by template: Custom Lists, Links Lists, Pages, Document Libraries, and Other Lists.
Image Source (list mode)Banner auto-detect vs a custom image column, plus optional Link URL Column.
Manual Images (manual mode)Manage the collection of image / divider items with the SPFx file picker.
Gallery LayoutItems per row (1-6, default 3), tile height slider (100-500 px, default 220), image fit (cover / contain / fill / none / scale-down), paging toggle, items per page (3-50, default 12).
Appearance & StyleBorder radius (0-24, default 6), hover effect (zoom / shadow / none, default zoom), show title overlay, open links in new window.
Search, Sort & FavoritesEnable search box + placeholder, enable favorites + sidebar label. Sort and Custom Order live on the web part toolbar in edit mode.
Category & Tag Filters (list mode)Toggle filter on/off, set the runtime label, pick the source column, and optionally pre-select allowed values.
Metadata & Badge (list mode)Up to two overlay metadata columns with custom labels, plus a hex category badge color.
Visual Quick Links
  • Items per row: 4
  • Enable title overlay + badge color
  • Enable paging for longer lists
Resource Favorites
  • Enable Favorites + label
  • Add two metadata lines for scanning
  • Enable search + sort toolbar

Use Manual mode for curated sections

Manual Images mode supports divider/section header rows, so you can create grouped galleries without managing a list.