README.md

July 10, 2024 ยท View on GitHub

Demo (Documentation)

<IntlProvider locale="en">
    <ContentExplorer
        contentPreviewProps={{
            contentSidebarProps: {
                detailsSidebarProps: {
                    hasProperties: true,
                    hasNotices: true,
                    hasAccessStats: true,
                    hasClassification: true,
                    hasRetentionPolicy: true,
                },
                features: FEATURES,
                hasActivityFeed: true,
                hasMetadata: true,
                hasSkills: true,
                hasVersions: true,
            },
        }}
        features={FEATURES}
        rootFolderId={FOLDER_ID}
        token={TOKEN}
    />
</IntlProvider>

Screenshot

---

Props

PropTypeDefaultDescription
token*stringSee the developer docs.
autoFocusbooleanSee the developer docs.
canCreateNewFolderbooleantrueSee the developer docs.
canDeletebooleantrueSee the developer docs.
canDownloadbooleantrueSee the developer docs.
canPreviewbooleantrueSee the developer docs.
canRenamebooleantrueSee the developer docs.
canSetShareAccessbooleantrueSee the developer docs.
canSharebooleantrueSee the developer docs.
canUploadbooleantrueSee the developer docs.
contentPreviewPropsObject{}Props to be forwarded to the ContentPreview UI Element. See the developer docs.
contentUploaderPropsObject{}Props to be forwarded to the ContentUploader UI Element. See the developer docs.
currentFolderIdstringThe current folder shown for the content explorer. This should be a sub folder to the root folder.
defaultViewstringfilesSee the developer docs.
initialPagenumber1See the developer docs.
initialPageSizenumber50See the developer docs.
isTouchbooleanSee the developer docs.
languagestringen-USSee the Internationalization section
logoUrlstringSee the developer docs.
messagesMap<string, string>See the Internationalization section
onCreateFolder>)Callback function for when a folder is created.
onDeletefunction(Array<File>)Callback function for when item(s) are deleted.
onDownloadfunction(Array<File>)Callback function for when item(s) are downloaded.
onNavigatefunction(File)Callback function for when navigating into a folder.
onPreviewfunction(File)Callback function for when an item is previewed.
onRenamefunction(File)Callback function for when an item is renamed.
onSelectfunction(Array<Folder|File|Web Link>)Callback function for when item(s) are selected.
onUploadfunction(Array<File>)Callback function for when item(s) are uploaded.
requestInterceptorfunctionSee the developer docs.
responseInterceptorfunctionSee the developer docs.
rootFolderIdstring0The root folder for the content explorer.
sharedLinkstringSee the developer docs.
sharedLinkPasswordstringSee the developer docs.
sortBystringnameSee the developer docs.
sortDirectionstringascSee the developer docs.

Keyboard Shortcuts

See the developer docs.