Skip to content

Listing layout

Every listing in Mateu renders in one of four layouts. The framework picks one automatically based on the columns you define and the available screen width. You can also force a specific layout when the automatic choice is not right for your use case.

Listing with search bar, filters and paginated table


LayoutWhen it appearsBest for
tableAll columns fit comfortablyDense data with many comparable fields
listColumns fit in two lines (title + secondary info)Navigation-heavy UIs on medium screens
cardsImage/rich content present, or many columns without a clear primary oneProduct catalogues, media galleries
masterDetailToo many or too wide columns to summariseComplex entities that need side-by-side browsing

The framework assigns a weight to every column (roughly, how many pixels wide it needs to be), then compares the total column weight to the available container width. 1 unit ≈ 76 px.

Column type / stereotypeWeight (units)
bool, icon1.0
status, integer1.5
combobox, select, number, date, money2.0
link, dateTime, dateRange2.5
plain String3.0
image4.0
html, richText, markdown, textarea5.0
density ratio = totalColumnWeight / (containerWidthPx / 76)
ratio ≤ 1.0 → table
ratio > 1.6 OR columns > 10 → masterDetail
otherwise:
compact columns exist AND their weight ≤ 8 → list
has image or html stereotype → cards
no compact columns AND 4–8 columns → cards
fallback → masterDetail

Compact columns are columns marked as the identifier (@Priority(identifier = true)) or with a priority value ≤ 2 (@Priority(1), @Priority(2)). They are the fields shown in the condensed views (list row title, master-detail panel header).


Influencing auto-selection via annotations

Section titled “Influencing auto-selection via annotations”
public record ProductRow(
@Priority(value = 1, identifier = true)
String name,
String category,
BigDecimal price,
ProductStatus status
) {}

identifier = true pins this column as the row title in list and master-detail layouts. Columns with priority ≤ 2 are included in the compact summary line.

public record ProductRow(
@Weight(5.0) // treat as very wide — pushes density ratio up
String description,
@ColumnWidth("60px") // narrow fixed column — weight derived from px
boolean active
) {}

@Weight takes precedence over the type-based default. @ColumnWidth also feeds into the weight calculation when @Weight is absent.


return Listing.builder()
.gridLayout(GridLayout.cards)
// ...
.build();

Available values: auto (default), table, list, cards, masterDetail.

return Listing.builder()
.listingType(ListingType.card)
// ...
.build();

listingType(ListingType.card) is equivalent to gridLayout(GridLayout.cards). It exists as a semantic alias for CRUDs whose primary presentation is always cards regardless of screen width.


Fixing the content height (cards and table)

Section titled “Fixing the content height (cards and table)”

By default the listing expands to fill the container, which scrolls the whole page. Set contentHeight to constrain the card or table area to a fixed height with its own internal scrollbar:

return Listing.builder()
.gridLayout(GridLayout.cards)
.contentHeight("400px")
.build();

SituationExpected layout
3 short columns (name, status, date) on desktoptable
6 columns total, 1 marked identifier, compact weight ≤ 8list
Any column with image or html stereotypecards
More than 10 columnsmasterDetail
Density ratio > 1.6 after adding many wide columnsmasterDetail
gridLayout(GridLayout.cards) set explicitlyalways cards