制限事項

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

JavaScript API利用時の制限事項

ファイルサイズ

JavaScriptファイルのサイズは「5MB」までに制限されています。

スマートフォン専用画面

JavaScript APIは動作対象外となります。

変数・ネームスペース

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

そのため、変数はグローバル変数にせず、無名関数を即時実行パターンで作成し、そのローカルスコープとして変数を定義してください。

(function() {
    const local = 1; // 良い例
    global = 1; // 悪い例
    collaboflow.var1 = {}; // 既存オブジェクトの書き換えは不可
})();

id/class及びDOM構造

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

パーツの変更・削除

フォームに配置したパーツを変更したり削除すると、パーツの存在や今までの設定を前提に記述されたカスタマイズ処理は恐らく期待した動作にならないでしょう。必ずパーツを変更・削除する前に、カスタマイズに影響が出るか検討してください。

• パーツを変更・削除したら、カスタマイズ処理の動作確認も行うようにしましょう。

CSSファイルの利用

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

外部ライブラリの利用

コラボフローで利用されているライブラリ（jQueryやnotyなど）をJavaScript APIで読み込むと、誤動作の原因となる可能性があります。また、その他のJavaScript（CSS）外部ライブラリに関しても、その構成によってはコラボフローの誤動作を引き起こす可能性があります。

外部ライブラリを利用したカスタマイズを行っている申請書で、コラボフローが想定外の動作となる場合は、一度外部ライブラリを外した上で、改めて動作を確認してみてください。

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

申請フォームには版（バージョン）の概念があります。
既に利用している申請フォームのパーツを変更したり設定を更新などするとフォーム改訂と判断され、版番号が更新されます。

アップロードしたカスタマイズファイルも申請フォームの版ごとに管理されています。
フォームの修正と同様にカスタマイズファイルの修正＆アップロード対象も最新版に対して適用されます。

• 現在のところ、過去版に対する修正はできません。

コラボフローのアップデート

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