syncfusion-javascript-docx-editor について
JavaScriptアプリ開発者向けに、Syncfusion DOCX Editorを組み込むTypeScriptコードを生成するスキルです。機能別のリファレンスを用意し、コード生成前に受け取り方法を確認します。
主な機能
- 01エディター初期化コードの生成
- 02文書保護と変更履歴の設定
- 03コメントとフォームフィールドの処理
- 04検索と置換の実装
- 05ツールバーとリボン設定の参照
活用シーン
- 01アプリへの文書エディター組み込み
- 02読み取り専用または変更履歴モードの有効化
- 03コメントやフォームフィールドの追加
- 04文書内テキスト置換の自動化
インストール
コマンドをコピーしてターミナルで実行します。
npx skills add https:/ / github.com/ syncfusion/ docx-editor-sdk-skills --skill syncfusion-javascript-docx-editorインストール後、Claude Code で/syncfusion-javascript-docx-editorを入力して読み込まれたか確認します。
同梱ファイル
SKILL.md と一緒にインストールされる参考資料やスクリプト。
README.mdreferences/collaborative-editing-core.mdcollaborative-editing-java.mdcomments.mdcustomize-ribbon.mdcustomize-toolbar.mddocument-protection.mdeditor-only.mdfind-and-replace.mdform-fields.mdgetting-started.mdinsert-text-box.mdpaste-formatting.mdribbon.mdspell-checker.mdtrack-changes.md詳細
Syncfusion JavaScript DOCX エディター
概要
このスキルは、Syncfusion DOCX Editor を JavaScript アプリケーションに統合するための TypeScript コードを開発者が生成できるよう支援します。編集、レビュー、書式設定などに対応したドキュメントエディターを組み込むための、そのまま使えるスニペットとベストプラクティスを提供します。
主な機能
- ドキュメントの編集: Word 文書を作成、編集、表示します。
- 保護: 読み取り専用モードを適用し、コメントやフォーム入力を許可し、変更履歴を強制し、編集可能な範囲を定義します。
- レビュー: 変更履歴(リビジョン)を有効にして、変更を承諾または拒否します。
- コメント: コメント、返信、作成者のメタデータを追加します。
- 検索と置換: 自動化のために、プログラムで検索と置換を実行します。
- フォームフィールド: テキストフィールド、チェックボックス、ドロップダウン形式のフォームフィールドを挿入して入力します。
前提条件
- npm パッケージ:
@syncfusion/ej2-documenteditor - Syncfusion ライセンス:https://www.syncfusion.com/products/communitylicense
クイックスタートの例
例 1:ドキュメントエディターを作成する
ユーザー:「ドキュメントエディターコンポーネントを作成するコードを見せてください。」
結果: ドキュメントエディターコンポーネントを初期化する TypeScript コードスニペット
例 2:読み取り専用制限モードを有効にする
ユーザー:「読み取り専用制限モードのドキュメントエディターを作成してください。」
結果: 読み取り専用の保護を有効にしたドキュメントエディターを作成する TypeScript スニペット。
はじめに — 最小限の JavaScript(ES6)コード
プレーンな Web プロジェクト向けの最小限の JavaScript(ES6)ドキュメントエディター設定:
/* styles.css */
@import '../node_modules/@syncfusion/ej2-base/styles/material.css';
@import '../node_modules/@syncfusion/ej2-buttons/styles/material.css';
@import '../node_modules/@syncfusion/ej2-inputs/styles/material.css';
@import '../node_modules/@syncfusion/ej2-popups/styles/material.css';
@import '../node_modules/@syncfusion/ej2-lists/styles/material.css';
@import '../node_modules/@syncfusion/ej2-navigations/styles/material.css';
@import '../node_modules/@syncfusion/ej2-splitbuttons/styles/material.css';
@import '../node_modules/@syncfusion/ej2-dropdowns/styles/material.css';
@import "../node_modules/@syncfusion/ej2-documenteditor/styles/material.css";
import { DocumentEditorContainer, Toolbar } from '@syncfusion/ej2-documenteditor';
DocumentEditorContainer.Inject(Toolbar);
let documenteditor: DocumentEditorContainer = new DocumentEditorContainer({
enableToolbar: true,
height: '390px',
serviceUrl: 'https://document.syncfusion.com/web-services/docx-editor/api/documenteditor/'
});
documenteditor.appendTo('#DocumentEditor');
注:例にある
serviceUrlは評価・デモ用です。本番環境では、ご自身のサービスをホストしてください。
ユーザーのプロジェクト向けに TypeScript コードを生成する
トリガーキーワード:「code」「snippet」「how to」「show me」「sample」「example code」「generate code」「implement」「add to component」「configure documenteditor」「create」「javascript es6 document editor」「docx editor」「document editor」「track changes」「load docx」「comments」「accept changes」「protect document」「find and replace」「content control」
ワークフロー:
-
ユーザーのリクエストを分析して、機能(変更履歴、編集制限、ツールバーのカスタマイズなど)を特定します。
-
該当する
references/*.mdファイルを読み、リクエストされた機能の API とコードパターンを確認します。 -
コードの生成前に必ず停止します。 ユーザーがすでに出力方法を選択しているか確認します。
-
**出力方法がまだ選択されていない場合は、**次の簡潔な複数選択式の質問を必ずユーザーにします。
「生成したコードはどのように受け取りますか?」
- オプション 1: 指定したプロジェクトファイルのコードを置き換える(ファイルパスの提示と確認が必要です)
- オプション 2: コードをチャット画面に直接表示する
-
ユーザーが出力方法を選択した後に限り、
references/*.mdの API とスニペットを使用し、ユーザーのプロジェクトにある具体的なプレースホルダーを置き換えて TypeScript コードを生成します。 -
**ユーザーがオプション 1 を明示的に選択し、許可とともにファイルパスを提示しない限り、**ワークスペース内のプロジェクトファイルを変更しないでください。
-
コードの提示後、完全な TypeScript スニペットと簡潔な統合手順を提供します。
運用上の制約(出力ディレクトリ、一時ファイル、使用可能なライブラリなど)については、## Rules セクションを参照してください。
コードリファレンス
コードスニペットとサンプルはすべて references/ フォルダーにあります。各ファイルには、次の内容が含まれています。
- 最小限の TypeScript コード — 動作確認済みで、そのまま使用できるスニペット
- プレースホルダー — ユーザーがカスタマイズする必要がある値
- 注意事項 — ベストプラクティス、機能の使用時に留意すべき追加情報、制約
| ファイル | トピック |
|---|---|
| getting-started.md | ドキュメントエディターの作成と初期化 |
| editor-only.md | エディターのみのモードの設定 |
| track-changes.md | 変更の追跡とリビジョンの管理 |
| comments.md | コメントの挿入、管理、削除 |
| form-fields.md | フォームフィールドの作成と管理 |
| find-and-replace.md | テキストの検索と置換 |
| customize-toolbar.md | ツールバー項目のカスタマイズ |
| customize-ribbon.md | リボンオプションのカスタマイズ |
| ribbon.md | リボン UI の有効化と設定 |
| document-protection.md | ドキュメントの編集保護と制限 |
| paste-formatting.md | 書式を保持して貼り付ける |
| insert-text-box.md | テキストボックスダイアログの挿入 |
| spell-checker.md | スペルチェックの設定と使用 |
| collaborative-editing-core.md | Collaboration Client と Server(ASP.NET Core バックエンド)を使用した共同編集 |
| collaborative-editing-java.md | Java(Spring Boot)バックエンドで SockJS、STOMP、Redis を使用した共同編集 |
コード生成の主なルール(TypeScript 優先)
-
SKILL.md にインラインコードを記載しない — 必ず
references/*.mdのスニペットを参照してください。このファイルはすべてのプロンプトでコンテキストに読み込まれるため、インラインコードはトークンを無駄にします。 -
スニペットはテスト済みであること — すべてのコードは、現行バージョンの
@syncfusion/ej2-documenteditorNuGet/npm パッケージに対してコンパイルおよび実行できる必要があります。 -
最小限のコード + プレースホルダー + 注意事項 — 各リファレンスファイルには、次の内容を含める必要があります。
- 最小限のコード(完全に動作するスニペット)
- プレースホルダー(ユーザーが置き換える値。
{{ }}または[PLACEHOLDER]でマーク) - 注意事項(ベストプラクティス、フレームワーク固有の適用方法、制約)
-
要件に必要なコードと注意事項を共有する — 一時ファイルやスクリプトは作成しないでください。
-
ライセンスの取り扱い — ライセンスキーをハードコードしないでください。環境変数または設定ファイルを参照するよう案内してください。
-
存在しない API を作り出さない — 検証済みの Syncfusion DOCX Editor SDK メソッド名のみを使用してください。メソッドをひとつ誤るだけで、ユーザーの信頼を損ないます。
-
サービス URL に関する注意 — serviceUrl が https://document.syncfusion.com/web-services/docx-editor/api/documenteditor/ の場合は、スニペット内にそのまま記載し、次の注意書きを追加してください。「Document Editor の serviceUrl プロパティは、デモおよび評価目的のみを想定しています。本番環境では、独自の Web サービスをホストしてください。」
ルール
- Syncfusion Document Editor API のみを使用する — 代替の Word Editor ライブラリを推奨または使用しないでください。
- 一時ファイルを作成しない — 出力ディレクトリ外に、一時スクリプト、中間ファイル、スキャフォールディングを作成しないでください。
- TypeScript のみを使用する — 生成するコードはすべて有効な TypeScript にしてください。バニラ JavaScript、jQuery、または JavaScript と TypeScript の混在したサンプルは生成しないでください。