hatake

表示

一覧をページングする ​

1ページの件数と、ページングを切る指定。

一覧のページングは table.pagination で指定する。何も書かなければページングは有効で、1ページ 50 件になる。

yaml
page:
  type: search
  id: product_search
  title: 商品照会
  repository: productRepository

  table:
    pagination: { pageSize: 50 }
    columns:
      - { field: code, label: コード }
      - { field: name, label: 商品名 }

書くのは既定を変えたいときだけ ​

pagination そのものを省略しても、既定でページングされる。書く理由は2つしかない。

  • 1ページの件数を変えたい — 業務によっては 20 件のほうが見やすい、逆に 200 件まとめて見たい
  • ページングを切りたい — 件数が必ず少ないマスタなど。enabled: false でページ送りを出さない
yaml
table:
  pagination: { pageSize: 200, enabled: false }

切っても、取りに行くのは pageSize 件まで ​

enabled: false は「全件出す」ではなく、最初の pageSize 件だけを1画面に出して、送る口を出さないという意味。pageSize を書かなければ 50 件で切れる。なので、ページングを切るときは来うる件数より大きい pageSize を一緒に書く。

それでも出しきれなかったら、黙って切らずに一覧の下にこう出る（Flutter・Vue・React で同じ字）:

250 件中 200 件を表示しています（絞り込んでください）

「全件が出ていると思ったら、実は 200 件目で切れていた」は、画面を見ても気づけない事故なので、出しきれていないことだけは必ず言う。0.9.20 までは、どの Renderer も enabled: false を読んでおらず、普通にページ送りが出ていた。

実際に切り出すのは Repository ​

指定した件数は、検索条件と一緒に Repository へ渡る。その件数だけ返すのも、総件数を返すのも Repository の仕事である。Framework は「何件目から何件」を伝えるだけで、SQL の LIMIT も API のページング仕様も知らない。

なので pageSize を変えたのに件数が変わらないときは、定義ではなく Repository 側の実装を見る。

明細のページングは別物 ​

subTable（明細）を別テーブルから引くときの source.pageSize（既定 20）は、一覧の pagination.pageSize とは無関係。親レコードの一覧と、その中の子行のグリッドは別々に数える。

ダッシュボードのカードが読む件数（limit、既定 100）もこれとは別。カードは1枚ずつ小さなクエリを投げるので、ページングではなく「上限」として指定する。

書けるキー ​

キー書く場所型必須既定値有効なページ種別説明
paginationtableobject → pagination任意—crud master report search—
enabledpaginationboolean任意truecrud master report searchfalse: no pager. The list shows only the first pageSize rows and, when there are more, says so ("N 件中 M 件を表示しています（絞り込んでください）") instead of cutting them silently.
pageSizepaginationinteger任意50crud master report searchRows per page. With enabled: false, the most rows the list fetches and shows at all.
pageSizesubTableSourceinteger任意20crud dashboard detail form master report search wizardRows per page.

この表は spec/reference.json から生成している（JSON Schema が正）。手元では npx -p @hatake-fw/api hatake reference <キー名> で同じものが引ける。

近い例 ​

例は丸ごと写して直すのが一番速い。以下は CI で検証済み（そのまま動く形）。

ファイル種別画面どういうときに使うか
customer_master.yamlcrud顧客マスタ検索して一覧に出して、その場で登録・修正・削除まで面倒を見る画面が欲しい
product_search.yamlsearch商品照会検索して一覧を見るだけ（登録も更新もさせない）画面が欲しい
order_entry_paged.yamlform受注入力（明細別テーブル）明細が何百行もあるので、子テーブルから外部キーで引いてページングしたい

実物を見る ​

デモアプリの「受注照会」がこれを使っている。 デモを開く