kintone JavaScript コーディングガイドライン

概要

kintoneの「JavaScript / CSSでカスタマイズ」機能を使用すると、kintoneの各機能やアプリの動作、画面をカスタマイズすることができます。
このページでは、JavaScriptを用いてkintoneのカスタマイズを行う際に注意すべき点について説明します。

JavaScriptでkintoneやアプリをカスタマイズする方法は、kintone ユーザーヘルプをご参照ください。

• JavaScriptやCSSでkintone全体をカスタマイズする
• JavaScriptやCSSでアプリをカスタマイズする

コーディング上の注意点

文字コード

UTF-8(BOMなし）で記述してください。

変数・ネームスペース

kintoneが正常に動作しなくなる可能性があるため、既存のグローバルオブジェクトを書き換えないようにしてください。
グローバル変数を使わず、即時関数のスコープ内で変数を定義してください。やむを得ずスコープ間で共有する変数を使用する場合は、名前空間オブジェクトを使用してください。

(function () {
  var localVariable = 1; // 良い例
  globalVariable = 1;  // 悪い例
  cybozu.foo = 'bar'; // 既存のオブジェクトを書き換えてはいけない
  myNameSpace = {}; // 名前空間オブジェクト
  myNameSpace.foo = 'bar';
})();

kintoneで使われているid/class属性について

各要素に付与されているid/class属性の値は、予告なく変更されることがあります。また、DOM構造についても変更されることがあります。

カスタマイズをされる際は、id/class属性の値やDOM構造を変更するカスタマイズを加えないようご注意ください。

URLの取得

将来のバージョンでも動作できるようにするため、kintoneのURLを取得するには、kintone.api.url()メソッドもしくは、kintone.api.urlForGet()メソッドをご使用ください。

JavaScript API によるカスタマイズができない箇所

スペースやスレッドの本文に貼り付けたアプリのレコード一覧やグラフに対して、JavaScript API によるカスタマイズを行うことはできません。

kintoneのアップデートによる影響

kintoneがアップデートされると、作成したプログラムの実装によっては、アップロードしたJavaScript / CSSファイルが動作しなくなる場合があります。必要に応じてJavaScript / CSSファイルを編集し、再度アップロードしてください。
kintoneのアップデートによる影響を少なくするため、デベロッパーサイトで公開されているJavascript APIをご利用ください。
API の仕様公開と仕様変更の方針

セキュリティ

作成したJavaScriptプログラムによってセキュリティ上の問題が発生するのを防ぐために、セキュアコーディングガイドラインに従ってプログラムの作成を行ってください。