Components

Select All

Use LyteNyte Grid's checkbox component to select all rows and render checked and indeterminate states.

Note

This guide assumes familiarity with row selection. See the Row Selection guide for details.

Select All Rendering

LyteNyte Grid exports the SelectAll component. Use it in a column header or any component with access to the grid API.

The demo below shows SelectAll in the marker column header. When checked, the grid selects all rows.


30 collapsed lines
1
import "@1771technologies/lytenyte-pro/components.css";
2
import "@1771technologies/lytenyte-pro/light-dark.css";
3
import type { OrderData } from "@1771technologies/grid-sample-data/orders";
4
import { data } from "@1771technologies/grid-sample-data/orders";
5
import {
6
  AvatarCell,
7
  EmailCell,
8
  IdCell,
9
  PaymentMethodCell,
10
  PriceCell,
11
  ProductCell,
12
  PurchaseDateCell,
13
} from "./components.jsx";
14
import { useClientDataSource, Grid } from "@1771technologies/lytenyte-pro";
15
import { Checkbox, SelectAll } from "@1771technologies/lytenyte-pro/components";
16

17
export interface GridSpec {
18
  readonly data: OrderData;
19
}
20

21
const columns: Grid.Column<GridSpec>[] = [
22
  { id: "id", width: 60, widthMin: 60, cellRenderer: IdCell, name: "ID" },
23
  { id: "product", cellRenderer: ProductCell, width: 200, name: "Product" },
24
  { id: "price", type: "number", cellRenderer: PriceCell, width: 100, name: "Price" },
25
  { id: "customer", cellRenderer: AvatarCell, width: 180, name: "Customer" },
26
  { id: "purchaseDate", cellRenderer: PurchaseDateCell, name: "Purchase Date", width: 130 },
27
  { id: "paymentMethod", cellRenderer: PaymentMethodCell, name: "Payment Method", width: 150 },
28
  { id: "email", cellRenderer: EmailCell, width: 220, name: "Email" },
29
];
30

31

32
const marker: Grid.ColumnMarker<GridSpec> = {
33
  on: true,
34
  cellRenderer: MarkerCell,
35
  headerRenderer: MarkerHeader,
36
};
37

38
export default function ColumnDemo() {
39
  const ds = useClientDataSource({ data: data });
40

41
  return (
42
    <div
43
      className="ln-grid ln-cell-marker:border-e ln-cell-marker:border-e-ln-border-strong"
44
      style={{ height: 500 }}
45
    >
46
      <Grid
47
        rowHeight={50}
48
        columns={columns}
49
        rowSource={ds}
50
        columnMarker={marker}
51
        rowSelectionMode="multiple"
52
      />
53
    </div>
54
  );
55
}
56

57
function MarkerHeader(params: Grid.T.HeaderParams<GridSpec>) {
58
  return (
59
    <div className="flex h-full w-full items-center justify-center">
60
      <SelectAll
61
        {...params}
62
        slot={({ indeterminate, selected, toggle }) => {
63
          return (
64
            <Checkbox
65
              checked={selected}
66
              indeterminate={indeterminate}
67
              onClick={(ev) => {
68
                ev.preventDefault();
69
                toggle();
70
              }}
71
              onKeyDown={(ev) => {
72
                if (ev.key === "Enter" || ev.key === " ") toggle();
73
              }}
74
            />
75
          );
76
        }}
77
      />
78
    </div>
79
  );
80
}
81

82
function MarkerCell({ api, selected }: Grid.T.CellRendererParams<GridSpec>) {
83
  return (
84
    <div className="flex h-full w-full items-center justify-center">
85
      <Checkbox
86
        checked={selected}
87
        onClick={(ev) => {
88
          ev.stopPropagation();
89
          api.rowHandleSelect({ shiftKey: ev.shiftKey, target: ev.target });
90
        }}
91
        onKeyDown={(ev) => {
92
          if (ev.key === "Enter" || ev.key === " ")
93
            api.rowHandleSelect({ shiftKey: ev.shiftKey, target: ev.target });
94
        }}
95
      />
96
    </div>
97
  );
98
}

