Column Header Name

Set the name property to give any column a user-friendly display name. The grid's default header renderer shows this value in the column header.

Other LyteNyte Grid components also use the name property when showing column-related information. For example, the Column Manager uses name values as row labels.

Header Name Usage

"use client";

import { Grid, useClientRowDataSource } from "@1771technologies/lytenyte-pro";
import "@1771technologies/lytenyte-pro/grid.css";
import type { Column } from "@1771technologies/lytenyte-pro/types";
import { bankDataSmall } from "@1771technologies/sample-data/bank-data-smaller";
import { useId } from "react";

type BankData = (typeof bankDataSmall)[number];
const columns: Column<BankData>[] = [
  { name: "Years Alive", id: "age", type: "number" },
  { name: "Employment", id: "job" },
  { name: "Money In Bank", id: "balance", type: "number" },
  { name: "Smartness Level", id: "education" },
  { name: "Single Or Not?", id: "marital" },
];

export default function ColumnHeaderName() {
  const ds = useClientRowDataSource({ data: bankDataSmall });

  const grid = Grid.useLyteNyte({
    gridId: useId(),
    rowDataSource: ds,
    columns,

    columnBase: {
      widthFlex: 1,
    },
  });

  const view = grid.view.useValue();

  return (
    <div className="lng-grid" style={{ height: 500 }}>
      <Grid.Root grid={grid}>
        <Grid.Viewport>
          <Grid.Header>
            {view.header.layout.map((row, i) => {
              return (
                <Grid.HeaderRow key={i} headerRowIndex={i}>
                  {row.map((c) => {
                    if (c.kind === "group") return null;

                    return (
                      <Grid.HeaderCell
                        key={c.id}
                        cell={c}
                        className="flex h-full w-full items-center px-2 capitalize"
                      />
                    );
                  })}
                </Grid.HeaderRow>
              );
            })}
          </Grid.Header>
          <Grid.RowsContainer>
            <Grid.RowsCenter>
              {view.rows.center.map((row) => {
                if (row.kind === "full-width") return null;

                return (
                  <Grid.Row row={row} key={row.id}>
                    {row.cells.map((c) => {
                      return (
                        <Grid.Cell
                          key={c.id}
                          cell={c}
                          className="flex h-full w-full items-center px-2 text-sm"
                        />
                      );
                    })}
                  </Grid.Row>
                );
              })}
            </Grid.RowsCenter>
          </Grid.RowsContainer>
        </Grid.Viewport>
      </Grid.Root>
    </div>
  );
}

Updating the Header Name

Use the columnUpdate API method to change a column's header name. This method lets you update any column property, including the header name.

Header Name Update

"use client";

import { Grid, useClientRowDataSource } from "@1771technologies/lytenyte-pro";
import "@1771technologies/lytenyte-pro/grid.css";
import type { Column } from "@1771technologies/lytenyte-pro/types";
import { bankDataSmall } from "@1771technologies/sample-data/bank-data-smaller";
import { useId } from "react";

type BankData = (typeof bankDataSmall)[number];

const columns: Column<BankData>[] = [
  { name: "Years Alive", id: "age", type: "number" },
  { name: "Employment", id: "job" },
  { name: "Money In Bank", id: "balance", type: "number" },
  { name: "Smartness Level", id: "education" },
  { name: "Single Or Not?", id: "marital" },
];

export default function ColumnHeaderNameUpdate() {
  const ds = useClientRowDataSource({ data: bankDataSmall });

  const grid = Grid.useLyteNyte({
    gridId: useId(),
    rowDataSource: ds,
    columns,

    columnBase: {
      widthFlex: 1,
    },
  });

  const cols = grid.state.columns.useValue();

  const view = grid.view.useValue();

  return (
    <div style={{ display: "flex", flexDirection: "column" }}>
      <div className="flex gap-2">
        <input
          className="rounded-xs h-full border bg-gray-900 p-1 px-2 text-sm text-white dark:text-black"
          aria-label="update-age"
          style={{ width: 150, boxSizing: "border-box" }}
          value={cols[0].name ?? ""}
          onChange={(e) => {
            grid.api.columnUpdate({ [cols[0].id]: { name: e.target.value } });
          }}
        />
        <input
          aria-label="update-job"
          className="rounded-xs h-full border bg-gray-900 p-1 px-2 text-sm text-white dark:text-black"
          style={{ width: 150, boxSizing: "border-box" }}
          value={cols[1].name ?? ""}
          onChange={(e) => {
            grid.api.columnUpdate({ [cols[1].id]: { name: e.target.value } });
          }}
        />
        <input
          aria-label="update-balance"
          className="rounded-xs h-full border bg-gray-900 p-1 px-2 text-sm text-white dark:text-black"
          style={{ width: 150, boxSizing: "border-box" }}
          value={cols[2].name ?? ""}
          onChange={(e) => {
            grid.api.columnUpdate({ [cols[2].id]: { name: e.target.value } });
          }}
        />
        <input
          aria-label="update-education"
          className="rounded-xs h-full border bg-gray-900 p-1 px-2 text-sm text-white dark:text-black"
          style={{ width: 150, boxSizing: "border-box" }}
          value={cols[3].name ?? ""}
          onChange={(e) => {
            grid.api.columnUpdate({ [cols[3].id]: { name: e.target.value } });
          }}
        />
        <input
          aria-label="update-marital"
          className="rounded-xs h-full border bg-gray-900 p-1 px-2 text-sm text-white dark:text-black"
          style={{ width: 150, boxSizing: "border-box" }}
          value={cols[4].name ?? ""}
          onChange={(e) => {
            grid.api.columnUpdate({ [cols[4].id]: { name: e.target.value } });
          }}
        />
      </div>

      <div className="lng-grid" style={{ height: 500 }}>
        <Grid.Root grid={grid}>
          <Grid.Viewport>
            <Grid.Header>
              {view.header.layout.map((row, i) => {
                return (
                  <Grid.HeaderRow key={i} headerRowIndex={i}>
                    {row.map((c) => {
                      if (c.kind === "group") return null;

                      return (
                        <Grid.HeaderCell
                          key={c.id}
                          cell={c}
                          className="flex h-full w-full items-center px-2 capitalize"
                        />
                      );
                    })}
                  </Grid.HeaderRow>
                );
              })}
            </Grid.Header>
            <Grid.RowsContainer>
              <Grid.RowsCenter>
                {view.rows.center.map((row) => {
                  if (row.kind === "full-width") return null;

                  return (
                    <Grid.Row row={row} key={row.id}>
                      {row.cells.map((c) => {
                        return (
                          <Grid.Cell
                            key={c.id}
                            cell={c}
                            className="flex h-full w-full items-center px-2 text-sm"
                          />
                        );
                      })}
                    </Grid.Row>
                  );
                })}
              </Grid.RowsCenter>
            </Grid.RowsContainer>
          </Grid.Viewport>
        </Grid.Root>
      </div>
    </div>
  );
}

Column Header NameCopy Page

Header Name Usage

Updating the Header Name

Header Name Update

On this page