コラボフォーム JavaScript API/CSSの制限事項

コラボフォーム JavaScript API/CSSを利用する際の制限事項について説明します。

コラボフォーム JavaScript API/CSS利用時の制限事項

ファイルサイズ制限

JavaScriptファイルおよびCSSファイルのサイズは、1ファイルあたり「5MB」までに制限されています。

アップロードファイル数の上限

1つのフォームに登録できるファイル数の上限は、JavaScriptファイル・CSSファイルそれぞれ100件です。

カスタマイズの適用範囲

JavaScript APIによるカスタマイズは公開フォーム、および送信済みフォームにのみ適用されます。フォーム設定＞表示設定のプレビューには適用されません。

変数・ネームスペース

コラボフォームが正常に動作しなくなる可能性がありますので、既存のグローバルオブジェクトを書き換えないようにする必要があります。

複数のスクリプト間での変数名の衝突を防ぐため、無名関数を即時実行パターンで作成し、そのローカルスコープとして変数を定義することを推奨します。

(function() {
    "use strict";
    const local = 1; // 良い例
    global = 1;    // 悪い例（グローバル変数への代入）
    collaboform.var1 = {}; // 既存オブジェクトの書き換えは不可
})();

複数ファイルの読み込み順序

複数のJavaScriptファイル・CSSファイルをアップロードしている場合、それぞれの読み込み順序は、フォーム設定＞カスタマイズ＞JavaScript/CSSカスタマイズの「アップロードしたファイル」に表示されている順番に従います（JavaScriptファイル・CSSファイルの順序はそれぞれ個別に管理されます）。

「アップロードしたファイル」に表示されているファイルをドラッグアンドドロップで入れ替えすることで、読み込み順を変更できます。

処理の実行順序に依存するカスタマイズをおこなう場合は、この並び順にご注意ください。

DOM構造への依存

コラボフォームの要素に使用されているid / class属性名、およびDOM構造については、事前の通知なく変更される場合があります。JavaScript APIを使ってカスタマイズする際は、id / class属性名やDOM構造に依存しない範囲でのカスタマイズを実施してください。

また、フォームの表示設定（デフォルト表示・シンプルフォーム表示）が切り替わると、DOM構造が大きく変化します。表示設定の変更時は、カスタマイズ内容が正しく動作するか必ず確認してください。

パーツの変更・削除

連携するコラボフローにて、フォームに配置したパーツの変更や削除をおこなうと、該当のパーツの存在や設定を前提に記述されたカスタマイズ内容が正常に動作しない可能性があります。パーツを変更・削除する前に、カスタマイズへの影響を必ず確認してください。

CSSファイルの利用

今後のアップデートによるデザイン変更により、フォームに適用したスタイルのレイアウトが崩れる可能性があります。デザインの変更によるスタイルの保障はいたしませんのでご注意ください。

外部ライブラリの利用

コラボフォームで内部的に利用されているライブラリと同名・同バージョンのライブラリを読み込むと、誤動作の原因となる可能性があります。外部ライブラリを利用したカスタマイズで想定外の動作が発生した場合は、一度外部ライブラリを外した上で改めて動作をご確認ください。

なお、外部ライブラリはURLを指定して動的に読み込むことはできません。該当のファイルをダウンロードし、コラボフォームのカスタマイズ機能からJavaScriptファイル・CSSファイルとしてアップロードしてご利用ください。

外部リソースの動的な読み込み制限

セキュリティ対策のため、アップロードしたJavaScript・CSSファイルから外部ドメインのスクリプト・スタイルシートを動的に読み込むことはできません。

具体的には、以下の読み込みがブロックされます。

• <script src="外部URL">など、スクリプトタグによる外部ドメインからのJavaScriptの動的な読み込み
• @importや動的な<link rel="stylesheet">による外部ドメインからのスタイルシートの読み込み

外部ドメインで公開されているJavaScriptライブラリやCSSを利用したい場合は、該当のファイルをダウンロードし、コラボフォームのカスタマイズ機能からJavaScriptファイル・CSSファイルとしてアップロードしてご利用ください。

パーツ（partsオブジェクト）の制限事項

• コラボフォームが対応していないパーツ（時刻パーツ・画像パーツ）は「data.parts」に含まれません。対応パーツの一覧は「コラボフォームに対応しているフォームパーツと設定」をご確認ください。
• 「parts」オブジェクトの「enabled」値は取得のみ可能です。「enabled」値を設定してパーツの有効/無効状態を変更することはできません。

外部API実行（プロキシ）の制限事項

• 接続先のプロトコルは「https://」のみ対応しています
• 「localhost」およびローカルネットワークアドレスへの接続は禁止されています
• 相手サーバーから受信できるボディ部は最大で 10MiB（10,485,760バイト） です
• 相手サーバーからの応答待ち時間（受信タイムアウト）は 120秒 です

カスタマイズファイルの適用対象

カスタマイズファイルは、コラボフローのフォームの版（バージョン）ごとに管理されます。

連携するコラボフローにて既に利用しているフォームのパーツの変更や設定更新をおこなうと、フォームの版が更新されます。

• 最新の版に対してカスタマイズファイルを保存すると、新規送信および同じ版で送信済みのフォームに即時適用されます。
• 過去の版の送信済みフォームには、その版で最後に保存されたカスタマイズが適用されます。
• 過去の版に対するカスタマイズは編集できません。
• コラボフロー側のフォーム編集によりフォームの版が更新された場合、カスタマイズは自動的に引き継がれます。
• フォームの経路設定より経路を変更し、コラボフローのフォームが変更された場合、カスタマイズが意図通りに動作しない可能性があります。

コラボフォームのアップデートによる影響

コラボフォームがアップデートされた場合、作成したJavaScriptファイル・CSSファイルの内容によっては、カスタマイズ内容が動作しなくなる場合があります。その場合は必要に応じてJavaScriptファイル・CSSファイルを修正し、再度アップロードをおこなってください。