TreeGrid
Displays hierarchical rows with grid-like columns.
See it and copy it
Framework example
Choose Astro, React, or Elements to compare native usage against the shared visual output. Each example assumes the framework-level setup is already complete.
Framework usage
Switch targets to compare the adapter code. The preview stays visually stable because all three packages share the same tokens andui-* class contract.---
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>
</>
)<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-astropnpm add @santi020k/lumen-astrolumen add TreeGridlumen add TreeGridpnpm add @santi020k/lumen-reactpnpm add @santi020k/lumen-reactlumen add TreeGrid --target reactlumen add TreeGrid --target reactpnpm add @santi020k/lumen-elementspnpm add @santi020k/lumen-elementslumen add TreeGrid --target elementslumen add TreeGrid --target elementsGlass
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.
Framework usage
Switch targets to compare the adapter code. The preview stays visually stable because all three packages share the same tokens andui-* class contract.---
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>
</>
)<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. |