Spotlight Rollup

Recent Updates

• Fixed: author name no longer shows as "Unknown" in card / image metadata when the rollup uses a saved SharePoint view. The Author value is now resolved across all three response shapes (REST expanded {Title}, RenderListDataAsStream array, and legacy id;#Name).
• Fixed: edit-mode draft preview — the rollup now surfaces unpublished pages with a contextual badge (Draft, Pending approval, Rejected, Unpublished changes, Checked out) so authors can verify their page will appear before publishing. Readers continue to see only published items.
• Fixed: saved view filters are now honoured — selecting a view in the View Picker correctly applies its <Where> and <OrderBy> clauses (previously the saved view's filter was silently overridden).
• Fixed: View Picker no longer shows the unnamed _SPAssetFolderId grouping view from SharePoint.
• Fixed: Show Promoted Only now returns an empty result (with a console warning) when the source list has no Showcase / Featured / PromotedState column — instead of silently showing every page.
• Fixed: spotlight item links now correctly honour the Open in New Tab toggle (Card and Image templates) and bypass SharePoint's link interception (data-interception="off").
• New: Date Field dropdown — pick which DateTime column drives the displayed date. Auto-populated from the source list's DateTime fields.
• Internal: hardened service-side list resolution and saved-view query handling for cross-site rollups.
• Image Source selector — choose between Banner Image (full-resolution hero) or Thumbnail (auto-generated preview).
• Combined engagement toggle — a single Show likes & comments toggle replaces the separate comment/like toggles.
• Show Metadata toggle with full date format customization (text vs numeric, month format, year display, separator, order).
• Disable Pagination option to show all items (up to 500) at once.
• Unpublished pages are now hidden from readers — drafts, pending, denied and folders never render in view mode, even on misconfigured lists or views.
• Bonzai Page Banner override image — if a page contains a Bonzai Page Banner web part with an override image URL, that image is used in preference to the banner thumbnail.
• Image selection prefers higher-resolution page images to avoid low-res thumbnails.

Common Configurations

Best Practices

Reference

Site Pages Schema

Spotlight Rollup reads from a selected list (commonly Site Pages). If no list is selected the web part renders a "Please configure" message and returns no items. Pages are read via the standard SharePoint REST API (or RenderListDataAsStream when a view is selected).

Published content only: drafts, pending/denied items, minor versions, checked-out pages and folders are always excluded — both in the server $filter and with a defense-in-depth client-side filter. This applies even when a SharePoint view is used.

Image resolution order

When Image Source is Banner Image, the service picks the best available URL in this order (higher-resolution wins, placeholders are rejected):

1. Bonzai Page Banner override image — if the page contains a Bonzai Page Banner web part with a configured overrideImageUrl in its CanvasContent1, that URL is used first.
2. BannerImageUrl field (URL or Description).
3. CanvasContent1 imageSources parsed from the page JSON.
4. Inline <img> tags inside CanvasContent1.
5. _PublishingRollupImage (classic publishing metadata).
6. Fallback: SharePoint's getpreview.ashx rendered at size=xl.

When Image Source is Thumbnail, the web part calls /_api/sitepages/pages/GetById(<id>) per item and uses the BannerThumbnailUrl. Generic placeholder thumbnails are ignored and the banner fallback is used instead.

Property Pane Configuration

Title Settings

Data Source Settings

Display Settings

Behavior notes

• Navigation: clicking a card or hero navigates to the page via window.location.href (same tab). Keyboard Enter / Space also activates.
• Title / Show More links: both open in a new tab with data-interception="off".
• Pagination: chevron-based (previous / next). Hidden when total pages ≤ 1 and no next link is reported.
• Engagement counts: loaded lazily per item from /Comments and /likedBy endpoints on the selected list, and cached in-memory per item.
• Image template layout: first item renders as a full hero with an overlay (category, title, author, date, engagement); remaining items render as smaller cards in a secondary grid.

Features Checklist

• ✅ Card (Grid) and Image (Hero + secondary grid) templates
• ✅ Image Source selector — Banner Image (full-res) vs Thumbnail
• ✅ Bonzai Page Banner override image URL detection
• ✅ Higher-resolution image preference (getpreview.ashx at size=xl fallback)
• ✅ Cross-site data source via Site Picker or manual URL
• ✅ List and View pickers (view is rescoped to selected list)
• ✅ Published-only safety filter (drafts, pending, denied, minor versions and folders hidden)
• ✅ Auto-discovery of promoted tagging column (Showcase / Featured? / PromotedState / …)
• ✅ Sort by Modified (default), Created, or Title
• ✅ Configurable pagination (chevron pager) or "show all" mode
• ✅ Show metadata (author + date) with full date format customization
• ✅ Combined engagement toggle (likes + comments), lazy-loaded and cached
• ✅ Image overlay on hero (category, title, author, date, engagement)
• ✅ Custom title with Fluent icon or image URL, optional clickable Title URL
• ✅ Show More link (hidden when URL is empty)
• ✅ Fixed container height with scroll (0 = auto)
• ✅ Chrome type: none / title only / border only / title and border
• ⏳ Content targeting — property reserved but not wired up yet