ListViewProps

ListViewProps<T> = object

Defined in: packages/ui/src/types.ts:574

Props for the ListView composite component.

Composes PageContainerSlotProps, FilterBarProps, DataTableProps, EmptyStateProps, BulkAction, and pagination controls into a full page layout. This is the primary component @cfast/admin uses for every table view. Handles loading/empty/data state transitions automatically.

See

• DataTableProps for the table configuration subset.
• DetailViewProps for the single-record counterpart.

Type Parameters

T

T = unknown

The row object type, forwarded to column rendering and selection.

Properties

actions?

optional actions: ClientDescriptor

Defined in: packages/ui/src/types.ts:601

Action descriptor for row-level actions.

---

breadcrumb?

optional breadcrumb: BreadcrumbItem[]

Defined in: packages/ui/src/types.ts:615

Breadcrumb trail items.

---

bulkActions?

optional bulkActions: BulkAction[]

Defined in: packages/ui/src/types.ts:613

Bulk actions shown when rows are selected.

---

columns?

optional columns: ColumnShorthand<T>[]

Defined in: packages/ui/src/types.ts:599

Column definitions or key strings for the data table.

---

createAction?

optional createAction: ClientDescriptor

Defined in: packages/ui/src/types.ts:607

Action descriptor for the create button.

---

createLabel?

optional createLabel: string

Defined in: packages/ui/src/types.ts:609

Label for the create button. Defaults to “Create”.

---

data

data: object

Defined in: packages/ui/src/types.ts:578

Paginated data with optional pagination controls.

currentPage?

optional currentPage: number

Current page number (offset pagination).

goToPage()?

optional goToPage: (page) => void

Navigate to a specific page (offset pagination).

Parameters

page

number

Returns

void

hasMore?

optional hasMore: boolean

Whether more items are available (cursor pagination).

isLoading?

optional isLoading: boolean

Whether data is currently being fetched.

items

items: T[]

Array of row objects to display.

loadMore()?

optional loadMore: () => void

Load the next page of items (cursor pagination).

Returns

void

total?

optional total: number

Total number of matching records.

totalPages?

optional totalPages: number

Total number of pages (offset pagination).

---

filters?

optional filters: FilterDef[]

Defined in: packages/ui/src/types.ts:603

Filter definitions for the FilterBar.

---

searchable?

optional searchable: string[]

Defined in: packages/ui/src/types.ts:605

Column names that support full-text search.

---

selectable?

optional selectable: boolean

Defined in: packages/ui/src/types.ts:611

Whether to enable row selection.

---

table?

optional table: unknown

Defined in: packages/ui/src/types.ts:597

Drizzle table for column and filter type inference.

---

title

title: string

Defined in: packages/ui/src/types.ts:576

Page title displayed in the header.