Skip to main content
We recommend that you familiarize yourselves with UI Customization Concepts before attempting to modify any components.

Overview

Skeleton

Panel

Header (Panel)

FullscreenButton (Panel Header)

Button to toggle full-screen mode for the Comments Sidebar. This component only appears when full-screen mode is enabled via the fullScreen prop or API method. Clicking it allows users to expand the sidebar to fill the entire viewport or return to normal mode.

CloseButton (Panel Header)

Search (Panel Header)

ResetFilterButton (Panel Header)

Status (Panel Header)

Trigger (Panel Header Status)
Name (Panel Header Status Trigger)
Arrow (Panel Header Status Trigger)
Indicator (Panel Header Status Trigger)
Content (Panel Header Status)
Item (Panel Header Status Content)
Icon (Panel Header Status Content Item)
Name (Panel Header Status Content Item)
Count (Panel Header Status Content Item)
Checkbox (Panel Header Status Content Item)
Checked (Panel Header Status Content Item Checkbox)
Unchecked (Panel Header Status Content Item Checkbox)

LocationFilterDropdown (Panel Header)

Trigger (Panel Header LocationFilterDropdown)
Label (Panel Header LocationFilterDropdown Trigger)
Content (Panel Header LocationFilterDropdown)

MinimalFilterDropdown (Panel Header)

Trigger (Panel Header MinimalFilterDropdown)
Content (Panel Header MinimalFilterDropdown)
SortDate (Panel Header MinimalFilterDropdown Content)
SelectedIcon (Panel Header MinimalFilterDropdown Content SortDate)
SortUnread (Panel Header MinimalFilterDropdown Content)
SelectedIcon (Panel Header MinimalFilterDropdown Content SortUnread)
FilterAll (Panel Header MinimalFilterDropdown Content)
SelectedIcon (Panel Header MinimalFilterDropdown Content FilterAll)
FilterUnread (Panel Header MinimalFilterDropdown Content)
SelectedIcon (Panel Header MinimalFilterDropdown Content FilterUnread)
FilterRead (Panel Header MinimalFilterDropdown Content)
SelectedIcon (Panel Header MinimalFilterDropdown Content FilterRead)
FilterResolved (Panel Header MinimalFilterDropdown Content)
SelectedIcon (Panel Header MinimalFilterDropdown Content FilterResolved)
FilterOpen (Panel Header MinimalFilterDropdown Content)
SelectedIcon (Panel Header MinimalFilterDropdown Content FilterOpen)
FilterReset (Panel Header MinimalFilterDropdown Content)
SelectedIcon (Panel Header MinimalFilterDropdown Content FilterReset)

MinimalActionsDropdown (Panel Header)

Trigger (Panel Header MinimalActionsDropdown)
Content (Panel Header MinimalActionsDropdown)
MarkAllRead (Panel Header MinimalActionsDropdown Content)
MarkAllResolved (Panel Header MinimalActionsDropdown Content)

DocumentFilterDropdown (Panel Header)

Trigger (Panel Header DocumentFilterDropdown)
Content (Panel Header DocumentFilterDropdown)
Document (Panel Header DocumentFilterDropdown Content)

FilterButton (Panel Header)

Filter (Panel)

Title (Panel Filter)

CloseButton (Panel Filter)

Location (Panel Filter)

Name (Panel Filter Location)
Search (Panel Filter Location)
Tags (Panel Filter Location Search)
Item (Panel Filter Location Search Tags)
HiddenCount (Panel Filter Location Search)
Input (Panel Filter Location Search)
DropdownIcon (Panel Filter Location Search)
Item (Panel Filter Location)
Checkbox (Panel Filter Location Item)
Checked (Panel Filter Location Item Checkbox)
Unchecked (Panel Filter Location Item Checkbox)
Name (Panel Filter Location Item)
Count (Panel Filter Location Item)
ViewAll (Panel Filter Location)

Document (Panel Filter)

Name (Panel Filter Document)
Search (Panel Filter Document)
Tags (Panel Filter Document Search)
Item (Panel Filter Document Search Tags)
HiddenCount (Panel Filter Document Search)
Input (Panel Filter Document Search)
DropdownIcon (Panel Filter Document Search)
Item (Panel Filter Document)
Checkbox (Panel Filter Document Item)
Checked (Panel Filter Document Item Checkbox)
Unchecked (Panel Filter Document Item Checkbox)
Name (Panel Filter Document Item)
Count (Panel Filter Document Item)
ViewAll (Panel Filter Document)

