SoPro.FancyTable

https://www.nuget.org/packages/SoPro.FancyTable

Overview

FancyTable is a reusable Blazor component that provides an interactive table experience with built-in support for searching, sorting, pagination, and column visibility management. It's designed to work with any data type through its generic TItem parameter.

FancyTreeTable extends the same column model and interaction patterns to hierarchical datasets, so parent/child structures can be displayed with expand/collapse behavior.

Features

Search

• Default search across all columns where Searchable = true
• Custom search predicates via SearchPredicate
• Debounced input with immediate apply on Enter
• Flexible search text extraction per column via SearchTextSelector

Sorting

• Column sorting with ascending / descending toggle
• Sort indicators in the header
• Custom sort values via SortValueSelector
• Tree-aware sorting that only reorders siblings within the same parent level

Column visibility

• Hideable columns via Hideable
• Hidden-column restore buttons below the table

Pagination

• Optional local/client-side pagination for flat and tree tables
• Bindable CurrentPage and PageSize state
• Default footer pager with optional page-size selector
• Custom pagination, summary, and page-size templates via FancyPaginationContext<TItem>

Localization

• Centralized default UI texts via FancyTableTexts
• Optional per-table text overrides through the Texts parameter
• Bundled FancyTable.resx, FancyTable.en.resx, and FancyTable.de.resx for future resource-based integration

Hierarchical data

• Expand/collapse in FancyTreeTable
• Expand all / collapse all via TreeActionsTemplate or @ref
• Shared column model across flat and tree tables
• Search keeps matching nodes and their ancestors visible
• Configurable child lookup via ChildItemsSelector
• Optional HasChildrenSelector optimization
• Null child entries are ignored during tree construction

Customization

• Custom toolbar via ToolbarTemplate
• Custom cell content via CellTemplate
• Full-row customization through a unified RowTemplate
• Conditional row replacement via RowTemplateSelector
• Unified row context for flat and tree tables via FancyRowContext<TItem>
• Optional row attributes via RowAttributesSelector
• Optional leading-content hook for the first cell via RowLeadingContentTemplate
• Row classes via RowClassSelector
• Header and cell styling via HeaderClass and CellClass
• Wrapper layout classes for toolbar, tree actions, page size, and pagination containers

Parameters

Parameter	Type	Description
Items	IReadOnlyList<TItem>	The data items to display in the table (required)
Columns	IReadOnlyList<FancyColumn<TItem>>	Column configuration (required)
Texts	FancyTableTexts?	Centralized overrides for built-in UI labels and summary text
ToolbarTemplate	RenderFragment?	Custom toolbar content; replaces the default search bar
SearchPredicate	Func<TItem, string, bool>?	Custom search logic; overrides default column-based search
RowClassSelector	Func<TItem, string?>?	Returns CSS class(es) for each row
RowAttributesSelector	Func<FancyRowContext<TItem>, IReadOnlyDictionary<string, object?>?>?	Supplies additional attributes for the rendered <tr>
RowLeadingContentTemplate	RenderFragment<FancyRowContext<TItem>>?	Renders extra content at the start of the first visible cell
RowTemplate	RenderFragment<FancyRowContext<TItem>>?	Renders a complete custom table row (<tr>...</tr>)
RowTemplateSelector	Func<FancyRowContext<TItem>, bool>?	Chooses which rows use RowTemplate; if omitted, RowTemplate applies to every row
PaginationEnabled	bool	Enables local pagination when PageSize > 0
PageSize	int	Active page size; values <= 0 effectively disable pagination
PageSizeChanged	EventCallback<int>	Raised when the page size changes
CurrentPage	int	Active 1-based page index
CurrentPageChanged	EventCallback<int>	Raised when the page changes
PageSizeOptions	IReadOnlyList<int>?	Available page-size options for the default selector
ShowPaginationSummary	bool	Shows the default or custom summary area in the footer
ShowPageSizeSelector	bool	Shows the default or custom page-size UI above the table
PaginationSummaryTemplate	RenderFragment<FancyPaginationContext<TItem>>?	Custom summary content for the default footer
PaginationTemplate	RenderFragment<FancyPaginationContext<TItem>>?	Replaces the visible footer pager area
PageSizeTemplate	RenderFragment<FancyPaginationContext<TItem>>?	Replaces the page-size selector area above the table
TopBarClass	string?	Additional CSS classes for the top bar wrapper
ToolbarContainerClass	string?	Additional CSS classes for the toolbar/search container
PageSizeContainerClass	string?	Additional CSS classes for the page-size wrapper
PaginationContainerClass	string?	Additional CSS classes for the pagination footer wrapper
PaginationSummaryClass	string?	Additional CSS classes for the pagination summary wrapper

