Site Directory
Search and browse SharePoint sites using SharePoint Search with typeahead and favourites.
Get Site Directory Working in 3 Steps
Prerequisites
- Bonzai 2 package installed on your site
- SharePoint sites indexed by search
Add the web part
Edit your page and add "Bonzai Site Directory" from the Bonzai category.
Configure display options
Open the property pane and configure which site details to display (owner, date, description).
Enable features
Toggle on favourites and typeahead search, then publish your page.
Search-based discovery
When to Use This Web Part
Use this when you need to...
- Create a searchable site catalog
- Allow users to find SharePoint sites
- Enable site bookmarking (favourites)
- Browse all sites in the organization
Best page locations
- Intranet homepage — site search widget
- Navigation hub — all sites directory
- People & Directory page — site listings
Consider alternatives when...
- • Quick links to specific pages — use Advanced Links
- • Document search — use Document Portal
- • Curated list of sites — use Favourite Sites
Related web parts:
Common Configurations
Full Site Directory
Complete site search with all details
| title | All Sites |
| itemsPerPage | 12 |
| showFavourites | On |
| showCreatedDate | On |
| showSiteOwner | On |
| showDescription | On |
| enableTypeahead | On |
Compact Site Search
Minimal site finder for homepage
| title | Find a Site |
| itemsPerPage | 8 |
| showFavourites | On |
| showCreatedDate | Off |
| showSiteOwner | Off |
| showDescription | Off |
| enableTypeahead | On |
Favourites Focus
Quick access to bookmarked sites
| title | My Sites |
| showFavourites | On |
| showDescription | On |
| additionalLinkText | View All Sites |
| additionalLinkUrl | /sites/intranet/sites |
Best Practices
Enable typeahead for large organizations
Use result source for scoping
Favourites are stored locally
Reference
How It Works
Site Directory uses the SharePoint Search API to discover and display sites. Unlike web parts that require a manually maintained list, Site Directory automatically finds all sites that users have access to. You can optionally scope results using a custom Result Source ID.
Property Pane Configuration
Title Settings
| Property | Type | Description |
|---|---|---|
title | Text | Web part title (default: Site Directory) |
titleIconOption | Dropdown | Title icon mode: Custom or None |
titleIconName | Icon Picker | Fluent UI icon picker (default: SharepointLogo) |
titleIconUrl | Text | Custom icon URL (overrides icon name) |
Data Source
| Property | Type | Description |
|---|---|---|
resultSourceId | Text | Optional Result Source ID to scope site search results |
itemsPerPage | Slider (4-50) | Number of sites to display per page (step: 4, default: 12) |
Display Options
| Property | Type | Description |
|---|---|---|
showFavourites | Toggle | Show favourites toggle and section (default: On) |
showCreatedDate | Toggle | Show site created date (default: On) |
showSiteOwner | Toggle | Show site owner (default: On) |
showDescription | Toggle | Show site description (default: On) |
enableTypeahead | Toggle | Enable typeahead search suggestions (default: On) |
Additional Link
| Property | Type | Description |
|---|---|---|
additionalLinkText | Text | Text for the footer link (e.g., "View All Sites") |
additionalLinkUrl | Text | URL for the footer link |
Features Checklist
- ✅ SharePoint Search-based site discovery
- ✅ Typeahead search suggestions
- ✅ Site favourites (browser local storage)
- ✅ Pagination
- ✅ Show/hide site metadata (owner, date, description)
- ✅ Custom Result Source filtering
- ✅ Responsive design