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

フォローする

Index

概要

Garoonの「JavaScript / CSSによるカスタマイズ」機能を使用すると、Garoonの動作、画面をカスタマイズすることができます。

対象は「Garoon on cybozu.com」のみとなります。

このページでは、JavaScriptを用いてGaroonのカスタマイズを行う際に注意すべき点について説明します。

JavaScriptでGaroonをカスタマイズするための設定画面については、Garoon 管理者ガイドの次の該当する箇所をご参照ください。

  • ワークフローをカスタマイズする場合: ワークフローのカスタマイズ
  • スケジュールをカスタマイズする場合: スケジュールのカスタマイズ
  • プロキシAPIを使用する場合: プロキシAPI

コーディング上の注意点

文字コード

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

変数・ネームスペース

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

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

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

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

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

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

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

セキュリティ

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

免責事項

ガルーンのJavaScriptカスタマイズに関する免責事項については以下のGaroon 管理者ガイドに記載のをご参照ください。

 

記事に関するフィードバック

直接的に記事と関連がないご質問はcybozu developer コミュニティをご活用ください。

ログインしてコメントを残してください。
Powered by Zendesk