/* Hide scrollbar for Chrome, Safari and Opera */
::-webkit-scrollbar {
  display: none;
}

/* Hide scrollbar for IE, Edge and Firefox */
* {
  -ms-overflow-style: none;  /* IE and Edge */
  scrollbar-width: none;  /* Firefox */
}

#content-area {
  overflow: scroll !important;
}

User Class Properties

UserOptions Class Properties

Velt

Documentation

UI Customization

API Reference

Release Notes

Examples

Get API Key

Quickstart for React. For other frameworks like `vue`, `angular`, `svelte`, `vanilla js` etc. check out the setup guide.

Quickstart

Steps to integrate Velt into an existing app

1. Install

Autheticate your logged in users with the SDK.

2. Authenticate

3. Initialize Document

Advanced Setup Options

Set Document

Set Location

Use Multiple Locations at once

Remove Locations

Your users can add comments in context to ask questions, leave feedback, report bugs etc. We handle all complexity to ensure the comments are robust against content changes. We support many types of comment UX patterns as illustrated below.

Overview

Comments

Customize Behavior

There are several options to send notifications to your users.

Comments Notifications

In-app Notifications

Setup

Inline Reactions

The Recorder allows your users to create audio, screen, and video recordings.

Recorder

View Analytics

Arrows

Your users can see other users online on the document. This makes your app feel alive.

Your users can view each other's cursors when interacting on the same document. This makes your app more alive. We handle the complexity of adapting the cursors to different screen sizes, differences in content etc.

This is like Figma's follow along feature. Start a shared session in a click. One person is the leader, and whatever they do - like clicking, scrolling, or navigating - happens automatically on everyone else's screen.

Enable slack-style effortless audio, video and screen sharing discussions inside your own product. It even comes with built in chat.

Huddle Webhooks

Your users can see what part of the document others are interacting with in real-time.

Allow users to sync state across forms in different clients

Redux Middleware

Lock down forms or settings dashboards so only a single editor can edit at once.

Replace component layout

Remove Components

Reorder Components

Themes

Remove Shadow DOM

Dark Mode

Use CSS Library

Use Custom CSS

Template Variables

Conditional Templates

Variants

This component is used to render the reaction tool and all the reactions.

Styling

Slots

Custom Button

Parts

Variables

Create Your Own UI

Comments Webhooks

Generating Auth Tokens

Generate JWT Tokens for additional security

JWT Tokens

Proxy Server

Add Organizations

Update Organizations

Delete Organizations

Get Organizations

Get Organizations v2

Update Disabled State for Organizations

Add Documents

Update Documents

Delete Documents

Get Documents

Get Documents v2

Update Access for Documents

Update Disabled State for Documents

Update Location

Delete all data associated with a specific location

Delete Data by Location

Add Users

Update Users

Remove Users from an Organization or a Document.

Delete Users

Delete All User Data (GDPR)

Get Users

Get Users v2

Add User Groups

Add Users to Groups

Delete Users from Groups

Add Notifications

Update Notifications

Delete Notifications

Get Notifications

Get Notifications v2

React Hooks

CommentAnnotation

CommentSelectionChangeData

CommentSidebarConfig

CommentSidebarCustomActionEventData

CommentSidebarData

Velt Client Config

ContactListScopeForOrganizationUsers

CursorUser

CustomCss

CustomFilter

DocumentMetadata

EditorAccessTimer

FlockOptions

LiveStateData

LocationMetadata

MediaPreviewConfig

PageInfo

PresenceUser

RecorderAnnotation

RecorderData

RewriterAnnotation

SyncVideoPlayer

UserContactSelectedPayload

UserContactUs

UserFeedback

Export Cord Data for Migration

AG Grid

Property	Type	Optional	Description
`userId`	string	No	Unique user identifier used to identify your user.
`name`	string	Yes	The full name of your user. Defaults to a random avatar name if not provided.
`photoUrl`	string	Yes	The display picture URL of your user. Defaults to a random avatar image if not provided.
`email`	string	Yes	Required for sending email or Slack notifications to users about comments and mentions.
`plan`	string	Yes	The product plan the user is on.
`organizationId`	string	Yes	Autogenerated organizationId based on the organizationId you provide.
`clientorganizationId`	string	Yes	The original organizationId provided by you.
`color`	string	Yes	A color assigned to the user for the current session, used for avatar border, live cursor, selection etc.
`textColor`	string	Yes	Used in the text color of the user’s intial when photoUrl is not present.
`type`	string	Yes	The type of user.
`isReadOnly`	boolean	Yes	Indicates if the user has read-only access.
`isAnonymous`	boolean	Yes	Indicates if the user is anonymous and can only view comments.
`isGuest`	boolean	Yes	Indicates if the user is a guest.
`isAdmin`	boolean	Yes	Use this to set the user as an admin. You also need to ensure that the jwt token you generate also has this property set to true.
`groupId`	string	Yes	[DEPRECATED] A domain name or identifier used to cluster a group of users who work together.
`clientGroupId`	string	Yes	[DEPRECATED] The original groupId provided by the user.
`initial`	string	Yes	First letter of the user’s first name.

Property	Type	Optional	Description
`replaceContacts`	boolean	Yes	If set to true, it will replace the user’s personal and group contacts with the ones provided.
`authToken`	string	Yes	The authentication token of the user.

REST APIs

Reference

User

`User` Class Properties

`UserOptions` Class Properties

REST APIs

Reference

​User Class Properties

​UserOptions Class Properties

`User` Class Properties

`UserOptions` Class Properties