kintoneは毎月の定期メンテナンスでアップデートしています。

このとき、 kintone API ドキュメントに記載していない方法でkintoneカスタマイズを行うと、kintoneの機能追加の影響を受けて、動作しなくなるリスクがあります。
たとえば、直接HTML要素の参照や編集をする「DOM操作」と呼ばれる実装方法などがあります。

そこで本記事では、kintoneのアップデートで動かなくなるリスクがあるカスタマイズの例を紹介します。
例を通じて、アップデートの影響を受けにくいカスタマイズについて考えていきましょう。

ここからは、具体例を交えて説明します。
回避策がある場合はその内容についても説明します。

HTML 要素の参照

kintoneの画面上に要素（ボタンなど）を表示したい場合は、次のような方法で取得したスペース要素にボタンなどの要素を追加してください。

• kintone.app.record.getSpaceElement()
• kintone.app.record.getHeaderMenuSpaceElement()

1
2
3
4
5
6

const newDiv = document.createElement('div');
const newContent = document.createTextNode('Hello');
newDiv.appendChild(newContent);

const element = kintone.app.record.getHeaderMenuSpaceElement();
element.appendChild(newDiv);

ID名やClass名の指定は動かなくなるリスクがあります。
たとえば以下のようなコードです。
クラス名のrecordlist-cell-gaiaは変更される可能性があるためです。

1
2
3
4
5
6

const newDiv = document.createElement('div');
const newContent = document.createTextNode('Hello');
newDiv.appendChild(newContent);

const currentDiv = document.getElementsByClassName('recordlist-cell-gaia')[0]; // 推奨しません
currentDiv.appendChild(newDiv);

もちろんjQueryを使ってjQuery（'.recordlist-cell-gaia'）のように指定するのも同様です。

つまり、APIで取得できる場所以外に要素を追加することは、動かなくなるリスクがあります。
以下のようにHTMLタグを参照するのも同様です。

1
2

const element = kintone.app.record.getFieldElement('文字列1行');
const span = jQuery(element).find('span')[0]; // 推奨しません

position を使った要素の配置

スペース要素やメニュー上側の空白要素を取得して、そこにHTML要素を追加するのはAPIドキュメントに準じた方法です。
しかし、positionプロパティを利用して任意の位置にHTML要素を追加する方法は、動かなくなるリスクがあります。
親要素などのスタイルは、変更になる可能性があるためです。
たとえば以下のようなコードが該当します。

1
2

const element = kintone.mobile.app.getHeaderSpaceElement();
jQuery(element).append('<div>Hello</div>').css({position: 'fixed', top: '80%', left: '50%'}); // 推奨しません

HTML 要素の操作

getFieldElement()で取得した要素はスタイル変更のみがAPIドキュメントに準じた方法です。
詳細は フィールド要素を取得するを確認してください。

1
2

const element = kintone.app.record.getFieldElement('文字列1行');
jQuery(element).css('color', 'red');

スタイル変更以外は動かなくなるリスクがあります。
たとえば以下のようなイベント取得です。

1
2

const element = kintone.app.record.getFieldElement('文字列1行');
jQuery(element).on('click', console.log); // 推奨しません

マウスやキーボード入力のイベントを利用したい場合は、以下の手順をおすすめします。

1. スペース要素を取得する。
2. スペース要素にテキストボックスなどを追加する。
3. テキストボックスのイベントを利用する。
4. 必要なタイミングで入力値を利用する。
   例）レコード保存実行前イベントで入力値をkintoneに反映する。

URL の参照

kintoneのURLは変更になる可能性があります。
たとえば JavaScriptやCSSを使用したカスタマイズ でURLを参照することにより特定スペースのみでカスタマイズを実行できますが、URL変更により動作しなくなる可能性があります。

URL の指定

同様に以下のようなURLの指定も動かなくなるリスクがあります。

1

window.location.href = '/k/' + kintone.app.getId() + '/';

cybozu developer networkでも、 安全に在庫管理を行うテクニック2 - リビジョンを試そう -などで、直接URLを指定したカスタマイズをしています。

URL パラメーター（クエリ文字列）を利用する

kintoneの画面を開くときにURLパラメーターを使えば外部からkintoneにデータを渡せますが、動かなくなるリスクがあります。
外部のデータを利用するにはレコード表示などのイベントでREST APIを利用してデータを取得してください。

今回取り上げた、リスクのあるカスタマイズ方法は一例です。
kintoneのアップデートで影響を受ける可能性のある実装方法のイメージがつかめる内容になっていれば幸いです。