# Velt ## Docs - [CLAUDE](https://docs.velt.dev/CLAUDE.md) - [Rewriter](https://docs.velt.dev/ai-copilot/design/overview.md): Let AI suggest improvements to your website text - [Setup](https://docs.velt.dev/ai-copilot/design/setup.md) - [Generate Token](https://docs.velt.dev/api-reference/rest-apis/v1/auth/generate-token.md) - [Add Comment Annotations](https://docs.velt.dev/api-reference/rest-apis/v1/comments-feature/comment-annotations/add-comment-annotations.md) - [Delete Comment Annotations](https://docs.velt.dev/api-reference/rest-apis/v1/comments-feature/comment-annotations/delete-comment-annotations.md) - [Get Comment Annotations](https://docs.velt.dev/api-reference/rest-apis/v1/comments-feature/comment-annotations/get-comment-annotations.md) - [Get Comment Annotations Count](https://docs.velt.dev/api-reference/rest-apis/v1/comments-feature/comment-annotations/get-comment-annotations-count.md) - [Update Comment Annotations](https://docs.velt.dev/api-reference/rest-apis/v1/comments-feature/comment-annotations/update-comment-annotations.md) - [Add Comments](https://docs.velt.dev/api-reference/rest-apis/v1/comments-feature/comments/add-comments.md) - [Delete Comments](https://docs.velt.dev/api-reference/rest-apis/v1/comments-feature/comments/delete-comments.md) - [Get Comments](https://docs.velt.dev/api-reference/rest-apis/v1/comments-feature/comments/get-comments.md) - [Update Comments](https://docs.velt.dev/api-reference/rest-apis/v1/comments-feature/comments/update-comments.md) - [Add Documents](https://docs.velt.dev/api-reference/rest-apis/v1/documents/add-documents.md) - [Delete Documents](https://docs.velt.dev/api-reference/rest-apis/v1/documents/delete-documents.md) - [Get Documents](https://docs.velt.dev/api-reference/rest-apis/v1/documents/get-documents.md) - [Move Documents](https://docs.velt.dev/api-reference/rest-apis/v1/documents/move-documents.md) - [Update Access for Documents](https://docs.velt.dev/api-reference/rest-apis/v1/documents/update-document-access.md) - [Update Disabled State for Documents](https://docs.velt.dev/api-reference/rest-apis/v1/documents/update-document-disable-state.md) - [Update Documents](https://docs.velt.dev/api-reference/rest-apis/v1/documents/update-documents.md) - [Add Folder](https://docs.velt.dev/api-reference/rest-apis/v1/folders/add-folder.md) - [Get Folders](https://docs.velt.dev/api-reference/rest-apis/v1/folders/get-folders.md) - [Update Folder](https://docs.velt.dev/api-reference/rest-apis/v1/folders/update-folder.md) - [Update Access for Folders](https://docs.velt.dev/api-reference/rest-apis/v1/folders/update-folder-access.md) - [Delete All User Data](https://docs.velt.dev/api-reference/rest-apis/v1/gdpr/delete-all-user-data-gdpr.md): Remove All User data from Velt. - [Get All User Data](https://docs.velt.dev/api-reference/rest-apis/v1/gdpr/get-all-user-data-gdpr.md): Get all feature data for a user stored in Velt. - [Get Delete All User Data Status](https://docs.velt.dev/api-reference/rest-apis/v1/gdpr/get-delete-user-data-status-gdpr.md): Get the status of the data deletion process for a user. - [Broadcast Event](https://docs.velt.dev/api-reference/rest-apis/v1/livestate/broadcast-event.md) - [Delete Data by Location](https://docs.velt.dev/api-reference/rest-apis/v1/locations/delete-data-by-location.md): Delete all data associated with a specific location - [Update Location](https://docs.velt.dev/api-reference/rest-apis/v1/locations/update-location.md): Update a Location's metadata - [Add Notifications](https://docs.velt.dev/api-reference/rest-apis/v1/notifications/add-notifications.md) - [Delete Notifications](https://docs.velt.dev/api-reference/rest-apis/v1/notifications/delete-notifications.md) - [Get Config](https://docs.velt.dev/api-reference/rest-apis/v1/notifications/get-config.md) - [Get Notifications](https://docs.velt.dev/api-reference/rest-apis/v1/notifications/get-notifications.md) - [Set Config](https://docs.velt.dev/api-reference/rest-apis/v1/notifications/set-config.md) - [Update Notifications](https://docs.velt.dev/api-reference/rest-apis/v1/notifications/update-notifications.md) - [Add Organizations](https://docs.velt.dev/api-reference/rest-apis/v1/organizations/add-organizations.md) - [Delete Organizations](https://docs.velt.dev/api-reference/rest-apis/v1/organizations/delete-organizations.md) - [Get Organizations](https://docs.velt.dev/api-reference/rest-apis/v1/organizations/get-organizations.md) - [Update Disabled State for Organizations](https://docs.velt.dev/api-reference/rest-apis/v1/organizations/update-organization-disable-state.md) - [Update Organizations](https://docs.velt.dev/api-reference/rest-apis/v1/organizations/update-organizations.md) - [Add User Groups](https://docs.velt.dev/api-reference/rest-apis/v1/user-groups/add-groups.md) - [Add Users to Groups](https://docs.velt.dev/api-reference/rest-apis/v1/user-groups/add-users-to-group.md) - [Delete Users from Groups](https://docs.velt.dev/api-reference/rest-apis/v1/user-groups/delete-users-from-group.md) - [Add Users](https://docs.velt.dev/api-reference/rest-apis/v1/users/add-users.md) - [Delete Users](https://docs.velt.dev/api-reference/rest-apis/v1/users/delete-users.md): Remove Users from an Organization or a Document. - [Get Users](https://docs.velt.dev/api-reference/rest-apis/v1/users/get-users.md) - [Update Users](https://docs.velt.dev/api-reference/rest-apis/v1/users/update-users.md) - [Add Domains](https://docs.velt.dev/api-reference/rest-apis/v1/workspace/add-domain.md) - [Delete Domains](https://docs.velt.dev/api-reference/rest-apis/v1/workspace/delete-domain.md) - [Add Activity Logs](https://docs.velt.dev/api-reference/rest-apis/v2/activities/add-activities.md) - [Delete Activity Logs](https://docs.velt.dev/api-reference/rest-apis/v2/activities/delete-activities.md) - [Get Activity Logs](https://docs.velt.dev/api-reference/rest-apis/v2/activities/get-activities.md) - [Update Activity Logs](https://docs.velt.dev/api-reference/rest-apis/v2/activities/update-activities.md) - [Add Permissions](https://docs.velt.dev/api-reference/rest-apis/v2/auth/add-permissions.md) - [Generate Signature](https://docs.velt.dev/api-reference/rest-apis/v2/auth/generate-signature.md) - [Generate Token](https://docs.velt.dev/api-reference/rest-apis/v2/auth/generate-token.md) - [Get Permissions](https://docs.velt.dev/api-reference/rest-apis/v2/auth/get-permissions.md) - [Remove Permissions](https://docs.velt.dev/api-reference/rest-apis/v2/auth/remove-permissions.md) - [Add Comment Annotations](https://docs.velt.dev/api-reference/rest-apis/v2/comments-feature/comment-annotations/add-comment-annotations.md) - [Delete Comment Annotations](https://docs.velt.dev/api-reference/rest-apis/v2/comments-feature/comment-annotations/delete-comment-annotations.md) - [Get Comment Annotations Count](https://docs.velt.dev/api-reference/rest-apis/v2/comments-feature/comment-annotations/get-comment-annotations-count.md) - [Get Comment Annotations](https://docs.velt.dev/api-reference/rest-apis/v2/comments-feature/comment-annotations/get-comment-annotations-v2.md) - [Update Comment Annotations](https://docs.velt.dev/api-reference/rest-apis/v2/comments-feature/comment-annotations/update-comment-annotations.md) - [Add Comments](https://docs.velt.dev/api-reference/rest-apis/v2/comments-feature/comments/add-comments.md) - [Delete Comments](https://docs.velt.dev/api-reference/rest-apis/v2/comments-feature/comments/delete-comments.md) - [Get Comments](https://docs.velt.dev/api-reference/rest-apis/v2/comments-feature/comments/get-comments.md) - [Update Comments](https://docs.velt.dev/api-reference/rest-apis/v2/comments-feature/comments/update-comments.md) - [Add CRDT Data](https://docs.velt.dev/api-reference/rest-apis/v2/crdt/add-crdt-data.md) - [Get CRDT Data](https://docs.velt.dev/api-reference/rest-apis/v2/crdt/get-crdt-data.md) - [Update CRDT Data](https://docs.velt.dev/api-reference/rest-apis/v2/crdt/update-crdt-data.md) - [Add Documents](https://docs.velt.dev/api-reference/rest-apis/v2/documents/add-documents.md) - [Delete Documents](https://docs.velt.dev/api-reference/rest-apis/v2/documents/delete-documents.md) - [Get Documents](https://docs.velt.dev/api-reference/rest-apis/v2/documents/get-documents-v2.md) - [Migrate Documents](https://docs.velt.dev/api-reference/rest-apis/v2/documents/migrate-documents.md) - [Migrate Documents Status](https://docs.velt.dev/api-reference/rest-apis/v2/documents/migrate-documents-status.md) - [Move Documents](https://docs.velt.dev/api-reference/rest-apis/v2/documents/move-documents.md) - [Update Access for Documents](https://docs.velt.dev/api-reference/rest-apis/v2/documents/update-document-access.md) - [Update Disabled State for Documents](https://docs.velt.dev/api-reference/rest-apis/v2/documents/update-document-disable-state.md) - [Update Documents](https://docs.velt.dev/api-reference/rest-apis/v2/documents/update-documents.md) - [Add Folder](https://docs.velt.dev/api-reference/rest-apis/v2/folders/add-folder.md) - [Delete Folder](https://docs.velt.dev/api-reference/rest-apis/v2/folders/delete-folder.md) - [Get Folders](https://docs.velt.dev/api-reference/rest-apis/v2/folders/get-folders.md) - [Update Folder](https://docs.velt.dev/api-reference/rest-apis/v2/folders/update-folder.md) - [Update Access for Folders](https://docs.velt.dev/api-reference/rest-apis/v2/folders/update-folder-access.md) - [Delete All User Data](https://docs.velt.dev/api-reference/rest-apis/v2/gdpr/delete-all-user-data-gdpr.md): Remove All User data from Velt. - [Get All User Data](https://docs.velt.dev/api-reference/rest-apis/v2/gdpr/get-all-user-data-gdpr.md): Get all feature data for a user stored in Velt. - [Get Delete All User Data Status](https://docs.velt.dev/api-reference/rest-apis/v2/gdpr/get-delete-user-data-status-gdpr.md): Get the status of the data deletion process for a user. - [Broadcast Event](https://docs.velt.dev/api-reference/rest-apis/v2/livestate/broadcast-event.md) - [Add Notifications](https://docs.velt.dev/api-reference/rest-apis/v2/notifications/add-notifications.md) - [Delete Notifications](https://docs.velt.dev/api-reference/rest-apis/v2/notifications/delete-notifications.md) - [Get Config](https://docs.velt.dev/api-reference/rest-apis/v2/notifications/get-config.md) - [Get Notifications](https://docs.velt.dev/api-reference/rest-apis/v2/notifications/get-notifications-v2.md) - [Set Config](https://docs.velt.dev/api-reference/rest-apis/v2/notifications/set-config.md) - [Update Notifications](https://docs.velt.dev/api-reference/rest-apis/v2/notifications/update-notifications.md) - [Add Organizations](https://docs.velt.dev/api-reference/rest-apis/v2/organizations/add-organizations.md) - [Delete Organizations](https://docs.velt.dev/api-reference/rest-apis/v2/organizations/delete-organizations.md) - [Get Organizations](https://docs.velt.dev/api-reference/rest-apis/v2/organizations/get-organizations-v2.md) - [Update Disabled State for Organizations](https://docs.velt.dev/api-reference/rest-apis/v2/organizations/update-organization-disable-state.md) - [Update Organizations](https://docs.velt.dev/api-reference/rest-apis/v2/organizations/update-organizations.md) - [Add User Groups](https://docs.velt.dev/api-reference/rest-apis/v2/user-groups/add-groups.md) - [Add Users to Groups](https://docs.velt.dev/api-reference/rest-apis/v2/user-groups/add-users-to-group.md) - [Delete Users from Groups](https://docs.velt.dev/api-reference/rest-apis/v2/user-groups/delete-users-from-group.md) - [Add Users](https://docs.velt.dev/api-reference/rest-apis/v2/users/add-users.md) - [Delete Users](https://docs.velt.dev/api-reference/rest-apis/v2/users/delete-users.md): Remove Users from an Organization or a Document. - [Get Users](https://docs.velt.dev/api-reference/rest-apis/v2/users/get-users-v2.md) - [Update Users](https://docs.velt.dev/api-reference/rest-apis/v2/users/update-users.md) - [Add Domains](https://docs.velt.dev/api-reference/rest-apis/v2/workspace/add-domain.md) - [Delete Domains](https://docs.velt.dev/api-reference/rest-apis/v2/workspace/delete-domain.md) - [API Methods Index](https://docs.velt.dev/api-reference/sdk/api/api-methods.md) - [React Hooks Index](https://docs.velt.dev/api-reference/sdk/api/react-hooks.md) - [Data models](https://docs.velt.dev/api-reference/sdk/models/data-models.md) - [Customize Behavior](https://docs.velt.dev/async-collaboration/activity/customize-behavior.md) - [Activity Logs](https://docs.velt.dev/async-collaboration/activity/overview.md) - [Setup](https://docs.velt.dev/async-collaboration/activity/setup.md) - [Customize Behavior](https://docs.velt.dev/async-collaboration/arrows/customize-behavior.md) - [Arrows](https://docs.velt.dev/async-collaboration/arrows/overview.md) - [Setup](https://docs.velt.dev/async-collaboration/arrows/setup.md) - [Customize Behavior](https://docs.velt.dev/async-collaboration/comments-sidebar/customize-behavior.md) - [Comments Sidebar](https://docs.velt.dev/async-collaboration/comments-sidebar/overview.md): Provide a toggleable sidebar to view and filter comments. - [Setup](https://docs.velt.dev/async-collaboration/comments-sidebar/setup.md) - [Customize Behavior](https://docs.velt.dev/async-collaboration/comments/customize-behavior.md) - [Notifications](https://docs.velt.dev/async-collaboration/comments/notifications.md): There are several options to send notifications to your users. - [Comments](https://docs.velt.dev/async-collaboration/comments/overview.md): 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. - [Ace Editor Setup](https://docs.velt.dev/async-collaboration/comments/setup/ace.md) - [ Comments](https://docs.velt.dev/async-collaboration/comments/setup/canvas.md): Add comments to an HTML Canvas. - [Overview](https://docs.velt.dev/async-collaboration/comments/setup/canvas-comments/overview.md) - [ChartJS Comments Setup](https://docs.velt.dev/async-collaboration/comments/setup/chart-comments-setup/chartjs.md) - [Custom Charts Setup](https://docs.velt.dev/async-collaboration/comments/setup/chart-comments-setup/custom-charts.md) - [Highcharts Comments Setup](https://docs.velt.dev/async-collaboration/comments/setup/chart-comments-setup/highcharts.md) - [NivoCharts Comments Setup](https://docs.velt.dev/async-collaboration/comments/setup/chart-comments-setup/nivo-charts.md) - [CodeMirror Setup](https://docs.velt.dev/async-collaboration/comments/setup/codemirror.md) - [Freestyle Setup](https://docs.velt.dev/async-collaboration/comments/setup/freestyle.md) - [Inline Comments Setup](https://docs.velt.dev/async-collaboration/comments/setup/inline-comments.md) - [Lexical Setup](https://docs.velt.dev/async-collaboration/comments/setup/lexical.md) - [Lottie Player Setup](https://docs.velt.dev/async-collaboration/comments/setup/lottie-player-setup.md) - [Page Mode Setup](https://docs.velt.dev/async-collaboration/comments/setup/page.md) - [Plate Setup](https://docs.velt.dev/async-collaboration/comments/setup/plate.md) - [Popover Setup](https://docs.velt.dev/async-collaboration/comments/setup/popover.md) - [Quill Setup](https://docs.velt.dev/async-collaboration/comments/setup/quill.md) - [SlateJS Setup](https://docs.velt.dev/async-collaboration/comments/setup/slatejs.md) - [Stream Setup](https://docs.velt.dev/async-collaboration/comments/setup/stream.md) - [Text Setup](https://docs.velt.dev/async-collaboration/comments/setup/text.md) - [Tiptap Setup](https://docs.velt.dev/async-collaboration/comments/setup/tiptap.md) - [Custom Video Player Setup](https://docs.velt.dev/async-collaboration/comments/setup/video-player-setup/custom-video-player-setup.md): Use this guide to add collaboration into your own custom video player. - [Prebuilt Video Player Setup](https://docs.velt.dev/async-collaboration/comments/setup/video-player-setup/video-player-setup.md): Use this guide if you want to set up a prebuilt video player from our SDK with collaborative features built in. - [Customize Behavior](https://docs.velt.dev/async-collaboration/comments/standalone-components/comment-composer/customize-behavior.md) - [Comment Standalone Composer](https://docs.velt.dev/async-collaboration/comments/standalone-components/comment-composer/overview.md) - [Setup](https://docs.velt.dev/async-collaboration/comments/standalone-components/comment-composer/setup.md) - [Customize Behavior](https://docs.velt.dev/async-collaboration/comments/standalone-components/comment-pin/customize-behavior.md) - [Comment Pin](https://docs.velt.dev/async-collaboration/comments/standalone-components/comment-pin/overview.md) - [Setup](https://docs.velt.dev/async-collaboration/comments/standalone-components/comment-pin/setup.md) - [Customize Behavior](https://docs.velt.dev/async-collaboration/comments/standalone-components/comment-thread/customize-behavior.md) - [Standalone Comment Thread](https://docs.velt.dev/async-collaboration/comments/standalone-components/comment-thread/overview.md) - [Setup](https://docs.velt.dev/async-collaboration/comments/standalone-components/comment-thread/setup.md) - [Customize Behavior](https://docs.velt.dev/async-collaboration/notifications/customize-behavior.md) - [In-app Notifications](https://docs.velt.dev/async-collaboration/notifications/overview.md) - [Setup](https://docs.velt.dev/async-collaboration/notifications/setup.md) - [Customize Behavior](https://docs.velt.dev/async-collaboration/reactions/customize-behavior.md) - [Inline Reactions](https://docs.velt.dev/async-collaboration/reactions/overview.md) - [Setup](https://docs.velt.dev/async-collaboration/reactions/setup.md) - [Customize Behavior](https://docs.velt.dev/async-collaboration/recorder/customize-behavior.md) - [Recorder](https://docs.velt.dev/async-collaboration/recorder/overview.md): The Recorder allows your users to create audio, screen, and video recordings. - [Setup](https://docs.velt.dev/async-collaboration/recorder/setup.md) - [Customize Behavior](https://docs.velt.dev/async-collaboration/view-analytics/customize-behavior.md) - [View Analytics](https://docs.velt.dev/async-collaboration/view-analytics/overview.md) - [Setup](https://docs.velt.dev/async-collaboration/view-analytics/setup.md) - [Python](https://docs.velt.dev/backend-sdks/python.md): Use the Velt Python SDK to simplify self-hosting backend implementation. Pass your DB and storage configs and let the SDK handle the data operations. - [Advanced Setup](https://docs.velt.dev/get-started/advanced.md): Optional advanced configuration options for Velt SDK - [Velt CLI](https://docs.velt.dev/get-started/cli.md): Use the add-velt CLI to scaffold Velt collaboration features into your Next.js app with a single command. - [Velt Installation MCP](https://docs.velt.dev/get-started/mcp-installer.md): Use the Velt MCP server to install collaboration features into React and Next.js projects through your AI coding agent. - [Overview](https://docs.velt.dev/get-started/overview.md) - [AI Plugins](https://docs.velt.dev/get-started/plugins.md): Install the Velt plugin in Cursor or Claude Code to get skills, rules, an expert agent, and MCP servers for building with the Velt SDK. - [Quickstart](https://docs.velt.dev/get-started/quickstart.md): Install and set up Velt in minutes in React, Angular, Vue, or HTML. - [Quickstart Old Copy](https://docs.velt.dev/get-started/quickstart-old.md): Quickstart for React. For other frameworks like `vue`, `angular`, `svelte`, `vanilla js` etc. check out the setup guide. - [Agent Skills](https://docs.velt.dev/get-started/skills.md): Use Velt Agent Skills to get accurate, best-practice code from AI coding agents like Claude Code, Cursor, and GitHub Copilot. - [CSS Injection](https://docs.velt.dev/global-styles/css-injection.md) - [Dark Mode](https://docs.velt.dev/global-styles/dark-mode.md) - [Global Styles](https://docs.velt.dev/global-styles/global-styles.md) - [Customize Behavior](https://docs.velt.dev/in-app-user-feedback/customize-behavior.md) - [Overview](https://docs.velt.dev/in-app-user-feedback/overview.md) - [Setup](https://docs.velt.dev/in-app-user-feedback/setup.md) - [AG Grid](https://docs.velt.dev/integrations/ag-grid.md) - [Overview](https://docs.velt.dev/key-concepts/overview.md) - [Customize Behavior](https://docs.velt.dev/live-co-editing/customize-behavior.md) - [Customize UI](https://docs.velt.dev/live-co-editing/customize-ui.md) - [Overview](https://docs.velt.dev/live-co-editing/overview.md) - [Setup](https://docs.velt.dev/live-co-editing/setup.md) - [MCP Servers (Beta)](https://docs.velt.dev/mcp/mcp.md) - [Managing Different Environments](https://docs.velt.dev/migration/environments.md): Manage production, staging, and development environments with Velt API keys - [Migrate from Cord to Velt](https://docs.velt.dev/migration/migrate-from-cord-to-velt.md) - [Migrate from Liveblocks to Velt](https://docs.velt.dev/migration/migrate-from-liveblocks-to-velt.md) - [Parts](https://docs.velt.dev/permission-management/share-and-invite/customize-ui/parts.md) - [Slots](https://docs.velt.dev/permission-management/share-and-invite/customize-ui/slots.md) - [Variables](https://docs.velt.dev/permission-management/share-and-invite/customize-ui/variables.md) - [Invite](https://docs.velt.dev/permission-management/share-and-invite/overview.md): A widget to invite others to collaborate together on a project - [Setup](https://docs.velt.dev/permission-management/share-and-invite/setup.md) - [Overview](https://docs.velt.dev/realtime-collaboration/crdt/overview.md): CRDT (Yjs) based collaborative editing. - [BlockNote Editor](https://docs.velt.dev/realtime-collaboration/crdt/setup/blocknote.md): Setup Multiplayer Editing for BlockNote Editor. - [CodeMirror Editor](https://docs.velt.dev/realtime-collaboration/crdt/setup/codemirror.md): Setup Multiplayer Editing for CodeMirror Editor. - [Core](https://docs.velt.dev/realtime-collaboration/crdt/setup/core.md): Setup Multiplayer Editing for any frameworks or custom implementations. - [React Flow Editor](https://docs.velt.dev/realtime-collaboration/crdt/setup/reactflow.md): Setup Multiplayer Editing for React Flow diagrams. - [Tiptap Editor](https://docs.velt.dev/realtime-collaboration/crdt/setup/tiptap.md): Setup Multiplayer Editing for Tiptap Editor. - [Customize Behavior](https://docs.velt.dev/realtime-collaboration/cursors/customize-behavior.md) - [Overview](https://docs.velt.dev/realtime-collaboration/cursors/overview.md): 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. - [Setup](https://docs.velt.dev/realtime-collaboration/cursors/setup.md) - [Customize Behavior](https://docs.velt.dev/realtime-collaboration/flock-mode/customize-behavior.md) - [Overview](https://docs.velt.dev/realtime-collaboration/flock-mode/overview.md): 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. - [Setup](https://docs.velt.dev/realtime-collaboration/flock-mode/setup.md) - [Customize Behavior](https://docs.velt.dev/realtime-collaboration/huddle/customize-behavior.md) - [Overview](https://docs.velt.dev/realtime-collaboration/huddle/overview.md): Enable slack-style effortless audio, video and screen sharing discussions inside your own product. It even comes with built in chat. - [Setup](https://docs.velt.dev/realtime-collaboration/huddle/setup.md) - [Webhooks](https://docs.velt.dev/realtime-collaboration/huddle/webhooks.md) - [Customize Behavior](https://docs.velt.dev/realtime-collaboration/live-selection/customize-behavior.md) - [Overview](https://docs.velt.dev/realtime-collaboration/live-selection/overview.md): Your users can see what part of the document others are interacting with in real-time. - [Setup](https://docs.velt.dev/realtime-collaboration/live-selection/setup.md) - [Overview](https://docs.velt.dev/realtime-collaboration/live-state-sync/overview.md): Sync and broadcast data in real-time across all connected clients. - [Redux Middleware](https://docs.velt.dev/realtime-collaboration/live-state-sync/redux-middleware.md) - [Setup](https://docs.velt.dev/realtime-collaboration/live-state-sync/setup.md) - [Customize Behavior](https://docs.velt.dev/realtime-collaboration/presence/customize-behavior.md) - [Overview](https://docs.velt.dev/realtime-collaboration/presence/overview.md): Your users can see other users online on the document. This makes your app feel alive. - [Setup](https://docs.velt.dev/realtime-collaboration/presence/setup.md) - [Customize Behavior](https://docs.velt.dev/realtime-collaboration/single-editor-mode/customize-behavior.md) - [Overview](https://docs.velt.dev/realtime-collaboration/single-editor-mode/overview.md): Allow only one user to edit at a time but still allow everyone to see the changes as they happen. - [Setup](https://docs.velt.dev/realtime-collaboration/single-editor-mode/setup.md): Enable Single Editor Mode to allow only one user to edit at a time while others remain in read-only mode. - [Overview](https://docs.velt.dev/realtime-collaboration/video-player-sync/overview.md) - [Setup](https://docs.velt.dev/realtime-collaboration/video-player-sync/setup.md) - [Version 3.0.0](https://docs.velt.dev/release-notes/3-0-0.md) - [April 16 2024](https://docs.velt.dev/release-notes/archive/april-16-2024.md) - [April 24 2024](https://docs.velt.dev/release-notes/archive/april-24-2024.md) - [Aug 12 2024](https://docs.velt.dev/release-notes/archive/aug-12-2024.md) - [Aug 13 2024](https://docs.velt.dev/release-notes/archive/aug-13-2024.md) - [Aug 14 2024](https://docs.velt.dev/release-notes/archive/aug-14-2024.md) - [Aug 16 2024](https://docs.velt.dev/release-notes/archive/aug-16-2024.md) - [Aug 21 2024](https://docs.velt.dev/release-notes/archive/aug-21-2024.md) - [Aug 22 2024](https://docs.velt.dev/release-notes/archive/aug-22-2024.md) - [Aug 6 2024](https://docs.velt.dev/release-notes/archive/aug-6-2024.md) - [Aug 8 2024](https://docs.velt.dev/release-notes/archive/aug-8-2024.md) - [Dec 28 2023](https://docs.velt.dev/release-notes/archive/dec-28-2023.md) - [Feb 13 2024](https://docs.velt.dev/release-notes/archive/feb-13-2024.md) - [Feb 20 2024](https://docs.velt.dev/release-notes/archive/feb-20-2024.md) - [Feb 27 2024](https://docs.velt.dev/release-notes/archive/feb-27-2024.md) - [Jan 14 2024](https://docs.velt.dev/release-notes/archive/jan-14-2024.md) - [July 02 2024](https://docs.velt.dev/release-notes/archive/july-02-2024.md) - [July 03 2024](https://docs.velt.dev/release-notes/archive/july-03-2024.md) - [July 04 2024](https://docs.velt.dev/release-notes/archive/july-04-2024.md) - [July 09 2024](https://docs.velt.dev/release-notes/archive/july-09-2024.md) - [July 10 2024](https://docs.velt.dev/release-notes/archive/july-10-2024.md) - [July 15 2024](https://docs.velt.dev/release-notes/archive/july-15-2024.md) - [July 17 2024](https://docs.velt.dev/release-notes/archive/july-17-2024.md) - [July 18 2024](https://docs.velt.dev/release-notes/archive/july-18-2024.md) - [July 19 2024](https://docs.velt.dev/release-notes/archive/july-19-2024.md) - [July 22 2024](https://docs.velt.dev/release-notes/archive/july-22-2024.md) - [July 23 2024](https://docs.velt.dev/release-notes/archive/july-23-2024.md) - [July 24 2024](https://docs.velt.dev/release-notes/archive/july-24-2024.md) - [July 26 2024](https://docs.velt.dev/release-notes/archive/july-26-2024.md) - [July 29 2024](https://docs.velt.dev/release-notes/archive/july-29-2024.md) - [July 31 2024](https://docs.velt.dev/release-notes/archive/july-31-2024.md) - [June 10 2024](https://docs.velt.dev/release-notes/archive/june-10-2024.md) - [June 24 2024](https://docs.velt.dev/release-notes/archive/june-24-2024.md) - [June 29 2024](https://docs.velt.dev/release-notes/archive/june-29-2024.md) - [June 30 2024](https://docs.velt.dev/release-notes/archive/june-30-2024.md) - [June 6 2024](https://docs.velt.dev/release-notes/archive/june-6-2024.md) - [March 14 2024](https://docs.velt.dev/release-notes/archive/march-14-2024.md) - [March 5 2024](https://docs.velt.dev/release-notes/archive/march-5-2024.md) - [May 10 2024](https://docs.velt.dev/release-notes/archive/may-10-2024.md) - [May 17 2024](https://docs.velt.dev/release-notes/archive/may-17-2024.md) - [May 23 2024](https://docs.velt.dev/release-notes/archive/may-23-2024.md) - [May 24 2024](https://docs.velt.dev/release-notes/archive/may-24-2024.md) - [May 29 2024](https://docs.velt.dev/release-notes/archive/may-29-2024.md) - [BlockNote CRDT Library](https://docs.velt.dev/release-notes/version-4/blocknote-changelog.md): Release Notes of Changes Affecting Velt BlockNote Library - [CodeMirror CRDT Library](https://docs.velt.dev/release-notes/version-4/codemirror-changelog.md): Release Notes of Changes Affecting Velt CodeMirror Library - [Core CRDT Library](https://docs.velt.dev/release-notes/version-4/crdt-core-changelog.md): Release Notes of Changes Affecting All CRDT Libraries - [Lexical Changelog](https://docs.velt.dev/release-notes/version-4/lexical-changelog.md): Release Notes of Changes Affecting Velt Lexical Library - [React Flow CRDT Library](https://docs.velt.dev/release-notes/version-4/reactflow-changelog.md): Release Notes of Changes Affecting Velt React Flow Library - [Velt SDK Changelog](https://docs.velt.dev/release-notes/version-4/sdk-changelog.md): Release Notes of changes added to the core Velt SDK - [Tiptap CRDT Library](https://docs.velt.dev/release-notes/version-4/tiptap-changelog.md): Release Notes of Changes Affecting Velt Tiptap CRDT Library - [Upgrade Guide](https://docs.velt.dev/release-notes/version-4/upgrade-guide.md) - [Core CRDT Library](https://docs.velt.dev/release-notes/version-5/crdt-core-changelog.md): Release Notes of Changes Affecting All CRDT Libraries - [Velt SDK Changelog](https://docs.velt.dev/release-notes/version-5/sdk-changelog.md): Release Notes of changes added to the core Velt SDK - [Upgrade Guide](https://docs.velt.dev/release-notes/version-5/upgrade-guide.md) - [Generating Auth Tokens](https://docs.velt.dev/security/auth-tokens.md) - [Content security policy](https://docs.velt.dev/security/content-security-policy.md) - [JWT Tokens](https://docs.velt.dev/security/jwt-tokens.md): Generate JWT Tokens for additional security - [Proxy Server](https://docs.velt.dev/security/proxy-server.md) - [Supported Regions](https://docs.velt.dev/security/supported-regions.md) - [Attachments](https://docs.velt.dev/self-host-data/attachments.md): Self-host your comments file attachments data while using Velt's components. Keep attachment storage on your infrastructure with minimal metadata stored on Velt servers. - [Comments](https://docs.velt.dev/self-host-data/comments.md): Self-host your comments data while using Velt's components. Keep comment storage on your infrastructure with minimal metadata stored on Velt servers. - [Overview](https://docs.velt.dev/self-host-data/overview.md): Self-host the user generated content on your infrastructure while storing only minimal identifiers on Velt servers. - [Reactions](https://docs.velt.dev/self-host-data/reactions.md): Self-host your reactions data while using Velt's components. Keep reaction storage on your infrastructure with minimal metadata stored on Velt servers. - [Recordings](https://docs.velt.dev/self-host-data/recordings.md): Self-host your recording annotation PII data while using Velt's components. Keep recorded files, identity, transcription, and attachment URLs on your infrastructure with only minimal identifiers stored on Velt servers. - [Users](https://docs.velt.dev/self-host-data/users.md): Self-host your users' PII while using Velt's collaboration features. Keep sensitive user data on your infrastructure with only user IDs stored on Velt servers. - [Temp release notes](https://docs.velt.dev/temp-release-notes.md) - [Temp release notes input](https://docs.velt.dev/temp-release-notes-input.md) - [Conditional Templates](https://docs.velt.dev/ui-customization/conditional-templates.md) - [Action Components](https://docs.velt.dev/ui-customization/custom-action-component.md) - [Custom Button](https://docs.velt.dev/ui-customization/features/async/arrows/custom-button.md) - [Parts](https://docs.velt.dev/ui-customization/features/async/arrows/parts.md) - [Slots](https://docs.velt.dev/ui-customization/features/async/arrows/slots.md) - [Variables](https://docs.velt.dev/ui-customization/features/async/arrows/variables.md) - [Comment Bubble](https://docs.velt.dev/ui-customization/features/async/comments/comment-bubble.md): This button shows the comment count and the author's avatar. This is used in Popover comments feature. - [Comment Dialog](https://docs.velt.dev/ui-customization/features/async/comments/comment-dialog-components.md): Comments Dialog Component. - [Comment Dialog Primitives](https://docs.velt.dev/ui-customization/features/async/comments/comment-dialog-primitives/overview.md): 92+ primitive components for building custom Comment Dialog interfaces with maximum flexibility. - [Comment Dialog — Structure](https://docs.velt.dev/ui-customization/features/async/comments/comment-dialog-structure.md): Canonical structure for the Velt Comment Dialog Wireframe (React & HTML mirrors). Order follows your provided JSX/HTML. Parent/child is defined only by the extension path. Direct children are marked with (Leaf) when they have no descendants. - [Variants](https://docs.velt.dev/ui-customization/features/async/comments/comment-dialog/pre-defined-variants.md) - [Styling](https://docs.velt.dev/ui-customization/features/async/comments/comment-dialog/styling.md) - [Comment Pin](https://docs.velt.dev/ui-customization/features/async/comments/comment-pin.md): The Pin that appears on the DOM when you place a Comment. - [Comment Player Timeline](https://docs.velt.dev/ui-customization/features/async/comments/comment-player-timeline.md) - [Comments Sidebar Button](https://docs.velt.dev/ui-customization/features/async/comments/comment-sidebar-button.md): The button used to open the Comments Sidebar panel. - [Comment Sidebar](https://docs.velt.dev/ui-customization/features/async/comments/comment-sidebar-components.md): Comment Sidebar Component. - [Comments Sidebar — Structure](https://docs.velt.dev/ui-customization/features/async/comments/comment-sidebar-structure.md): Canonical structure for the Velt Comments Sidebar Wireframe (React only). Order follows your provided JSX. Parent/child is defined ONLY by dot-path extensions. Direct children with no descendants are marked (Leaf). - [Comment Tool](https://docs.velt.dev/ui-customization/features/async/comments/comment-tool.md): The button to add new comments. - [Velt Video Player](https://docs.velt.dev/ui-customization/features/async/comments/comment-video-player.md) - [Styling](https://docs.velt.dev/ui-customization/features/async/comments/comments-sidebar/styling.md) - [Empty placeholder](https://docs.velt.dev/ui-customization/features/async/comments/comments-sidebar/subcomponents/empty-placeholder.md): The subcomponent of the Comments Sidebar that represents the placeholder when there are no Comments - [Overview](https://docs.velt.dev/ui-customization/features/async/comments/comments-sidebar/subcomponents/filter/overview.md): The subcomponent of the Comments Sidebar that represents the filter that is used to filter what Comments appear in the Sidebar - [Filter Type - Assigned](https://docs.velt.dev/ui-customization/features/async/comments/comments-sidebar/subcomponents/filter/subcomponents/assigned.md): The subcomponent of the Comments Sidebar Filter that represents the Assigned filter - [Filter Type - Category](https://docs.velt.dev/ui-customization/features/async/comments/comments-sidebar/subcomponents/filter/subcomponents/category.md): The subcomponent of the Comments Sidebar Filter that represents the Category - [Close button](https://docs.velt.dev/ui-customization/features/async/comments/comments-sidebar/subcomponents/filter/subcomponents/close-button.md): The subcomponent of the Comments Sidebar Filter that represents the Close button - [Filter Type - Comment Type](https://docs.velt.dev/ui-customization/features/async/comments/comments-sidebar/subcomponents/filter/subcomponents/comment-type.md): The subcomponent of the Comments Sidebar Filter that represents the Comment Type filter - [Filter Type - Custom](https://docs.velt.dev/ui-customization/features/async/comments/comments-sidebar/subcomponents/filter/subcomponents/custom.md): The subcomponent of the Comments Sidebar Filter that represents the Custom filter - [Filter Type - Document](https://docs.velt.dev/ui-customization/features/async/comments/comments-sidebar/subcomponents/filter/subcomponents/document.md): The subcomponent of the Comments Sidebar Filter that represents the Document filter - [Done button](https://docs.velt.dev/ui-customization/features/async/comments/comments-sidebar/subcomponents/filter/subcomponents/done-button.md): The subcomponent of the Comments Sidebar Filter that represents the Done Button - [Filter item](https://docs.velt.dev/ui-customization/features/async/comments/comments-sidebar/subcomponents/filter/subcomponents/filter-item.md): Used to customize all the filter option items of the Comments Sidebar Filter at once - [Groupby](https://docs.velt.dev/ui-customization/features/async/comments/comments-sidebar/subcomponents/filter/subcomponents/groupby.md): The subcomponent of the Comments Sidebar Filter that represents the Groupby filter option - [Filter Type - Involved](https://docs.velt.dev/ui-customization/features/async/comments/comments-sidebar/subcomponents/filter/subcomponents/involved.md): The subcomponent of the Comments Sidebar Filter that represents the Involved filter - [Filter Type - Location](https://docs.velt.dev/ui-customization/features/async/comments/comments-sidebar/subcomponents/filter/subcomponents/location.md): The subcomponent of the Comments Sidebar Filter that represents the Location filter - [Filter Type - Author](https://docs.velt.dev/ui-customization/features/async/comments/comments-sidebar/subcomponents/filter/subcomponents/people.md): The subcomponent of the Comments Sidebar Filter that represents the Author filter - [Filter Type - Priority](https://docs.velt.dev/ui-customization/features/async/comments/comments-sidebar/subcomponents/filter/subcomponents/priority.md): The subcomponent of the Comments Sidebar Filter that represents the Priority filter - [Reset button](https://docs.velt.dev/ui-customization/features/async/comments/comments-sidebar/subcomponents/filter/subcomponents/reset-button.md): The subcomponent of the Comments Sidebar Filter that represents the Reset Filter Button - [Filter Type - Status](https://docs.velt.dev/ui-customization/features/async/comments/comments-sidebar/subcomponents/filter/subcomponents/status.md): The subcomponent of the Comments Sidebar Filter that represents the Status filter - [Filter Type - Tagged](https://docs.velt.dev/ui-customization/features/async/comments/comments-sidebar/subcomponents/filter/subcomponents/tagged.md): The subcomponent of the Comments Sidebar Filter that represents the Tagged filter - [Title](https://docs.velt.dev/ui-customization/features/async/comments/comments-sidebar/subcomponents/filter/subcomponents/title.md): The subcomponent of the Comments Sidebar Filter that represents the Title - [Filter Type - Versions](https://docs.velt.dev/ui-customization/features/async/comments/comments-sidebar/subcomponents/filter/subcomponents/versions.md): The subcomponent of the Comments Sidebar Filter that represents the Version filter - [Focused thread](https://docs.velt.dev/ui-customization/features/async/comments/comments-sidebar/subcomponents/focused-thread.md) - [Header](https://docs.velt.dev/ui-customization/features/async/comments/comments-sidebar/subcomponents/header.md): The subcomponent of the Comments Sidebar that represents the Header of the Sidebar - [Overview](https://docs.velt.dev/ui-customization/features/async/comments/comments-sidebar/subcomponents/header/overview.md): The subcomponent of the Comments Sidebar that represents the Header of the Sidebar - [Overview](https://docs.velt.dev/ui-customization/features/async/comments/comments-sidebar/subcomponents/header/subcomponents/document-filter-dropdown/overview.md) - [Overview](https://docs.velt.dev/ui-customization/features/async/comments/comments-sidebar/subcomponents/header/subcomponents/location-filter-dropdown/overview.md) - [Overview](https://docs.velt.dev/ui-customization/features/async/comments/comments-sidebar/subcomponents/header/subcomponents/minimal-action-dropdown/overview.md) - [Overview](https://docs.velt.dev/ui-customization/features/async/comments/comments-sidebar/subcomponents/header/subcomponents/minimal-filter-dropdown/overview.md) - [Overview](https://docs.velt.dev/ui-customization/features/async/comments/comments-sidebar/subcomponents/header/subcomponents/status/overview.md) - [Content](https://docs.velt.dev/ui-customization/features/async/comments/comments-sidebar/subcomponents/header/subcomponents/status/subcomponents/content.md) - [Trigger](https://docs.velt.dev/ui-customization/features/async/comments/comments-sidebar/subcomponents/header/subcomponents/status/subcomponents/trigger.md) - [Overview](https://docs.velt.dev/ui-customization/features/async/comments/comments-sidebar/subcomponents/list/overview.md): The subcomponent of the Comments Sidebar that represents the List of Comments in the Sidebar - [Dialog container](https://docs.velt.dev/ui-customization/features/async/comments/comments-sidebar/subcomponents/list/subcomponents/dialog-container.md): You can customize the Comment Dialog that appears inside the Sidebar with this subcomponent - [Group](https://docs.velt.dev/ui-customization/features/async/comments/comments-sidebar/subcomponents/list/subcomponents/group.md): The subcomponent of the Comments Sidebar List that represents the Group - [Page mode composer](https://docs.velt.dev/ui-customization/features/async/comments/comments-sidebar/subcomponents/page-mode-composer.md): The subcomponent of the Comments Sidebar that represents the Composer that appears in Page Mode. - [Panel](https://docs.velt.dev/ui-customization/features/async/comments/comments-sidebar/subcomponents/panel.md): The subcomponent of the Comments Sidebar that represents the List of Comments in the Sidebar - [Reset filter button](https://docs.velt.dev/ui-customization/features/async/comments/comments-sidebar/subcomponents/reset-filter-button.md) - [Overview](https://docs.velt.dev/ui-customization/features/async/comments/comments-sidebar/subcomponents/sidebar-button/overview.md): The button that is used to open the Comments Sidebar panel. - [Styling](https://docs.velt.dev/ui-customization/features/async/comments/comments-sidebar/subcomponents/sidebar-button/styling.md) - [Comments count](https://docs.velt.dev/ui-customization/features/async/comments/comments-sidebar/subcomponents/sidebar-button/subcomponents/comments-count.md): The subcomponent on the Sidebar Button that shows the total - [Icon](https://docs.velt.dev/ui-customization/features/async/comments/comments-sidebar/subcomponents/sidebar-button/subcomponents/icon.md): The subcomponent on the Sidebar Button that shows the total - [Skeleton](https://docs.velt.dev/ui-customization/features/async/comments/comments-sidebar/subcomponents/skeleton.md): The subcomponent of the Comments Sidebar that represents the Skeleton loader that appears when the Sidebar is first loading. - [Variants](https://docs.velt.dev/ui-customization/features/async/comments/comments-sidebar/variants.md) - [Confirmation Dialog](https://docs.velt.dev/ui-customization/features/async/comments/confirm-dialog.md): The Confirmation Dialog that appears when you delete a comment annotation. - [Inline Comments Section](https://docs.velt.dev/ui-customization/features/async/comments/inline-comments-section.md): Components that appear when using Inline Comments - [MultiThread Comment Dialog](https://docs.velt.dev/ui-customization/features/async/comments/multithread-comment-dialog.md) - [Persistent Comment Mode Banner](https://docs.velt.dev/ui-customization/features/async/comments/persistent-comment-mode-banner.md): The persistent comment mode banner that appears when persistent mode is enabled and user is adding a comment. - [Comment Composer](https://docs.velt.dev/ui-customization/features/async/comments/standalone-components/comment-composer.md) - [Comment Thread](https://docs.velt.dev/ui-customization/features/async/comments/standalone-components/comment-thread.md) - [Text Comment Tool](https://docs.velt.dev/ui-customization/features/async/comments/text-comment-tool.md): The Comment Tool that appears when you highlight some text. - [Text Comment Toolbar](https://docs.velt.dev/ui-customization/features/async/comments/text-comment-toolbar.md): The Toolbar that appears when you highlight some text - [Inline Reactions Section](https://docs.velt.dev/ui-customization/features/async/inline-reactions.md): This component is used to render the reaction tool and all the reactions. - [Notifications Panel](https://docs.velt.dev/ui-customization/features/async/notifications/notifications-panel.md): The Notification Panel contains all notifications within the current organization. It appears when you click the notification tool or embed it directly on a page. - [Notifications Tool](https://docs.velt.dev/ui-customization/features/async/notifications/notifications-tool.md): The button that opens or closes the notification panel. - [Control Panel](https://docs.velt.dev/ui-customization/features/async/recorder/control-panel.md): Recorder control panel component. - [Media Source Settings](https://docs.velt.dev/ui-customization/features/async/recorder/media-source-settings.md): Media source settings component. - [Recorder player](https://docs.velt.dev/ui-customization/features/async/recorder/recorder-player.md): Recorder player component. This is the small player that appears when a recording is done. - [Recorder Player Expanded](https://docs.velt.dev/ui-customization/features/async/recorder/recorder-player-expanded.md): Recorder player expanded component. This is the expanded player that appears when user wants to view the recording in full screen. - [Recorder Tool](https://docs.velt.dev/ui-customization/features/async/recorder/recorder-tool.md): The button to add new recordings. - [Recording Preview Steps Dialog](https://docs.velt.dev/ui-customization/features/async/recorder/recording-preview-steps-dialog.md): Recording preview steps dialog component. - [Subtitles](https://docs.velt.dev/ui-customization/features/async/recorder/subtitles.md): Subtitles component. - [Transcription](https://docs.velt.dev/ui-customization/features/async/recorder/transcription.md): Transcription component. - [Video Editor](https://docs.velt.dev/ui-customization/features/async/recorder/video-editor.md): Video editor component. - [Cursors](https://docs.velt.dev/ui-customization/features/realtime/cursors.md): The Cursors component displays the cursors of users in a document. - [Parts](https://docs.velt.dev/ui-customization/features/realtime/huddle/parts.md) - [Slots](https://docs.velt.dev/ui-customization/features/realtime/huddle/slots.md) - [Variables](https://docs.velt.dev/ui-customization/features/realtime/huddle/variables.md) - [Live Selection](https://docs.velt.dev/ui-customization/features/realtime/live-selection.md) - [Presence](https://docs.velt.dev/ui-customization/features/realtime/presence.md): The Presence component displays the avatars of users in a room. - [Single Editor Mode](https://docs.velt.dev/ui-customization/features/realtime/single-editor-mode.md): Wireframes for the Single Editor Mode Panel. - [Layout Customization](https://docs.velt.dev/ui-customization/layout.md) - [Localisation](https://docs.velt.dev/ui-customization/localisation.md) - [Overview](https://docs.velt.dev/ui-customization/overview.md) - [Setup Wireframes](https://docs.velt.dev/ui-customization/setup.md) - [CSS Customization](https://docs.velt.dev/ui-customization/styling.md) - [Template Variables](https://docs.velt.dev/ui-customization/template-variables.md) - [Advanced Webhooks](https://docs.velt.dev/webhooks/advanced.md) - [Basic Webhooks](https://docs.velt.dev/webhooks/basic.md) ## OpenAPI Specs - [openapi](https://docs.velt.dev/api-reference/open-api/openapi.yaml) - [package](https://docs.velt.dev/package.json) - [package-lock](https://docs.velt.dev/package-lock.json) ## Optional - [Examples](https://velt.dev/examples) - [DevTools](https://velt.dev/devtools) Built with [Mintlify](https://mintlify.com).