Changelog
New Features
- [Folders]: Added an API to fetch folder metadata and subfolders by organizationId, folderId with pagination.
- [Documents]: Added an API to fetch document metadata by organizationId, folderId or documentIds with pagination.
- [Comments]: Added a new API to fetch comment annotations by organizationId, folderId or documentIds with pagination and filtering options. This is different from the existing subscription API which susbcribes to realtime changes to the comments data.
New Features
-
[Folders]: Introducing Folders! Organize documents hierarchically with granular access control. Modeled after Google Drive’s folder structure.
- Folders can contain documents and other folders.
- Uses same permission model as Organizations and Documents.
- APIs:
- Frontend: Subscribe to folders and query by folderId.
- Backend: CRUD operations for folders and access control. Learn More
- Added folder support to existing relevant APIs.
-
[Folders]: API to subscribe to a particular folder and all its documents at the same time.
Using Hooks:
Using API:
- [Locations]: API to subscribe to a particular location within a single or multiple documents. This will only fetch a filtered set of data associated with that location.
Using Hooks:
Using API:
Improvements
- [Comments]: Paste image from clipboard as attachment in the comment composer.
Bug Fixes
- [Comments]: Fixed an issue where standalone comment composer was not working.
- [Comments]: Fixed an issue where line breaks were not being preserved in comments.
- [Comments]: Fixed an issue where image preview was not opening in sidebar.
- [Comments]: Fixed an issue where inline comment threads had unnecessary scroll.
- [Comments]: Fixed an issue where assign user component was not being removed after editing a comment.
Improvements
- [Core]: Added support for additional regions.
Bug Fixes
- [Core]: Fixed an issue where setting an avatar image URL would not update all the time.
- [Comments]: Fixed URL parsing issues when editing comments.
New Features
- [Core]: Added
useUnsetDocuments
hook to unsubscribe from all documents at once.
Bug Fixes
- [Core]: Fixed performance issues in @mention autocomplete feature.
- [Comments]: Fixed spacing around mentioned tags when editing comments.
Improvements
- [Core]: Added
unsetDocuments
method to unsubscribe from all documents at once.
- [Comments]: Added new props to customize inline comments section:
composerPosition
: Position the comment composer at ‘top’ or ‘bottom’ of the sectionsortBy
: Sort comments by ‘createdAt’ or ‘lastUpdated’sortOrder
: Sort comments in ‘asc’ or ‘desc’ order
- [Core]: Flushed cached data for Notifications and Comments when the User signs out.
Bug Fixes
- [Comments]: Fixed an issue where the comments data was not updated in the frontend local cache when all comments were deleted from the document using REST API.
Improvements
- [Comments]: Removed extra margin appearing around @mention chips in comment text.
- [Comments]: Improved the alignment of the inline assign dropdown menu.
- [Notifications]: Removed the people tab by default in notification panel. You can enable it using custom props.
Bug Fixes
- [Comments]: Fixed an issue where delete confirmation dialog was appearing behind the sidebar.
- [Comments]: Fixed an issue where inline comments would disappear from the inline section when comment was clicked in the sidebar.
- [UI]: Fixed dark mode styling issues in autocomplete tool and copy link button.
- [Notifications]: Fixed an issue where loading skeleton was visible in notifications “For You” tab when no document was set.
Improvements
- [REST API]: Added
notificationId
parameter to Add Notifications REST API so you can have more control on the ID being set and prevent duplicate notifications. - [REST API]: Added
notifyAll
parameter to Add Notifications REST API to target notifications to specific users. If its set to false, the notification will be sent to only the users specified in the request.
Bug Fixes
- [UI Customization]: Fixed an issue where
Velt Button
was not returning context data in the callback. - [Comments]: Fixed an issue where
getCommentAnnotationsCount
andgetCommentAnnotations
APIs were first returning empty data before returning the actual data.
Known Issues
- [UI Customization]: Velt Button component is missing context data in the callback.
Improvements
- [Comments]: Added loading skeleton in inline comments section.
- [Performance]: Improved SDK performance for apps with complex UI.
Bug Fixes
- [Comments]: Fixed multiple documents subscription permission issue. It should now subscribe to 30 documents at a time.
- [Comments]: Fixed an issue where
selectCommentByAnnotationId
API was not working when triggered after a comment was clicked in the sidebar. - [UI Customization]: Fixed an issue where
Velt Button
was not triggering callback when type was set tobutton
. - [UI Customization]: Fixed an issue where
Velt Button
with typesingle-select
was incorrectly toggling when clicked again.
New Features
- [Live State]: Now you can broadcast events with any arbitrary data to any document using the new REST API.
Improvements
-
[UI Customization]: Simplified how UI can be customized using wireframes. React support pending.
- Simplified component visibility control: conditionally show/hide any component directly without needing to specify parent or sibling wireframes.
- Added direct class application: classes added to wireframes are automatically applied to the rendered components.
- Full children support: all wireframe components can now contain nested child elements.
Breaking change: This only affects you if you added CSS to wireframe component selectors.
- Wireframe components are no longer rendered within Velt components. There were a few wireframe components that were rendered within Velt components.
- CSS targeting wireframe component selectors needs to be updated to target Velt component selectors directly.
- [Comments]: Improved comment dialog positioning to be more stable when near screen edges, providing a smoother user experience.
Bug Fixes
- [Comments]: Fixed an issue where custom lists were extending out of the comment dialog.
Bug Fixes
- [Comments]: Fixed an issue where comments was not working for fresh documents if the advanced queries option wasn’t enabled. Note this is mandatory for all versions of v4 SDK.
- [Comments]: Fixed an issue where updateContactList was not working.
- [Comments]: Fixed an issue where in inline comments, the resolve button was visible for all messages in a thread.
Features
- [Security] You can now self-host your user PII metadata.
- Send only userId instead of full user object and a client side data provider.
- Components will automatically fetch the user details from the provider and hydrate the user object.
- The metadata will not be sent to Velt servers.
Improvements
- [Core]: Added core performance improvements throughout the SDK.
- [Recorder]: Added new API methods to get the recorded data.
- [Recorder] Added missing props to disable shadow DOM for recorder components in React SDK.
Bug Fixes
- [Recording]: Fixed Safari recording compatibility issues across some macOS versions.
Features
- [Core]: Added support for React v19 in
sdk-react
library.
Improvements
- [Authentication]: Made
organizationId
mandatory inidentify
method. - [New Accounts]: New accounts or API keys will have advanced queries turned on by default.
Bug Fixes
- [Notifications]: Fixed an issue where notifications were not working when organizationId was not set.
- [REST API]: Fixed an issue where the REST API for adding or updating organizations and documents did not allow custom fields in metadata.
Improvements
- [Comments]: Improved comments performance with optimistic local-first reads and writes.
- [Notifications]: Added
documentMetadata
object in the properties that are sent to SendGrid for emails.
Bug Fixes
- [Comments]: Fixed an issue where custom metadata added to a comment using
addContext
was not sent to the first notification event (newlyAdded
).
Features
- [Comments]: Added a
transcriptionDone
event callback when recording transcription is done.
Using Hooks:
Using API:
Improvements
- [Comments]: Disabled @here in the contacts dropdown by default. You can turn it on using this.
Bug Fixes
- [Comments]: Removed virtual scroll from autocomplete panel and removed fixed height. This was causing weird UI issues. We are rewriting the autocomplete panel with virtual scroll.
- [Comments]: Fixed an issue where horizontal scroll was visible on sidebar in some scenarios.
- [Comments]: Fixed an issue where the
shadowDom
prop was not passed down to page mode composer in comment sidebar. - [Comments]: Fixed an issue where
sortData
prop was not working in comments sidebar.
Bug Fixes
- [Comments]: Fixed an issue with
getCommentAnnotationsCount
API when filtering by specific document IDs in the query.
Improvements
- [Security]: Merged security patch in the React package
Bug Fixes
- [Recording]: Fixed an issue where the floating recording player was visible for threaded recorder notes
- [Comments]: Fixed an issue where the sidebar button border color was using light mode colors in dark mode
New APIs
1. setDocuments
-
Set multiple documents at the same time. You can specify 30 documents at a time.
-
The first document in the list will be considered as the root document.
-
For features like comments, notifications, recorder, reactions etc. you will be able to read and write to multiple documents at the same time.
-
For features like cursors, presence, huddle, live state sync etc. it will default to the root document.
-
Sidebar will automatically show data from all the documents.
-
Params:
documents
: Document[]options?
: SetDocumentsRequestOptions
Using Hooks:
Using API:
2. getCommentAnnotations
- Get all the comment annotations for all the specified documents.
- You can specify 30 documents at a time.
- If you don’t specify any query, it will return data from the documents specified in the
setDocuments
method.
Using Hooks:
Using API:
3. getCommentAnnotationsCount
- Get the total and unread comment annotations count of all the comment annotations for all the specified documents.
- You can specify 30 documents at a time.
- If you don’t specify any query, it will return data from the documents specified in the
setDocuments
method.
Using Hooks:
Using API:
4. Read/Write data from multiple documents on the same page
- If you want to display data (eg: comments) from multiple documents on the same page, you can add
data-velt-document-id
attribute to the container that contains thedocument
. - It will be used to identify which part of the DOM belongs to which document.
Other updates
New Features
- [Comments]: Added support for Status Filter in Comments Sidebar’s main filter menu:
- By default, the status filter is disabled in the main filter menu.
- Currently, it doesn’t support grouping.
- Added Wireframe support for this. Learn more.
- If you were using wireframes before, you will add this to your wireframes.
Bug Fixes
- [Comments]: Fixed an issue where empty state visibility was not visible when filter is applied and grouping was disabled.
- [Comments]: Fixed an issue where users could click on the comment in the sidebar and navigate to comments when they shouldn’t.
Was this page helpful?