README.md

July 10, 2024 ยท View on GitHub

Demo (Documentation)

<IntlProvider locale="en">
    <ContentSidebar
        detailsSidebarProps={{
            hasProperties: true,
            hasNotices: true,
            hasAccessStats: true,
            hasClassification: true,
            hasRetentionPolicy: true,
        }}
        features={FEATURES}
        fileId={FILE_ID}
        hasActivityFeed
        hasMetadata
        hasSkills
        hasVersions
        token={TOKEN}
        {...PROPS}
    />
</IntlProvider>

Screenshot

---

Props

PropTypeDefaultDescription
fileId*stringThe id of the file to preview.
token*stringSee the developer docs.
activitySidebarPropsActivitySidebarProps{}See below
detailsSidebarPropsDetailsSidebarProps{}See below
hasActivityFeedbooleanfalseSee the developer docs.
hasMetadatabooleanfalseSee the developer docs.
hasSkillsbooleanfalseSee the developer docs.
hasVersionsbooleanfalseSee the developer docs.
languagestringen-USSee the Internationalization section
messagesMap<string, string>See the Internationalization section
metadataSidebarPropsMetadataSidebarProps{}See below
requestInterceptorfunctionSee the developer docs.
responseInterceptorfunctionSee the developer docs.
skillsSidebarPropsSkillsSidebarProps{}See below

ActivitySidebarProps

PropTypeDefaultDescription
onCommentCreatefunctionSee the developer docs.
onCommentDeletefunctionSee the developer docs.

DetailsSidebarProps

PropTypeDefaultDescription
hasAccessStatsbooleanfalseSee the developer docs.
hasNoticesbooleanfalseSee the developer docs.
hasPropertiesbooleanfalseSee the developer docs.

MetadataSidebarProps

PropTypeDefaultDescription
selectedTemplateKeystringtemplateKey for the template to show. If provided,
no other templates will be visible.
templateFiltersArray<string>Template field IDs for fields that should be visible and editable.
or stringTo show a single field, pass the ID as a string; to show multiple
fields, pass an array of IDs as strings. If no templateFilters are
provided, then all fields will be visible and editable.

SkillsSidebarProps

PropTypeDefaultDescription
tbd---