CxJS

Buffering

import { Grid } from 'cx/widgets'; Copied

Grid supports buffered rendering which dramatically improves performance with large datasets. Instead of rendering all rows, only visible rows plus a buffer are rendered, enabling smooth scrolling with thousands of records.

<div controller={PageController}>
  <Grid
    records={m.records}
    keyField="id"
    buffered
    style="height: 400px"
    mod={["fixed-layout", "contain"]}
    cached
    selection={{ type: KeySelection, bind: m.selection }}
    columns={[
      {
        header: "#",
        align: "center",
        children: <div class="cxe-grid-row-number" />,
        defaultWidth: 70,
      },
      {
        header: { text: "Name", style: "width: 100%" },
        field: "fullName",
        sortable: true,
        resizable: true,
      },
      {
        header: "Continent",
        field: "continent",
        sortable: true,
        resizable: true,
        defaultWidth: 130,
      },
      {
        header: "Browser",
        field: "browser",
        sortable: true,
        resizable: true,
        defaultWidth: 100,
      },
      {
        header: "Visits",
        field: "visits",
        sortable: true,
        align: "right",
        resizable: true,
        defaultWidth: 70,
      },
    ]}
  />
</div>
#Name
Continent
Browser
Visits
Alice JohnsonNorth AmericaChrome13
Bob SmithEuropeFirefox66
Carol WhiteAsiaSafari90
David BrownSouth AmericaEdge37
Eva GreenAfricaOpera61
Alice JohnsonNorth AmericaChrome71
Bob SmithEuropeFirefox43
Carol WhiteAsiaSafari68
David BrownSouth AmericaEdge19
Eva GreenAfricaOpera84
Alice JohnsonNorth AmericaChrome99
Bob SmithEuropeFirefox75
Carol WhiteAsiaSafari87
David BrownSouth AmericaEdge90
Eva GreenAfricaOpera15
Alice JohnsonNorth AmericaChrome60
Bob SmithEuropeFirefox49
Carol WhiteAsiaSafari49
David BrownSouth AmericaEdge60
Eva GreenAfricaOpera40
Alice JohnsonNorth AmericaChrome89
Bob SmithEuropeFirefox8
Carol WhiteAsiaSafari97
David BrownSouth AmericaEdge93
Eva GreenAfricaOpera15
Alice JohnsonNorth AmericaChrome99
Bob SmithEuropeFirefox92
Carol WhiteAsiaSafari21
David BrownSouth AmericaEdge62
Eva GreenAfricaOpera82
Alice JohnsonNorth AmericaChrome98
Bob SmithEuropeFirefox88
Carol WhiteAsiaSafari27
David BrownSouth AmericaEdge34
Eva GreenAfricaOpera81
Alice JohnsonNorth AmericaChrome81
Bob SmithEuropeFirefox69
Carol WhiteAsiaSafari78
David BrownSouth AmericaEdge33
Eva GreenAfricaOpera12
Alice JohnsonNorth AmericaChrome31
Bob SmithEuropeFirefox82
Carol WhiteAsiaSafari2
David BrownSouth AmericaEdge62
Eva GreenAfricaOpera62
Alice JohnsonNorth AmericaChrome67
Bob SmithEuropeFirefox43
Carol WhiteAsiaSafari81
David BrownSouth AmericaEdge64
Eva GreenAfricaOpera36
Alice JohnsonNorth AmericaChrome26
Bob SmithEuropeFirefox91
Carol WhiteAsiaSafari70
David BrownSouth AmericaEdge94
Eva GreenAfricaOpera70
Alice JohnsonNorth AmericaChrome78
Bob SmithEuropeFirefox72
Carol WhiteAsiaSafari91
David BrownSouth AmericaEdge62
Eva GreenAfricaOpera82

This grid contains 5,000 rows but renders smoothly thanks to buffered mode. Try scrolling and sorting to see the performance.

How It Works

Enable buffered mode by setting the buffered property. The grid calculates which rows are visible and renders only those plus a configurable buffer for smooth scrolling.

<Grid
  records={m.records}
  buffered
  style="height: 400px"
  mod={["fixed-layout", "contain"]}
  cached
  columns={columns}
/>

For optimal performance, combine buffering with:

  • Fixed height - The grid needs a fixed height to calculate visible rows
  • mod="fixed-layout" - Uses CSS table-layout: fixed for faster rendering
  • mod="contain" - Adds CSS containment for better browser optimization
  • cached - Prevents row re-renders when unrelated store data changes

Row Numbers

Use the built-in cxe-grid-row-number class to display automatic row numbers:

{
  header: "#",
  defaultWidth: 50,
  children: <div class="cxe-grid-row-number" />
}

Configuration

PropertyTypeDescription
bufferedbooleanEnables buffered rendering mode.
bufferSizenumberNumber of rows to render outside the visible area. Default is 60.
bufferStepnumberNumber of rows to add/remove when scrolling. Default is 15.
cachedbooleanPrevents row re-renders when unrelated store data changes. Rows only update when their record data changes.
lockColumnWidthsbooleanLocks column widths to prevent layout shifts during scrolling.
lockColumnWidthsRequiredRowCountnumberMinimum number of rows required before column widths are locked.
measureRowsOnScrollbooleanRe-measures row heights while scrolling. Useful for variable height rows.

See also: Infinite Scrolling