aerizwysiwyg

@aeriz/wysiwygDOCS

韓国語の文書に合わせた WYSIWYG エディターです。結合セルのある表、Word・HWP・Excel からの貼り付けの整形、pt 単位の文字サイズと韓国語フォント、検索と置換、印刷を備え、React・Vue・Svelte・Angular・jQuery・Web Components で同じオプションのまま使えます。

v2.0.1 · コア 80 KB(gzip)· コードハイライターは別途 4 KB · 依存ゼロ

概要

@aeriz/wysiwyg は、韓国語の文書作成に合わせて作られた WYSIWYG エディターです。要素をひとつ渡すだけで、ツールバー、表、貼り付けの整形、元に戻すまですぐに動きます。

  • ワープロのような表 結合セルがあっても、行・列の挿入と削除、結合と分割の後で列がそろいます。
  • きれいな貼り付け Word・HWP(ハングル)・Excel の書式は残し、mso-*、クラス、コメントは取り除きます。
  • 韓国語文書の書式 pt 単位のサイズ、맑은 고딕・바탕 などのシステムフォント、行間(%)、文字間隔、検索と置換、印刷。
  • 安全で高速 貼り付け・setHTML・ビューアー・サーバーが同じルールでサニタイズ。65 ページの文書でもキー入力 1 回約 18 ms。
  • 使い方はひとつ バニラ JS、React、Vue、Svelte、Angular、jQuery、Web Components が同じオプションを受け取ります。
  • Web フォントなし 実行時に何もダウンロードしません。使いたいフォントだけを自分でつなぎます。

サンプル

実際のプロダクトに組み込んだときの姿を再現したサンプルです。すべてこのページ上で動いていて、JS・HTML・CSS タブにあるのがそれぞれのコードのすべてです。同じエディターが、オプションを変えるだけで掲示板、社内文書、コメント欄になります。

ブロックギャラリー

@aeriz/wysiwyg · JS 79 行

エディターが扱う 16 種類のブロックを 1 つの文書にまとめました。左の一覧をクリックするとそのブロックに移動し、下の欄にそのブロックが保存される HTML・Markdown が表示されます。ビューアーに切り替えると保存した JSON だけで同じ画面を描き、ダークでダークテーマを確認できます。