Involved (Panel Filter)

Name (Panel Filter Involved)
Search (Panel Filter Involved)
Tags (Panel Filter Involved Search)
Item (Panel Filter Involved Search Tags)
HiddenCount (Panel Filter Involved Search)
Input (Panel Filter Involved Search)
DropdownIcon (Panel Filter Involved Search)
Item (Panel Filter Involved)
Checkbox (Panel Filter Involved Item)
Checked (Panel Filter Involved Item Checkbox)
Unchecked (Panel Filter Involved Item Checkbox)
Name (Panel Filter Involved Item)
Count (Panel Filter Involved Item)

People (Panel Filter)

Name (Panel Filter People)
Search (Panel Filter People)
Tags (Panel Filter People Search)
Item (Panel Filter People Search Tags)
Name (Panel Filter People Search Tags Item)
Close (Panel Filter People Search Tags Item)
HiddenCount (Panel Filter People Search)
Input (Panel Filter People Search)
DropdownIcon (Panel Filter People Search)
Item (Panel Filter People)
Checkbox (Panel Filter People Item)
Checked (Panel Filter People Item Checkbox)
Unchecked (Panel Filter People Item Checkbox)
Name (Panel Filter People Item)
Count (Panel Filter People Item)

Tagged (Panel Filter)

Name (Panel Filter Tagged)
Search (Panel Filter Tagged)
Tags (Panel Filter Tagged Search)
Item (Panel Filter Tagged Search Tags)
Name (Panel Filter Tagged Search Tags Item)
Close (Panel Filter Tagged Search Tags Item)
HiddenCount (Panel Filter Tagged Search)
Input (Panel Filter Tagged Search)
DropdownIcon (Panel Filter Tagged Search)
Item (Panel Filter Tagged)
Checkbox (Panel Filter Tagged Item)
Checked (Panel Filter Tagged Item Checkbox)
Unchecked (Panel Filter Tagged Item Checkbox)
Name (Panel Filter Tagged Item)
Count (Panel Filter Tagged Item)

Assigned (Panel Filter)

Name (Panel Filter Assigned)
Search (Panel Filter Assigned)
Tags (Panel Filter Assigned Search)
Item (Panel Filter Assigned Search Tags)
Name (Panel Filter Assigned Search Tags Item)
Close (Panel Filter Assigned Search Tags Item)
HiddenCount (Panel Filter Assigned Search)
Input (Panel Filter Assigned Search)
DropdownIcon (Panel Filter Assigned Search)
Item (Panel Filter Assigned)
Checkbox (Panel Filter Assigned Item)
Checked (Panel Filter Assigned Item Checkbox)
Unchecked (Panel Filter Assigned Item Checkbox)
Name (Panel Filter Assigned Item)
Count (Panel Filter Assigned Item)

Custom (Panel Filter)

Name (Panel Filter Custom)
Search (Panel Filter Custom)
Tags (Panel Filter Custom Search)
Item (Panel Filter Custom Search Tags)
Name (Panel Filter Custom Search Tags Item)
Close (Panel Filter Custom Search Tags Item)
HiddenCount (Panel Filter Custom Search)
Input (Panel Filter Custom Search)
DropdownIcon (Panel Filter Custom Search)
Item (Panel Filter Custom)
Checkbox (Panel Filter Custom Item)
Checked (Panel Filter Custom Item Checkbox)
Unchecked (Panel Filter Custom Item Checkbox)
Name (Panel Filter Custom Item)
Count (Panel Filter Custom Item)

Category (Panel Filter)

Name (Panel Filter Category)
Search (Panel Filter Category)
Tags (Panel Filter Category Search)
Item (Panel Filter Category Search Tags)
Name (Panel Filter Category Search Tags Item)
Close (Panel Filter Category Search Tags Item)
HiddenCount (Panel Filter Category Search)
Input (Panel Filter Category Search)
DropdownIcon (Panel Filter Category Search)
Item (Panel Filter Category)
Checkbox (Panel Filter Category Item)
Checked (Panel Filter Category Item Checkbox)
Unchecked (Panel Filter Category Item Checkbox)
Name (Panel Filter Category Item)
Count (Panel Filter Category Item)

Priority (Panel Filter)