1
import { format } from "date-fns";
2
import { type JSX, type ReactNode } from "react";
3
import type { Grid } from "@1771technologies/lytenyte-pro";
4
import type { GridSpec } from "./demo.jsx";
5
import { clsx, type ClassValue } from "clsx";
6
import { twMerge } from "tailwind-merge";
7

8
export function tw(...c: ClassValue[]) {
9
  return twMerge(clsx(...c));
10
}
11

12
export function ProductCell({ api, row }: Grid.T.CellRendererParams<GridSpec>) {
13
  if (!api.rowIsLeaf(row) || !row.data) return;
14

15
  const url = row.data?.productThumbnail;
16
  const title = row.data.product;
17
  const desc = row.data.productDescription;
18

19
  return (
20
    <div className="flex h-full w-full items-center gap-2">
21
      <img className="border-ln-border-strong h-7 w-7 rounded-lg border" src={url} alt={title + desc} />
22
      <div className="text-ln-text-dark flex flex-col gap-0.5">
23
        <div className="font-semibold">{title}</div>
24
        <div className="text-ln-text-light text-xs">{desc}</div>
25
      </div>
26
    </div>
27
  );
28
}
29

30
export function AvatarCell({ api, row }: Grid.T.CellRendererParams<GridSpec>) {
31
  if (!api.rowIsLeaf(row) || !row.data) return;
32

33
  const url = row.data?.customerAvatar;
34

35
  const name = row.data.customer;
36

37
  return (
38
    <div className="flex h-full w-full items-center gap-2">
39
      <img className="border-ln-border-strong h-7 w-7 rounded-full border" src={url} alt={name} />
40
      <div className="text-ln-text-dark flex flex-col gap-0.5">
41
        <div>{name}</div>
42
      </div>
43
    </div>
44
  );
45
}
46

47
const formatter = new Intl.NumberFormat("en-Us", {
48
  minimumFractionDigits: 2,
49
  maximumFractionDigits: 2,
50
});
51
export function PriceCell({ api, row }: Grid.T.CellRendererParams<GridSpec>) {
52
  if (!api.rowIsLeaf(row) || !row.data) return;
53

54
  const price = formatter.format(row.data.price);
55
  const [dollars, cents] = price.split(".");
56

57
  return (
58
    <div className="flex h-full w-full items-center justify-end">
59
      <div className="flex items-baseline tabular-nums">
60
        <span className="text-ln-text font-semibold">${dollars}</span>.
61
        <span className="relative text-xs">{cents}</span>
62
      </div>
63
    </div>
64
  );
65
}
66

67
export function PurchaseDateCell({ api, row }: Grid.T.CellRendererParams<GridSpec>) {
68
  if (!api.rowIsLeaf(row) || !row.data) return;
69

70
  const formattedDate = format(row.data.purchaseDate, "dd MMM, yyyy");
71

72
  return <div className="flex h-full w-full items-center">{formattedDate}</div>;
73
}
74
export function IdCell({ api, row }: Grid.T.CellRendererParams<GridSpec>) {
75
  if (!api.rowIsLeaf(row) || !row.data) return;
76

77
  return <div className="text-xs tabular-nums">{row.data.id}</div>;
78
}
79

80
export function PaymentMethodCell({ api, row }: Grid.T.CellRendererParams<GridSpec>) {
81
  if (!api.rowIsLeaf(row) || !row.data) return;
82

83
  const cardNumber = row.data.cardNumber;
84
  const provider = row.data.paymentMethod;
85

86
  let Logo: ReactNode = null;
87
  if (provider === "Visa") Logo = <VisaLogo className="w-6" />;
88
  if (provider === "Mastercard") Logo = <MastercardLogo className="w-6" />;
89

90
  return (
91
    <div className="flex h-full w-full items-center gap-2">
92
      <div className="flex w-7 items-center justify-center">{Logo}</div>
93
      <div className="flex items-center gap-px">
94
        <div className="bg-ln-gray-40 size-2 rounded-full"></div>
95
        <div className="bg-ln-gray-40 size-2 rounded-full"></div>
96
        <div className="bg-ln-gray-40 size-2 rounded-full"></div>
97
        <div className="bg-ln-gray-40 size-2 rounded-full"></div>
98
      </div>
99
      <div className="tabular-nums">{cardNumber}</div>
100
    </div>
101
  );
102
}
103

