機能別の書き方
「こうしたい」から引く。定義の書き方・書けるキー・つまずきどころ。
| やりたいこと | 何ができるか | 関係するキー |
|---|---|---|
| 画面を1枚定義する | どの画面にも要る4つのキーと、レコードを1件に絞る key。 | type id title repository key |
| 一覧に列を出す | 表示する列、幅、並べ替え、値の見せ方。 | table columns label width sortable format |
| 一覧をページングする | 1ページの件数と、ページングを切る指定。 | pagination enabled pageSize |
| 検索条件を出す | 検索欄に並べる条件と、比較のしかた(等値・部分一致・範囲)。 | search filters operator options layout |
| 行ごとの操作を付ける | 編集・削除など、一覧の各行に出すボタン。 | rowActions |
| ボタンと処理を定義する | 画面上部のアクション、組み込みの処理、独自処理の差し込み。 | actions params plugin |
| 確認ダイアログと成功後の動き | 「本当に削除しますか」と「保存できたら一覧に戻る」を定義で書く。 | confirm okLabel cancelLabel danger message onSuccess onError prompt |
| 画面から画面へ遷移する | 遷移先の指定と、渡す値。 | page home open |
| 入力フォームを組む | フォームをセクションに分け、項目を並べる。 | form sections fields |
| 項目の並べ方を変える | 1行あたり何項目並べるか。table の columns とは別物。 | layout |
| 入力項目の型と見せ方 | 項目の型、初期値、読み取り専用、選択肢。 | field defaultValue readOnly |
| 選択肢を連動させる | 親の項目で子の選択肢を絞る(都道府県→市区町村)。定義に書くか、Repository から引く。検索条件でも同じ。 | optionsFrom when optionsSource options |
| 必須と入力検証を付ける | 必須、組み込みバリデータ、メッセージの差し替え。 | required validators |
| 入力値を正規化する | 全角→半角、トリムなど、保存前に値を整える。 | normalize |
| 他の項目から計算する | 金額=単価×数量のような、自動で埋まる項目。 | computed op separator of where |
| 条件で出し隠し・必須・読み取り専用を切り替える | 他の項目の値や新規/編集の状態で、表示・入力可否・必須を切り替える。区画ごとの出し分けも。 | visibleWhen enabledWhen all any not field value mode requiredWhen readOnlyWhen |
| 明細を表で入力する | 1件の伝票に複数行の明細を持たせる。別テーブルから引く場合も。 | source parentKey |
| 入力を数ステップに分ける | 長い入力をウィザード形式にする。 | steps description |
| ダッシュボードに数字を並べる | 件数・合計のカード、並べ方、絞り込み、押したときの遷移。 | items span value aggregate limit sort ascending filters action |
| ダッシュボードにグラフを出す | 棒・円などのグラフと、軸に使う項目。 | chart kind labelField valueField |
| 帳票を出力する | 用紙、グループごとの小計、総合計、改ページ。 | report paper size orientation rowsPerPage groupBy pageBreak totals |
| CSV で出力する | 一覧や帳票の内容を CSV で落とす。受け側が Shift_JIS 固定でも合わせられる。 | type config limit |
| アプリ全体とメニューを定義する | 複数の画面をまとめて1つのアプリにする。メニュー階層と初期表示。 | app dsl_version pages menu group icon navigation |
| 見た目を変える | 色、明暗、フォント、余白、角丸。 | theme brightness primaryColor secondaryColor fontFamily density radius |
| 権限で出し分ける | ロールに応じてボタン・列・項目・メニューを出す/出さない。 | roles |
| 選んだ行にまとめて実行する | 一覧にチェックボックスを出して、選んだ行に対してボタンを1回押す。 | scope maxRows batchSize default byRole |
| 拡張を差し込む(config) | 本体を直さずに、独自の描画・処理・型をプラグインで足す。 | config |