The headless rich text editor framework for web artisans.
Installations
npm install @tiptap/extension-list-itemDeveloper
Developer Guide
Module System
ESM, UMD
Min. Node Version
Typescript Support
Yes
Node Version
20.18.1
NPM Version
10.8.2
Statistics
27,705 Stars
6,740 Commits
2,303 Forks
153 Watching
52 Branches
359 Contributors
Updated on 28 Nov 2024
Bundle Size
820.00 B
Minified
444.00 B
Minified + Gzipped
Languages
TypeScript (97.14%)
JavaScript (2.85%)
Shell (0.01%)
Total Downloads
Cumulative downloads
Total Downloads
73,199,319
Last day
-1.5%
210,407
Compared to previous day
Last week
3.4%
1,112,664
Compared to previous week
Last month
13%
4,601,623
Compared to previous month
Last year
104%
40,309,375
Compared to previous year
Daily Downloads
Weekly Downloads
Monthly Downloads
Yearly Downloads
Peer Dependencies
1
Dev Dependencies
1
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, which allows multiple users to edit documents simultaneously, drag-and-drop file management for easier handling of documents and media, and unique node ID assignment. Review the docs right here.
Pro Extensions are free with a Tiptap account. Once signed up, review the guide in your account.
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.
- Basic example of the Tiptap editor.
- Collaboration ready Tiptap CodeSandbox
- React notion-like block editor template: Demo
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:
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.
No vulnerabilities found.
Reason
30 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 10
Reason
no dangerous workflow patterns detected
Reason
no binaries found in the repo
Reason
license file detected
Details
- Info: project has a license file: LICENSE.md:0
- Info: FSF or OSI recognized license: MIT License: LICENSE.md:0
Reason
3 existing vulnerabilities detected
Details
- Warn: Project is vulnerable to: GHSA-p8p7-x288-28g6
- Warn: Project is vulnerable to: GHSA-3xgq-45jj-v275
- Warn: Project is vulnerable to: GHSA-5j4c-8p2g-v4jx
Reason
Found 10/27 approved changesets -- score normalized to 3
Reason
dependency not pinned by hash detected -- score normalized to 1
Details
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/build.yml:32: update your workflow using https://app.stepsecurity.io/secureworkflow/ueberdosis/tiptap/build.yml/develop?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/build.yml:35: update your workflow using https://app.stepsecurity.io/secureworkflow/ueberdosis/tiptap/build.yml/develop?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/build.yml:40: update your workflow using https://app.stepsecurity.io/secureworkflow/ueberdosis/tiptap/build.yml/develop?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/build.yml:89: update your workflow using https://app.stepsecurity.io/secureworkflow/ueberdosis/tiptap/build.yml/develop?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/build.yml:92: update your workflow using https://app.stepsecurity.io/secureworkflow/ueberdosis/tiptap/build.yml/develop?enable=pin
- Warn: third-party GitHubAction not pinned by hash: .github/workflows/build.yml:106: update your workflow using https://app.stepsecurity.io/secureworkflow/ueberdosis/tiptap/build.yml/develop?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/build.yml:117: update your workflow using https://app.stepsecurity.io/secureworkflow/ueberdosis/tiptap/build.yml/develop?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/build.yml:125: update your workflow using https://app.stepsecurity.io/secureworkflow/ueberdosis/tiptap/build.yml/develop?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/build.yml:142: update your workflow using https://app.stepsecurity.io/secureworkflow/ueberdosis/tiptap/build.yml/develop?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/build.yml:145: update your workflow using https://app.stepsecurity.io/secureworkflow/ueberdosis/tiptap/build.yml/develop?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/build.yml:150: update your workflow using https://app.stepsecurity.io/secureworkflow/ueberdosis/tiptap/build.yml/develop?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/issues.yml:13: update your workflow using https://app.stepsecurity.io/secureworkflow/ueberdosis/tiptap/issues.yml/develop?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/publish.yml:31: update your workflow using https://app.stepsecurity.io/secureworkflow/ueberdosis/tiptap/publish.yml/develop?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/publish.yml:34: update your workflow using https://app.stepsecurity.io/secureworkflow/ueberdosis/tiptap/publish.yml/develop?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/publish.yml:40: update your workflow using https://app.stepsecurity.io/secureworkflow/ueberdosis/tiptap/publish.yml/develop?enable=pin
- Warn: third-party GitHubAction not pinned by hash: .github/workflows/publish.yml:54: update your workflow using https://app.stepsecurity.io/secureworkflow/ueberdosis/tiptap/publish.yml/develop?enable=pin
- Warn: third-party GitHubAction not pinned by hash: .github/workflows/publish.yml:69: update your workflow using https://app.stepsecurity.io/secureworkflow/ueberdosis/tiptap/publish.yml/develop?enable=pin
- Warn: third-party GitHubAction not pinned by hash: .github/workflows/publish.yml:81: update your workflow using https://app.stepsecurity.io/secureworkflow/ueberdosis/tiptap/publish.yml/develop?enable=pin
- Warn: npmCommand not pinned by hash: .github/workflows/build.yml:162
- Warn: npmCommand not pinned by hash: .github/workflows/build.yml:53
- Warn: npmCommand not pinned by hash: .github/workflows/build.yml:99
- Info: 0 out of 14 GitHub-owned GitHubAction dependencies pinned
- Info: 0 out of 4 third-party GitHubAction dependencies pinned
- Info: 1 out of 4 npmCommand dependencies pinned
Reason
detected GitHub workflow tokens with excessive permissions
Details
- Warn: no topLevel permission defined: .github/workflows/build.yml:1
- Warn: no topLevel permission defined: .github/workflows/issues.yml:1
- Warn: topLevel 'contents' permission set to 'write': .github/workflows/publish.yml:13
- Info: no jobLevel write permissions found
Reason
no effort to earn an OpenSSF best practices badge detected
Reason
project is not fuzzed
Details
- Warn: no fuzzer integrations found
Reason
security policy file not detected
Details
- Warn: no security policy file detected
- Warn: no security file to analyze
- Warn: no security file to analyze
- Warn: no security file to analyze
Reason
SAST tool is not run on all commits -- score normalized to 0
Details
- Warn: 0 commits out of 17 are checked with a SAST tool
Score
4.9
/10
Last Scanned on 2024-11-18
The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.
Learn More