saturation/uisaturation/ui
DocsComponentsBlocksPagesEmails
GitHub

Sections

IntroductionComponentsInstallationMCPThemingDesign

Components

Components

General

AvatarBadgeButtonKbdProgressSeparatorSkeletonSpin ResolveSpinnerSync ButtonTypography

Forms & Inputs

Address LookupCalendar PickerCheckboxComboboxDate PickerEmoji PickerFavicon SearchFieldInputInput GroupInput OTPRadio GroupSelectSliderSwitchTextareaToggleToggle Group

Data Display

AccordionAlertCardChartComparison SliderCredit CardData TableEmptyItemSaturation Credit CardTableTree

Navigation

BreadcrumbCommandMenubarNavigation MenuPaginationTabs

Overlays

CollapsibleContext MenuDialogDropdown MenuSheet

Layout

Button GroupFont ProviderWizard Split Layout

Feedback

Sonner

Animation & Effects

Animated GroupAnimated ListAnimated NumberBeamBlur FadeBorder TrailGlow EffectLiquid MetalLoading StateParallaxPixelProgressive BlurRippleSpotlightText EffectText Shimmer

Productivity

Agent ChatAI Chat InputCoding AgentFiltersFull CalendarKanbanNovel Editor
Docs/Components/Novel Editor

Novel Editor

A rich text editor powered by Novel/Tiptap.

Loading...

Installation

pnpm dlx shadcn@latest add @saturation-ui/novel-editor

Tailwind v4 — Source Scanning

The public shadcn registry installs component source into your project. If Tailwind v4 isn't scanning your components directory, add this to your CSS entry file:

@source "../components";

This ensures all utility classes in CVA variants and data attribute selectors are included in your build.

Usage

import { NovelEditor } from "@/components/ui/novel-editor"
<NovelEditor content={content} onChange={setContent} />

Examples

Slash Commands

Loading...
Editor with slash command menu.

Bubble Menu

Loading...
Editor with floating toolbar.

API Reference

PropTypeDefaultDescription
contentstring—Editor content (JSON).
onChange(content: string) => void—Content change handler.
PreviousNavigation MenuNextPagination

On This Page

  • Installation
  • Usage
  • Examples
  • Slash Commands
  • Bubble Menu
  • API Reference

Welcome to the Editor

This is a rich text editor built with modern React components. It supports various formatting options:

  • Bold, italic, and underline text
  • Headings and paragraphs
  • Bullet and numbered lists
  • Block quotes and code blocks
Pro tip: Use the toolbar above to format your text, or try keyboard shortcuts like Cmd+B for bold.

Start typing to create your content...

Type / for commands61 words

Start typing and press / to see the slash command menu.


Type / for commands11 words

Rich Text with Bubble Toolbar

Select any text in this editor to see the floating bubble toolbar appear. You can use it to apply formatting such as italic, underline, or inline code.

Try selecting a word or phrase below to format it:

The quick brown fox jumps over the lazy dog. Pack my box with five dozen liquor jugs.

Select text to format59 words