ueberdosis/tiptap · error

The "provider" option is required for the CollaborationCaret

Error message

The "provider" option is required for the CollaborationCaret extension

What it means

Error "The "provider" option is required for the CollaborationCaret extension" thrown in ueberdosis/tiptap.

Source

Thrown at packages/extension-collaboration-caret/src/collaboration-caret.ts:148

        label.setAttribute('style', `background-color: ${user.color}`)
        label.insertBefore(document.createTextNode(user.name), null)
        cursor.insertBefore(label, null)

        return cursor
      },
      selectionRender: defaultSelectionBuilder,
      onUpdate: defaultOnUpdate,
    }
  },

  onCreate() {
    if (this.options.onUpdate !== defaultOnUpdate) {
      console.warn(
        '[tiptap warn]: DEPRECATED: The "onUpdate" option is deprecated. Please use `editor.storage.collaborationCaret.users` instead. Read more: https://tiptap.dev/api/extensions/collaboration-caret',
      )
    }
    if (!this.options.provider) {
      throw new Error('The "provider" option is required for the CollaborationCaret extension')
    }
  },

  addStorage() {
    return {
      users: [],
    }
  },

  addCommands() {
    return {
      updateUser: attributes => () => {
        this.options.provider.awareness.setLocalStateField('user', attributes)
        return true
      },
      user:
        attributes =>
        ({ editor }) => {

View on GitHub (pinned to 496d53afd7)

When it happens

Trigger: Thrown at packages/extension-collaboration-caret/src/collaboration-caret.ts:148 when the library encounters an invalid state.

Common situations: See trigger scenarios.

AI-assisted analysis of ueberdosis/tiptap@496d53afd7 (2026-08-26). Data as JSON: /api/errors/057e82386ff9d874. Report an issue: GitHub.