Documentation

Data displayGlass surface

TreeGrid

Displays hierarchical rows with grid-like columns.

View preview API reference View in Figma

FrameworksAstro · React · Elements

Registry commandlumen add TreeGrid

InteractionNative markup

Design sourceLinked component node

See it in context

Preview

PackageStatus

packages—

astroReady

reactReady

Copy a working example

Usage

---
import { TreeGrid } from '@santi020k/lumen-astro'
---

<TreeGrid aria-label="Project status">
  <div role="row">
    <span role="columnheader">Package</span>
    <span role="columnheader">Status</span>
  </div>
  <div aria-expanded="true" aria-level="1" role="row">
    <span role="gridcell">packages</span>
    <span role="gridcell">—</span>
  </div>
  <div aria-level="2" role="row">
    <span role="gridcell">astro</span>
    <span role="gridcell">Ready</span>
  </div>
  <div aria-level="2" role="row">
    <span role="gridcell">react</span>
    <span role="gridcell">Ready</span>
  </div>
</TreeGrid>

---
import { TreeGrid } from '@santi020k/lumen-astro'
---

<TreeGrid aria-label="Project status">
  <div role="row">
    <span role="columnheader">Package</span>
    <span role="columnheader">Status</span>
  </div>
  <div aria-expanded="true" aria-level="1" role="row">
    <span role="gridcell">packages</span>
    <span role="gridcell">—</span>
  </div>
  <div aria-level="2" role="row">
    <span role="gridcell">astro</span>
    <span role="gridcell">Ready</span>
  </div>
  <div aria-level="2" role="row">
    <span role="gridcell">react</span>
    <span role="gridcell">Ready</span>
  </div>
</TreeGrid>

import { TreeGrid } from '@santi020k/lumen-react'

export const Example = () => (
  <>
    <TreeGrid aria-label="Project status">
      <div role="row">
        <span role="columnheader">Package</span>
        <span role="columnheader">Status</span>
      </div>
      <div aria-expanded="true" aria-level="1" role="row">
        <span role="gridcell">packages</span>
        <span role="gridcell">—</span>
      </div>
      <div aria-level="2" role="row">
        <span role="gridcell">astro</span>
        <span role="gridcell">Ready</span>
      </div>
      <div aria-level="2" role="row">
        <span role="gridcell">react</span>
        <span role="gridcell">Ready</span>
      </div>
    </TreeGrid>
  </>
)

import { TreeGrid } from '@santi020k/lumen-react'

export const Example = () => (
  <>
    <TreeGrid aria-label="Project status">
      <div role="row">
        <span role="columnheader">Package</span>
        <span role="columnheader">Status</span>
      </div>
      <div aria-expanded="true" aria-level="1" role="row">
        <span role="gridcell">packages</span>
        <span role="gridcell">—</span>
      </div>
      <div aria-level="2" role="row">
        <span role="gridcell">astro</span>
        <span role="gridcell">Ready</span>
      </div>
      <div aria-level="2" role="row">
        <span role="gridcell">react</span>
        <span role="gridcell">Ready</span>
      </div>
    </TreeGrid>
  </>
)

<script type="module">
  import { defineLumenElements } from '@santi020k/lumen-elements/define'

  defineLumenElements()
</script>

<lumen-tree-grid aria-label="Project status">
  <div role="row">
    <span role="columnheader">Package</span>
    <span role="columnheader">Status</span>
  </div>
  <div aria-expanded="true" aria-level="1" role="row">
    <span role="gridcell">packages</span>
    <span role="gridcell">—</span>
  </div>
  <div aria-level="2" role="row">
    <span role="gridcell">astro</span>
    <span role="gridcell">Ready</span>
  </div>
  <div aria-level="2" role="row">
    <span role="gridcell">react</span>
    <span role="gridcell">Ready</span>
  </div>
</lumen-tree-grid>

<script type="module">
  import { defineLumenElements } from '@santi020k/lumen-elements/define'

  defineLumenElements()
</script>

<lumen-tree-grid aria-label="Project status">
  <div role="row">
    <span role="columnheader">Package</span>
    <span role="columnheader">Status</span>
  </div>
  <div aria-expanded="true" aria-level="1" role="row">
    <span role="gridcell">packages</span>
    <span role="gridcell">—</span>
  </div>
  <div aria-level="2" role="row">
    <span role="gridcell">astro</span>
    <span role="gridcell">Ready</span>
  </div>
  <div aria-level="2" role="row">
    <span role="gridcell">react</span>
    <span role="gridcell">Ready</span>
  </div>
</lumen-tree-grid>

Choose your target

Add this component