Tree Table Parameters

FancyTreeTable<TItem> supports the same parameters as FancyTable<TItem> and adds the following:

Parameter	Type	Description
ChildItemsSelector	Func<TItem, IEnumerable<TItem>?>	Returns the child items for a given node (required)
HasChildrenSelector	Func<TItem, bool>?	Optional optimization to indicate whether a node should render an expand/collapse toggle
InitiallyExpandedSelector	Func<TItem, bool>?	Optional initial state provider used to seed each node's expand/collapse state the first time it appears
Texts	FancyTableTexts?	Centralized overrides for built-in UI labels and summary text
TreeActionsTemplate	RenderFragment<FancyTreeTableContext<TItem>>?	Renders custom tree-level actions such as expand/collapse all
TreeActionsContainerClass	string?	Additional CSS classes for the tree actions wrapper

Row Context

FancyRowContext<TItem> is passed into RowTemplate, RowTemplateSelector, RowAttributesSelector, and RowLeadingContentTemplate.

Property	Type	Description
Item	TItem	The current row item
Columns	IReadOnlyList<FancyColumn<TItem>>	Currently visible columns
VisibleColumnCount	int	Count of visible columns, useful for colspan rows
IsTreeNode	bool	Indicates whether the row comes from FancyTreeTable
Depth	int	Tree depth for tree rows; 0 for flat tables
HasChildren	bool	Whether the tree row has children
IsExpanded	bool	Whether the tree row is currently expanded
CanToggle	bool	Convenience flag for toggle availability
ToggleNode	EventCallback	Expands or collapses the current tree node
ExpandLabel	string	Accessible label for collapsed nodes
CollapseLabel	string	Accessible label for expanded nodes

For flat tables, tree-specific values are neutral: IsTreeNode = false, Depth = 0, HasChildren = false, and ToggleNode is empty.

Tree Table Context

FancyTreeTableContext<TItem> is passed into TreeActionsTemplate.

Property	Type	Description
RootItemCount	int	Number of root items in the tree
VisibleNodeCount	int	Number of currently visible nodes after search and expand/collapse state
ExpandedNodeCount	int	Number of currently expanded nodes that have children
HasExpandableNodes	bool	Whether the tree contains any expandable nodes
CanExpandAny	bool	Whether at least one expandable node is currently collapsed
CanCollapseAny	bool	Whether at least one expandable node is currently expanded
ExpandAll()	Task	Expands the entire tree across all levels
CollapseAll()	Task	Collapses the entire tree across all levels

FancyTreeTable<TItem> also exposes imperative methods for @ref usage:

• ExpandAllAsync()
• CollapseAllAsync()

Pagination Context

FancyPaginationContext<TItem> is passed into PaginationSummaryTemplate, PaginationTemplate, and PageSizeTemplate.

Property	Type	Description
CurrentPage	int	Active 1-based page index
PageSize	int	Active page size
TotalItemCount	int	Unfiltered item count
FilteredItemCount	int	Count after search/filtering
PageCount	int	Number of available pages
StartItemIndex	int	1-based start index of the current page
EndItemIndex	int	1-based end index of the current page
HasPreviousPage	bool	Whether a previous page exists
HasNextPage	bool	Whether a next page exists
GoToPage(int)	Task	Jumps to a specific page
GoToPreviousPage()	Task	Moves to the previous page
GoToNextPage()	Task	Moves to the next page
SetPageSize(int)	Task	Updates the page size and resets to page 1

Localization

