Documents
The Sprocket Documents web part enables you to display and manage documents from any SharePoint document library directly on your page. Connect to libraries across site collections, customize which fields to display, apply filters, and organize documents by metadata groups to create tailored document views for your users.
Features
- Connect to any document library from any SharePoint site (cross-site collection)
- Type ahead results filter
- No need to configure a SharePoint view, just select the fields you wish to display in the webpart
- List and Tile layouts - display documents in a data grid or as document cards with thumbnails
- View fields order (list layout) - reorder columns after selecting view fields without changing which fields are shown
- Document Card Designer (tile layout) - reorder fields on each card and optionally show profile or image previews for person-type columns
- Group by metadata field - collapsible groups in list and tile layouts, optional default collapsed state, and an end-user control to turn grouping on or off
- Specify filters
- Create filters using query strings and page data
- Flatten files without folders
- Show documents within a specific folder
- Use within 'Full-Content' section
Layouts
List layout
The default layout shows documents in a Fluent UI data grid (table).
- Columns match the View fields you select in Query Options.
- Use View fields order (below View fields) to drag or move columns into the order you want. The first column in that order is treated as the primary link column (typically the file name).
- Show File Type adds a fixed-width type icon column before your fields.
- Column Minimum Width and First Column Minimum Width apply only in list layout.
- Compact View and Wrap Rows apply only in list layout.
- Column headers support in-grid filtering (menu on each column) to narrow visible rows without changing web part configuration.
Tile layout
Tile layout shows each document or folder as a card with a preview area and metadata rows.
- Preview - Files use SharePoint thumbnail previews where available; folders show a folder icon and can be opened in-place when Show Folders is on.
- Metadata - Each selected view field (except the file type column) can appear on the card. Values use the same rendering as list view where possible.
- Document Card Designer - Appears under View fields when at least one view field is selected. Reorder fields on the card; use Show preview on supported person or image columns to show a profile photo or avatar (not used in list layout).
- Show column names as labels - When on, each value on the card is prefixed with the column display name (labels are shown in bold).
- If no name/title column is included in view fields, the file name is still shown on the card.
- Column Minimum Width, First Column Minimum Width, Compact View, and Wrap Rows are hidden in tile layout because they apply to the grid only.
- Tile cards follow the page theme (including dark sections). When the web part is hosted in a light Full-Content panel, tiles stay on the light palette for readability.
Configuration
Adding the Web Part
- If you are not already in edit mode, click Edit at the top right of your page.
- Click the + icon to add a new web part to your page.
- Search for and select Sprocket Documents.
- Configure the web part settings using the property pane on the right.
Display Options
The Documents web part offers the following display configuration settings:
| Setting | Description | Options/Values | Default |
|---|---|---|---|
| Layout | How documents are displayed | List / Tile | List |
| Show Breadcrumb | Display breadcrumb navigation showing the current folder path | On / Off | Off |
| Column Minimum Width | Set minimum width for all columns (in pixels) | 0 - 500 px | 0 (auto-sized) |
| First Column Minimum Width | Set minimum width for the first column excluding icon (in pixels) | 0 - 500 px | 0 (auto-sized) |
| Maximum number of items | Limit the number of documents displayed | 1+ | - |
| Show Pagination | Enable next/previous paging through the result set | On / Off | Off |
| Show Command Bar | Display command bar with See All button to view all documents | On / Off | Off |
| Show Filter | Display search filter to find specific documents using keywords | On / Off | Off |
| Compact View | Use compact list layout for denser document display | On / Off | Off |
| Show File Type | Display file type column in the document list | On / Off | Off |
| Show Folders | Include folders in the document listing | On / Off | Off |
| Wrap Rows | Allow row content to wrap to multiple lines | On / Off | Off |
| Enable Vertical Scroll Bar | Add vertical scrolling within the web part | On / Off | Off |
| Height | Set web part height when vertical scrolling is enabled | 100+ px | 400 px |
| Open list in new tab | Open the full document list in a new browser tab when clicking See All | On / Off | Off |
| Group Collapsed | Display grouped items in collapsed state by default | On / Off | Off |
Query Options
Configure the document source and display settings:
| Setting | Description | Required | Options/Values |
|---|---|---|---|
| Site URL | Select the SharePoint site containing the document library | Yes | Dropdown of available sites |
| Web URL | Select the web within the site | Yes | Dropdown of available webs |
| Document Library | Select the document library to display | Yes | Dropdown of available libraries |
| Folder | Specify a folder path to display documents from a specific folder For nested folders, use '/' as separator (e.g., Folder1/Subfolder2) | No | Text input |
| View Fields | Select which metadata columns to display in the list | Yes | Checkboxes for available fields |
| View fields order | Reorder columns for list layout. Appears after view fields are selected. List layout. | No | Drag / up-down reorder |
| Document Card Designer | Reorder fields on tile cards; optional Show preview per field. Tile layout. | No | Drag / up-down; preview toggles |
| Order By | Choose the field to sort documents by | No | Dropdown of available fields |
| Sort Direction | Set the sort order | No | • Ascending • Descending |
| Query within folders | Include documents from subfolders in the results | No | On / Off |
| Group By | Group documents by a metadata field | No | Dropdown of available fields |
View fields order and Document Card Designer
Both controls use the same underlying field order. Which control you see depends on Layout:
| Layout | Control label | What you can configure |
|---|---|---|
| List | View fields order | Column order only (no preview toggles) |
| Tile | Document Card Designer | Field order on each card plus Show preview where offered |
- Select one or more fields in View fields.
- The designer appears directly below View fields in Query Options.
- Drag rows or use the up/down buttons to change order.
- In tile layout, turn on Show preview for person or image-style columns when you want a photo or initials on the card.
Newly checked view fields are appended to the end of the order until you move them.
Group by
When Group By is set in Query Options:
- List layout - Documents appear in collapsible groups (expand/collapse per group). Sorting on column headers is disabled while grouped.
- Tile layout - Cards are rendered under group headings with the same expand/collapse behaviour.
- Group Collapsed (Display Options) - When enabled, groups start collapsed.
- End users - A grouping pill appears above the content so viewers can temporarily turn grouping off or back on without editing the page. This does not change the saved web part configuration.
Grouping uses the raw value of the selected metadata field. Choose a field with stable, human-readable values for best results.
Using Filters
Filters enable you to control which documents are displayed in the web part. To add filters:
- Click the Add Filter button in the Filters section
- Select the field, operator, and value(s) for your filter
- Use And/Or conditions to combine multiple filter expressions
- Build complex queries to precisely control document visibility
FAQs
1. What is the maximum allowed file size of a document?
There is no maximum file size - any document size is allowed as per SharePoint specifications.
2. What are the allowed file types?
All SharePoint-allowed file types are allowed, however currently Excel and PowerPoint templates will open in Display Mode.
3. How can I find a specific item in the list?
You have the option to search for items in the list.
4. What is the difference between List and Tile layout?
List layout is a sortable table with column sizing and header filters. Tile layout is a card grid with thumbnails and the Document Card Designer (including optional profile previews). Both layouts respect the same query, filters, folder, and group-by settings.
5. Why do I see View fields order in list mode but Document Card Designer in tile mode?
It is the same reordering tool with a layout-specific label. Preview options only apply to tile cards.
6. Does Group By work in tile layout?
Yes. Groups can be collapsed or expanded, and viewers can dismiss or re-apply grouping using the pill above the tiles.