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 AmericaChrome67
Bob SmithEuropeFirefox79
Carol WhiteAsiaSafari73
David BrownSouth AmericaEdge87
Eva GreenAfricaOpera81
Alice JohnsonNorth AmericaChrome2
Bob SmithEuropeFirefox63
Carol WhiteAsiaSafari32
David BrownSouth AmericaEdge13
Eva GreenAfricaOpera34
Alice JohnsonNorth AmericaChrome75
Bob SmithEuropeFirefox34
Carol WhiteAsiaSafari90
David BrownSouth AmericaEdge69
Eva GreenAfricaOpera5
Alice JohnsonNorth AmericaChrome72
Bob SmithEuropeFirefox30
Carol WhiteAsiaSafari57
David BrownSouth AmericaEdge9
Eva GreenAfricaOpera33
Alice JohnsonNorth AmericaChrome58
Bob SmithEuropeFirefox48
Carol WhiteAsiaSafari94
David BrownSouth AmericaEdge90
Eva GreenAfricaOpera58
Alice JohnsonNorth AmericaChrome20
Bob SmithEuropeFirefox90
Carol WhiteAsiaSafari74
David BrownSouth AmericaEdge23
Eva GreenAfricaOpera49
Alice JohnsonNorth AmericaChrome50
Bob SmithEuropeFirefox25
Carol WhiteAsiaSafari81
David BrownSouth AmericaEdge9
Eva GreenAfricaOpera100
Alice JohnsonNorth AmericaChrome50
Bob SmithEuropeFirefox47
Carol WhiteAsiaSafari25
David BrownSouth AmericaEdge93
Eva GreenAfricaOpera93
Alice JohnsonNorth AmericaChrome99
Bob SmithEuropeFirefox58
Carol WhiteAsiaSafari9
David BrownSouth AmericaEdge77
Eva GreenAfricaOpera11
Alice JohnsonNorth AmericaChrome86
Bob SmithEuropeFirefox46
Carol WhiteAsiaSafari20
David BrownSouth AmericaEdge68
Eva GreenAfricaOpera62
Alice JohnsonNorth AmericaChrome34
Bob SmithEuropeFirefox49
Carol WhiteAsiaSafari41
David BrownSouth AmericaEdge55
Eva GreenAfricaOpera97
Alice JohnsonNorth AmericaChrome98
Bob SmithEuropeFirefox69
Carol WhiteAsiaSafari6
David BrownSouth AmericaEdge75
Eva GreenAfricaOpera66

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