FancyTableTexts lets you override all package-owned default UI text without requiring direct IStringLocalizer wiring inside the library.

Example:

privatestaticreadonlyFancyTableTextsGermanTexts=FancyTableTexts.Defaultwith{SearchPlaceholder="Suchen",RowsPerPageLabel="Zeilen pro Seite",AllItemsLabel="Alle",HiddenColumnsLabel="Ausgeblendete Spalten:",PreviousPageLabel="Zurueck",NextPageLabel="Weiter",ExpandLabel="Aufklappen",CollapseLabel="Zuklappen"};

The package also includes FancyTable.resx, FancyTable.en.resx, and FancyTable.de.resx so the same string catalog is already available for a future resource-driven integration layer.

Column Configuration

Each column is configured using FancyColumn<TItem>:

Property	Type	Description
Key	string	Unique identifier for the column
Title	string	Display name shown in the header
Sortable	bool	Whether the column can be sorted
Searchable	bool	Whether the column is included in search (default: true)
Hideable	bool	Whether the column can be hidden by the user
HeaderClass	string?	CSS class applied to the header cell
CellClass	string?	CSS class applied to data cells
ValueSelector	Func<TItem, object?>?	Extracts the value to display for each row
SortValueSelector	Func<TItem, IComparable?>?	Extracts the value used for sorting (falls back to ValueSelector)
SearchTextSelector	Func<TItem, string?>?	Extracts the text used for searching (falls back to ValueSelector?.ToString())
CellTemplate	RenderFragment<TItem>?	Custom Blazor template to render cell content

Setup

To use SoPro.FancyTable in your Blazor application, include Bootstrap CSS and Bootstrap Icons in your app (App.razor / host page):

<linkrel="stylesheet" href="https://cdn.jsdelivr.net/npm/bootstrap@5.3.7/dist/css/bootstrap.min.css" /><linkrel="stylesheet" href="https://cdn.jsdelivr.net/npm/bootstrap-icons@1.11.3/font/bootstrap-icons.min.css" />

Add SoPro.FancyTable.Components to your _Imports.razor and rebuild the project:

@usingSoPro.FancyTable.Components

Usage Example

This example covers:

• default toolbar
• custom toolbar (ToolbarTemplate)
• custom cell template
• row-level classes (RowClassSelector)
• conditional custom rows (RowTemplate + RowTemplateSelector)
• custom row callbacks

