MCPcopy
hub / github.com/ueberdosis/tiptap

github.com/ueberdosis/tiptap @v3.27.1 sqlite

repository ↗ · DeepWiki ↗ · release v3.27.1 ↗
2,279 symbols 6,864 edges 1,122 files 208 documented · 9%
README

Tiptap Editor

LFX Health Score Build Status Version Downloads License Chat Sponsor LFX Active Contributors

Tiptap Editor

The Tiptap Editor is a headless, framework-agnostic rich text editor that's customizable and extendable through extensions. Its headless nature means it comes without a set user interface, offering full design freedom (for a jumpstart, see linked UI templates below). Tiptap is based on the highly reliable ProseMirror library.

Tiptap Editor is complemented by the collaboration open-source backend Hocuspocus. Both the Editor and Hocuspocus form the foundation of the Tiptap Suite.

How does the Tiptap Editor work?

  • Headless Framework: Tiptap does not rely on a user interface. So there is no need for class overrides or code hacks. If you do need an example UI feel free to browse our UI templates linked below.
  • Framework-agnostic: The Tiptap Editor is designed to work across different frontend frameworks. This means whether you're using Vue, React, or plain JavaScript, Tiptap integrates without compatibility issues.
  • Extension based: Extensions in Tiptap allow for a tailored editing experience, from simple text styling to advanced features like drag-and-drop block editing. You have the option to choose from over 100 extensions available in the documentation and community to enhance your editor's functionality.
  • Customize your UX: The editor was built to give you control to define your own extensions and nodes.

Editor Pro Extensions

The Pro Extensions are a set of advanced functionalities that enhance the capabilities of the Tiptap Editor. They are additional features that can be integrated into the base editor to provide more sophisticated editing options.

Key functionalities include collaborative editing, commenting, versioning, document conversion and AI related features. Review the docs right here.

Pro Extensions need a valid subscription.

Make your editor collaborative

Interested in collaborative editing? Check out our open-source package Hocuspocus - a collaboration backend built around the CRDT power of Yjs. Hocuspocus serves as the backbone for the Tiptap Suite.

Documentation

For more detailed information, make sure to check out our documentation. If you encounter any problems or have suggestions for our system, please open an issue.

Examples, CodeSandbox and UI Templates

Have a look at the examples to see Tiptap in action or review and fork our codesandboxes.

About Tiptap

Tiptap is a collection of developer components based on open-source technology, forming the basis of our advanced, paid features. It includes the open-source editor component, collaboration features, Content AI, and Tiptap Cloud. We are developing open-source products that also shape our paid features. We're committed to improving both, ensuring quality and reliability in every update.

For more details, visit the Tiptap documentation or website.

Community

For help, discussion about best practices, or any other conversation that would benefit from being searchable:

Discuss Tiptap on GitHub

Sponsors 💖

Complish Storyblok PostHog Reflect Ziff Media Basewell Poggio

iFixit, ApostropheCMS, Novadiscovery, Omics Data Automation, Flow Mobile, DocIQ and hundreds of awesome individuals.

Contributing

Feel like adding some magic of your own to Tiptap Editor Core? We welcome contributions! Please see our CONTRIBUTING guidelines for how to get started.

Contributors

Sam Willis, Brian Hung, Dirk Holtwick, Sam Duvall, Christoph Flathmann, Erick Wilder, Marius Tolzmann, jjangga0214, Maya Nedeljkovich, Ryan Bliss, Gregor and many more.

License

The MIT License (MIT). Please see License File for more information.

Extension points exported contracts — how you extend this code

DragHandleOptions (Interface)
(no doc) [2 implementers]
packages/extension-drag-handle/src/drag-handle.ts
CreateEditorOptions (Interface)
* Options for creating a test editor.
packages/server-ai-toolkit/src/server-ai-toolkit.spec.ts
PluginState (Interface)
* The state of the DecorationsExtension ProseMirror plugin.
demos/src/Extensions/CollaborationMapPositions/React/index.tsx
CodeBlockLowlightOptions (Interface)
(no doc)
packages/extension-code-block-lowlight/src/code-block-lowlight.ts
CollaborationCaretOptions (Interface)
(no doc)
packages/extension-collaboration-caret/src/collaboration-caret.ts
CodeOptions (Interface)
(no doc)
packages/extension-code/src/code.ts
TwitchOptions (Interface)
(no doc)
packages/extension-twitch/src/twitch.ts
HorizontalRuleOptions (Interface)
(no doc)
packages/extension-horizontal-rule/src/horizontal-rule.ts

Core symbols most depended-on inside this repo

run
called by 576
packages/core/src/CommandManager.ts
chain
called by 545
packages/core/src/Editor.ts
destroy
called by 313
packages/core/src/types.ts
create
called by 284
packages/core/src/Node.ts
textInputRule
called by 268
packages/core/src/inputRules/textInputRule.ts
isActive
called by 254
packages/core/src/Editor.ts
getEditor
called by 243
demos/test/helpers.ts
configure
called by 240
packages/core/src/Node.ts

Shape

Function 1,532
Method 363
Interface 289
Class 94
Enum 1

Languages

TypeScript100%

Modules by API surface

packages/markdown/src/MarkdownManager.ts49 symbols
packages/core/src/Editor.ts39 symbols
packages/extension-typography/src/typography.ts26 symbols
packages/core/src/NodePos.ts25 symbols
packages/static-renderer/src/pm/markdown/markdown.ts24 symbols
packages/extension-drag-handle/src/drag-handle-plugin.ts21 symbols
packages/core/src/lib/ResizableNodeView.ts21 symbols
packages/react/src/ReactNodeViewRenderer.tsx19 symbols
packages/react/src/menus/useMenuElementProps.ts18 symbols
scripts/aggregate-changeset.js17 symbols
packages/vue-3/src/VueNodeViewRenderer.ts17 symbols
packages/react/src/EditorContent.tsx17 symbols

Dependencies from manifests, versioned

@babel/core7.26.0 · 1×
@babel/plugin-proposal-nullish-coalescing-operator7.18.6 · 1×
@babel/plugin-proposal-optional-chaining7.21.0 · 1×
@babel/preset-env7.26.0 · 1×
@babel/preset-react7.26.3 · 1×
@changesets/changelog-github0.6.0 · 1×
@changesets/cli2.27.11 · 1×
@changesets/get-release-plan4.0.13 · 1×
@commitlint/cli19.6.1 · 1×
@commitlint/config-conventional19.6.0 · 1×
@floating-ui/dom1.6.13 · 1×
@hocuspocus/provider2.15.0 · 1×

For agents

$ claude mcp add tiptap \
  -- python -m otcore.mcp_server <graph>

⬇ download graph artifact