Choose the package for your runtime. All adapters share the Lumen stylesheet. Use the matching registry command when you want a local wrapper for that framework.

pnpm add @santi020k/lumen-astro

pnpm add @santi020k/lumen-astro

lumen add TreeGrid

lumen add TreeGrid

pnpm add @santi020k/lumen-react

pnpm add @santi020k/lumen-react

lumen add TreeGrid --target react

lumen add TreeGrid --target react

pnpm add @santi020k/lumen-elements

pnpm add @santi020k/lumen-elements

lumen add TreeGrid --target elements

lumen add TreeGrid --target elements

Glass

Add the glass prop to apply the shared blur, saturation, border, and highlight tokens. Glass reads best over vivid content, so place the surface above imagery or color.

SurfaceGlass

TreeGridSupported

VirtualListSupported

---
import { TreeGrid } from '@santi020k/lumen-astro'
---

<div class="docs-glass-demo">
  <TreeGrid glass>
    <div role="row"><span role="gridcell">Surface</span><span role="gridcell">Glass</span></div>
    <div role="row"><span role="gridcell">TreeGrid</span><span role="gridcell">Supported</span></div>
    <div role="row"><span role="gridcell">VirtualList</span><span role="gridcell">Supported</span></div>
  </TreeGrid>
</div>

---
import { TreeGrid } from '@santi020k/lumen-astro'
---

<div class="docs-glass-demo">
  <TreeGrid glass>
    <div role="row"><span role="gridcell">Surface</span><span role="gridcell">Glass</span></div>
    <div role="row"><span role="gridcell">TreeGrid</span><span role="gridcell">Supported</span></div>
    <div role="row"><span role="gridcell">VirtualList</span><span role="gridcell">Supported</span></div>
  </TreeGrid>
</div>

import { TreeGrid } from '@santi020k/lumen-react'

export const Example = () => (
  <>
    <div className="docs-glass-demo">
      <TreeGrid glass>
        <div role="row"><span role="gridcell">Surface</span><span role="gridcell">Glass</span></div>
        <div role="row"><span role="gridcell">TreeGrid</span><span role="gridcell">Supported</span></div>
        <div role="row"><span role="gridcell">VirtualList</span><span role="gridcell">Supported</span></div>
      </TreeGrid>
    </div>
  </>
)

import { TreeGrid } from '@santi020k/lumen-react'

export const Example = () => (
  <>
    <div className="docs-glass-demo">
      <TreeGrid glass>
        <div role="row"><span role="gridcell">Surface</span><span role="gridcell">Glass</span></div>
        <div role="row"><span role="gridcell">TreeGrid</span><span role="gridcell">Supported</span></div>
        <div role="row"><span role="gridcell">VirtualList</span><span role="gridcell">Supported</span></div>
      </TreeGrid>
    </div>
  </>
)

<script type="module">
  import { defineLumenElements } from '@santi020k/lumen-elements/define'

  defineLumenElements()
</script>

<div class="docs-glass-demo">
  <lumen-tree-grid glass>
    <div role="row"><span role="gridcell">Surface</span><span role="gridcell">Glass</span></div>
    <div role="row"><span role="gridcell">TreeGrid</span><span role="gridcell">Supported</span></div>
    <div role="row"><span role="gridcell">VirtualList</span><span role="gridcell">Supported</span></div>
  </lumen-tree-grid>
</div>

<script type="module">
  import { defineLumenElements } from '@santi020k/lumen-elements/define'

  defineLumenElements()
</script>

<div class="docs-glass-demo">
  <lumen-tree-grid glass>
    <div role="row"><span role="gridcell">Surface</span><span role="gridcell">Glass</span></div>
    <div role="row"><span role="gridcell">TreeGrid</span><span role="gridcell">Supported</span></div>
    <div role="row"><span role="gridcell">VirtualList</span><span role="gridcell">Supported</span></div>
  </lumen-tree-grid>
</div>

API reference

Lumen-specific props and runtime attributes for the Astro primitive. React props follow the same names; Elements use equivalent kebab-case attributes where custom elements expose them.

Attribute	Values	Default	Description
glass	boolean \| "subtle" \| "strong"	false	Applies the tokenized liquid-glass surface treatment with backdrop-filter fallbacks; "subtle" and "strong" adjust the fill intensity.
role	ARIA role	"treegrid"	Generated treegrid role for the root element.
role="row", role="gridcell"	ARIA roles	-	Use on children to build out the hierarchical grid rows and cells.
class, className	string	""	Merges custom classes with the generated ui-* root classes.
...native attributes	HTML attributes	-	Forwards standard attributes to the root element unless the component consumes them.