104
export function EmailCell({ api, row }: Grid.T.CellRendererParams<GridSpec>) {
105
  if (!api.rowIsLeaf(row) || !row.data) return;
106

107
  return <div className="text-ln-primary-50 flex h-full w-full items-center">{row.data.email}</div>;
108
}
109

110
const VisaLogo = (props: JSX.IntrinsicElements["svg"]) => (
111
  <svg xmlns="http://www.w3.org/2000/svg" width={2500} height={812} viewBox="0.5 0.5 999 323.684" {...props}>
112
    <path
113
      fill="#1434cb"
114
      d="M651.185.5c-70.933 0-134.322 36.766-134.322 104.694 0 77.9 112.423 83.28 112.423 122.415 0 16.478-18.884 31.229-51.137 31.229-45.773 0-79.984-20.611-79.984-20.611l-14.638 68.547s39.41 17.41 91.734 17.41c77.552 0 138.576-38.572 138.576-107.66 0-82.316-112.89-87.537-112.89-123.86 0-12.91 15.501-27.053 47.662-27.053 36.286 0 65.892 14.99 65.892 14.99l14.326-66.204S696.614.5 651.185.5zM2.218 5.497.5 15.49s29.842 5.461 56.719 16.356c34.606 12.492 37.072 19.765 42.9 42.353l63.51 244.832h85.138L379.927 5.497h-84.942L210.707 218.67l-34.39-180.696c-3.154-20.68-19.13-32.477-38.685-32.477H2.218zm411.865 0L347.449 319.03h80.999l66.4-313.534h-80.765zm451.759 0c-19.532 0-29.88 10.457-37.474 28.73L709.699 319.03h84.942l16.434-47.468h103.483l9.994 47.468H999.5L934.115 5.497h-68.273zm11.047 84.707 25.178 117.653h-67.454z"
115
    />
116
  </svg>
117
);
118

119
const MastercardLogo = (props: JSX.IntrinsicElements["svg"]) => (
120
  <svg
121
    xmlns="http://www.w3.org/2000/svg"
122
    width={2500}
123
    height={1524}
124
    viewBox="55.2 38.3 464.5 287.8"
125
    {...props}
126
  >
127
    <path
128
      fill="#f79f1a"
129
      d="M519.7 182.2c0 79.5-64.3 143.9-143.6 143.9s-143.6-64.4-143.6-143.9S296.7 38.3 376 38.3s143.7 64.4 143.7 143.9z"
130
    />
131
    <path
132
      fill="#ea001b"
133
      d="M342.4 182.2c0 79.5-64.3 143.9-143.6 143.9S55.2 261.7 55.2 182.2 119.5 38.3 198.8 38.3s143.6 64.4 143.6 143.9z"
134
    />
135
    <path
136
      fill="#ff5f01"
137
      d="M287.4 68.9c-33.5 26.3-55 67.3-55 113.3s21.5 87 55 113.3c33.5-26.3 55-67.3 55-113.3s-21.5-86.9-55-113.3z"
138
    />
139
  </svg>
140
);

The code below shows the SelectAll component. LyteNyte Grid also exports a Checkbox for rendering the indeterminate state, though you can use your own checkbox component instead.

1
<SelectAll
2
  api={params.api}
3
  slot={({ indeterminate, selected, toggle }) => {
4
    return (
5
      <Checkbox
6
        checked={selected}
7
        indeterminate={indeterminate}
8
        onClick={(ev) => {
9
          ev.preventDefault();
10
          toggle();
11
        }}
12
        onKeyDown={(ev) => {
13
          if (ev.key === "Enter" || ev.key === " ") toggle();
14
        }}
15
      />
16
    );
17
  }}
18
/>

Menu Button: Display a list of actions or options in an accessible dropdown menu.
Smart Select: Streamline data selection using a versatile combobox or select element.
Pill Manager: Create and manage grid interactions using label pills.

Select All

Note

Select All Rendering

Select All Implementation

Why Use Select All

Select All Properties

Next Steps

On this page