CRUDUI

Home > @polyspec/crudui-generator-core > BuildListOptions

BuildListOptions interface

Options for building a list view model.

Signature:

export interface BuildListOptions 

Properties

Property

Modifiers

Type

Description

basepath?

string

(Optional) Basepath for relative $ref.

data?

Record<string, unknown>

(Optional) List-level form data for column-visibility expressions (e.g. design.show: '.admin' on a column). NOT the rows — rows are the separate argument.

files?

Record<string, Record<string, unknown>>

(Optional) $ref file set for composition (virtual in-memory loader).

language?

Language

(Optional) Active content language (default 'ko').

loader?

FileLoader

(Optional) A custom loader (overrides files).

page?

number | null

(Optional) Current page supplied by the caller: absent, null or an integer from 1 to Number.MAX_SAFE_INTEGER.

total?

number | null

(Optional) Total record count supplied by the caller: absent, null or an integer from 0 to Number.MAX_SAFE_INTEGER.