Skip to content

Commit

Permalink
Document summable / showTotals
Browse files Browse the repository at this point in the history
  • Loading branch information
LukeTowers authored Dec 3, 2024
1 parent 77d2b42 commit 543bcb4
Showing 1 changed file with 2 additions and 0 deletions.
2 changes: 2 additions & 0 deletions backend/lists.md
Original file line number Diff line number Diff line change
Expand Up @@ -73,6 +73,7 @@ Option | Description
`showCheckboxes` | displays checkboxes next to each record. Default: `false`.
`showSetup` | displays the list column set up button. Default: `false`.
`showTree` | displays a tree hierarchy for parent/child records. Default: `false`.
`showTotals` | displays the summed values for the columns in the form of `totalOnPage (totalForQuery)` in the list header and footer. Default: `true`.
`treeExpanded` | if tree nodes should be expanded by default. Default: `false`.
`customViewPath` | specify a custom view path to override partials used by the list, optional.

Expand Down Expand Up @@ -161,6 +162,7 @@ Option | Description
`searchable` | include this column in the list search results. Default: `false`.
`invisible` | specifies if this column is hidden by default. Default: `false`.
`sortable` | specifies if this column can be sorted. Default: `true`.
`summable` | specifies if this column can be summed (requires column to be of `type: number`). Default: `true`.
`clickable` | if set to false, disables the default click behavior when the column is clicked. Default: `true`.
`select` | defines a custom SQL select statement to use for the value.
`valueFrom` | defines a model attribute to use for the value.
Expand Down

0 comments on commit 543bcb4

Please sign in to comment.