FilterForm

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

@palmyralabs/rt-forms-mui · grid/plugins/filter/FilterForm.tsx

Overview#

Filter-panel plugin. Renders an inline PalmyraForm whose fields are generated from the grid’s column definitions, wires Reset + Filter buttons to the grid’s queryRef, and calls onClose(filter) on apply.

Props — `FilterOptions`#

interface FilterOptions extends DataGridPluginOptions {
  onClose?:       (filter: any) => void;
  column?:        1 | 2 | 3;
  defaultFilter?: Record<string, any>;
}

Behaviour#

On mount: reads queryRef.current.getCurrentFilter() and hydrates the form.
Reset clears the form and calls queryRef.current.resetFilter().
Filter calls queryRef.current.setFilter(formData) and then onClose(formData).

Example#

import { FilterForm } from '@palmyralabs/rt-forms-mui';

<PalmyraGrid
  topic="manufacturer"
  columns={manufacturerColumns}
  endPoint="/mstManufacturer"
  plugins={{ Filter: FilterForm }}
/>

Internal helpers#

Two helpers in the same folder are used by FilterForm but aren’t barrel-exported:

SelectablePagination

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

SelectablePagination#

@palmyralabs/rt-forms-mui · grid/plugins/pagination/SelectablePagination.tsx

Overview#

MUI Pagination plus a Select for page size. Subscribes to the grid’s ${topic}/data channel to re-render, and delegates every action to the grid’s queryRef:

Page click → queryRef.current.gotoPage(n)
Page size change → queryRef.current.setPageSize(n) + re-query
Totals / current page / current limit — read from getTotalRecords / getPageNo / getQueryLimit

Props — `PageQueryPluginOptions`#

Declared in this package’s grid/types.ts. Consumed fields:

Prop	Type	Purpose
`queryRef`	`RefObject<IPageQueryable>`	The grid’s query controller
`pageSize`	`number \| number[]?`	Dropdown options (or a single fixed size)
`ignoreSinglePage`	`boolean?`	When `true`, hide pagination if totalPages ≤ 1

Example#

import { SelectablePagination } from '@palmyralabs/rt-forms-mui';

<PalmyraGrid
  topic="manufacturer"
  columns={manufacturerColumns}
  endPoint="/mstManufacturer"
  pageSize={[15, 30, 45, 100]}
  plugins={{ Pagination: SelectablePagination }}
/>

Plugins on Palmyra

FilterForm

FilterForm#

Overview#

Props — `FilterOptions`#

Behaviour#

Example#

Internal helpers#

SelectablePagination

SelectablePagination#

Overview#

Props — `PageQueryPluginOptions`#

Example#

Plugins on Palmyra

FilterForm

FilterForm#

Overview#

Props — FilterOptions#

Behaviour#

Example#

Internal helpers#

SelectablePagination

SelectablePagination#

Overview#

Props — PageQueryPluginOptions#

Example#

Props — `FilterOptions`#

Props — `PageQueryPluginOptions`#