aerizwysiwyg

@aeriz/wysiwygDOCS

한글 문서에 맞춘 WYSIWYG 에디터입니다. 병합 셀 표, 워드 · 한글 · 엑셀 붙여넣기 정리, pt 글자 크기와 한국어 글꼴, 찾기 · 바꾸기, 인쇄를 갖췄고 React · Vue · Svelte · Angular · jQuery · 웹 컴포넌트에서 같은 옵션으로 씁니다.

v2.0.1 · 코어 80 KB (gzip) · 코드 색칠기 별도 4 KB · 의존성 0

소개

@aeriz/wysiwyg는 한글 문서에 맞춘 WYSIWYG 에디터입니다. 요소 하나만 넘기면 툴바 · 표 · 붙여넣기 정리 · 되돌리기까지 바로 동작합니다.

  • 표는 워드프로세서처럼 병합 셀이 있어도 행 · 열을 넣고 지우고, 합치고 나눈 뒤 칸이 맞습니다.
  • 깨끗한 붙여넣기 워드 · 한글 · 엑셀의 서식은 남기고 mso-* · 클래스 · 주석은 버립니다.
  • 한국 문서 서식 pt 크기, 맑은 고딕 · 바탕 같은 시스템 글꼴, 줄 간격 %, 자간, 찾기 · 바꾸기, 인쇄.
  • 안전하고 빠름 붙여넣기 · setHTML · 뷰어 · 서버가 같은 규칙으로 정화. 65쪽 문서도 한 글자 약 18 ms.
  • 한 가지 사용법 바닐라 JS · React · Vue · Svelte · Angular · jQuery · 웹 컴포넌트가 같은 옵션을 받습니다.
  • 웹 글꼴 0 실행 중에 글꼴을 내려받지 않습니다. 필요한 글꼴만 직접 연결합니다.

예제

실제 서비스에 넣은 모습 그대로의 예제입니다. 모두 이 페이지에서 돌아가고, JS · HTML · CSS 탭이 그 화면을 만든 코드 전부입니다. 같은 에디터를 옵션만 바꿔 게시판, 사내 문서, 댓글 창으로 씁니다.

블록 갤러리

@aeriz/wysiwyg · JS 79줄

에디터가 다루는 블록 16가지를 한 문서에 담았습니다. 왼쪽 목록을 누르면 그 블록으로 가고, 아래 칸에 그 블록이 저장되는 HTML · Markdown이 바로 보입니다. 뷰어로 바꾸면 저장된 JSON만으로 같은 화면을 그리고, 어둡게로 다크 테마를 봅니다.

