Novel은 ProseMirror와 Tiptap을 기반으로 구축된 Notion 스타일의 WYSIWYG 에디터로, AI 기반 자동 완성 기능을 기본 제공합니다. 이 글에서는 React 환경에서 Novel 에디터를 통합하고 커스터마이징하는 기술적 접근 방법을 다룹니다.
Novel 에디터의 기술적 특징
- Notion 스타일 UI/UX: 블록 기반 편집과 직관적인 인터페이스를 제공합니다.
- AI 자동 완성: 컨텍스트를 분석하여 텍스트 생성 및 보완 기능을 수행합니다.
- 확장 가능한 아키텍처: Tiptap/ProseMirror 기반의 플러그인 시스템을 지원합니다.
- 테마 지원: Tailwind CSS와 연동되어 다크/라이트 모드를 쉽게 구현할 수 있습니다.
설치 및 기본 통합
프로젝트에 Novel 패키지를 설치합니다.
npm install novel
# 또는
pnpm add novel
1. 에디터 래퍼 컴포넌트 구성
상태 관리를 최적화하기 위해 useCallback을 사용하여 업데이트 핸들러를 메모이제이션합니다.
"use client";
import { EditorRoot, EditorContent } from "novel";
import { useState, useCallback } from "react";
const NovelEditorWrapper = () => {
const [documentState, setDocumentState] = useState(null);
const handleContentUpdate = useCallback(({ editor }) => {
const currentJson = editor.getJSON();
setDocumentState(currentJson);
}, []);
return (
<EditorRoot>
<EditorContent
initialContent={documentState}
onUpdate={handleContentUpdate}
/>
</EditorRoot>
);
};
export default NovelEditorWrapper;
2. 확장 프로그램(Extensions) 설정
기본 확장 프로그램에 커스텀 플러그인을 추가하여 에디터의 기능을 확장합니다.
import { defaultExtensions } from "./custom-extensions";
const activeExtensions = [
...defaultExtensions,
// 추가 커스텀 확장 프로그램 삽입
];
// EditorContent 컴포넌트 내부
<EditorContent
extensions={activeExtensions}
// ... 기타 props
/>
3. 에디터 속성 및 이벤트 바인딩
키보드 단축키 및 slash command 네비게이션을 처리하기 위해 DOM 이벤트를 구성합니다.
import { handleCommandNavigation } from "novel/extensions";
const customEditorProps = {
handleDOMEvents: {
keydown: (_view, keyboardEvent) => handleCommandNavigation(keyboardEvent),
},
attributes: {
class: "prose prose-xl dark:prose-invert focus:outline-none max-w-none",
},
};
// EditorContent 컴포넌트 내부
<EditorContent
editorProps={customEditorProps}
// ...
/>
핵심 기능 및 상호작용
AI 자동 완성 및 Slash 명령어
에디터 내부에서 /를 입력하면 명령어 팔레트가 활성화됩니다. 여기서 'Continue writing'을 선택하면 AI가 현재 커서 위치의 컨텍스트를 분석하여 후속 텍스트를 생성합니다. 이 기능은 OpenAI 등 외부 LLM API와 연동되어 작동합니다.
버블 메뉴(Bubble Menu)
텍스트를 드래그하여 선택하면 플로팅 버블 메뉴가 표시됩니다. 이 메뉴를 통해 굵게, 기울임꼴, 코드 블록, 링크 삽입 등 인라인 서식을 신속하게 적용할 수 있습니다.
스타일 커스터마이징
Novel의 UI는 Tailwind CSS와 ProseMirror 스타일에 의존합니다. 디자인 시스템을 변경하려면 다음 파일을 수정합니다.
- ProseMirror 스타일:
prosemirror.css를 오버라이드하여 커서, 선택 영역, 노드 간격 등을 조정합니다. - 전역 변수:
globals.css에서 CSS 변수를 재정의하여 테마 색상을 변경합니다.
성능 최적화 및 트러블슈팅
대용량 문서를 처리할 때 렌더링 성능 저하가 발생할 수 있습니다. 이를 해결하기 위해 다음 전략을 적용합니다.
- 상태 업데이트 디바운싱:
onUpdate콜백에서 상태 저장 로직에 디바운스(debounce)를 적용하여 불필요한 리렌더링을 방지합니다. - 확장 프로그램 최소화: 사용하지 않는 Tiptap 확장 프로그램은 초기화 시 제외합니다.
- 미디어 리소스 최적화: 이미지 업로드 시 클라이언트 단에서 리사이징을 수행하거나, 지연 로딩(Lazy Loading)을 적용합니다.