@page "/fancy-table-demo"<div class="d-flex"><div class="p-3 col"><h5>Default Toolbar</h5><FancyTable TItem="PersonRow"
Items="PeopleRows"
Columns="PeopleColumns"
PaginationEnabled="true"PageSize="10"ShowPageSizeSelector="true"Texts="DemoTexts"/></div><div class="p-3 col"><h5>Custom Toolbar</h5><FancyTable TItem="ProductRow"
Items="ProductRows"
Columns="ProductColumns"><ToolbarTemplate><div class="d-flex"><button class="btn btn-sm btn-info mx-1"><i class="bi bi-search"></i></button><input class="form-control form-control-md"placeholder="Custom search UI"/></div></ToolbarTemplate></FancyTable></div><div class="p-3 col"><h5>Conditional custom rows</h5><FancyTable TItem="PersonRow"
Items="PeopleRows"
Columns="StyledPeopleColumns"RowClassSelector="GetPersonRowClass"RowTemplate="PersonHighlightRow"RowTemplateSelector="context => context.Item.Age >= 35"/></div></div>@code{private static readonly FancyTableTexts DemoTexts = FancyTableTexts.Default with{SearchPlaceholder="Search name or city..."};
private IReadOnlyList<PersonRow>PeopleRows=[new("Alice","Berlin",31),new("Bob","Hamburg",27),new("Carol","Munich",36),new("David","Cologne",29)];
private IReadOnlyList<FancyColumn<PersonRow>> PeopleColumns =>[newFancyColumn<PersonRow>{Key="name",Title="Name",Sortable=true,Searchable=true,ValueSelector= person =>person.Name,SortValueSelector= person =>person.Name},newFancyColumn<PersonRow>{Key="city",Title="City",Sortable=true,Searchable=true,Hideable=true,ValueSelector= person =>person.City,SortValueSelector= person =>person.City},newFancyColumn<PersonRow>{Key="age",Title="Age",Sortable=true,Searchable=false,ValueSelector= person =>person.Age,SortValueSelector= person =>person.Age}];
private IReadOnlyList<ProductRow>ProductRows=[new("SW-1001","Switch",149.99m,42,"NetWare Ltd"),new("FW-2300","Firewall",899.00m,5,"SecureCore AG")];
private IReadOnlyList<FancyColumn<ProductRow>> ProductColumns =>[newFancyColumn<ProductRow>{Key="sku",Title="SKU",Sortable=true,Searchable=true,ValueSelector= product =>product.Sku,SortValueSelector= product =>product.Sku},newFancyColumn<ProductRow>{Key="price",Title="Price",Sortable=true,Searchable=false,ValueSelector= product =>product.Price.ToString("C2"),SortValueSelector= product =>product.Price}];
private IReadOnlyList<FancyColumn<PersonRow>> StyledPeopleColumns =>[newFancyColumn<PersonRow>{Key="styled-name",Title="Name",Sortable=true,Searchable=true,HeaderClass="text-bg-dark",CellClass="fw-semibold text-primary",ValueSelector= person =>person.Name,SortValueSelector= person =>person.Name},newFancyColumn<PersonRow>{Key="styled-age",Title="Age",Sortable=true,Searchable=false,CellTemplate= person => @<span class="badge text-bg-info-subtle border border-info text-info-emphasis">@person.Age yrs</span>}];
private string?GetPersonRowClass(PersonRowperson)=>person.Age>=35?"bg-warning":null;
private RenderFragment<FancyRowContext<PersonRow>> PersonHighlightRow => context => @<tr class="table-warning"><td colspan="@context.VisibleColumnCount"><strong>@context.Item.Name</strong>is flagged for review from @context.Item.City.<button class="btn btn-sm btn-primary ms-2"@onclick="() => OpenPerson(context.Item)">Details</button></td></tr>;
private voidOpenPerson(PersonRowperson){Console.WriteLine($"Open details for {person.Name}");}privatesealed record PersonRow(stringName,stringCity,intAge);
private sealed recordProductRow(stringSku,stringCategory,decimalPrice,intStock,stringSupplier);}

RowTemplate renders the full row (<tr>...</tr>). If RowTemplateSelector is omitted, the custom row template applies to every row.

When pagination is enabled, FancyTable paginates after search and sorting. CurrentPage and PageSize can be bound to keep state stable across parent rerenders.

Wrapper class parameters append to the built-in layout classes, so utility classes such as d-inline-flex, justify-content-end, or gap-3 can adjust the layout without replacing templates.

Tree Table Example

FancyTreeTable<TItem> works with nested data while keeping the same column definition style:

