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 AmericaChrome35
Bob SmithEuropeFirefox45
Carol WhiteAsiaSafari3
David BrownSouth AmericaEdge33
Eva GreenAfricaOpera75
Alice JohnsonNorth AmericaChrome46
Bob SmithEuropeFirefox95
Carol WhiteAsiaSafari87
David BrownSouth AmericaEdge28
Eva GreenAfricaOpera29
Alice JohnsonNorth AmericaChrome29
Bob SmithEuropeFirefox100
Carol WhiteAsiaSafari4
David BrownSouth AmericaEdge31
Eva GreenAfricaOpera31
Alice JohnsonNorth AmericaChrome31
Bob SmithEuropeFirefox35
Carol WhiteAsiaSafari89
David BrownSouth AmericaEdge59
Eva GreenAfricaOpera59
Alice JohnsonNorth AmericaChrome53
Bob SmithEuropeFirefox62
Carol WhiteAsiaSafari66
David BrownSouth AmericaEdge49
Eva GreenAfricaOpera21
Alice JohnsonNorth AmericaChrome6
Bob SmithEuropeFirefox73
Carol WhiteAsiaSafari81
David BrownSouth AmericaEdge34
Eva GreenAfricaOpera57
Alice JohnsonNorth AmericaChrome20
Bob SmithEuropeFirefox17
Carol WhiteAsiaSafari32
David BrownSouth AmericaEdge96
Eva GreenAfricaOpera7
Alice JohnsonNorth AmericaChrome24
Bob SmithEuropeFirefox70
Carol WhiteAsiaSafari87
David BrownSouth AmericaEdge58
Eva GreenAfricaOpera41
Alice JohnsonNorth AmericaChrome18
Bob SmithEuropeFirefox24
Carol WhiteAsiaSafari69
David BrownSouth AmericaEdge82
Eva GreenAfricaOpera80
Alice JohnsonNorth AmericaChrome23
Bob SmithEuropeFirefox9
Carol WhiteAsiaSafari3
David BrownSouth AmericaEdge3
Eva GreenAfricaOpera95
Alice JohnsonNorth AmericaChrome66
Bob SmithEuropeFirefox17
Carol WhiteAsiaSafari28
David BrownSouth AmericaEdge36
Eva GreenAfricaOpera70
Alice JohnsonNorth AmericaChrome48
Bob SmithEuropeFirefox78
Carol WhiteAsiaSafari57
David BrownSouth AmericaEdge99
Eva GreenAfricaOpera60

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