Name (Panel Filter Priority)
Search (Panel Filter Priority)
Tags (Panel Filter Priority Search)
Item (Panel Filter Priority Search Tags)
Name (Panel Filter Priority Search Tags Item)
Close (Panel Filter Priority Search Tags Item)
HiddenCount (Panel Filter Priority Search)
Input (Panel Filter Priority Search)
DropdownIcon (Panel Filter Priority Search)
Item (Panel Filter Priority)
Checkbox (Panel Filter Priority Item)
Checked (Panel Filter Priority Item Checkbox)
Unchecked (Panel Filter Priority Item Checkbox)
Name (Panel Filter Priority Item)
Count (Panel Filter Priority Item)

Status (Panel Filter)

Name (Panel Filter Status)
Search (Panel Filter Status)
Tags (Panel Filter Status Search)
Item (Panel Filter Status Search Tags)
Name (Panel Filter Status Search Tags Item)
Close (Panel Filter Status Search Tags Item)
HiddenCount (Panel Filter Status Search)
Input (Panel Filter Status Search)
DropdownIcon (Panel Filter Status Search)
Item (Panel Filter Status)
Checkbox (Panel Filter Status Item)
Checked (Panel Filter Status Item Checkbox)
Unchecked (Panel Filter Status Item Checkbox)
Name (Panel Filter Status Item)
Count (Panel Filter Status Item)

CommentType (Panel Filter)

Name (Panel Filter CommentType)
Item (Panel Filter CommentType)
Checkbox (Panel Filter CommentType Item)
Checked (Panel Filter CommentType Item Checkbox)
Unchecked (Panel Filter CommentType Item Checkbox)
Name (Panel Filter CommentType Item)
Count (Panel Filter CommentType Item)

Versions (Panel Filter)

Name (Panel Filter Versions)
Search (Panel Filter Versions)
Tags (Panel Filter Versions Search)
Item (Panel Filter Versions Search Tags)
Name (Panel Filter Versions Search Tags Item)
Close (Panel Filter Versions Search Tags Item)
HiddenCount (Panel Filter Versions Search)
Input (Panel Filter Versions Search)
DropdownIcon (Panel Filter Versions Search)
Item (Panel Filter Versions)
Checkbox (Panel Filter Versions Item)
Checked (Panel Filter Versions Item Checkbox)
Unchecked (Panel Filter Versions Item Checkbox)
Name (Panel Filter Versions Item)
Count (Panel Filter Versions Item)

GroupBy (Panel Filter)

Name (Panel Filter GroupBy)
Item (Panel Filter GroupBy)
Checkbox (Panel Filter GroupBy Item)
Checked (Panel Filter GroupBy Item Checkbox)
Unchecked (Panel Filter GroupBy Item Checkbox)
Name (Panel Filter GroupBy Item)
Count (Panel Filter GroupBy Item)

ResetButton (Panel Filter)

DoneButton (Panel Filter)

If you want to change the filters globally across all filters in the sidebar, customize the shared filter option item (shown below) once and reuse it. Use VeltCommentsSidebarWireframe.Filter.Item (and its Checkbox, Name, and Count subcomponents) to apply changes across all filters.

Item (Panel)

Checkbox (Panel Item)

Checked (Panel Item Checkbox)
Unchecked (Panel Item Checkbox)

Name (Panel Item)

Count (Panel Item)

List (Panel)

Item (Panel List)

Group (Panel List Item)
Name (Panel List Item Group)
Count (Panel List Item Group)
Arrow (Panel List Item Group)
Annotation (Panel List Item)

EmptyPlaceholder (Panel)

PageModeComposer (Panel)

FocusedThread

BackButton (FocusedThread)

DialogContainer (FocusedThread)

Styling

Disable ShadowDOM

  • By default, ShadowDOM is used to ensure that your app’s CSS does not interfere with the styling of the SDK components.
  • Disable the shadow dom to apply your custom CSS to the component.
Default: true
Example
API methods

Dark Mode

By default, all components are in Light Mode, but there are several properties and methods to enable Dark Mode. Default: false To enable Dark Mode for comments sidebar:
Example
API methods

Variants

Here are the variants that you can use in Comments Sidebar:
  • variant: This is the variant for the entire Comments Sidebar.
  • dialogVariant: This is the variant for the Comment Dialog that appears in the Comments Sidebar.
  • pageModeComposerVariant: This is the variant for the Comment Composer that appears in the Comments Sidebar in page mode.
  • focusedThreadDialogVariant: This is the variant for the Comment Dialog that appears when a focused thread mode is enabled.
React / Next.js