@page "/fancy-tree-table-demo"<FancyTreeTable TItem="RuleRow"
@ref="RuleTable"
Items="Rules"
Columns="RuleColumns"
ChildItemsSelector="row => row.Children"HasChildrenSelector="row => row.Children.Count > 0"PaginationEnabled="true"PageSize="5"ShowPageSizeSelector="true"TopBarClass="justify-content-end"PageSizeContainerClass="me-auto"TreeActionsContainerClass="d-inline-flex align-items-center gap-2"PaginationContainerClass="justify-content-end"TreeActionsTemplate="RuleTreeActions"RowTemplate="SectionHeaderTemplate"RowTemplateSelector="context => context.Item.IsSectionHeader"Texts="RuleTableTexts"/>@code{private FancyTreeTable<RuleRow>? RuleTable;
private staticreadonly FancyTableTexts RuleTableTexts = FancyTableTexts.Default with{SearchPlaceholder="Search rules..."};
private staticreadonly RuleRow Rule_11_1 =new("11.1","Allow HTTPS","TCP","443","Any","Server-A","Allow",[],false);
private staticreadonly RuleRow Rule_11_2 =new("11.2","Allow DNS","UDP","53","Any","DNS-1","Allow",[],false);
private staticreadonly RuleRow Rule_11_3 =new("11.3","Block Telnet","TCP","23","Any","Any","Deny",[],false);
private IReadOnlyList<RuleRow>Rules=[new("","Section Header","","","","","",[Rule_11_1,Rule_11_2,Rule_11_3],IsSectionHeader:true)];
private IReadOnlyList<FancyColumn<RuleRow>> RuleColumns =>[new(){Key="number",Title="Rule",ValueSelector= x =>x.Number},new(){Key="name",Title="Name",ValueSelector= x =>x.Name},new(){Key="protocol",Title="Protocol",ValueSelector= x =>x.Protocol},new(){Key="port",Title="Port",ValueSelector= x =>x.Port},new(){Key="source",Title="Source",ValueSelector= x =>x.Source},new(){Key="destination",Title="Destination",ValueSelector= x =>x.Destination},new(){Key="action",Title="Action",ValueSelector= x =>x.Action}];
private RenderFragment<FancyRowContext<RuleRow>> SectionHeaderTemplate => context => @<tr class="table-secondary fw-bold"><td colspan="@context.VisibleColumnCount"><button type="button"class="btn btn-link btn-sm text-decoration-none p-0 me-2"@onclick="() => context.ToggleNode.InvokeAsync()"aria-label="@(context.IsExpanded ? context.CollapseLabel : context.ExpandLabel)"
aria-expanded="@context.IsExpanded"><i class="bi @(context.IsExpanded ? "bi-caret-down-fill" : "bi-caret-right-fill")"></i></button>@context.Item.Name<span class="ms-2 text-muted">(@context.Item.Children.CountRegeln)</span><button class="btn btn-sm btn-outline-primary ms-3"@onclick="() => InspectSection(context.Item)">Inspect</button></td></tr>;
private RenderFragment<FancyTreeTableContext<RuleRow>> RuleTreeActions => context => @<div class="d-flex flex-wrap gap-2 align-items-center"><button type="button"class="btn btn-sm btn-outline-primary"disabled="@(!context.CanExpandAny)"@onclick="context.ExpandAll">Expand All
</button><button type="button"
class="btn btn-sm btn-outline-secondary"disabled="@(!context.CanCollapseAny)"@onclick="context.CollapseAll">Collapse All
</button><button type="button"
class="btn btn-sm btn-outline-dark"disabled="@(RuleTable is null)"@onclick="ExpandViaReferenceAsync">Expand via @@ref
</button><span class="small text-muted">@context.VisibleNodeCountvisible rows, @context.ExpandedNodeCount expanded nodes
</span></div>;
private void InspectSection(RuleRowrow){Console.WriteLine($"Inspect section {row.Name}");}
private Task ExpandViaReferenceAsync()=> RuleTable?.ExpandAllAsync()??Task.CompletedTask;
private sealed record RuleRow(stringNumber,stringName,stringProtocol,stringPort,stringSource,stringDestination,stringAction,IReadOnlyList<RuleRow>Children,boolIsSectionHeader= false);}

Global expand/collapse actions always operate on the full tree, not just on the current page or currently visible search results.

Tree Search and Sorting Semantics

• Search shows matching nodes and their ancestors, so hits remain visible in context
• Clearing the search restores the manual expand/collapse state from before the search
• Sorting keeps the tree structure intact by sorting only within each sibling group

Component Dependencies

• Bootstrap 5: For styling and grid utilities (MIT License)
• Bootstrap Icons: For UI icons (search, sort, eye, etc.) (MIT License)

License

This project is licensed under the MIT License.

Bootstrap and Bootstrap Icons are also licensed under the MIT License.

---

Roadmap

• NuGet package release
• Pagination support with optional custom templates
• Localization support for default UI text
• Column resizing and reordering
• Export to CSV/Excel
• Detail rows / expandable row content
• Row click / activation API
• Default sorting per column
• Per-column filtering
• Custom summary / action rows without full row override
• Persistable UI state
• Sticky header / scroll container options
• Row selection and bulk actions
• Dark Mode support
• Accessibility improvements (ARIA roles, keyboard navigation)
• Performance optimizations for large datasets (virtualization)