Web Parts
Site Directory Favourites
Display your saved Site Directory favourites as a simple list — ideal for a “My Apps” / “My Favourite Sites” panel.
NavigationFeature Parity: 85%
Get Site Directory Favourites Working in 3 Steps
5-10 minutes
Prerequisites
- Bonzai 2 package installed on your site
- Site Directory web part is available (users save favourites from there)
1
Add the web part
Edit your page and add “Bonzai Site Directory Favourites”.
2
Have users favourite sites
Users add favourites in the Site Directory (star/favourite action). This web part displays those favourites.
3
Optional: add a “Show More” link
Configure a link that takes users to a full Site Directory page (for adding/removing favourites).
When to Use This Web Part
Use this when you need to...
- Create a “My Apps” panel that reflects what users actually use
- Add a lightweight personalised navigation section to a homepage
- Provide quick access to frequently used sites without curating a separate list
Best page locations
- Homepages — “My Apps” / “My Sites” widget
- Department hubs — quick personalized links
- Dashboard pages — small navigation panel
Consider alternatives when...
- • Organization-wide featured sites — use Favourite Sites (list-based)
- • A searchable site catalog — use Site Directory
Related web parts:
Site Directory — you want discovery/search and the ability to favourite sitesFavourite Sites — you want curated favourites driven by a SharePoint list
How it Works
This web part reads the current user’s favourites that were saved from the Site Directory web part. Both web parts share the same browser storage, so anything a user stars in Site Directory shows up here and vice versa.
- Favourites are stored in
localStorageunder the keybonzai_site_directory_favorites(shared with Site Directory). - Entries are sorted newest first by the date they were added.
- The list updates live across browser tabs — if a user stars a site in another tab, this web part refreshes automatically.
- Each item shows a gold star icon with the site title and opens the site in a new tab.
- When there are no favourites, the web part shows a friendly empty-state message prompting users to star sites in Site Directory.
Personalised per user (browser storage)
Favourites are stored per user in the browser. That means a user’s favourites list can vary by browser/device, and private/guest sessions may block saving. There is no server-side persistence — this web part does not write to a SharePoint list.
Common Configurations
My Apps (compact)
- Show paging: On
- Items per page: 6
- Chrome: Title and border
My Favourite Sites (no border)
- Chrome: Title only
- Fixed height: Auto
- Show more link: Off
“Add to My Apps” link
- Show more text: Add to My Apps
- Show more URL: link to your Site Directory page
- Helps users manage favourites
Reference
The property pane is organised into three groups: Title & Navigation, Data Source, and Display Options.
Title & Navigation
| Setting | Property | What it controls | Default |
|---|---|---|---|
| Title | title | Header title shown above the list | My Favorite Sites |
| Title URL | titleUrl | Optional URL that makes the title a clickable link (opens in a new tab) | — |
| Title Icon | titleIconOption | Dropdown: custom (show an icon) or none (hide icon fields) | custom |
| Title Icon Name | titleIconName | Fluent UI icon name shown before the title (e.g. FavoriteStar, Home). Hidden when Title Icon is “None”. | FavoriteStar |
| Title Icon URL | titleIconUrl | Custom image URL — overrides the Fluent UI icon when set | — |
| Description | description | Optional multi-line description shown under the title | — |
Data Source
| Setting | Property | What it controls | Default |
|---|---|---|---|
| Site URL | siteUrl | Reserved context field. Favourites always come from the user’s browser storage (localStorage) regardless of this value. | — |
Favourites are browser-local
The
siteUrl setting is exposed for future use. Today, favourites are read from localStorage under the key bonzai_site_directory_favorites — the same key the Site Directory web part writes to.Display Options
| Setting | Property | What it controls | Default |
|---|---|---|---|
| Chrome Type | chromeType | none / titleOnly / borderOnly / titleAndBorder | titleAndBorder |
| Fixed Height | fixedHeight | Optional fixed height in pixels (slider 0–800, step 50). 0 = auto. Values > 0 add scrolling inside the web part. | 0 (auto) |
| Show More Text | showMoreText | Label for the optional action link at the bottom | Add to My Apps |
| Show More URL | showMoreUrl | Target URL for the action link. Both text and URL must be set for the link to appear. | — |
| Show Pagination | showPaging | Toggle pagination on or off | On |
| Items Per Page | itemsPerPage | How many favourites to show per page (slider 3–20). Disabled when pagination is off. | 6 |
Hosts & Theming
- Supported hosts:
SharePointWebPart,SharePointFullPage,TeamsTab,TeamsPersonalApp. - Supports SharePoint theme variants.
Pair it with Site Directory
Add Site Directory Favourites to the homepage, and link “Show more” to a dedicated Site Directory page so users can quickly add/remove favourites.
Design note
This web part is intentionally minimal: it’s designed to be a compact list that fits in a narrow column.