다크 모드 출시 준비.doc블록 16가지가 한 문서에
    저장되는 모양 · 제목
    
        

    게시판 글쓰기

    @aeriz/wysiwyg · JS 24줄

    말머리 · 제목 · 본문을 쓰고 등록하면 AerizViewer가 글 보기 화면을 그립니다. 툴바는 필요한 버튼만 골랐습니다.

    aeriz 커뮤니티 › 등산 게시판 › 글쓰기

    붙여넣기 시험장

    @aeriz/wysiwyg · JS 44줄

    엑셀 · 워드 · 한글이 클립보드에 넣는 지저분한 HTML(을 본뜬 견본)과 악성 코드가 든 웹 글을 붙여넣어 보세요. 서식은 남기고 mso-* · 이벤트 속성 · javascript:는 버립니다. 오른쪽에서 저장되는 HTML · JSON · Markdown을 바로 봅니다.

    붙여넣기:
    
          
    위 버튼을 누르면 오피스가 클립보드에 넣는 모양의 HTML을 그대로 붙여넣습니다. 직접 복사해 붙여넣어도 됩니다.

    업무 보고서

    @aeriz/wysiwyg · JS 14줄

    결재란과 병합 셀 표가 있는 사내 문서 양식. 양식은 HTML 그대로 넣고, 결재를 올리면 setReadOnly(true)로 잠급니다.

    주간 업무 보고서.doc

    댓글 입력창

    @aeriz/wysiwyg · JS 22줄

    같은 에디터를 툴바 4칸, 높이 110px, 상태 표시줄 없이 줄였습니다. Ctrl + Enter로 등록합니다.

    댓글 2
    • 표덕후

      병합 셀 있는 표에 행을 넣어도 줄이 안 밀리네요. 이거 좋다

      10분 전
    • 한글러

      한글 문서에서 붙여넣었는데 자간까지 그대로예요.

      3분 전
    Ctrl + Enter로 등록

    설치

    사용하는 패키지 매니저를 고르세요. 빌드 도구 없이 쓰려면 CDN 탭을 보세요.

    bash
    npm install @aeriz/wysiwyg

    스타일시트는 어느 방법이든 한 번 불러야 합니다. 번들러에서는 import '@aeriz/wysiwyg/style.css'로 부릅니다.

    Tip CDN 주소에는 @2.0.1처럼 정확한 버전을 적으세요. 바뀌지 않는 주소라 오래 캐시됩니다.

    빠른 시작

    요소 하나를 넘기면 됩니다. height를 주면 본문이 그 높이 안에서 스크롤되고, 주지 않으면 부모 높이를 채웁니다(최소 320px).

    js
    import { AerizEditor } from '@aeriz/wysiwyg';
    import '@aeriz/wysiwyg/style.css';
    
    const editor = new AerizEditor({
      element: document.querySelector('#editor'),
      initialHTML: '<p>안녕하세요</p>',
      height: 480,
      upload: { url: '/api/upload' },
      onChange: (html) => save(html),
    });
    
    editor.getHTML();    // 어디에 붙여도 같은 모양인 HTML
    editor.getBlocks();  // 저장용 JSON 스냅샷

    표 안을 누른 뒤 툴바의 표 메뉴로 행 · 열을 넣거나, 셀을 끌어 고른 뒤 병합해 보세요. Ctrl+H는 찾기 · 바꾸기, Alt+F10은 툴바로 가기입니다.

    그림 · 파일 올리기

    upload 하나로 그림과 파일을 모두 올립니다. 주지 않으면 다이얼로그의 "올리기" 탭이 꺼지고, 붙여넣은 그림은 data URL로 문서에 담깁니다.

    js
    new AerizEditor({
      element,
      upload: {
        url: '/api/upload',                                  // POST multipart: file, kind('image' | 'file')
        headers: () => ({ Authorization: `Bearer ${token()}` }), // 보낼 때마다 불러 최신 토큰을 씀
        maxSize: 10 * 1024 * 1024,                           // 넘으면 올리지 않고 onError
      },
      onError: (error, { code }) => toast(code === 'upload' ? '올리기 실패' : error.message),
    });

    서버는 { "url": "https://…" }를 돌려주면 됩니다. 직접 올리려면 url 대신 handler: (file, kind) => Promise<url>를 씁니다. 둘 다 있으면 handler가 먼저입니다.

    코드 색칠 (선택)

    코드 블록 색칠기는 코어에 들어 있지 않습니다. 필요할 때만 가져와 highlighter에 넘기세요. 15개 언어, gzip 약 4 KB입니다.

    js
    import { AerizEditor } from '@aeriz/wysiwyg';
    import { highlighter } from '@aeriz/wysiwyg/highlight';
    
    new AerizEditor({ element, highlighter });

    넘기지 않으면 코드 블록은 색 없이 보이고 언어 고르기 버튼이 숨습니다. 다른 색칠기도 { languages: [{ id, label }], highlight(code, id) } 모양이면 됩니다. 결과 HTML은 글과 <span class>만 남기고 걸러서 넣습니다.

    • 언어는 툴바 버튼으로 고르거나 자동으로 정해집니다.
    • GitHub · VS Code · 블로그에서 복사한 코드(language-py · lang-js · highlight-source-shell · data-lang)와 마크다운 펜스(```ts)는 언어를 그대로 알아봅니다.
    • py → Python, sh → Bash 같은 별칭도 읽습니다.
    • 한글을 조합하는 중에 언어를 바꿔도 글자가 겹치지 않습니다.

    Vanilla JS

    프레임워크 없이 쓸 때는 클래스를 그대로 씁니다. CDN 스크립트로 불렀다면 전역 AerizWysiwyg에 같은 것이 있습니다.

    html
    <div id="editor"></div>
    <script>
      const editor = new AerizWysiwyg.AerizEditor({
        element: document.getElementById('editor'),
        highlighter: AerizWysiwygHighlight.highlighter, // 색칠기를 불렀을 때
      });
    </script>

    React

    @aeriz/wysiwyg/react의 컴포넌트는 new AerizEditor()와 같은 옵션을 props로 받습니다. React 16.8 이상에서 동작합니다.

    jsx
    import { useState } from 'react';
    import { AerizEditor } from '@aeriz/wysiwyg/react';
    import '@aeriz/wysiwyg/style.css';
    
    export function Compose() {
      const [html, setHtml] = useState('<p>안녕하세요</p>');
      return <AerizEditor value={html} onChange={setHtml} height={480} upload={{ url: '/api/upload' }} />;
    }
    • value를 그대로 되돌려 줘도 캐럿이 튀지 않습니다. 들어온 값이 에디터의 지금 출력과 같으면 본문을 바꾸지 않습니다.
    • readOnly는 다시 만들지 않고 바로 바뀝니다. locale · height · fonts처럼 화면 구조를 바꾸는 옵션은 에디터를 다시 만들며, 글은 그대로 옮겨 갑니다.

    Vue

    Vue 3은 @aeriz/wysiwyg/vue, Vue 2.6 · 2.7은 @aeriz/wysiwyg/vue2를 씁니다. v-model로 HTML을 묶습니다.

    vue
    <script setup>
    import { ref } from 'vue';
    import { AerizEditor } from '@aeriz/wysiwyg/vue';
    import '@aeriz/wysiwyg/style.css';
    const html = ref('<p>안녕하세요</p>');
    </script>
    
    <template>
      <AerizEditor v-model="html" :height="480" :read-only="locked" @error="onError" />
    </template>

    Svelte

    컴포넌트가 아니라 액션이라 Svelte 3 · 4 · 5에서 같은 파일이 동작합니다.

    html
    <script>
      import { aerizEditor } from '@aeriz/wysiwyg/svelte';
      let html = '<p>안녕하세요</p>';
    </script>
    
    <div use:aerizEditor={{ value: html, onChange: (v) => (html = v), height: 480 }}></div>

    Angular

    Angular 14 이상에서 쓰는 디렉티브를 TypeScript 소스로 배포합니다. tsconfig.app.json의 include에 node_modules/@aeriz/wysiwyg/angular/*.ts를 더하세요.

    ts
    import { AerizEditorDirective } from '@aeriz/wysiwyg/angular';
    
    @Component({
      standalone: true,
      imports: [FormsModule, AerizEditorDirective],
      template: `<div aerizEditor [(ngModel)]="html" [height]="480" (error)="onError($event)"></div>`,
    })
    export class ComposeComponent { html = '<p>안녕하세요</p>'; }

    폼 컨트롤을 disable()하면 읽기 전용이 됩니다.

    웹 컴포넌트

    html
    <script type="module">import '@aeriz/wysiwyg/wc';</script>
    
    <form method="post">
      <aeriz-editor name="body" height="480" upload-url="/api/upload"></aeriz-editor>
    </form>

    속성: value · placeholder · theme · locale · toolbar · read-only · height · status-bar · upload-url · aria-label. 문자열로 못 쓰는 옵션은 프로퍼티(upload · fonts · fontSizes · highlighter · favicon)로 줍니다. 이벤트: input · change · error · aeriz-ready.

    jQuery

    js
    import '@aeriz/wysiwyg/jquery';   // 전역 jQuery가 있으면 자동 등록
    
    $('#editor').aerizEditor({ value: '<p>안녕하세요</p>', height: 480 });
    $('#editor').aerizEditor('getHTML');
    $('#editor').aerizEditor('destroy');

    서버 · 엣지

    @aeriz/wysiwyg/server는 CSS를 불러오지 않고 document를 쓰지 않아 Node, Deno, Bun, Cloudflare Workers에서 그대로 돕니다.

    js
    import { renderBlocksToHTML, blocksToMarkdown, blocksToPlainText } from '@aeriz/wysiwyg/server';
    
    const html = renderBlocksToHTML(post.blocks, { wrapper: 'content' }); // 같은 입력이면 늘 같은 출력
    const text = blocksToPlainText(post.blocks);                          // 검색 색인용

    표

    표 안에 캐럿을 두면 툴바에 표 메뉴와 칸 배경색이 나옵니다. 칸을 끌어 여러 개 고를 수 있습니다.

    동작병합 셀이 있을 때
    열 넣기병합 머리글 안쪽이면 머리글이 넓어지고, 위아래 병합 셀 옆이면 새 칸도 같은 높이입니다.
    행 넣기위아래 병합 셀을 가로지르면 그 셀이 한 줄 길어집니다.
    행 · 열 지우기병합 셀이 시작하는 행을 지우면 셀이 아래로 내려가고, 병합 머리글은 한 칸 줄어듭니다.
    병합고른 범위가 다른 병합 셀에 반쯤 걸치면 범위를 넓혀 통째로 합칩니다. 글은 줄을 바꿔 잇습니다.
    분할1칸짜리로 되돌리고, 빈 칸을 채워 직사각형을 유지합니다.
    Tab격자 순서로 다음 칸. 마지막 칸에서는 새 행을 만듭니다.

    붙여넣기

    어디서남는 것버리는 것
    엑셀병합, 굵기, 배경색, 테두리, 정렬, 글자색mso-number-format, 클래스, <col>, 칸 공통 글꼴
    워드굵게 · 기울임, 들여쓰기, 글머리 · 번호 목록(중첩 포함)mso-list 문단, Wingdings 글머리, <o:p>, lang
    한글들여쓰기, 자간, 글꼴(<font>는 <span style>로), 칸 너비와 배경HStyle 클래스, style-name, 칸 안의 빈 문단, 기본 크기(size="3")
    구글 문서문단 · 제목 · 목록 · 굵게전체를 감싼 <b id="docs-internal-guid-…">, 목록 항목 안의 <p>
    웹문단 · 제목 · 목록 · 표 · 링크스크립트, 이벤트 속성, 블록 id
    이 에디터문서에 있는 그대로(서식 · 링크 · 목록 · 표 구조)브라우저가 덧입히는 계산된 스타일(font-size: 15px 등), 정렬 단추 · 크기 손잡이
    • 블록을 품은 링크 · 굵게(<a><p>…</p></a>)는 껍데기를 풀고 안쪽 글마다 다시 입힙니다. 문단 안에 문단이 들어가지 않습니다.
    • 목록 항목 · 표 칸 · 그림 설명처럼 블록을 둘 수 없는 자리에는 인용 · 콜아웃까지 줄바꿈으로 이은 글로 넣습니다.
    • 그런 자리에 온 링크 카드 · 파일 · 영상은 주소를 잇는 링크 한 줄(카드 제목 · 파일 이름)이 됩니다. 인용 · 콜아웃 안에 붙여넣은 카드 · 파일 · 영상은 속을 채워 상자 밖으로 꺼냅니다.
    • 한 표의 여러 칸에 걸쳐 고른 채 붙여넣으면 칸은 그대로 두고 고른 글만 지운 뒤 첫 칸에 넣습니다. 표 모양이 깨지지 않습니다.
    • 그림 · 링크 카드 위에 캐럿이 있으면 그 뒤 문단에 넣고, 블록에 걸친 선택 위에 붙여넣으면 선택부터 지웁니다.
    • 링크 글 안에 주소를 붙여넣으면 주소 글자만 들어갑니다. 링크 안에 링크가 생기지 않습니다.

    길이의 pt는 px로 바꾸고 글자 크기는 pt 그대로 둡니다. Ctrl+Shift+V는 서식 없이 붙여넣고, 그림 파일을 붙여넣거나 끌어 놓으면 upload로 올립니다.

    글꼴 · 크기 · 줄 간격

    js
    import { AerizEditor, DEFAULT_FONTS } from '@aeriz/wysiwyg';
    
    new AerizEditor({
      element,
      fontSizes: [9, 10, 10.5, 11, 12, 14, 16, 20],  // pt
      fonts: [
        ...DEFAULT_FONTS,
        { label: 'Pretendard', stack: 'Pretendard, sans-serif', cssUrl: 'https://…/pretendard.css' },
      ],
    });
    • 기본 글꼴은 맑은 고딕, 굴림, 돋움, 바탕, 궁서, 나눔고딕, 나눔명조, Apple SD 산돌고딕 Neo, Arial, Times New Roman, Courier New입니다. 이 기기에 없는 글꼴은 목록에서 빠집니다.
    • cssUrl을 준 글꼴만 글꼴 목록을 열 때 그 CSS를 받습니다. 그 밖에는 외부 요청이 없습니다.
    • 줄 간격은 100~300%, 자간은 em 단위입니다. 특수 문자는 기호 · 화살표 · 원문자 · 단위 · 괄호 · 수학 묶음으로 고릅니다.

    무료 글꼴 (SIL OFL 1.1)

    저작권 걱정 없이 쓸 수 있는 한글 글꼴 15종을 FREE_FONTS로 담아 두었습니다. 글꼴 파일은 패키지에 들어 있지 않고, 기본으로 부르는 CDN 주소도 없습니다. 쓰는 쪽에서 호스팅한 CSS 주소를 freeFonts({ cssUrl })로 넘기면 그 글꼴만 글꼴 목록을 열 때 받습니다.

    js
    import { AerizEditor, freeFonts } from '@aeriz/wysiwyg';
    
    new AerizEditor({
      element,
      // 기본 목록(DEFAULT_FONTS) 뒤에 붙고, 겹치는 나눔고딕 · 나눔명조는 그 자리에 주소만 채웁니다.
      fonts: freeFonts({
        only: ['pretendard', 'noto-serif-kr', 'd2coding'],      // 빼면 전부
        cssUrl: (font) => `/fonts/${font.id}/font.css`,        // 직접 올린 CSS
      }),
    });
    • cssUrl을 주지 않은 글꼴은 이 기기에 깔려 있을 때만 목록에 보입니다. freeFonts()는 어디로도 요청을 보내지 않습니다.
    • 글꼴 파일을 직접 올려 배포할 때는 각 글꼴의 OFL.txt를 함께 두세요. OFL은 상업용 · 웹 임베딩을 허용하며, 글꼴 파일만 따로 파는 것은 금지합니다.
    • 기본 목록의 맑은 고딕 · 굴림 · 바탕 같은 시스템 글꼴은 기기에 깔린 것을 쓸 뿐 파일을 나눠 주지 않습니다.
    글꼴id종류저작권자라이선스받는 곳
    Pretendardpretendard고딕Kil Hyung-jinSIL OFL 1.1github.com
    Noto Sans KRnoto-sans-kr고딕Google · AdobeSIL OFL 1.1fonts.google.com
    Noto Serif KRnoto-serif-kr명조Google · AdobeSIL OFL 1.1fonts.google.com
    나눔고딕nanum-gothic고딕NAVER (NHN)SIL OFL 1.1hangeul.naver.com
    나눔명조nanum-myeongjo명조NAVER (NHN)SIL OFL 1.1hangeul.naver.com
    IBM Plex Sans KRibm-plex-sans-kr고딕IBMSIL OFL 1.1github.com
    Spoqa Han Sans Neospoqa-han-sans-neo고딕SpoqaSIL OFL 1.1github.com
    SUITsuit고딕SUNNSIL OFL 1.1github.com
    Wanted Sanswanted-sans고딕Wanted LabSIL OFL 1.1github.com
    Gothic A1gothic-a1고딕HanYang I&CSIL OFL 1.1fonts.google.com
    고운돋움gowun-dodum고딕Gowun Dodum Project AuthorsSIL OFL 1.1github.com
    고운바탕gowun-batang명조Gowun Batang Project AuthorsSIL OFL 1.1github.com
    함렛hahmlet명조Hahmlet Project AuthorsSIL OFL 1.1fonts.google.com
    나눔고딕코딩nanum-gothic-coding고정폭NAVER (NHN)SIL OFL 1.1hangeul.naver.com
    D2Codingd2coding고정폭NAVERSIL OFL 1.1github.com

    블록 경계 · 링크

    문단, 목록, 인용, 코드, 표, 영상 사이를 오가며 쓸 때의 동작입니다.

    줄바꿈

    상황동작
    목록 · 인용의 빈 줄에서 Enter블록을 빠져나와 본문(<p>)이 됩니다.
    블록 안에서 Shift+Enter블록은 그대로, 줄만 바꿉니다(<br>). 어느 블록에서나 같습니다.
    표 칸에서 Enter칸 안에서 줄을 바꿉니다.
    코드 블록에서 Enter들여쓰기를 이어 줄을 바꿉니다. 빈 마지막 줄의 Enter 또는 Ctrl+Enter로 나갑니다.
    인용 · 콜아웃 안의 목록 · 코드Enter는 새 항목 · 새 줄. 빈 항목 · 빈 마지막 줄에서는 상자 안 문단이 됩니다.
    콜아웃인용과 같습니다. 빈 마지막 줄의 Enter는 상자를 나가고, 첫 줄 맨 앞 Backspace는 그 줄을 본문으로 꺼냅니다.
    토글제목의 Enter는 본문 맨 앞에 새 줄(접혀 있으면 토글 뒤), 본문 빈 마지막 줄의 Enter는 토글을 나갑니다. 제목 맨 앞 Backspace는 토글을 풀어 본문 문단으로 바꿉니다.

    지우기

    상황동작
    빈 블록에서 Backspace먼저 본문 문단이 되고, 한 번 더 누르면 앞 블록 끝에 합쳐집니다. 빈 둘째 목록 항목은 윗항목 끝으로 갑니다. 빈 문서는 그대로입니다.
    문단 맨 앞 Backspace · 끝 Delete앞뒤 문단과 합칩니다. <span style>이 남지 않습니다. 표 · 코드와는 합치지 않고 캐럿만 들어갑니다.
    코드 블록 끝 Delete다음 문단을 끌어오지 않고 캐럿만 옮깁니다.
    구분선 · 그림 · 영상 · 링크 카드 옆첫 번째는 빨간 테두리로 표시만, 두 번째에 지웁니다.

    고른 채 입력

    상황동작
    여러 블록을 고른 채 입력고른 부분만 바꿉니다. 세 번 클릭으로 고른 문단은 다음 문단을 끌어오지 않습니다.
    표 칸 → 표 밖, 토글 제목 → 본문까지 고른 채 입력글(한글 포함)이 고르기 시작한 자리에 순서대로 들어갑니다.
    Ctrl+A표로 시작하거나 카드 · 영상으로 끝나는 문서도 전부 고릅니다. 이어서 지우거나 치면 빈 문단 하나만 남습니다.
    목록 유형 바꾸기다른 목록으로는 항목이 모두 남고, 제목 · 본문으로는 캐럿이 있는 항목만 바뀝니다.
    모르는 블록새 줄과 인식하지 못한 요소(<div> · <section> 등)는 본문 문단이 됩니다.

    그림 · 영상 · 카드

    상황동작
    구분선 · 영상 · 표 넣기쓰던 문단 뒤에 넣고, 캐럿은 다음 문단으로 갑니다.
    그림 · 카드 · 영상을 누른 뒤 입력글자 · 한글 · Enter는 그 뒤 문단에서 시작합니다. 그림 설명 안은 예외입니다.
    링크 카드 · 파일을 누르거나 끈 뒤 입력포커스가 본문에 남아 친 글자가 사라지지 않습니다.
    영상 클릭첫 클릭은 블록 선택, 두 번째에 재생합니다. 읽기 전용 · 뷰어는 바로 재생합니다.
    카드 · 영상으로 끝나게 붙여넣기캐럿이 그 뒤 문단에 놓여, 키가 재생기로 가지 않습니다.
    링크 카드 클릭새 탭 대신 편집 창이 열립니다. 본문 링크는 Ctrl+클릭으로 엽니다.
    HTML 블록 높이처음엔 내용 높이만큼 펼칩니다. 아래 막대를 끌어 높이를 정하고, 두 번 누르면 되돌립니다. 정한 높이는 getHTML() · 뷰어에도 남습니다.

    참고 가져온 HTML의 고정 머리글과 안쪽 스크롤 상자는 풀어서 펼칩니다. 그래서 내용이 중간에 잘리지 않습니다.

    상황동작
    링크 걸기글을 고르고 Ctrl+K 또는 툴바 링크 버튼. https://…를 치고 띄어쓰거나 주소를 붙여넣어도 됩니다. example.com에는 https://를 붙입니다.
    유튜브 주소빈 문단에 붙여넣으면 영상이 됩니다. 영상 창에 다른 주소를 넣으면 안내를 띄웁니다.
    되돌리기 · 다시 실행낱말 단위로 되돌리고 캐럿도 제자리로 옵니다. 브라우저 메뉴 · 오른쪽 클릭의 되돌리기도 같은 이력을 씁니다. 빠르게 오가도 다시 실행이 끊기지 않습니다.

    단축키 · 접근성

    동작단축키
    되돌리기 / 다시 실행Ctrl+Z / Ctrl+Shift+Z · Ctrl+Y
    굵게 · 기울임 · 밑줄 · 취소선Ctrl+B · Ctrl+I · Ctrl+U · Ctrl+Shift+X
    위 첨자 · 아래 첨자Ctrl+. · Ctrl+,
    본문 전체 고르기Ctrl+A
    찾기 · 바꾸기Ctrl+H
    서식 없이 붙여넣기Ctrl+Shift+V
    링크 넣기 · 고치기Ctrl+K
    블록 안 줄바꿈Shift+Enter
    코드 블록: 줄바꿈 / 빠져나가기Enter / Ctrl+Enter · 빈 마지막 줄에서 Enter
    목록: 들여쓰기 / 내어쓰기Tab / Shift+Tab
    툴바로 가기 / 본문으로Alt+F10 / Esc
    본문 · 제목 1~6Ctrl+Alt+0 · Ctrl+Alt+1~6 (표 칸 안에서는 표를 지키기 위해 동작하지 않음. 인용 · 토글을 바꾸면 안쪽 목록 항목이 한 줄씩)
    번호 목록 · 글머리 목록 · 인용 · 코드 · 체크리스트Ctrl+Alt+7 · Ctrl+Alt+8 · Ctrl+Alt+9 · Ctrl+Alt+C · Ctrl+Alt+T
    블록 위 · 아래로 옮기기 / 블록 지우기Ctrl+Shift+↑ · Ctrl+Shift+↓ / Ctrl+Shift+D
    표: 다음 / 이전 칸Tab / Shift+Tab
    전체 화면 끝내기Esc
    • macOS Ctrl 대신 Cmd, Alt 대신 Option (예: Cmd+Option+1)
    • 유럽 자판 Ctrl+Alt로 치는 글자(AltGr+7 = {)는 단축키가 가로채지 않습니다.
    • 툴바 탭 정지는 하나. 버튼 사이는 화살표 · Home · End로 움직입니다.
    • 스크린 리더 본문에 접근성 이름이 붙습니다 (ariaLabel, 기본 "본문 편집기").

    입력 규칙 (마크다운)

    본문 문단 맨 앞에서 아래처럼 치면 블록이 바로 바뀝니다. 한 번 Ctrl+Z로 친 글자 그대로 되돌릴 수 있습니다.

    입력결과
    # ~ ###### + 공백제목 1~6
    - · * · + + 공백글머리 목록
    1. · 1) + 공백번호 목록 (아무 숫자나)
    [ ] · [] · [x] + 공백체크리스트 ([x]는 완료 표시). 글머리 목록 항목 맨 앞에서도 됩니다.
    > + 공백인용
    ``` · ~~~코드 블록. 이어서 첫 줄에 언어 이름(py · js · sql …)만 치고 Enter를 누르면 그 언어로 색칠합니다(색칠기를 넘겼을 때).
    --- · ***구분선

    유튜브 주소를 빈 문단에 붙여넣으면 영상, 다른 주소는 링크가 됩니다. 그림 파일은 붙여넣거나 끌어 놓으면 그림이 됩니다. 콜아웃 · 토글 · 표 · 링크 카드 · 파일 첨부 · HTML 가져오기는 툴바 첫 칸의 블록 메뉴에서 넣습니다.

    옵션

    옵션타입기본값설명
    elementHTMLElement—에디터를 넣을 요소 (필수)
    initialHTMLstring—처음 본문
    placeholderstring—빈 본문 안내 문구
    toolbar{ items, sticky } | falseDEFAULT_TOOLBAR툴바 항목. '|'는 구분선
    theme'light' | 'dark''light'테마
    locale'ko' | 'en' | 'ja' | 'zh''ko'화면 문구 언어
    heightnumber | string부모 높이숫자는 px. 주면 본문이 그 안에서 스크롤
    readOnlybooleanfalse읽기 전용. 툴바는 인쇄 · 전체 화면만 남음
    statusBarbooleantrue아래 상태 표시줄 (블록 수 · 글자 수 · 되돌리기)
    upload{ url, headers, handler, maxSize }—그림 · 파일 올리기
    onChange(html) => void—본문이 바뀔 때
    onError(error, { code }) => voidconsole.errorcode: 'upload' · 'paste'
    fonts{ label, stack, cssUrl? }[]DEFAULT_FONTS글꼴 목록 · 무료 글꼴
    fontSizesnumber[]DEFAULT_FONT_SIZES글자 크기 목록 (pt)
    highlighterCodeHighlighter—코드 색칠기 (@aeriz/wysiwyg/highlight)
    favicon(href) => string | null—링크 카드 파비콘 주소. 주지 않으면 파비콘을 그리지 않고 외부 서비스도 부르지 않습니다. 예: (href) => `/favicon?url=${encodeURIComponent(href)}`
    htmlStyles'inline' | 'class''inline'getHTML() 출력 방식. 'class'는 스타일시트가 있는 페이지용
    ariaLabelstring"본문 편집기"본문의 접근성 이름

    메서드

    메서드설명
    getHTML({ styles? })본문 HTML. 편집용 표시는 빠집니다
    setHTML(html)본문을 바꿈 (정화를 거침, 되돌리기 한 단계). 속 없이 속성만 온 링크 카드 · 파일 · 영상(<a class="aw-file-attachment" href data-file-name></a>)도 속성으로 다시 그립니다
    getBlocks() · setBlocks(blocks)저장용 JSON 스냅샷 읽기 · 쓰기
    setReadOnly(on)읽기 전용 켜고 끄기
    setTheme(theme)테마 바꾸기
    focus() · undo() · redo()포커스 · 되돌리기 · 다시 실행
    openFind() · toggleSource() · toggleFullscreen()찾기 창 · 소스 보기 · 전체 화면
    getState() · onStateChange(fn)블록 · 선택 상태와 그 변화 구독 (해제 함수를 돌려줌)
    destroy()이벤트를 정리하고 요소를 비움

    함께 내보내는 것: AerizViewer(읽기 전용 렌더), DEFAULT_TOOLBAR · DEFAULT_FONTS · DEFAULT_FONT_SIZES, 무료 글꼴 FREE_FONTS · freeFonts(), 변환기 renderBlocksToHTML · htmlToBlocks · blocksToMarkdown · markdownToBlocks · markdownToHtml · blocksToPlainText · sanitizeHTML · upgradeSnapshots. TypeScript 타입이 함께 들어 있습니다.

    경로

    경로 목록: adapter react vue vue2 svelte jquery wc

    경로내용
    @aeriz/wysiwyg에디터 · 뷰어 · 변환기 (스타일시트를 부수 효과로 불러옴)
    @aeriz/wysiwyg/style.css스타일시트
    @aeriz/wysiwyg/highlight코드 색칠기
    @aeriz/wysiwyg/serverDOM 없는 변환기
    @aeriz/wysiwyg/react · /vue · /vue2 · /svelte · /angular · /jquery · /wc프레임워크 연동
    @aeriz/wysiwyg/adapter직접 연동을 만들 때 쓰는 컨트롤러

    배포 파일

    번들러 · Node · CDN이 고르는 파일은 모두 압축본입니다. 공백 · 주석을 지우고 지역 이름만 줄였으며, 난독화나 소스맵은 없습니다. 공개 API 이름과 타입은 그대로이고, @__PURE__ 표시가 남아 쓰는 쪽 번들러의 트리 셰이킹도 그대로 됩니다.

    쓰는 곳파일크기 (gzip)
    import (번들러)dist/aeriz-wysiwyg.esm.min.js295 KB (83 KB)
    require (Node)dist/aeriz-wysiwyg.min.cjs—
    <script> (CDN)dist/aeriz-wysiwyg.min.js (전역 AerizWysiwyg)—
    디버깅용 비압축본dist/aeriz-wysiwyg.esm.js · .cjs · .jsCDN 주소로만 (예: https://cdn.jsdelivr.net/npm/@aeriz/wysiwyg@2.0.1/dist/aeriz-wysiwyg.esm.js)

    1.x에서 2.0으로

    2.0은 공개 API를 한 가지 방법으로 정리한 버전입니다. 저장해 둔 1.x 스냅샷은 그대로 열립니다.

    1.x2.0
    editor.serialize()editor.getBlocks() (이제 BlockSnapshot[]을 돌려줌)
    editor.getRawHTML()editor.getHTML()
    onImageUpload · onFileUploadupload: { handler: (file, kind) => url }
    imageUploadUrl · fileUploadUrlupload: { url, headers, maxSize }
    <aeriz-editor image-upload-url file-upload-url>upload-url 속성 또는 upload 프로퍼티
    코드 색칠이 늘 켜짐@aeriz/wysiwyg/highlight의 highlighter 옵션
    글자 크기 pxpt (fontSizes)
    글꼴 목록의 구글 글꼴한국어 시스템 글꼴. 웹 글꼴은 fonts의 cssUrl로
    setLocale · t · getLocalelocale 옵션
    renderBlockToHTML · upgradeSnapshot · snapshotVersionOfrenderBlocksToHTML · upgradeSnapshots
    블록 내부 모듈 (BLOCK_TYPES 등)내보내지 않음

    새로 생긴 것

    • 옵션: readOnly, height, upload, onError, fonts, fontSizes, ariaLabel, highlighter, favicon.
    • 메서드: setReadOnly(), setBlocks(), openFind(), toggleSource(), toggleFullscreen().
    • 툴바: 줄 간격, 자간, 특수 문자, 찾기 · 바꾸기, 소스 보기, 인쇄, 전체 화면, 표 메뉴의 셀 병합 · 분할.

    2.0.1에서 바뀐 것

    npm 2.0.0 이후의 변경입니다. 저장해 둔 스냅샷 · HTML은 그대로 열리고, 공개 API는 늘기만 했습니다.

    전체 변경 내역 보기

    저작권 정리

    • 툴바 · 블록 아이콘을 이 패키지에서 처음부터 다시 그렸습니다(20×20 격자, 선 굵기 1.6). 다른 아이콘 세트에서 가져온 그림은 없습니다.
    • 링크 카드가 기본으로 구글 파비콘 서비스를 부르지 않습니다. 파비콘이 필요하면 favicon 옵션으로 주소를 정하세요. 주지 않으면 파비콘 없이 그리고 외부 요청도 없습니다.
    • 라이선스를 확인한 무료 한글 글꼴 15종을 FREE_FONTS · freeFonts()로 넣었습니다(모두 SIL OFL 1.1). 글꼴 파일은 패키지에 넣지 않았고 기본 CDN 주소도 없습니다.

    새 기능

    • 코드 언어 자동 인식: 붙여넣은 코드의 language-* 클래스 · data-lang, 마크다운 펜스 별칭(py · sh · c++)을 읽습니다. ``` 다음 첫 줄에 언어 이름을 쓰고 Enter를 누르면 그 언어로 정해집니다.
    • 링크: Ctrl+K로 넣기 · 고치기 · 해제. https://… · www.… 뒤 띄어쓰기 · Enter는 자동 링크, 주소 하나를 붙여넣으면 링크(글을 고른 채면 그 글에), 빈 본문에 유튜브 주소를 붙여넣으면 영상 블록. example.com · 메일 주소는 https:// · mailto:로 보정합니다. 링크 카드를 누르면 새 탭 대신 편집 창이 열립니다.
    • 체크리스트 입력 규칙: 문단이나 글머리 목록 항목 맨 앞에서 [ ] · [] · [x] (완료). Ctrl+Z 한 번이면 친 글자로 돌아갑니다.
    • 가져온 HTML 블록은 내용 높이로 펼쳐집니다(고정 머리글 · 안쪽 스크롤 상자를 풂). 아래 가장자리를 끌면 높이가 정해지고, 두 번 누르면 내용 높이로 돌아갑니다. 정한 높이는 getHTML() · 뷰어 · Markdown 내보내기에도 그대로 나갑니다.
    • 되돌리기: 띄어쓰기마다 끊어 한 번에 낱말 하나씩 되돌리고, 캐럿은 그 변경 직전 자리로 돌아갑니다. 브라우저 편집 메뉴 · 오른쪽 클릭 메뉴의 되돌리기도 에디터 이력을 씁니다.
    • macOS Cmd+Option 블록 단축키는 자판 위치로 찾고, 유럽 자판의 AltGr 글자(AltGr+7 = {)는 가로채지 않습니다.

    편집 동작 (블록 경계)

    • Enter: 제목 끝에서는 다음 줄이 본문, 목록 빈 항목에서는 목록을 빠져나온 본문, 인용 · 콜아웃 · 토글은 빈 마지막 줄에서 빠져나옵니다. 코드 블록은 윗줄 들여쓰기를 잇고 빈 마지막 줄 Enter · Ctrl+Enter로 빠져나옵니다.
    • Backspace · Delete로 문단을 합쳐도 <span style>이 생기지 않습니다. 표 · 코드 블록과는 합치지 않고, 구분선 · 그림 · 영상 · 링크 카드 · 파일은 빨간 테두리로 한 번 표시한 뒤 지웁니다.
    • 여러 블록에 걸친 선택 · 세 번 클릭 · Ctrl/Cmd+A 뒤 입력 · 지우기 · 잘라내기는 고른 부분만 지우고 이어 씁니다. Ctrl/Cmd+A는 카드 · 표로 시작하거나 끝나는 문서도 끝까지 고릅니다.
    • 구분선 · 영상 · 링크 카드 · 표를 넣으면 쓰던 문단을 바꾸지 않고 그 뒤에 넣습니다. 편집 중 영상 첫 클릭은 블록 고르기라 키가 재생기로 넘어가지 않습니다.
    • 복사 · 잘라내기는 문서에 있는 요소만 싣습니다(브라우저의 계산된 스타일이 붙지 않음). 대화 상자를 닫으면 열기 전 캐럿으로 돌아갑니다.
    • 모르는 블록(<div class> · <section>)은 본문 단락이 되고, 인용 안 카드 · 인용 안 인용 · 빈 표 · 링크 안 링크 같은 깨진 구조는 생기는 즉시 바로잡습니다. 표 칸 안에서는 글 블록 유형 바꾸기를 하지 않습니다.

    표 · 붙여넣기 · 체크리스트

    • 툴바의 표 크기 고르기 칸과 열 너비 끌기가 한 프레임에 한 번만 그려 끊김 없이 따라옵니다. 칸 오른쪽 가장자리를 끌지 않고 누르기만 하면 캐럿이 그 칸에 들어갑니다.
    • 한글 · 옛 웹 페이지의 <font face color size>는 글꼴 · 색 · 크기 도구가 읽는 <span style>이 됩니다. 링크 글 안에 주소를 붙여넣으면 주소 글자만 들어갑니다.
    • 속 없이 속성만 온 링크 카드 · 파일 · 영상 HTML(서버 정화를 거친 HTML 등)도 에디터에서 다시 그립니다.
    • 완료한 체크리스트 항목을 저장했다 다시 불러온 뒤 완료를 풀어도 회색 · 취소선이 남던 문제를 고쳤습니다.

    배포

    • 번들러가 고르는 ES 모듈과 서버 · 색칠기 · 프레임워크 연동 파일을 실제로 압축했습니다. 본체 ES 모듈은 422 KB → 295 KB(gzip 113 KB → 83 KB), npm 패키지는 904 KB → 871 KB입니다. 자세한 것은 배포 파일을 보세요.
    • 예제 페이지를 더했습니다: 블록 갤러리, 게시판 글쓰기, 댓글, 붙여넣기 시험장, 보고서.

    고친 것

    • 코드 블록에서 한글을 조합하는 도중 언어를 바꾸면 글자가 두 번 들어가고 색칠이 멈추던 문제.
    • 인용 · 콜아웃 안에 붙여넣은 링크 카드가 빈 상자로 남고 파일 · 영상이 사라지던 문제. 목록 항목 · 표 칸에 붙여넣은 카드 · 파일 · 영상이 사라지던 문제(이제 주소 링크로 남음).
    • 카드 · 영상으로 끝나게 붙여넣은 뒤 영상을 누르면 이어 친 글자가 재생기로 넘어가던 문제. 파일 칸 · 링크 카드를 누르거나 끈 뒤 친 글자가 사라지던 문제.
    • 인용 · 콜아웃 · 토글 안 코드 블록에서 Enter가 코드 블록을 문단으로 감싸 되돌리기 왕복 뒤 모양이 바뀌던 문제.
    • 표의 여러 칸에 걸친 선택 위에 붙여넣으면 칸이 지워져 표가 직사각형이 아니게 되던 문제.