Web Parts
Favourite Documents
Display documents marked as favourites using a SharePoint column filter (Showcase column).
DocumentsFeature Parity: 95%
Get Favourite Documents Working in 3 Steps
15-30 minutes
Prerequisites
- Bonzai 2 package installed on your site
- A document library with a "Showcase" column (or custom column) to mark favourites
1
Add the web part
Edit your page and add "Bonzai Favourite Documents" from the Bonzai category.
2
Select a library and column
Choose the document library, set the Showcase column name and the value to filter by (e.g., "Favorite").
3
Configure display
Set max items, toggle file type and location display, then publish.
When to Use This Web Part
Use this when you need to...
- Display documents marked as favourites in a SharePoint column
- Highlight important or featured documents
- Create a curated document showcase
Best page locations
- Homepage — featured document showcase
- Dashboard pages — important files panel
- Document Center — alongside Document Portal
- Department pages — curated content
Consider alternatives when...
- • Displaying all documents — use Documents Rollup
- • Per-user favourites — this filters by a shared column value
Related web parts:
Documents Rollup — show all documents with filteringDocument Portal — full search with personal favourites
How Favourites Work
This web part filters documents from a SharePoint library based on a column value:
- Create a column in your document library (default name: "Showcase")
- Set the column value to "Favorite" (or your custom value) for documents you want to feature
- The web part displays documents matching that column filter
Shared favourites
Unlike browser-based favourites, documents shown here are determined by the SharePoint column value. All users see the same favourited documents. To personalize, users can set their own column values.
Column name resolution
The column name lookup is flexible: it matches by internal name or display title (case-insensitive), and automatically handles spaces (e.g., "Showcase Column" is resolved to the internal name
Showcase_x0020_Column). You can enter the column's display title as shown in the library.Removing from Favourites (Optional)
An optional allowRemove toggle lets viewers clear the Showcase column value directly from the web part. When enabled, each document shows a star button; clicking it sets the Showcase column on that item to blank, which removes it from the filtered view.
Remove is shared / org-wide
Because this web part is driven by a SharePoint column, the remove action updates the source library item for everyone, not just the current user. It is not a personal "unfavourite". Keep
allowRemove disabled (the default) unless editors should be able to unfeature documents for all viewers. The action also requires edit permissions on the underlying library; users without them will see a permission error.Common Configurations
Copy these ready-to-use configurations:
Featured Documents
Show documents marked as favorites
Best for: Homepage sidebar
Configuration
| title | Featured Documents |
| showcaseColumnName | Showcase |
| showcaseValue | Favorite |
| maxItems | 10 |
| showFileType | On |
Important Policies
Filter by policy category
Best for: Policies page
Configuration
| title | Key Policies |
| showcaseColumnName | Priority |
| showcaseValue | High |
| maxItems | 5 |
| showSiteLocation | Off |
Team Resources
Department curated documents
Best for: Team page
Configuration
| title | Team Resources |
| showcaseColumnName | Team |
| showcaseValue | Marketing |
| usePaging | On |
| itemsPerPage | 5 |
Editable Showcase (Admin)
Let editors unfeature documents inline
Best for: Content owner page — shared remove
Configuration
| title | Featured Documents |
| showcaseColumnName | Showcase |
| showcaseValue | Favorite |
| allowRemove | On |
| maxItems | 10 |
Best Practices
Use a Choice column
Create a Choice column in your library with options like "Favorite", "Featured", "Important" to easily categorize and filter documents.
Configure the column name
The default column name is "Showcase" with value "Favorite". Customize these to match your library's column structure.
Reference
Required Library Setup
Favourite Documents uses a document library and filters items by a Showcase-style column.
- Select an existing document library with files.
- Add a Showcase column (Choice or Text) if it does not exist.
- Set the Showcase value (default: Favorite) on documents you want to feature.
| Column | Type | Required | Description |
|---|---|---|---|
| Title | Single line of text | Yes | Document title (built-in) |
| FileLeafRef | Single line of text | Yes | File name (built-in) |
| FileRef | Hyperlink | Yes | Server-relative path (built-in) |
| Modified | Date/Time | Yes | Used for sorting (built-in) |
| Created | Date/Time | No | Fallback sort |
| Author | Person | No | Displayed when available |
| Showcase | Choice or Text | Yes | Column to filter by (default name). Add choice "Favorite" as an option. |
Property Pane Configuration
Title Settings
| Property | Type | Description |
|---|---|---|
title | Text | Web part title displayed above the content |
titleUrl | Text | Optional URL to make the title clickable |
titleIconOption | Dropdown | Title icon mode: Custom or None |
titleIconName | Icon Picker | Fluent UI icon picker (default: FavoriteStar) |
titleIconUrl | Text | Custom icon URL (overrides icon name) |
description | Text (Multiline) | Optional description below the title |
manageDocsUrl | Text | URL for the "Show More" link |
manageDocsText | Text | Text for the "Show More" link (default: Manage Documents) |
Data Source Settings
| Property | Type | Description |
|---|---|---|
siteUrl | Text | Site URL where the library is located (empty = current site) |
listName | List Picker | Document library to display files from |
showcaseColumnName | Text | Column name to filter by (default: Showcase) |
showcaseValue | Text | Value to look for in the column (default: Favorite) |
Display Settings
| Property | Type | Description |
|---|---|---|
maxItems | Slider (1-50) | Maximum number of documents to display (default: 10) |
showFileType | Toggle | Show file type icon (default: On) |
showSiteLocation | Toggle | Show library/location name (default: On) |
showAddedDate | Toggle | Show the item's Modified date (default: Off) |
allowRemove | Toggle | Allow viewers to clear the Showcase value inline. Affects all users — shared action (default: Off) |
Paging Settings
| Property | Type | Description |
|---|---|---|
usePaging | Toggle | Enable pagination (default: Off) |
itemsPerPage | Slider (3-20) | Items per page when paging is enabled (default: 5) |
Appearance
| Property | Type | Description |
|---|---|---|
chromeType | Dropdown | Chrome type: None, Title Only, Border Only, Title and Border (default: Title and Border) |
fixedHeight | Slider (0-800, step 50) | Fixed height in pixels (0 = auto height) |
Features Checklist
- ✅ Filter by SharePoint column value (sorted by Modified date, descending)
- ✅ Configurable column name and value (handles spaces / special characters)
- ✅ File type icons (Word, Excel, PowerPoint, OneNote, Visio, PDF, text, images, video, archives, code)
- ✅ Site / library location display
- ✅ Added date display (item's Modified date)
- ✅ Pagination support with "from-to of total" indicator
- ✅ Custom title with Fluent icon or custom icon URL, optional clickable link
- ✅ Title icon mode: Custom or None
- ✅ Show More link (footer)
- ✅ Fixed height option (0-800px)
- ✅ Chrome type (None / Title Only / Border Only / Title and Border)
- ✅ Optional inline remove (clears Showcase column — shared/org-wide)
- ✅ Loading / error / empty / not-configured states with retry
- ✅ Bonzai theme integration