Skip to content
Binary file modified docs/addon/toggleAppDescription/images/saved.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/addon/toggleAppDescription/images/setting_dialog.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
38 changes: 28 additions & 10 deletions docs/addon/toggleAppDescription/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,28 +7,41 @@

### 1. 設定ダイアログを開く

アプリの`一覧画面`、`詳細画面`、`編集画面`、`作成画面`のいずれかを開いた状態で`アプリ説明欄の表示/非表示`を選択します。
Devkinox の拡張機能アイコンをクリックし、`アプリ説明欄の表示/非表示` を選択します。

<img src="./images/select_toggleAppDescription.png" alt="「アプリ説明欄の表示/非表示」の選択画像" style="border: 1px solid #e0e0e0;" />

<br>
### 2. 非表示ルールを設定

### 2. 非表示にしたいアプリIDを設定
説明欄を自動的に非表示にしたいアプリIDを半角数字/カンマ区切りで入力します。
アプリ画面では現在表示中のアプリIDも表示されるため、入力の参考にできます。

説明欄を自動的に非表示にしたいアプリIDをカンマ区切りで入力します。
現在表示中のアプリIDも表示されるため、入力の参考にできます。
> [!NOTE]
> ポータル画面などアプリ以外の画面でも設定ダイアログは利用できます。
> ただし、その場合は現在のアプリIDは表示されません。

また、`すべてのアプリで説明欄を非表示にする` を有効化すると、全アプリが対象になります。
このチェックが ON の間は、アプリID入力欄は編集できません。

<img src="./images/setting_dialog.png" alt="設定ダイアログ" style="border: 1px solid #e0e0e0;" />

> [!TIP]
> 例: `1, 54, 67` のように複数のアプリ ID を設定できます。

<br>
> [!NOTE]
> `すべてのアプリで説明欄を非表示にする` を ON にしても、個別のアプリID設定は保持されます。
> OFF に戻すと、保持されていた個別設定が再び適用されます。

### 3. 設定を保存

「保存」ボタンをクリックすると、設定が保存されます。
設定したアプリでは、次回表示時から説明欄が自動的に閉じた状態になります。
保存後は現在の画面にも反映されます。

入力に無効な値(数値以外、0 以下など)が含まれている場合は、その値を自動的に除外して保存し、
保存完了メッセージに「除外した無効値」が表示されます。
保存完了メッセージは約 4 秒表示されます。

また、対象ページを開いた瞬間にも設定が自動適用されます。

<img src="./images/saved.png" alt="保存完了" style="border: 1px solid #e0e0e0;" />

Expand All @@ -37,17 +50,20 @@
### 自動適用

- 設定は localStorage に保存されます
- 設定したアプリを開くと、自動的に説明欄が閉じられます
- 一覧画面、詳細画面、編集画面、作成画面すべてで動作します
- 設定したアプリを開いた瞬間に、自動的に説明欄が閉じられます
- 一覧/詳細/編集/追加/グラフ画面で動作します
- `すべてのアプリで説明欄を非表示にする` を ON にすると、対象画面では常に非表示になります

### 設定の変更

設定を変更したい場合は、再度ダイアログを開いてアプリIDを入力してください
設定を変更したい場合は、拡張機能から再度このアドオンを選択してダイアログを開き、アプリIDを入力してください

### 設定の解除

特定のアプリで説明欄を再び表示したい場合は、そのアプリIDを削除して保存してください。

全アプリ対象を解除したい場合は、`すべてのアプリで説明欄を非表示にする` のチェックを OFF にして保存してください。

## 注意事項

> [!NOTE]
Expand All @@ -63,6 +79,8 @@
- 設定データは JSON 形式で localStorage に保存されます
- kintone の標準 API(`kintone.app.showDescription`)を使用しています
- 無効なアプリID(数値以外、0 以下)は自動的に除外されます
- 無効値が除外された場合は、保存完了メッセージに除外内容を表示します
- kintone オブジェクト初期化の遅延には、プロパティフックで準備完了を検知してイベント登録します

### 作成者

Expand Down
2 changes: 1 addition & 1 deletion manifest.json
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
{
"matches": ["*://*.cybozu.com/*"],
"js": ["addons/toggleAppDescription.js"],
"run_at": "document_end",
"run_at": "document_start",
"world": "MAIN"
}
],
Expand Down
Loading