@rtecn/editor
v0.2.6
Published
A **toolbar-style** rich text editor built on [Tiptap](https://tiptap.dev/) with shadcn/ui design tokens. Part of the [rtecn](https://rtecn.space) editor suite.
Readme
@rtecn/editor
A toolbar-style rich text editor built on Tiptap with shadcn/ui design tokens. Part of the rtecn editor suite.
Features
- Compound component API (
RichTextEditor,RichTextEditor.Toolbar,RichTextEditor.Content, etc.) - 20+ built-in toolbar controls (Bold, H1, Link, Undo, etc.)
- Sticky toolbar with configurable control groups
- Fully typed with TypeScript
- Extensible via Tiptap extensions
- Built with shadcn/ui CSS variables — matches your theme
Installation
npm
npm install @rtecn/editor @tiptap/react @tiptap/pm @tiptap/starter-kit @tiptap/extension-linkshadcn registry
npx shadcn@latest add @rtecn/editorMake sure your components.json includes the rtecn registry:
{
"registries": {
"@rtecn": "https://rtecn.space/r/{name}.json"
}
}Usage
"use client";
import { useEditor } from "@tiptap/react";
import StarterKit from "@tiptap/starter-kit";
import Underline from "@tiptap/extension-underline";
import { RichTextEditor, Link } from "@rtecn/editor";
import "@rtecn/editor/style.css";
export function MyEditor() {
const editor = useEditor({
extensions: [StarterKit, Link, Underline],
content: "<p>Start typing...</p>",
});
return (
<RichTextEditor editor={editor}>
<RichTextEditor.Toolbar sticky>
<RichTextEditor.ControlsGroup>
<RichTextEditor.Bold />
<RichTextEditor.Italic />
<RichTextEditor.Underline />
</RichTextEditor.ControlsGroup>
<RichTextEditor.ControlsGroup>
<RichTextEditor.H1 />
<RichTextEditor.H2 />
<RichTextEditor.H3 />
</RichTextEditor.ControlsGroup>
<RichTextEditor.ControlsGroup>
<RichTextEditor.Undo />
<RichTextEditor.Redo />
</RichTextEditor.ControlsGroup>
</RichTextEditor.Toolbar>
<RichTextEditor.Content />
</RichTextEditor>
);
}Documentation
Full API reference at rtecn.space/docs/editor.
License
MIT
