Blazor-ApexGrid 1.0.1

There is a newer version of this package available.
See the version list below for details.
dotnet add package Blazor-ApexGrid --version 1.0.1
                    
NuGet\Install-Package Blazor-ApexGrid -Version 1.0.1
                    
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="Blazor-ApexGrid" Version="1.0.1" />
                    
For projects that support PackageReference, copy this XML node into the project file to reference the package.
<PackageVersion Include="Blazor-ApexGrid" Version="1.0.1" />
                    
Directory.Packages.props
<PackageReference Include="Blazor-ApexGrid" />
                    
Project file
For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package.
paket add Blazor-ApexGrid --version 1.0.1
                    
#r "nuget: Blazor-ApexGrid, 1.0.1"
                    
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
#:package Blazor-ApexGrid@1.0.1
                    
#:package directive can be used in C# file-based apps starting in .NET 10 preview 4. Copy this into a .cs file before any lines of code to reference the package.
#addin nuget:?package=Blazor-ApexGrid&version=1.0.1
                    
Install as a Cake Addin
#tool nuget:?package=Blazor-ApexGrid&version=1.0.1
                    
Install as a Cake Tool

Blazor-ApexGrid

A Blazor wrapper for apex-grid, a Lit-based web-component data grid. The core library (and its dependencies) are bundled into a single self-contained ES module and shipped inside this package, so no <script> tag, CDN reference, or npm build step is required in your app.

  • Typed ApexGrid<TItem> component with strongly-typed columns and events.
  • Data pipeline: sorting, filtering, quick filter, and (local or remote) pagination.
  • Selection: single or multiple, with an optional checkbox column.
  • Inline editing: cell or row mode, with undo/redo history.
  • Column operations: pin, reorder, resize, show/hide.
  • Rows: pinning to sticky bands and drag/keyboard reordering.
  • Tree data and row detail expansion.
  • State persistence: capture and restore a JSON snapshot of the whole view.
  • Multi-targets net8.0, net9.0, and net10.0.

Installation

dotnet add package Blazor-ApexGrid

No other setup is needed: the grid's JavaScript and styles are served automatically from _content/Blazor-ApexGrid/.

Quick start

@using Blazor_ApexGrid.Components
@using Blazor_ApexGrid.Models

<ApexGrid TItem="Person"
          Data="people"
          Columns="columns"
          Height="360px"
          Pagination="pagination"
          Selection="selection"
          OnRowSelected="OnRowSelected" />

@code {
    private readonly PaginationConfiguration pagination = new() { Enabled = true, PageSize = 10 };
    private readonly GridSelectionConfiguration selection = new()
    {
        Enabled = true, Mode = SelectionMode.Multiple, ShowCheckboxColumn = true,
    };

    private readonly List<GridColumn<Person>> columns = new()
    {
        new() { Key = "name", HeaderText = "Name", Sort = true, Filter = true },
        new() { Key = "age", HeaderText = "Age", Type = GridDataType.Number, Sort = true },
        new() { Key = "role", HeaderText = "Role", Filter = true },
    };

    private List<Person> people = new()
    {
        new() { Name = "Ada Lovelace", Age = 36, Role = "Mathematician" },
        new() { Name = "Alan Turing", Age = 41, Role = "Computer Scientist" },
    };

    private void OnRowSelected(GridRowSelectedEventArgs<Person> e) { /* e.Selected, e.Added, e.Removed */ }

    public class Person
    {
        public string Name { get; set; } = "";
        public int Age { get; set; }
        public string Role { get; set; } = "";
    }
}

Column Key values bind to your row properties by their serialized (camelCase) name, so a Name property is referenced as "name".

Good to know

  • Editing a row in place needs RefreshAsync(). The grid redraws when Data is reassigned or its row count changes. Changing a property on a row already in the list does neither, so call await grid.RefreshAsync() to show the edit.
  • Give the grid a bounded height. Height defaults to 400px. A percentage only works if the parent has a height of its own; otherwise it resolves to zero and the grid renders as nothing.
  • Cell and header templates are JavaScript function strings, passed through AdditionalConfig, not Razor RenderFragments, so a template cannot contain Blazor components.

Columns

GridColumn<TItem> mirrors the core column configuration:

Property Purpose
Key Row field to bind (camelCase property name).
HeaderText Header label (falls back to Key).
Type GridDataType controlling the cell renderer/editor (Number, String, Boolean, Select, Rating, Date, Image, Currency, Avatar, Badge, Progress, Sparkline, Status).
Width, Hidden, Exportable Layout and export.
Pinned, Reorderable, Resizable Column operations.
Sort, Filter Enable sorting/filtering on the column.
Editable Allow inline editing (requires grid Editing).
AdditionalConfig Escape hatch ([JsonExtensionData]) for options not modeled above, including JS-function-string renderers.

Features

Sorting, filtering, pagination

<ApexGrid TItem="Person" @ref="grid"
          Data="people" Columns="columns"
          SortConfiguration="new() { Multiple = true, TriState = true }"
          Pagination="new() { Enabled = true, PageSize = 25 }" />

Drive them programmatically: SortAsync, ClearSortAsync, FilterAsync, ClearFilterAsync, SetQuickFilterAsync, GotoPageAsync, NextPageAsync/PreviousPageAsync, FirstPageAsync/LastPageAsync, SetPageSizeAsync.

Inline editing with undo/redo

<ApexGrid TItem="Person" @ref="grid" Data="people" Columns="columns"
          Editing="editing" OnCellValueChanged="OnEdited" OnHistoryChanged="OnHistory" />

