File list component in Microsoft Graph Toolkit
The File List component displays a list of multiple folders and files by using the file/folder name, an icon, and other properties that you specify. This component uses the mgt-file component. You can specify a specific drive or site, display a list of files based on insight type (trending, used, or shared), or provide queries to a custom list of files. The component also provides the option to allow users to upload files to a specified location in One Drive or SharePoint.
Example
The following example displays a file using the mgt-file-list component. You can use the code editor to see how properties change the behavior of the component.
Properties
You can use several properties to customize the component.
| Attribute | Property | Description |
|---|---|---|
| file-list-query | fileListQuery | The full query or path to the drive or site that contains the list of files to render. |
| file-queries | fileQueries | An array of file queries rendered by the component. |
| - | files | An array of files to get or set the list of files rendered by the component. Use this property to access the files loaded by the component. Set this value to load your own files. |
| insight-type | insightType | Set to show the user’s trending, used, or shared files. |
| drive-id | driveId | ID of the drive the folder belongs to. Must also provide either item-id or item-path. |
| group-id | groupId | ID of the group the folder belongs to. Must also provide either item-id or item-path. |
| site-id | siteId | ID of the site the folder belongs to. Must also provide either item-id or item-path. Provide list-id if you’re referencing a file from a specific list. |
| user-id | userId | ID of the user the files belongs to. Must also provide either item-id or item-path. Provide list-id if you’re referencing a file from a specific list. |
| item-id | itemId | ID of the folder. Default query is /me/drive/items. Provide drive-id, group-id, site-id, or user-id to query a specific location. |
| item-path | itemPath | Item path of the folder (relative to the root). Default query is /me/drive/root. Provide drive-id, group-id, site-id, or user-id to query a specific location. |
| item-view | itemView | Sets what data to be rendered (file icon only, oneLine, twoLines threeLines). Default is 'threeLines' |
| page-size | pageSize | A number value to indicate the maximum number of files to render on each page. Note: page-size isn't supported with insight-type. |
| file-extensions | fileExtensions | An array of file extensions used to filter files to show. |
| hide-more-files-button | hideMoreFilesButton | Boolean to indicate whether to show a button to render more files. |
| enable-file-upload | enableFileUpload | Boolean to enable or disable file upload functionality. The default value is false. |
| excluded-file-extensions | excludedFileExtensions | String array of file extensions to be excluded from file upload. Must also set the enable-file-upload attribute to true. |
| max-file-size | maxFileSize | A number representing the maximum file upload size (KB). Must also set the enable-file-upload attribute to true. |
| max-upload-file | maxUploadFile | A number representing the maximum number of files allowed to be uploaded. The default value is 10 files. Must also set the enable-file-upload attribute to true. |
| disable-open-on-click | disableOpenOnClick | Boolean to enable or disable the default behavior of opening a file in separate browser tab when clicked. |
The following example changes the behavior of the component to fetch a file list from a specific query.
<mgt-file-list
file-list-query="/me/drive/items/01BYE5RZYJ43UXGBP23BBIFPISHHMCDTOY/children"
></mgt-file-list>
The following example changes the behavior of the component to fetch a file list from a folder by providing the folder ID.
<mgt-file-list item-id="01BYE5RZYJ43UXGBP23BBIFPISHHMCDTOY"></mgt-file-list>
The following example changes the behavior of the component to fetch file list from a group by providing the group ID and folder path.
<mgt-file-list
group-id="8090c93e-ba7c-433e-9f39-08c7ba07c0b3"
item-path="/Design"
></mgt-file-list>
The following example changes the behavior of the component to fetch file list from a user by providing the user ID and folder ID.
<mgt-file-list
user-id="48d31887-5fad-4d73-a9f5-3c356e68a038"
item-id="01BYE5RZYFPM65IDVARFELFLNTXR4ZKABD"
></mgt-file-list>
The following example changes the behavior of the component to fetch file list by providing the insight type.
<mgt-file-list insight-type="shared"></mgt-file-list>
The following example enables the file upload feature.
<mgt-file-list enable-file-upload></mgt-file-list>
The following example limits the maximum number of files that can be uploaded to 5.
<mgt-file-list max-upload-file="5" enable-file-upload></mgt-file-list>
The following example limits the maximum file size that can be uploaded to 10,000 KB.
<mgt-file-list max-file-size="10000" enable-file-upload></mgt-file-list>
The following example excludes upload of files with file extensions ".doc, .pdf".
<mgt-file-list
excluded-file-extensions=".doc,.pdf"
enable-file-upload
></mgt-file-list>
CSS custom properties
The mgt-file-list component defines the following CSS custom properties.
<mgt-file-list class="file-list" insight-type="shared"></mgt-file-list>
.file-list {
/** mgt-file-upload custom styling */
--file-upload-background-color-drag: rgb(255, 0, 0, 0.5);
--file-upload-border-drag: 2px groove black;
--file-upload-button-background-color: orange;
--file-upload-button-background-color-hover: green;
--file-upload-button-text-color: whitesmoke;
--file-upload-dialog-background-color: azure;
--file-upload-dialog-text-color: yellow;
--file-upload-dialog-replace-button-background-color: white;
--file-upload-dialog-replace-button-background-color-hover: gray;
--file-upload-dialog-replace-button-text-color: black;
--file-upload-dialog-keep-both-button-background-color: black;
--file-upload-dialog-keep-both-button-background-color-hover: gray;
--file-upload-dialog-keep-both-button-text-color: white;
--file-upload-button-border: 2px dotted yellow;
--file-upload-dialog-replace-button-border: 2px dotted;
--file-upload-dialog-keep-both-button-border: 2px dashed;
--file-upload-dialog-border: 2px solid blue;
--file-upload-dialog-width: 300px;
--file-upload-dialog-height: 100px;
--file-upload-dialog-padding: 36px;
/** mgt-file custom styling */
--file-type-icon-height: 30px;
--file-border: 4px dotted #ffbdc3;
--file-border-radius: 8px;
--file-box-shadow: 0px 2px 4px rgba(0, 0, 0, 0.1);
--file-background-color: #e0f8db;
--file-background-color-focus: yellow;
--file-background-color-hover: green;
--file-padding: 8px;
--file-padding-inline-start: 12px;
--file-margin: 3px 4px;
--file-line1-font-size: 15px;
--file-line1-font-weight: 500;
--file-line1-color: gray;
--file-line1-text-transform: capitalize;
--file-line2-font-size: 14px;
--file-line2-font-weight: 300;
--file-line2-color: #e50000;
--file-line2-text-transform: lowercase;
--file-line3-font-size: 13px;
--file-line3-font-weight: 500;
--file-line3-color: purple;
--file-line3-text-transform: capitalize;
/** mgt-file-list CSS tokens */
--file-list-background-color: #e0f8db;
--file-list-box-shadow: none;
--file-list-border: 4px dotted #ffbdc3;
--file-list-border-radius: 10px;
--file-list-padding: 0;
--file-list-margin: 0;
--show-more-button-background-color: #fef8dd;
--show-more-button-background-color--hover: #ffe7c7;
--show-more-button-font-size: 14px;
--show-more-button-padding: 16px;
--show-more-button-border-bottom-right-radius: 12px;
--show-more-button-border-bottom-left-radius: 12px;
}
To learn more, see styling components.
Methods
| Method | Description |
|---|---|
| reload(clearCache = false) | Call the method to reload the component with potential new data based on its properties. Pass true to clear the cache before reloading. |
Reloading example
You can use the reload() method that is exposed on mgt-file-list by getting the mgt-file-list reference from the DOM and triggering the method in a button using the click event.
<mgt-file-list insight-type="shared"></mgt-file-list>
<button id="reload-btn">Reload Files</button>
const fileList = document.querySelector("mgt-file-list");
document.getElementById("reload-btn").addEventListener("click", () => {
// passing true will clear file cache before reloading
fileList.reload(true);
});
Events
| Event | When is it emitted | Custom data | Cancelable | Bubbles | Works with custom template |
|---|---|---|---|---|---|
itemClick |
Fired when the user selects a file. | Selected file | No | No | Yes, with a custom file template. |
For more information about handling events, see events.
Templates
The mgt-file-list component supports many templates that allow you to replace certain parts of the component. To specify a template, include a <template> element inside of a component and set the data-type value to one of the data types listed in the following table.
| Data type | Data context | Description |
|---|---|---|
| default | files: list of file objects |
The default template replaces the entire component with your own. |
| file | file: file object |
The template used to render each file. |
| no-data | No data context is passed | The template used when no data is available. |
| loading | No data context is passed | The template used while the component loads state. |
Template usage example
<mgt-file-list insight-type="shared">
<template data-type="loading">
<p>Getting files</p>
</template>
<template data-type="no-data">
<p>No files found</p>
</template>
<template data-type="file">
<p>File name{{file.name}}</p>
</template>
</mgt-file-list>
Microsoft Graph permissions
This component uses the following Microsoft Graph APIs. For each API call, one of the permissions listed is required.
| Configuration | Permissions | API |
|---|---|---|
| Default (no identifiers or query provided) | Files.Read, Files.ReadWrite, Files.Read.All, Files.ReadWrite.All, Group.Read.All, Group.ReadWrite.All, Sites.Read.All, Sites.ReadWrite.All | GET /me/drive/root/children |
Provide {drive-id} AND {item-id} |
Files.Read, Files.ReadWrite, Files.Read.All, Files.ReadWrite.All, Group.Read.All, Group.ReadWrite.All, Sites.Read.All, Sites.ReadWrite.All | GET /drives/{drive-id}/items/{item-id}/children |
Provide {group-id} AND {item-id} |
Files.Read, Files.ReadWrite, Files.Read.All, Files.ReadWrite.All, Group.Read.All, Group.ReadWrite.All, Sites.Read.All, Sites.ReadWrite.All | GET /groups/{group-id}/drive/items/{item-id}/children |
Provide ONLY {item-id} |
Files.Read, Files.ReadWrite, Files.Read.All, Files.ReadWrite.All, Group.Read.All, Group.ReadWrite.All, Sites.Read.All, Sites.ReadWrite.All | GET /me/drive/items/{item-id}/children |
Provide {site-id} AND {item-id} |
Files.Read, Files.ReadWrite, Files.Read.All, Files.ReadWrite.All, Group.Read.All, Group.ReadWrite.All, Sites.Read.All, Sites.ReadWrite.All | GET /sites/{site-id}/drive/items/{item-id}/children |
Provide {user-id} AND {item-id} |
Files.Read, Files.ReadWrite, Files.Read.All, Files.ReadWrite.All, Group.Read.All, Group.ReadWrite.All, Sites.Read.All, Sites.ReadWrite.All | GET /users/{user-id}/drive/items/{item-id}/children |
Provide {drive-id} AND {item-path} |
Files.Read, Files.ReadWrite, Files.Read.All, Files.ReadWrite.All, Group.Read.All, Group.ReadWrite.All, Sites.Read.All, Sites.ReadWrite.All | GET /drives/{drive-id}/root:/{item-path}:/children |
Provide {group-id} AND {item-path} |
Files.Read, Files.ReadWrite, Files.Read.All, Files.ReadWrite.All, Group.Read.All, Group.ReadWrite.All, Sites.Read.All, Sites.ReadWrite.All | GET /groups/{group-id}/root:/{item-path}:/children |
Provide {site-id} AND {item-path} |
Files.Read, Files.ReadWrite, Files.Read.All, Files.ReadWrite.All, Group.Read.All, Group.ReadWrite.All, Sites.Read.All, Sites.ReadWrite.All | GET /sites/{site-id}/root:/{item-path}:/children |
Provide {user-id} AND {item-path} |
Files.Read, Files.ReadWrite, Files.Read.All, Files.ReadWrite.All, Group.Read.All, Group.ReadWrite.All, Sites.Read.All, Sites.ReadWrite.All | GET /users/{user-id}/root:/{item-path}:/children |
Provide only {item-path} |
Files.Read, Files.ReadWrite, Files.Read.All, Files.ReadWrite.All, Group.Read.All, Group.ReadWrite.All, Sites.Read.All, Sites.ReadWrite.All | GET /me/drive/root:/{item-path}:/children |
insight-type is set to trending |
Sites.Read.All, Sites.ReadWrite.All | GET /me/insights/trending |
insight-type is set to used |
Sites.Read.All, Sites.ReadWrite.All | GET /me/insights/used |
insight-type is set to shared |
Sites.Read.All, Sites.ReadWrite.All | GET /me/insights/shared |
Providing enable-file-upload additionally requires |
Files.ReadWrite, Files.ReadWrite.All, Sites.ReadWrite.All | PUT /me/drive/root:/{filename}:/content POST /me/drive/root:/{filename}:/createUploadSession |
Subcomponents
The mgt-file-list component consists of one or more subcomponents that might require permissions other than the ones listed previously. For more information, see the documentation for each subcomponent: mgt-file.
Authentication
The control uses the global authentication provider described in the authentication documentation to fetch the required data.
Cache
| Object store | Cached data | Remarks |
|---|---|---|
fileLists |
List of file lists | Default cache list to store file lists. |
insightfileLists |
List of insight file lists | Used when insightType is provided. |
Note
The mgt-file-list component also uses the fileQueries object store in mgt-file IndexedDB to cache files when fileQueries is provided.
For details about how to configure the cache, see Caching.
Localization
The control exposes the following variables that can be localized. For details about how to set up localization, see Localizing components.
| String name | Default value |
|---|---|
| showMoreSubtitle | Show more items |
| filesSectionTitle | Files |
| sharedTextSubtitle | Shared |
Feedback
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see: https://aka.ms/ContentUserFeedback.
Submit and view feedback for