2.8 KiB
:::error Don’t try this at home Nothing here is production-ready, don’t use it anywhere. :::
Introduction
tiptap is a renderless wrapper around ProseMirror – a toolkit for building rich-text WYSIWYG editors, which is already in use at many well-known companies such as New York Times, The Guardian or Atlassian.
Although tiptap tries to hide most of the complexity of ProseMirror, it’s built on top of its APIs and we recommend you to read through the ProseMirror Guide for advanced usage. You’ll have a better understanding of how everything works under the hood and get more familiar with many terms and jargon used by tiptap.
Features
Renderless. We don’t tell you what a menu should look like or where it should be rendered in the DOM. That’s why tiptap is renderless and comes without any CSS. You are in full control over markup and styling.
Framework-agnostic. We don’t care what framework you use. tiptap is ready to be used with plain JavaScript or Vue.js. That makes it even possible to write a renderer for React, Svelte and others.
TypeScript. tiptap 2 is written in TypeScript. That gives you a nice autocomplete for the API (if your IDE supports that), helps to find bugs early and makes it possible to generate a complete API documentation on top of the extensive human written documentation.
Who uses tiptap?
License
tiptap is licensed under MIT, so you’re free to whatever you want. Anyway, we kindly ask you to become a sponsor on GitHub to fund the development, maintenance and support of tiptap.