Skip to content

custom-element

Directory actions

More options

Directory actions

More options

Latest commit

 

History

History

custom-element

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
docs
docs
 
 
src
src
 
 
CHANGELOG.md
CHANGELOG.md
 
 
README.md
README.md
 
 
package.json
package.json
 
 
rollup.config.js
rollup.config.js
 
 
tsconfig.json
tsconfig.json
 
 
tsconfig.rollup.json
tsconfig.rollup.json
 
 

README.md

@burger-editor/custom-element

npm version

TipTap ベースの WYSIWYG エディタを Web Components（<bge-wysiwyg-editor>）として提供。@burger-editor/blocks の wysiwyg アイテムの編集 UI 実体。

Installation

yarn add @burger-editor/custom-element

Related Packages

パッケージ 関係 使い分け
@burger-editor/client 本要素を内部で利用する完成形のエディタ UI 通常はこちらを使う
@burger-editor/blocks wysiwyg アイテムの編集 UI として本要素を参照 リッチテキスト編集 UI 単体なら本パッケージのみで足りる

Usage

import { defineBgeWysiwygEditorElement } from '@burger-editor/custom-element';

defineBgeWysiwygEditorElement();
<bge-wysiwyg-editor
	name="my-editor"
	item-name="wysiwyg"
	commands="bold,italic,underline,link,blockquote,bullet-list,ordered-list,h3,h4,h5,h6">
</bge-wysiwyg-editor>
const editor = document.querySelector('bge-wysiwyg-editor') as BgeWysiwygEditorElement;
editor.value; // 現在の内容（getter、読み取り専用）
editor.innerHTML = '<p>新しい内容</p>'; // innerHTML の独自 setter が TipTap に同期する
editor.editor.chain().focus().toggleBold().run(); // TipTap への直接アクセス

属性 / プロパティ

commands 属性

カンマ区切りでツールバーに表示するコマンドを指定する。代表的な値:

値 機能
bold 太字
italic 斜体
underline 下線
link リンク挿入
blockquote 引用
bullet-list 箇条書き
ordered-list 番号付きリスト
h3 / h4 / h5 / h6 見出しレベル切替

指定順がそのまま表示順になる。完全な一覧は型定義参照。

value プロパティ

  • getter のみ（読み取り専用）: 現在のエディタ内容を HTML 文字列で返す。TipTap の editor.getHTML() 相当だが、本要素の正規化（属性順序・改行など）を経た最終 HTML
  • 内容の書き換えは innerHTML への代入で行う。本要素は innerHTML に独自 setter を定義しており、TipTap の document state に同期させる（詳細は docs/API.md）

name / item-name 属性

  • name: フォーム要素としての識別子（複数エディタを区別する用途）
  • item-name: ブロックカタログ上のアイテム名（通常 wysiwyg）。スタイル適用のための DOM 契約

イベント

bge:structure-change

エディタ内のブロック構造（段落・リスト・見出しレベル・リンク状態など）が変化したときに発火する CustomEvent。ツールバーの押下状態同期に使う。

editor.addEventListener('bge:structure-change', (event) => {
	const { detail } = event;
	// detail: {
	//   active: Record<string, boolean>;   // 例: { bold: true, italic: false, 'heading-3': false, ... }
	//   canExecute: Record<string, boolean>; // 各コマンドが現在のカーソル位置で実行可能か
	// }
});

active のキーは commands 属性で指定する値と同じ命名規則。canExecute は無効化状態のボタン UI を作るときに使う。

transaction

TipTap のトランザクション単位で発火する低レベルイベント。bge:structure-change で間に合わないユースケース（IME 中の入力ステップを観測したい等）でのみ使用。

ドキュメント

設計詳細・API リファレンス・カスタマイズ手順は docs/ 配下を参照。

実験的機能

experimental.textOnlyMode を有効化すると、以下の 3 モードを切り替え可能になる:

モード値 名称 概要
'wysiwyg' デザインモード TipTap エディタでリッチテキスト編集
'text-only' テキスト編集モード HTML 構造を保持したままテキストのみ編集
'html' HTML モード HTML ソースコードを直接編集 
defineBgeWysiwygEditorElement({
	experimental: { textOnlyMode: true },
});

ブラウザサポート

ツールバーが Invoker Commands API（command/commandfor）を使用するため、対応ブラウザが下限（ポリフィルなし）。対応状況は https://caniuse.com/mdn-api_commandevent を参照。

License

Dual Licensed under MIT OR Apache-2.0