ダークモード公開.doc16 種類のブロックを 1 つの文書に
    保存形式 · 見出し
    
        

    掲示板の投稿

    @aeriz/wysiwyg · JS 25 行

    分類・タイトル・本文を書いて投稿すると、AerizViewer が投稿の表示画面を描きます。ツールバーには必要なボタンだけを並べています。

    aeriz コミュニティ › 登山 › 新規投稿

    貼り付けラボ

    @aeriz/wysiwyg · JS 45 行

    Excel・Word・HWP(ハングル)がクリップボードに入れる雑多な HTML(を再現したサンプル)や、悪意のあるコードを含む Web の文章を貼り付けてみてください。書式は残し、mso-*・イベント属性・javascript: は取り除きます。右側で、保存される HTML・JSON・Markdown をすぐに確認できます。

    貼り付け:
    
          
    各ボタンは、Office がクリップボードに入れる形の HTML を貼り付けます。手元の文書をコピーして貼り付けても試せます。

    業務報告書

    @aeriz/wysiwyg · JS 15 行

    決裁欄と結合セルの表がある社内文書のテンプレートです。テンプレートは HTML のまま読み込み、決裁すると setReadOnly(true) でロックします。

    週報.doc

    コメント欄

    @aeriz/wysiwyg · JS 23 行

    同じエディターを、ツールバー 4 ボタン・高さ 110px・ステータスバーなしに絞りました。Ctrl + Enter で投稿します。

    コメント 2
    • table_fan

      結合セルのある表に行を足しても、何もずれません。最高

      10 分前
    • hwp_user

      HWP の文書から貼り付けたら、文字間隔まで残りました。

      3 分前
    Ctrl + Enter で投稿

    インストール

    お使いのパッケージマネージャーを選んでください。ビルドツールを使わない場合は CDN タブを見てください。

    bash
    npm install @aeriz/wysiwyg

    どの方法でインストールしても、スタイルシートは一度だけ読み込みます。バンドラーを使う場合は import '@aeriz/wysiwyg/style.css' と書きます。

    ヒント CDN の URL には @2.0.1 のように正確なバージョンを書きましょう。URL が変わらないので、長期間キャッシュされます。

    クイックスタート

    要素をひとつ渡します。height を指定すると、本文はその高さの中でスクロールします。指定しない場合、エディターは親要素いっぱいに広がります(最小 320px)。

    js
    import { AerizEditor } from '@aeriz/wysiwyg';
    import '@aeriz/wysiwyg/style.css';
    
    const editor = new AerizEditor({
      element: document.querySelector('#editor'),
      initialHTML: '<p>Hello</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',                                  // multipart で POST: 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 が優先されます。

    コードのハイライト(任意)

    コードブロックのハイライターはコアに含まれていません。必要なときだけ import して 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)や Markdown のコードフェンス(```ts)は、言語がそのまま引き継がれます。
    • py → Python、sh → Bash のような別名も認識します。
    • IME で変換中(日本語入力など)に言語を切り替えても、文字が重複しません。

    バニラ 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>Hello</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 を使います。HTML は v-model でバインドします。

    vue
    <script setup>
    import { ref } from 'vue';
    import { AerizEditor } from '@aeriz/wysiwyg/vue';
    import '@aeriz/wysiwyg/style.css';
    const html = ref('<p>Hello</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>Hello</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>Hello</p>'; }

    フォームコントロールで disable() を呼ぶと、エディターは読み取り専用になります。

    Web コンポーネント

    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>Hello</p>', height: 480 });
    $('#editor').aerizEditor('getHTML');
    $('#editor').aerizEditor('destroy');

    サーバーとエッジ

    @aeriz/wysiwyg/server は CSS を import せず 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 行分伸びます。
    行・列の削除結合セルの始まりの行を削除すると、そのセルは下の行に移ります。結合された見出しは 1 列分狭くなります。
    結合選択範囲がほかの結合セルに半分かかっている場合は、そのセル全体を含むまで範囲を広げます。テキストは改行でつなぎます。
    分割単独のセルに戻し、表が長方形のままになるよう空のセルを補います。
    Tabグリッド順で次のセルに移動します。最後のセルでは行を追加します。

    貼り付け

    貼り付け元残すもの取り除くもの
    Excelセル結合、太字、背景色、罫線、配置、文字色mso-number-format、クラス、<col>、シートの既定フォント
    Word太字と斜体、インデント、箇条書きと番号付きリスト(入れ子も)mso-list の段落、Wingdings の行頭記号、<o:p>、lang
    HWP(ハングル)インデント、文字間隔、フォント(<font> は <span style> に変換)、セルの幅と背景色HStyle クラス、style-name、セル内を包む段落、既定サイズ(size="3")
    Google ドキュメント段落、見出し、リスト、太字全体を包む <b id="docs-internal-guid-…">、リスト項目内の <p>
    Web段落、見出し、リスト、表、リンクスクリプト、イベント属性、ブロック id
    このエディター文書の中身(書式、リンク、リストと表の構造)ブラウザーが付ける計算済みスタイル(font-size: 15px など)、配置ボタン、リサイズハンドル
    • ブロックを包むリンクや太字(<a><p>…</p></a>)はいったん外し、各ブロックのテキストに付け直します。段落の中に段落が入ることはありません。
    • リスト項目、表のセル、キャプションのようにブロックを置けない場所では、引用やコールアウトも改行でつないだテキストとして入ります。
    • そうした場所に貼り付けたリンクカード、ファイル、動画は、そのアドレスへの 1 行のリンク(カードのタイトルやファイル名)になります。引用やコールアウトの中に貼り付けた場合は、中身を埋めたうえでボックスの外に出します。
    • 同じ表の複数のセルにまたがる選択範囲に貼り付けると、セルはすべて残したまま選択したテキストだけを削除し、最初のセルに挿入します。表の形は崩れません。
    • キャレットが画像やリンクカードの上にあるときは、その次の段落に貼り付けます。複数のブロックにまたがる選択範囲に貼り付けると、先に選択範囲を削除します。
    • リンクのテキストの中で URL を貼り付けると、アドレスだけを挿入します。リンクの中にリンクが入ることはありません。

    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 です。端末にないフォントは一覧に表示しません。
    • CSS を読み込むのは cssUrl を持つフォントだけで、それもフォント一覧を開いたときだけです。それ以外のリクエストは発生しません。
    • 行間は 100%〜300%、文字間隔は em 単位です。特殊文字は記号、矢印、丸囲み、単位、括弧、数学のグループに分かれています。

    無料フォント(SIL OFL 1.1)

    FREE_FONTS は、ライセンスを気にせず無料で使える韓国語フォント 15 種の一覧です。パッケージにフォントファイルは含まれておらず、既定の CDN URL もありません。自分でホストした CSS を freeFonts({ cssUrl }) に渡すと、フォント一覧を開いたときにそのフォントだけを読み込みます。

    js
    import { AerizEditor, freeFonts } from '@aeriz/wysiwyg';
    
    new AerizEditor({
      element,
      // DEFAULT_FONTS の後ろに追加。나눔고딕 と 나눔명조 はすでにあるので URL だけが付く
      fonts: freeFonts({
        only: ['pretendard', 'noto-serif-kr', 'd2coding'],      // 省略するとすべて
        cssUrl: (font) => `/fonts/${font.id}/font.css`,        // 自分でホストする CSS
      }),
    });
    • cssUrl のないフォントは、端末にインストールされている場合にだけ表示されます。freeFonts() 自体はリクエストを送りません。
    • フォントファイルを自分でホストする場合は、各フォントの OFL.txt を一緒に置いてください。OFL は商用利用と Web への埋め込みを認めていますが、フォントファイル単体の販売は禁止しています。
    • 既定一覧にある 맑은 고딕、굴림、바탕 などのシステムフォントは端末のものを使い、ファイルは配布しません。
    フォント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 でボックスから抜け、1 行目の先頭の Backspace でその行を本文として外に出します。
    トグルタイトルの Enter で本文の先頭に新しい行(折りたたみ中はトグルの後ろ)。本文の空の最終行の Enter でトグルから抜けます。タイトル先頭の Backspace でトグルを外し、本文の段落に戻します。

    削除

    操作結果
    空のブロックで Backspaceまず本文の段落になり、もう一度押すと上のブロックの末尾につながります。空の 2 番目のリスト項目は上の項目の末尾へ。空の文書はそのままです。
    段落の先頭で Backspace、末尾で Delete前後の段落と結合します。<span style> は残りません。表・コードとは結合せず、キャレットが中に入ります。
    コードブロックの末尾で Delete次の段落を取り込まず、キャレットだけが移ります。
    区切り線・画像・動画・リンクカードの隣1 回目は赤い枠で示すだけ、2 回目で削除します。

    選択して入力

    操作結果
    複数のブロックを選択して入力選択範囲だけを置き換えます。トリプルクリックで選んだ段落が次の段落を巻き込むことはありません。
    表のセルから表の外まで、トグルのタイトルから本文まで選択して入力文字(日本語を含む)が選択の始点に順番どおり入ります。
    Ctrl+A表で始まる文書や、カード・動画で終わる文書もすべて選択します。続けて削除や入力をすると、空の段落がひとつ残ります。
    リストの種類を変更別のリストにするとすべての項目が残り、見出し・本文にするとキャレットのある項目だけが変わります。
    不明なブロック新しい行や、認識できない要素(<div>、<section> など)は本文の段落になります。

    画像・動画・カード

    操作結果
    区切り線・動画・表を挿入書いていた段落の後ろに入り、キャレットは次の段落に移ります。
    画像・カード・動画をクリックして入力文字、日本語入力、Enter はその次の段落から始まります。キャプションの中は例外です。
    リンクカードやファイルをクリック・ドラッグして入力フォーカスがエディターに残るので、入力が失われません。
    動画をクリック1 回目でブロックを選択、2 回目で再生します。読み取り専用モードとビューアーではすぐに再生します。
    カード・動画で終わる内容を貼り付けキャレットがその次の段落に置かれるので、キー入力がプレーヤーに奪われません。
    リンクカードをクリック新しいタブではなく編集ダイアログが開きます。本文中のリンクは Ctrl+クリック で開きます。
    HTML ブロックの高さ最初は内容の高さいっぱいに開きます。下端のバーをドラッグして高さを決め、ダブルクリックで元に戻します。高さは getHTML() とビューアーでも保たれます。

    メモ 読み込んだ HTML の固定ヘッダーや内側のスクロール領域は、開くときに解除します。そのため内容が途中で切れません。

    操作結果
    リンクを付けるテキストを選んで Ctrl+K かツールバーのリンクボタン。https://… と入力してスペースを押すか、URL を貼り付けてもリンクになります。example.com には https:// を補います。
    YouTube の URL を貼り付け空の段落なら動画になります。YouTube 以外の URL を動画ダイアログに入れると、ヒントを表示します。
    元に戻す・やり直し1 単語ずつ戻り、キャレットも元の位置に戻ります。ブラウザーのメニューからの「元に戻す」も同じ履歴を使い、すばやく行き来してもやり直しが壊れません。

    ショートカットとアクセシビリティ

    操作ショートカット
    元に戻す / やり直し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(表を守るため、表のセル内では無視します。引用やトグルを変換すると、中のリスト項目はそれぞれ 1 行になります)
    番号付きリスト · 箇条書き · 引用 · コード · チェックリスト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 = {)は、ショートカットに横取りされません。
    • ツールバー タブ移動は 1 回分。ボタン間は矢印キー、Home、End で移動します。
    • スクリーンリーダー 本文エリアにアクセシブルな名前が付きます(ariaLabel。既定は各言語の「リッチテキストエディター」)。

    入力ルール(Markdown)

    本文の段落の先頭で次のように入力すると、すぐにブロックが変わります。Ctrl+Z を 1 回押せば、入力したとおりの文字に戻ります。

    入力結果
    #〜###### + スペース見出し 1〜6
    - · * · + + スペース箇条書き
    1. · 1) + スペース番号付きリスト(数字は任意)
    [ ] · [] · [x] + スペースチェックリスト([x] は完了済み)。箇条書きの項目の先頭でも使えます。
    > + スペース引用
    ``` · ~~~コードブロック。続けて 1 行目に言語名だけ(py、js、sql …)を入力して Enter を押すと、その言語でハイライトします(ハイライターを設定している場合)。
    --- · ***区切り線

    空の段落に YouTube の URL を貼り付けると動画になり、それ以外の URL はリンクになります。画像ファイルを貼り付けたりドロップしたりすると画像になります。コールアウト、トグル、表、リンクカード、ファイル添付、HTML の読み込みは、ツールバー先頭のブロックメニューから使えます。

    オプション

    オプション型既定値説明
    elementHTMLElement—エディターを置く場所(必須)
    initialHTMLstring—最初の本文
    placeholderstring—空のときに表示するヒント
    toolbar{ items, sticky } | falseDEFAULT_TOOLBARツールバーの項目。'|' は区切り
    theme'light' | 'dark''light'テーマ
    locale'ko' | 'en' | 'ja' | 'zh''ko'UI の言語
    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—リンクカードのファビコン URL。指定しない場合はファビコンを描かず、外部サービスも呼ばない。例:(href) => `/favicon?url=${encodeURIComponent(href)}`
    htmlStyles'inline' | 'class''inline'getHTML() の出力形式。'class' はスタイルシートを読み込むページ向け
    ariaLabelstring「リッチテキストエディター」(ja)本文エリアのアクセシブルな名前

    メソッド

    メソッド説明
    getHTML({ styles? })編集用 UI を除いた本文の HTML
    setHTML(html)本文を置き換える(サニタイズ済み、元に戻す 1 回分)。属性だけの空の要素として届いたリンクカード、ファイル、動画(<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 が選ぶファイルはすべて minify 済みです。空白とコメントを除き、ローカル変数名を短くしていますが、難読化はせず、ソースマップも含めていません。公開 API の名前と型は変わらず、@__PURE__ の印も残しているので、バンドラーの tree-shaking はそのまま効きます。

    使う側ファイルサイズ(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)—
    デバッグ用(minify なし)dist/aeriz-wysiwyg.esm.js · .cjs · .jsCDN の URL で直接指定する場合のみ(例: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)
    フォント一覧に Google Fonts韓国語のシステムフォント。Web フォントは 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)。ほかのアイコンセットから持ってきたものはありません。
    • リンクカードが既定で Google のファビコンサービスを呼ばなくなりました。ファビコンを表示するには favicon オプションでアドレスを指定します。指定しない場合、カードはファビコンを描かず、外部へのリクエストも発生しません。
    • ライセンスを確認済みの無料韓国語フォント 15 種を FREE_FONTS · freeFonts() で使えます(すべて SIL OFL 1.1)。フォントファイルは同梱しておらず、既定の CDN アドレスもありません。

    新機能

    • コードの言語の自動判定:貼り付けたコードの language-* クラスと data-lang、py・sh・c++ のようなコードフェンスの別名を読み取ります。``` の後の 1 行目に言語名を入力して Enter を押すと、その言語に設定されます。
    • リンク:Ctrl+K で挿入・編集・削除できます。https://… や www.… の後にスペースか Enter を押すとリンクになり、URL をひとつだけ貼り付けるとリンクになります(テキストを選択していればそのテキストに付きます)。空の段落に YouTube の URL を貼り付けると動画ブロックになります。example.com やメールアドレスには https://、mailto: を補います。リンクカードをクリックすると、新しいタブではなく編集ダイアログが開きます。
    • タスクリストの入力ルール:段落や箇条書き項目の先頭で [ ] 、[] 、[x] (完了)。Ctrl+Z を 1 回押せば入力した文字に戻ります。
    • 読み込んだ HTML ブロックは内容の高さで開きます(固定ヘッダーや内側のスクロール領域は解除)。下端をドラッグして高さを決め、ダブルクリックで元に戻します。高さは getHTML()、ビューアー、Markdown 書き出しでも保たれます。
    • 元に戻す単位をスペースごとに区切ったので、1 回の「元に戻す」で 1 単語分戻り、キャレットもその変更前の位置に戻ります。ブラウザーの編集メニューや右クリックメニューからの「元に戻す」も、エディターの履歴を使います。
    • macOS の Cmd+Option ブロックショートカットはキーの位置で判定し、ヨーロッパ系キーボードの AltGr 文字(AltGr+7 = {)は横取りしません。

    編集(ブロックの境界)

    • Enter:見出しの末尾では次の行が本文になり、空のリスト項目ではリストから抜け、引用・コールアウト・トグルでは空の最終行でボックスから抜けます。コードブロックは前の行のインデントを保ち、空の最終行での Enter か Ctrl+Enter で抜けます。
    • Backspace や Delete で段落を結合しても <span style> は付きません。表とコードブロックは結合せず、区切り線・画像・動画・リンクカード・ファイルは、削除の前にいったん赤い枠で示します。
    • 複数ブロックにまたがる選択範囲、トリプルクリック、Ctrl/Cmd+A の上で入力・削除・切り取りをすると、選択範囲だけを削除して続けます。文書がカードや表で始まる・終わる場合でも、Ctrl/Cmd+A ですべてを選択します。
    • 区切り線、動画、リンクカード、表を挿入すると、書いていた段落はそのまま残し、その後ろに入ります。編集中は動画の 1 回目のクリックでブロックを選択するので、キー入力がプレーヤーに渡りません。
    • コピーと切り取りでは、文書の中身だけを運びます(ブラウザーの計算済みスタイルは含めません)。ダイアログを閉じると、キャレットが元の位置に戻ります。
    • 不明なブロック(<div class>、<section>)は本文の段落になり、引用の中のカードや引用、空の表、リンクの中のリンクといった壊れた構造は、現れた時点で直します。表のセル内では、テキストブロックの種類の変更を適用しません。

    表・貼り付け・タスクリスト

    • ツールバーの表サイズ選択と列幅の調整は 1 フレームに 1 回だけ描くので、マウスに遅れずについてきます。ドラッグせずにセルの右端をクリックすると、そのセルにキャレットが入ります。
    • HWP(ハングル)や古い Web ページの <font face color size> は、フォント・色・サイズのツールが読める <span style> に変換します。リンクのテキストの中で URL を貼り付けると、アドレスだけを挿入します。
    • 空の要素として届いたリンクカード、ファイル、動画の HTML(サーバー側でサニタイズした後など)は、エディター内で組み立て直します。
    • 修正:完了済みのタスクリスト項目を保存して読み込み直した後、チェックを外しても灰色の取り消し線が残っていました。

    配布

    • バンドラーが選ぶ ES モジュールと、サーバー・ハイライター・フレームワーク用ファイルが、実際に minify されるようになりました。メインの ES モジュールは 422 KB から 295 KB(gzip で 113 KB から 83 KB)に、npm パッケージは 904 KB から 871 KB になりました。配布ファイルを参照してください。
    • サンプルページを追加:ブロックギャラリー、掲示板の投稿、コメント欄、貼り付けラボ、業務報告書。

    修正

    • 韓国語の入力変換中にコードブロックの言語を変えると、文字が二重に入力され、ハイライトが止まっていました。
    • 引用やコールアウトに貼り付けたリンクカードが空のボックスのままになり、ファイルと動画は消えていました。リスト項目や表のセルに貼り付けたカード、ファイル、動画も消えていました(現在はアドレスのリンクとして残ります)。
    • カードや動画で終わる貼り付けの後に動画をクリックすると、次のキー入力がプレーヤーに渡っていました。ファイルやリンクカードをクリック・ドラッグした後に入力したテキストが失われていました。
    • 引用、コールアウト、トグルの中のコードブロックで Enter を押すと、コードブロックが段落に包まれ、元に戻す・やり直しの後に文書が変わっていました。
    • 表の複数のセルにまたがる選択範囲に貼り付けると、セルが削除され、表が長方形でなくなっていました。