syncfusion-vue-docx-editor について
Vueアプリ開発者向けに、Syncfusion DOCX Editorを組み込むVueコードを生成するスキルです。機能別のリファレンスを備え、生成前に受け取り方法を確認し、Vueコードのみを扱います。
主な機能
- 01エディター初期化コードの生成
- 02文書保護と変更履歴の設定
- 03コメントとフォームフィールドの処理
- 04検索と置換の実装
- 05ツールバーとリボン設定の参照
活用シーン
- 01Vueアプリへの文書エディター組み込み
- 02読み取り専用または変更履歴モードの有効化
- 03コメントやフォームフィールドの追加
- 04文書内テキスト置換の自動化
インストール
コマンドをコピーしてターミナルで実行します。
npx skills add https:/ / github.com/ syncfusion/ docx-editor-sdk-skills --skill syncfusion-vue-docx-editorインストール後、Claude Code で/syncfusion-vue-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-check.mdtrack-changes.md詳細
Syncfusion Vue DOCX エディター
概要
このスキルは、アプリケーションに Syncfusion DOCX エディターを統合するための Vue コードを開発者が生成できるよう支援します。編集、レビュー、書式設定などに対応したドキュメントエディターを組み込むための、すぐに使えるコードスニペットとベストプラクティスを提供します。
主な機能
- ドキュメント編集: Word ドキュメントを作成、編集、表示します。
- 保護: 読み取り専用モードを適用し、コメントやフォーム入力を許可し、変更履歴を有効にして、編集可能な範囲を定義します。
- レビュー: 変更履歴(リビジョン)を有効にし、変更を承認または却下します。
- コメント: コメント、返信、作成者のメタデータを追加します。
- 検索と置換: 自動化のために、プログラムから検索と置換を実行します。
- フォームフィールド: テキストフィールド、チェックボックス、ドロップダウン形式のフォームフィールドを挿入して入力します。
前提条件
- npm パッケージ:
@syncfusion/ej2-vue-documenteditor - Syncfusion ライセンス:https://www.syncfusion.com/products/communitylicense
クイックスタートの例
例 1:ドキュメントエディターを作成する
ユーザー:「ドキュメントエディターコンポーネントを作成するコードを見せてください。」
**結果:**ドキュメントエディターコンポーネントを初期化する Vue コードスニペット
例 2:読み取り専用の制限モードを有効にする
ユーザー:「読み取り専用の制限モードを有効にしたドキュメントエディターを作成してください。」
**結果:**読み取り専用の保護を有効にしたドキュメントエディターを作成する Vue コードスニペット
はじめに — 最小限の Vue コード
一般的な Web プロジェクト向けの最小限の Vue ドキュメントエディター設定:
<template>
<DocumentEditorContainerComponent
id="container"
height="590px"
:serviceUrl="serviceUrl"
:enableToolbar="true"
/>
</template>
<script setup>
import { DocumentEditorContainerComponent, Toolbar } from '@syncfusion/ej2-vue-documenteditor';
DocumentEditorContainerComponent.Inject(Toolbar);
const serviceUrl = "https://document.syncfusion.com/web-services/docx-editor/api/documenteditor/";
</script>
<style scoped>
#container {
width: 100%;
height: 590px;
}
</style>
注:例で使用している
serviceUrlは評価/デモ用です。本番環境では、独自のサービスをホストしてください。
ユーザーのプロジェクト向けに Vue コードを生成する
トリガーキーワード:「コード」、「スニペット」、「方法」、「見せて」、「サンプル」、「コード例」、「コードを生成」、「実装」、「コンポーネントに追加」、「documenteditor を設定」、「作成」、「vue document editor」、「docx editor」、「document editor」、「変更履歴」、「docx を読み込む」、「コメント」、「変更を承認」、「ドキュメントを保護」、「検索と置換」、「コンテンツコントロール」
ワークフロー:
-
ユーザーのリクエストを分析して、機能(変更履歴、編集制限、ツールバーのカスタマイズなど)を特定します。
-
関連する
references/*.mdファイルを読み、リクエストされた機能の API とコードパターンを確認します。 -
コードを生成する前に停止します。 ユーザーが受け取り方法をすでに選択しているか確認します。
-
受け取り方法がまだ選択されていない場合、次の簡潔な複数選択式の質問を必ずユーザーに尋ねます。
「生成されたコードはどのように受け取りますか?」
- オプション 1: 特定のプロジェクトファイル内のコードを置き換える(ファイルパスの提示と確認が必要です)
- オプション 2: コードをチャット画面に直接表示する
-
ユーザーが受け取り方法を選択した後にのみ、
references/*.mdの API とコードスニペットを使って Vue コードを生成し、ユーザーのプロジェクトにある具体的な値でプレースホルダーを置き換えます。 -
ユーザーがオプション 1 を明示的に選択し、ファイルパスと許可を提示していない限り、ワークスペースのプロジェクトファイルを変更してはいけません。
-
コードを提示した後、完全な Vue コードスニペットと簡潔な統合手順を提供します。
運用上の制約(出力ディレクトリ、一時ファイル、使用可能なライブラリなど)については、## Rules セクションを参照してください。
コードリファレンス
コードスニペットとサンプルはすべて references/ フォルダーにあります。各ファイルには以下が含まれます。
- 最小限の Vue コード — 動作確認済みで、そのまま使用できるスニペット
- プレースホルダー — ユーザーがカスタマイズする必要のある値
- 注意事項 — ベストプラクティス、機能の使用時に留意すべき追加情報や制約
| ファイル | トピック |
|---|---|
| getting-started.md | ドキュメントエディターの作成と初期化 |
| track-changes.md | 変更履歴の記録とリビジョンの管理 |
| comments.md | コメントの挿入、管理、削除 |
| customize-ribbon.md | リボンのオプションのカスタマイズ |
| customize-toolbar.md | ツールバー項目のカスタマイズ |
| document-protection.md | ドキュメント編集の保護と制限 |
| editor-only.md | エディター専用モードの設定 |
| find-and-replace.md | テキストの検索と置換 |
| form-fields.md | フォームフィールドの作成と管理 |
| paste-formatting.md | 貼り付け時の書式設定の動作を制御 |
| insert-text-box.md | テキストボックスダイアログの挿入 |
| ribbon.md | Ribbon UI を使用した documentEditor の初期化 |
| spell-check.md | スペルチェックの有効化と設定 |
| collaborative-editing-core.md | Collaboration Client と Server による共同編集(ASP.NET Core バックエンド) |
| collaborative-editing-java.md | Java(Spring Boot)バックエンドでの SockJS、STOMP、Redis を使用した共同編集 |
コード生成の主なルール
-
SKILL.md にインラインコードを記載しない — 常に
references/*.mdのスニペットを参照してください。このファイルはすべてのプロンプトでコンテキストに読み込まれるため、インラインコードはトークンを無駄にします。 -
スニペットはテスト済みであること — すべてのコードが、現在の
@syncfusion/ej2-vue-documenteditornpm パッケージのバージョンでコンパイルおよび実行できる必要があります。 -
最小限のコード + プレースホルダー + 注意事項 — すべてのリファレンスファイルに以下を含める必要があります。
- 最小限のコード(完全で動作するスニペット)
- プレースホルダー(ユーザーが置き換える値。
{{ }}または[PLACEHOLDER]で示す) - 注意事項(ベストプラクティス、フレームワーク固有の適用方法、制約)
-
要件に応じたコードと注意事項を共有する — 一時ファイルやスクリプトは作成しないでください。
-
ライセンスの取り扱い — ライセンスキーをハードコードしないでください。環境変数または設定ファイルを案内してください。
-
存在しない API を作り上げない — 検証済みの Syncfusion DOCX Editor SDK メソッド名のみを使用してください。誤ったメソッドを1つ使うだけで、ユーザーの信頼を損ないます。
-
サービス URL に関する注意 — serviceUrl に https://document.syncfusion.com/web-services/docx-editor/api/documenteditor/ が含まれている場合は、その URL をスニペットに残し、次の注意書きを追加してください。「Document Editor の serviceUrl プロパティは、デモおよび評価目的のみを想定しています。本番環境では、独自の Web サービスをホストしてください。」
ルール
- Syncfusion Document Editor API のみを使用する — 代替の Word Editor ライブラリを推奨または使用しないでください。
- 一時ファイルを作成しない — 出力ディレクトリ外に一時スクリプト、中間ファイル、足場となるファイルを作成しないでください。
- Vue 専用コード — 生成するコードはすべて有効な Vue コードである必要があります。バニラ JavaScript、jQuery、または Vue 以外のパターンは生成しないでください。