Data Components

Beyond entity and apiActions, the hook takes pageSize (default 20 — becomes the query limit in every fetch) and initialSort / initialFilters (both default []) which seed the sort and filter query state used by the initial-mount fetch. All three are optional.

items, the pagination meta (page, totalItems, totalPages, hasNextPage…), isLoading, isLoadingMore and a top-level error state — ready to feed a table or list or build failure UI.

addItem, updateItem, deleteItem plus bulkAdd / bulkDelete call the generated CRUD/bulk actions and then re-fetch the list from the server (loadData in onAfterHandle, which resets to page 1) so the list reflects the server state — not an optimistic local mutation, and not a scroll-preserving re-fetch of the current page.

Holds the search term, sort and filter conditions; setSearch / setSort / setFilters are plain state setters that only update the held values — they do NOT auto re-fetch (the only automatic fetch is the initial mount). Call loadData() to re-fetch through the Query API with the held (or explicitly passed) search/sort/filter values; refetch() is the argument-less shorthand that re-runs loadData() (resetting to page 1 with the held values). loadMore appends the next page (de-duplicated) for infinite lists, and the top-level hasMore boolean (mirroring meta.hasNextPage) tells you whether there is another page left to append. The hook also returns currentPage (the last-fetched page number) and setCurrentPage, so you can drive explicit page navigation as well.

Each column sets header, width bounds, sortable / resizable / editable and optional cellRenderer / headerRenderer. editable columns get an editConfig (text / number / select / textarea). actionColumns render buttons per row.

Toggles: isFrontendSort vs server sort, enableInfiniteScroll + threshold + pageSize, enableSelection, column resize and defaults. autoFetchUntilScroll keeps loading until the viewport fills.

onCellClick / onCellDoubleClick / onCellEdit, onSort, onLoadMore, onColumnResize (onRowResize exists on the type but is not yet wired — only column resize fires) — wire these to useNucleusEntity's loadMore / updateItem / sort to get a live editable grid.

isPending drives the skeleton table; isLoading shows a full-table loading spinner; isLoadingMore + hasMoreData drive the infinite-scroll sentinel; emptyMessage and a selectionToolbar (over selected rows) round out the UX.

The columns to render, in add or edit mode with initialValues. Field types map from the column type (number, boolean, date via DatePicker, enum via SelectBox, etc.).

minLength / maxLength / min / max / pattern / format (email, url, uuid, ipv4…) come straight off the column, mirroring the server's validatePayload — so client and API agree on what's valid.

Override label, placeholder, helperText, static options, span and order, and conditional visibility via showWhen — without leaving the column-driven model. Per-field custom rendering in FormBuilder is the top-level renderField prop, not a fieldConfigs override.

Grid layout, size and column span control the look; the underlying useFormBuilder hook (state, setValue, validate, submit, getFieldProps) is exposed for fully custom forms.

Point it at an entity and the generated actions; it infers columns, renders the grid and forms, and handles create/edit/delete and paging end to end. Foreign-key columns are auto-detected: each referenced table is fetched (via its GET_<TABLE> action) to populate the form's SelectBox, table cells render the related row as a clickable relation badge that opens a per-row detail modal, and FK values are normalized by references.foreignKey (falling back to the column name) on both edit-load and submit.

The batteries-included screen stays tailorable: searchable / filterable / sortable / selectable toggles (all default on), the showAdd / showEdit / showDelete / showBulkDelete CRUD toggles (all default on, but showAdd / showEdit / showDelete are additionally suppressed when the entity excludes the corresponding POST / PUT / DELETE method — i.e. ANDed with the entity's excluded_methods; showBulkDelete is not), columnConfigs / fieldConfigs overrides, excludeColumns / excludeFields lists, pageSize (default 20), onRowClick, and the renderHeader / renderToolbar slots. title (defaults to the formatted table name) and description feed the default header when renderHeader is not supplied, and className is applied to the root container. (searchFields and showBulkAdd exist on the props type but are inert — the component destructures them unused.)