StaticGrid

Mon, 01 Jan 0001 00:00:00 +0000

StaticGrid#

@palmyralabs/rt-forms-mantine · grid/StaticGrid.tsx

Overview#

Client-side table. Renders columns against an in-memory rowData array using BaseTable — no server fetching, no pagination infrastructure. Use it for already-loaded result sets, detail drills, and fixture tables.

Signature#

const StaticGrid = forwardRef(function StaticGrid(
  props: StaticGridOptions,
  ref: RefObject<IPageQueryable>,
): JSX.Element);

Props — `StaticGridOptions` (from `@palmyralabs/rt-forms`)#

Prop	Type	Purpose
`columns`	`ColumnDefinition[]`	Column defs (attribute, label, type, cellRenderer, …)
`rowData`	`any[]`	Rows to render
`EmptyChild`	`ComponentType?`	Rendered when `rowData` is empty
`customizer`	`GridCustomizer?`	Header/footer/cell overrides (defaults to `NoopGridCustomizer`)
`onRowClick`	`(rowData) => void?`	Per-row click handler
`setSortColumns`	`(sort) => void?`	Client-side sort callback

Ref — `IPageQueryable`#

Inherited from @palmyralabs/rt-forms. On a StaticGrid only the client-side subset is meaningful (getCurrentData, refresh, setSortColumns); server methods like gotoPage / setQueryLimit are no-ops.

PalmyraGrid

Mon, 01 Jan 0001 00:00:00 +0000

PalmyraGrid#

@palmyralabs/rt-forms-mantine · grid/PalmyraGrid.tsx

Overview#

Server-backed grid. Internally composes GridX (the base Mantine table + toolbar + pagination) and subscribes to a pub-sub topic so other parts of the app can refresh or refilter the grid without holding its ref.

Signature#

const PalmyraGrid = forwardRef(function PalmyraGrid<ControlPropsType>(
  props: PalmyraGridOptions<ControlPropsType>,
  ref: RefObject<IPalmyraGrid>,
): JSX.Element);

Props — `PalmyraGridOptions<ControlPropsType>` (from `@palmyralabs/rt-forms`)#

Common props include:

Prop	Type	Purpose
`columns`	`ColumnDefinition[]`	Column defs
`endPoint`	`IEndPoint`	Wire endpoint path
`storeOptions`	`StoreOptions?`	Forwarded to the store factory
`pageSize`	`number \| number[]?`	Options for the page-size selector
`topic`	`string?`	Base topic name for the external bus
`DataGridControls`	`ComponentType<ControlPropsType>?`	Toolbar / row-action component
`controlProps`	`ControlPropsType?`	Props forwarded to the controls component
`initParams`	`{ filter?, sort?, limit?, offset? }?`	Initial query state

Full prop contract lives in the upstream @palmyralabs/rt-forms package.

Grid on Palmyra

StaticGrid

StaticGrid#

Overview#

Signature#

Props — StaticGridOptions (from @palmyralabs/rt-forms)#

Ref — IPageQueryable#

PalmyraGrid

PalmyraGrid#

Overview#

Signature#

Props — PalmyraGridOptions<ControlPropsType> (from @palmyralabs/rt-forms)#

Props — `StaticGridOptions` (from `@palmyralabs/rt-forms`)#

Ref — `IPageQueryable`#

Props — `PalmyraGridOptions<ControlPropsType>` (from `@palmyralabs/rt-forms`)#