Skip to content

DocumentSidebar

Sidebar for the Document Explorer.

Lists documents, supports search + pagination, and emits actions for selecting, deleting, renaming, and mass deletion (where permitted).


Props

Prop nameDescriptionTypeValuesDefault
documentsList of documents to render in the sidebar.Array-
selectedDocIdCurrently selected document ID in the explorer UI (may be null before selection).union-
currentDocumentIdDocument ID that is currently open/active in the underlying client/store.union-
documentListLoadedWhether the initial document list has been loaded.boolean-
deletableDocumentsCountCount of documents that are deletable (typically owned and not currently active).number-
isSyncingWhether the app is currently syncing documents/metadata.boolean-

Events

Event namePropertiesDescription
selectEmitted when the user selects a document.
deleteEmitted when the user requests deleting a document.
mass-deleteEmitted when the user requests the mass deletion flow.
add-documentEmitted when the user requests creating a new document.
rename-documentEmitted when the user requests renaming a document.