アイコン

概要

NocoBase では、アイコン（Icon） をアイコン識別子の保存に使用します。

アイコンフィールドは、分類、メニュー、ステータス、エントリ設定などに視覚的な識別子を付けるのに適しています。保存されるのはアイコンの値で、画面上ではアイコンコンポーネントによって表示されます。

実際の画像をアップロードする場合は、添付ファイルを選択してください。アイコンに関する説明だけを保存する場合は、単行テキストを選択してください。

適用シーン

アイコンは、次のような業務シーンに適しています。

メニューアイコン、機能エントリのアイコン
分類アイコン、タグアイコン
ステータスアイコン、ランクアイコン
ダッシュボードやカード内の視覚的な識別子

作成時の設定

データテーブルの「Configure fields」ページで「Add field」をクリックし、「アイコン」を選択すると、アイコンフィールドを作成できます。

20240512180027

設定	説明
Field interface	フィールドのインターフェースタイプです。アイコンには `icon` が対応し、画面上での入力方法と表示方法を決定します。
Field display name	画面上に表示されるフィールド名です。たとえば「メニューアイコン」「分類アイコン」「ステータスアイコン」などです。業務担当者が見ただけで理解できる名称を使用することをおすすめします。
Field name	API、リレーションフィールド、権限、ワークフローなどで内部参照するためのフィールド識別名です。作成後は通常変更せず、英字、数字、アンダースコアのみ使用でき、先頭は英字にする必要があります。
Field type	データ層におけるフィールドのタイプです。アイコンフィールドのデフォルトは `string` です。
Default value	デフォルト値です。新しいレコードを追加する際、ユーザーが入力しなかった場合に自動的に設定できます。
Validation rules	バリデーションルールです。通常は必須項目に設定します。
Description	フィールドの説明です。フィールドの意味、入力要件、データソース、担当者などを記載するのに適しています。

注意

フィールド名は、作成後にページブロック、権限、ワークフロー、API から参照されます。後から変更すると設定の調整コストが発生するため、作成前に命名を確認してください。

フィールドの特性

アイコンフィールドのデフォルトの動作は次のとおりです。

特性	説明
デフォルトの Field interface	`icon`。
デフォルトの Field type	`string`。
選択可能な Field type	`string`。
ページコンポーネント	編集モードではアイコン選択コンポーネントを使用します。
フィルター	通常、主要なフィルター条件としては使用しません。
並べ替え	通常、並べ替えには使用しません。
バリデーション	必須項目などの基本的なバリデーションに対応しています。

設定の編集

作成後、フィールド右側の「Edit」をクリックすると、アイコンフィールドの設定を編集できます。フィールドの編集は、主に NocoBase でのフィールドの表示方法や使用方法を調整するために行います。たとえば、表示名、説明、デフォルト値、バリデーションルール、フィールド固有の設定などを変更できます。

フィールドがメインデータベースですでに同期されているテーブルに由来する場合、編集時には通常、フィールドマッピングを行います。つまり、データベースフィールドを NocoBase の Field type と Field interface にマッピングします。

設定	編集	説明
Field display name	はい	画面上のフィールド表示名を変更します。フィールド識別名は変更しません。
Field name	いいえ	フィールド識別名は、作成後は通常、編集フォームから変更できません。
Field interface	条件付きで対応	メインデータベースのフィールドまたは同期フィールドは、フィールドマッピング時に調整できます。調整すると、ページ上での入力方法、表示方法、バリデーション方法に影響します。
Field type	条件付きで対応	メインデータベースのフィールドまたは同期フィールドは、フィールドマッピング時に調整できます。調整前に、既存のデータを新しいタイプで使用できるか確認する必要があります。
Default value	はい	新しいレコードを追加する際のデフォルト値を調整します。
Validation rules	はい	フィールドのバリデーションルールを調整します。
Description	はい	フィールドの意味、入力要件、データソース、担当者などを補足します。

注意

Field type や Field interface の切り替えは、単に表示名を変更することとは異なります。フィールドの保存方法、入力コンポーネント、バリデーションルール、フィルター条件、ワークフロー変数の使用方法に影響します。既存データが多い場合は、データ形式が適合するか事前に確認してください。

フィールドの削除

フィールド右側の「Delete」をクリックすると、アイコンフィールドを削除できます。メインデータベースでは、複数のフィールドを選択して一括削除することもできます。

メインデータベースで新規作成したアイコンフィールドを削除すると、通常はデータベース内の実際の列と、その列に保存されている既存データも同時に削除されます。データベースとの同期や外部データソースからマッピングされたフィールドを削除する場合、影響範囲は対応するデータソースとフィールドの出所によって異なります。

警告

フィールドを削除すると、ページブロック、フォーム、フィルター、権限、ワークフロー、API、インポート・エクスポート、既存データに影響する可能性があります。削除前に、そのフィールドが業務設定で引き続き参照されていないか確認してください。

ページ設定での使用

アイコンフィールドは、リスト、カード、詳細画面で視覚的な案内を表示するのに適しています。 20260709225630

シーン	用途
フォームブロック	アイコンを選択します。
詳細ブロック	アイコンを表示します。
リストまたはカード	分類、ステータス、エントリの視覚的な識別子として使用します。
権限とワークフロー	通常、主要な条件フィールドとしては使用しません。

#アイコン

#概要

#適用シーン

#作成時の設定

#フィールドの特性

#設定の編集

#フィールドの削除

#ページ設定での使用

#関連リンク