@code {
    private readonly GridEditingConfiguration editing = new()
    {
        Enabled = true, Mode = EditMode.Cell, Trigger = EditTrigger.DoubleClick,
        History = new() { Enabled = true },
    };
}

API: EditCellAsync, EditRowAsync, CommitEditAsync, CancelEditAsync, UndoAsync, RedoAsync, ClearHistoryAsync, CanUndoAsync, CanRedoAsync. Mark editable columns with Editable = true.

Column and row operations

PinColumnAsync / UnpinColumnAsync / MoveColumnAsync / UpdateColumnsAsync; set ColumnReordering="true" for drag reordering. Rows: PinRowAsync / UnpinRowAsync / GetPinnedRowsAsync (with RowPinning), and MoveRowAsync (with RowReordering).

Tree data

The hierarchy is derived from a path array on each row; point PathKey at that field. No callbacks required.

<ApexGrid TItem="Employee" Data="employees" Columns="columns"
          Tree="new() { Enabled = true, PathKey = &quot;path&quot;, DefaultExpanded = true }" />

Row detail

Expanding a row opens a detail panel beneath it, rendered from an HTML template whose {field} tokens are replaced with the row's (HTML-escaped) values. The panel holds HTML, not a nested grid.

<ApexGrid TItem="Product" Data="products" Columns="columns" Expansion="expansion" />

@code {
    private readonly GridExpansionConfiguration expansion = new()
    {
        Enabled = true,
        DetailTemplateHtml = "<div style='padding:12px'><strong>{name}</strong> &mdash; {category}</div>",
    };
}

Expansion/tree API: ExpandRowAsync, CollapseRowAsync, ToggleRowExpansionAsync, ExpandAllRowsAsync, CollapseAllRowsAsync, and the ...TreeRow... equivalents.

State persistence

var snapshot = await grid.GetStateAsync();   // JSON-safe; persist it anywhere
await grid.SetStateAsync(snapshot);          // restore later (only present slices are applied)

GetSchemaAsync returns a machine-readable description of the grid (columns, available operations, current state), useful for driving a view editor or an AI layer.

Events

All events surface as strongly-typed EventCallbacks. Payloads use string fields for enum-like values (Blazor's default JSInterop deserialization applies no string-enum converter) and expose selected/affected rows as your TItem.

Area Events
Sorting OnSorting, OnSorted
Filtering OnFiltering, OnFiltered, OnQuickFilterChanging, OnQuickFilterChanged
Pagination OnPageChanging, OnPageChanged
Selection OnRowSelecting, OnRowSelected
Columns OnColumnPinning, OnColumnPinned, OnColumnMoving, OnColumnMoved
Editing OnCellValueChanging, OnCellValueChanged, OnCellValidationFailed, OnHistoryChanged, OnRowEditStarted, OnRowEditEnded
Rows OnRowPinning, OnRowPinned, OnRowMoving, OnRowMoved
Expansion / tree OnRowExpanding, OnRowExpanded, OnTreeRowExpanding, OnTreeRowExpanded
State OnStateChanged

Live demo

A running sample (data grid, plus tree and row detail) is deployed at https://apexcharts.github.io/Blazor-ApexGrid/. Source is under src/Blazor-ApexGrid.Sample.

License

This wrapper bundles apex-grid, which is offered under the ApexCharts dual-license model: a Community License at no cost for individuals, non-profits, educators and organizations under $2M USD in annual revenue, operating budget or funding, and a paid Commercial or OEM license at or above that. Embedding the grid in a product or platform used by other people needs the OEM License whatever your size. See LICENSE.md for the full terms.

Built on top of apex-grid v3.3.0.

Product Compatible and additional computed target framework versions.
.NET net8.0 is compatible.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed.  net9.0 is compatible.  net9.0-android was computed.  net9.0-browser was computed.  net9.0-ios was computed.  net9.0-maccatalyst was computed.  net9.0-macos was computed.  net9.0-tvos was computed.  net9.0-windows was computed.  net10.0 is compatible.  net10.0-android was computed.  net10.0-browser was computed.  net10.0-ios was computed.  net10.0-maccatalyst was computed.  net10.0-macos was computed.  net10.0-tvos was computed.  net10.0-windows was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages (1)

Showing the top 1 NuGet packages that depend on Blazor-ApexGrid:

Package Downloads
Blazor-ApexGrid-Enterprise

The enterprise companion to Blazor-ApexGrid: an ApexGridEnterprise component for apex-grid-enterprise with row grouping, aggregations, pivoting, a grand-total row, cell range selection, a context menu and XLSX export. The enterprise bundle ships inside the package and reuses the apex-grid core from Blazor-ApexGrid. A commercial product: a Premium license or higher is required, and without a license key the grid renders a trial watermark.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last Updated
1.3.0 85 11/14/2026
1.2.1 99 11/10/2026
1.2.0 90 11/9/2026
1.2.0-beta.1 53 11/8/2026
1.1.0 114 10/31/2026
1.0.1 106 10/31/2026
1.0.0 247 7/7/2026

1.0.1 Packaging and documentation fixes, no code changes. The package ships the licence as LICENSE.md, and the README describes the Community License on its current terms. Row expansion is documented as "row detail" so it is not mistaken for nested master/detail grids. Blazor Server is listed in the package tags, as it is supported. Bundles apex-grid 3.3.0 with strongly-typed callbacks for all 29 grid events.