Web Parts
Pages Rollup
Display SharePoint pages with sorting, filtering, multiple templates (Default and Card), comments, and likes.
ContentFeature Parity: 95%
Get Pages Rollup Working in 3 Steps
10-20 minutes
Prerequisites
- Bonzai 2 package installed on your site
- Site Pages or a custom list with pages
1
Add the web part
Edit your page and add "Bonzai Pages Rollup" from the Bonzai category.
2
Select source list and view
Choose your pages list from the List picker. Optionally select a view to filter.
3
Configure display
Choose template (Default or Card), set items per page, and configure sort order.
When to Use This Web Part
Use this when you need to...
- Display recent pages on the homepage
- Show pages by category or tag (via views)
- Create a knowledge base listing
- Display child pages of a section
Best page locations
- Homepage — recent pages widget
- Category pages — filtered content
- Documentation hubs — page listings
Consider alternatives when...
- • News specifically — use News Rollup
- • Featured content — use Spotlight Rollup
Related web parts:
News Rollup — news-specific contentSpotlight Rollup — featured/promoted content
Recent Updates
- Image selection prefers higher-resolution page images to avoid low-res thumbnails.
- Drafts, folders, and unpublished items are always filtered out server-side — only published pages are rendered, regardless of the selected view.
- New: optional toolbar for search, filtering, and runtime sorting (toggle on/off in the property pane).
- Improved: if a selected SharePoint view can’t be applied, Pages Rollup falls back to showing all items and shows a warning.
- Improved: pagination range display is more accurate and can show an “of total” count once the last page is reached.
- Improved: the View picker accepts either a view title or a view GUID; resolution tries GUID first, then title.
Common Configurations
Copy these ready-to-use configurations:
Recent Pages List
Recent pages in list format
Best for: Homepage sidebar
Configuration
| title | Recent Pages |
| templateName | default |
| sortBy | modified |
| itemsPerPage | 10 |
| showPaging | On |
Page Cards Gallery
Cards with thumbnails
Best for: Department page
Configuration
| title | Pages |
| templateName | card |
| itemsPerRow | 3 |
| itemsPerPage | 6 |
| showComments | On |
Featured Pages
Promoted pages only
Best for: Landing page
Configuration
| showPromotedOnly | On |
| templateName | card |
| itemsPerRow | 4 |
Knowledge Base
Alphabetical page listing
Best for: Documentation hub
Configuration
| title | Knowledge Base |
| sortBy | title |
| templateName | default |
| itemsPerPage | 20 |
Best Practices
Sort by Modified for recent content
Set Sort By to "Modified" to show the most recently updated pages.
Use views for filtering
Create SharePoint views to filter pages by category, then select the view in the web part. If the view can’t be applied (for example, it was created on a different list), Pages Rollup will fall back to showing all items and display a warning message.
Only published pages are shown
Pages Rollup always hides drafts, folders, and unpublished items server-side. You don’t need a special view or filter to keep drafts private — they never reach the rollup.
Reference
Site Pages Schema
Pages Rollup reads from a selected list (commonly Site Pages). If no list is selected, it triesPages, SitePages, and Site Pages on the chosen site in that order. Drafts, folders, and unpublished items are always hidden server-side — you don’t need to create a view to exclude them.
- Select the Site Pages library (or a custom pages list).
- Optional: add a Category column and use views for filtering.
- Optional: use Promoted/Featured values if you enable promoted-only filtering.
- Publish pages so they are visible in the rollup.
| Column | Type | Required | Notes |
|---|---|---|---|
| Title | Single line of text | Yes | Default Site Pages column. Falls back to "Untitled" if empty. |
| FileRef | System | Yes | Used to build the page link and a thumbnail preview when no banner image is found. |
| Author | Person | No | Displayed on every item (list and card). Falls back to "Unknown". |
| Modified | Date/Time | No | Shown next to each item and used for the Date-range filter. |
| Created | Date/Time | No | Used by the Created sort option. |
| BannerImageUrl / CanvasContent1 / _PublishingRollupImage | System / Image | No | Used (in that preference order) for card and list thumbnails. Higher-resolution candidates are preferred. |
| Description | Multiple lines | No | Optional excerpt/summary. HTML is stripped and the text is truncated to ~200 characters. |
| Category | Choice / Text | No | Shown on card items, used for the Category filter, and can be used for view-based filtering. |
| PromotedState | Number | No | Used when Show Promoted Only is On (keeps items with PromotedState ≥ 1). |
Property Pane Configuration
Title Settings
| Property | Type | Description |
|---|---|---|
title | Text | Web part title displayed above the content. Leave empty to hide the title block. |
titleUrl | Text | Optional URL to make the title clickable |
titleIconOption | Dropdown | Title icon mode: custom (default) or none |
titleIconName | Text | Fluent UI icon name (default: Page). Only shown when Title Icon is set to Custom. |
titleIconUrl | Text | Custom icon URL (overrides icon name) |
description | Text (Multiline) | Optional description below the title |
showMoreText | Text | Text for the "Show More" link (default: See all pages) |
showMoreUrl | Text | URL for the "Show More" link (empty = hidden) |
Data Source Settings
| Property | Type | Description |
|---|---|---|
siteUrl | Text | Site URL where the pages library is located (empty = current site) |
listName | List Picker | Source list or library (all lists/libraries available — no base-template filter). If left empty, Pages Rollup will try Pages, SitePages, and Site Pages in order. |
viewName | View Picker | View used to filter pages; disabled until a list is chosen. Accepts a view GUID or title — resolution tries GUID first, then title. If the view can’t be resolved, the rollup falls back to an unfiltered query and surfaces a warning. |
sortBy | Dropdown | Initial server-side sort: modified (newest first, default), created (newest first), or title (A–Z). |
Display Settings
| Property | Type | Description |
|---|---|---|
templateName | Dropdown | Display template: default (list, default) or card (grid) |
itemsPerRow | Dropdown | Items per row: 2, 3 (default), or 4. Only active when templateName is card. |
itemsPerPage | Slider (1–20) | Number of pages to display per page (default: 10) |
showPaging | Toggle | Show pagination controls (default: On) |
fixedHeight | Slider (0–800, step 50) | Fixed container height in pixels with scroll. 0 = auto (default). |
chromeType | Dropdown | Chrome type: none, titleOnly, borderOnly, or titleAndBorder (default). When set to none or borderOnly, the title block is hidden even if a title is set. |
showPromotedOnly | Toggle | Show only promoted/featured pages — items where PromotedState ≥ 1 (default: Off) |
showComments | Toggle | Show comment count (default: On) |
showLikes | Toggle | Show like count (default: On) |
Search, Filter & Sort
Pages Rollup can optionally show a toolbar above the results so users can search, narrow, and re-sort the list at runtime. When any of these toggles is On, the rollup switches from server-paged mode to client-side filtering: it pre-fetches up to the first 200 published pages (matching your list, view, sort, and Promoted-only settings) and performs search / filter / sort in the browser. Disable all three to return to pure server-side paging.
| Property | Type | Description |
|---|---|---|
enableSearch | Toggle | Show a search box. Matches against page Title, Description, Author, and Category (case-insensitive, 400 ms debounce). Default: Off. |
enableFilters | Toggle | Show Category and Author dropdowns plus a Modified-date range (From / To). Category and Author options are built from the loaded items. Default: Off. |
enableSort | Toggle | Show a runtime sort dropdown with six options: Modified (Newest/Oldest), Created (Newest/Oldest), and Title (A–Z / Z–A). Default: Off. Initial selection mirrors sortBy. |
Features Checklist
- ✅ Default and Card display templates
- ✅ View-based filtering
- ✅ Multiple sort options (Modified, Created, Title)
- ✅ Optional user toolbar: search, filters, and runtime sort
- ✅ Pagination support
- ✅ Promoted pages filtering
- ✅ Comments and likes display
- ✅ Configurable items per row (Card template)
- ✅ Custom title with icon and link
- ✅ Show more link