Enterprise-level component library based on Bootstrap and BlazorFilter and sort function
Filter to quickly find the data you want to see; sort to quickly find or compare data.
- Filters a column of data to specify the column to be filtered by specifying the
filterableproperty of the column - Sort a column of data, specify the column to be sorted by specifying the
Sortableproperty of the column, change the collation by multiple clicks
Table with filterable data
Set the Filterable property of the TableColumn column to control whether the column header has data filtering enabled
Demo
Filterable currently supports two applications:
- The
Filtersin the query method parameters are filter criteria, and the database can filter the data by itself through this property when querying data - No sense of use, normal query data, no processing is done to filtering, internal processing will be carried out according to
Filter - When external filtering has been made, set the
Value of the IsFilteredproperty of theQueryData<TItem>parameter totrue - Each column can be set separately, and the filter between columns is
Andand relationship
This example is
of DateTime, string, bool, enum, int type, and the pop-up filter box is also differentCustom Filter Template
Set FilterTemplate template values, customize column filter templates, very suitable for complex types of filter pop-ups
Demo
The FilterTemplate type is RenderFragment: its value is a custom component, and the component must inherit the filterBase In this case, the last column in this case, the Quantity column, uses the custom component by filtering the template CustomerFilter [portal] CustomerFilter component source code
Show Filter Header
Show filter header when the ShowFilterHeader property value is set to true
Demo
Default sort function
Default sorts as default when setting the DefaultSort property value to true
Demo
- Set
DefaultSort=trueto enable the default sort function, when multiple columns set this property, the first column works - Set
DefaultSortOrdervalue, set default collation
In this case the default sort is the last column in reverse order
Multi-column sort
Set the SortList property, use this parameter for multi-column sorting when the table loads
Demo
The default collation in this case is: DeteTime desc Address, you don't need to handle the sort logic yourself, the component is already built-in
Dynamic multi-column sorting
Set OnSort Parameters
Demo
When clicking the column header to sort, the component calls the OnSort callback internally, where its return value can be set according to the business logic to achieve dynamic multi-column sorting, in this case, when clicking the time column header for positive order sorting, use DateTime,Count internally, useDateTime desc, Count descwhen Count reverse order
Set filters by code
Example shows how to set filters through code
Demo
@page "/tables/filter"
<h3>@FilterLocalizer["Title"]</h3>
<h4>@FilterLocalizer["Desc"]</h4>
<ul class="ul-demo mt-3">
<li>@((MarkupString)FilterLocalizer["DescLi1"].Value)</li>
<li>@((MarkupString)FilterLocalizer["DescLi2"].Value)</li>
</ul>
<DemoBlock Title="@FilterLocalizer["FilterableTitle"]" Introduction="@FilterLocalizer["FilterableIntro"]" Name="Filterable">
<p>@((MarkupString)FilterLocalizer["FilterableP"].Value)</p>
<ul class="ul-demo mb-3">
<li>@((MarkupString)FilterLocalizer["FilterableLi1"].Value)</li>
<li>@((MarkupString)FilterLocalizer["FilterableLi2"].Value)</li>
<li>@((MarkupString)FilterLocalizer["FilterableLi3"].Value)</li>
<li>@((MarkupString)FilterLocalizer["FilterableLi4"].Value)</li>
</ul>
<div>@((MarkupString)FilterLocalizer["FilterableDiv"].Value)</div>
<Alert ShowBar="true" Color="Color.Info" class="mt-3">@((MarkupString)FilterLocalizer["FilterableAlert"].Value)</Alert>
<Table TItem="Foo"
IsPagination="true" PageItemsSource="@PageItemsSource"
IsStriped="true" IsBordered="true" IsMultipleSelect="true"
ShowSkeleton="true"
OnQueryAsync="@OnQueryAsync">
<TableColumns>
<TableColumn @bind-Field="@context.DateTime" Width="180" Sortable="true" Filterable="true" />
<TableColumn @bind-Field="@context.Name" Width="100" Sortable="true" Filterable="true" />
<TableColumn @bind-Field="@context.Address" Sortable="true" Filterable="true" />
<TableColumn @bind-Field="@context.Complete" Width="100" Sortable="true" Filterable="true" />
<TableColumn @bind-Field="@context.Education" Width="100" Sortable="true" Filterable="true" />
<TableColumn @bind-Field="@context.Count" Width="100" Sortable="true" Filterable="true" />
</TableColumns>
</Table>
</DemoBlock>
<DemoBlock Title="@FilterLocalizer["FilterTemplateTitle"]" Introduction="@FilterLocalizer["FilterTemplateIntro"]" Name="FilterTemplate">
<p>@((MarkupString)FilterLocalizer["FilterTemplateP", ComponentSourceCodeUrl].Value)</p>
<Table TItem="Foo"
IsPagination="true" PageItemsSource="@PageItemsSource"
IsStriped="true" IsBordered="true" IsMultipleSelect="true"
ShowSkeleton="true"
OnQueryAsync="@OnQueryAsync">
<TableColumns>
<TableColumn @bind-Field="@context.DateTime" Width="180" Sortable="true" Filterable="true" />
<TableColumn @bind-Field="@context.Name" Width="100" Sortable="true" Filterable="true" />
<TableColumn @bind-Field="@context.Address" Sortable="true" Filterable="true" />
<TableColumn @bind-Field="@context.Complete" Width="100" Sortable="true" Filterable="true">
<Template Context="value">
<Checkbox Value="@value.Value" IsDisabled="true"></Checkbox>
</Template>
</TableColumn>
<TableColumn @bind-Field="@context.Count" Width="100" Sortable="true" Filterable="true">
<FilterTemplate>
<CustomerFilter></CustomerFilter>
</FilterTemplate>
</TableColumn>
</TableColumns>
</Table>
</DemoBlock>
<DemoBlock Title="@FilterLocalizer["ShowFilterHeaderTitle"]" Introduction="@FilterLocalizer["ShowFilterHeaderIntro"]" Name="ShowFilterHeader">
<Table TItem="Foo"
IsPagination="true" PageItemsSource="@PageItemsSource"
IsStriped="true" IsBordered="true" IsMultipleSelect="true"
ShowSkeleton="true" ShowFilterHeader="true"
OnQueryAsync="@OnQueryAsync">
<TableColumns>
<TableColumn @bind-Field="@context.DateTime" Width="180" Sortable="true" />
<TableColumn @bind-Field="@context.Name" Width="100" Sortable="true" />
<TableColumn @bind-Field="@context.Address" Sortable="true" />
<TableColumn @bind-Field="@context.Complete" Width="100" Sortable="true" Filterable="true" />
<TableColumn @bind-Field="@context.Education" Width="100" Sortable="true" Filterable="true" />
<TableColumn @bind-Field="@context.Count" Width="100" Sortable="true" DefaultSort="true" DefaultSortOrder="@SortOrder.Desc" />
</TableColumns>
</Table>
</DemoBlock>
<DemoBlock Title="@FilterLocalizer["DefaultSortTitle"]" Introduction="@FilterLocalizer["DefaultSortIntro"]" Name="DefaultSort">
<ul class="ul-demo mb-3">
<li>@((MarkupString)FilterLocalizer["DefaultSortLi1"].Value)</li>
<li>@((MarkupString)FilterLocalizer["DefaultSortLi2"].Value)</li>
</ul>
<p>@FilterLocalizer["DefaultSortP"]</p>
<Table TItem="Foo"
IsPagination="true" PageItemsSource="@PageItemsSource"
IsStriped="true" IsBordered="true" IsMultipleSelect="true"
ShowSkeleton="true"
OnQueryAsync="@OnQueryAsync">
<TableColumns>
<TableColumn @bind-Field="@context.DateTime" Width="180" Sortable="true" />
<TableColumn @bind-Field="@context.Name" Width="100" Sortable="true" />
<TableColumn @bind-Field="@context.Address" Sortable="true" />
<TableColumn @bind-Field="@context.Count" Width="100" Sortable="true" DefaultSort="true" DefaultSortOrder="@SortOrder.Desc" />
</TableColumns>
</Table>
</DemoBlock>
<DemoBlock Title="@FilterLocalizer["SortListTitle"]" Introduction="@FilterLocalizer["SortListIntro"]" Name="SortString">
<p>@((MarkupString)FilterLocalizer["SortListP"].Value)</p>
<Table TItem="Foo"
IsPagination="true" PageItemsSource="@PageItemsSource"
IsStriped="true" IsBordered="true" IsMultipleSelect="true"
ShowSkeleton="true" SortString="SortList"
OnQueryAsync="@OnQueryAsync">
<TableColumns>
<TableColumn @bind-Field="@context.DateTime" Width="180" Sortable="true" />
<TableColumn @bind-Field="@context.Name" Width="100" Sortable="true" />
<TableColumn @bind-Field="@context.Address" Sortable="true" />
<TableColumn @bind-Field="@context.Count" Width="100" Sortable="true" />
</TableColumns>
</Table>
</DemoBlock>
<DemoBlock Title="@FilterLocalizer["OnSortTitle"]" Introduction="@FilterLocalizer["OnSortIntro"]" Name="OnSort">
<p>@((MarkupString)FilterLocalizer["OnSortP"].Value)</p>
<Table TItem="Foo"
IsPagination="true" PageItemsSource="@PageItemsSource"
IsStriped="true" IsBordered="true" IsMultipleSelect="true"
ShowSkeleton="true" SortString="@SortString" OnSort="OnSort"
OnQueryAsync="@OnQueryAsync">
<TableColumns>
<TableColumn @bind-Field="@context.DateTime" Width="180" Sortable="true" />
<TableColumn @bind-Field="@context.Name" Width="100" Sortable="true" />
<TableColumn @bind-Field="@context.Address" Sortable="true" />
<TableColumn @bind-Field="@context.Count" Width="100" Sortable="true" />
</TableColumns>
</Table>
</DemoBlock>
<DemoBlock Title="@FilterLocalizer["SetFilterInCodeTitle"]" Introduction="@FilterLocalizer["SetFilterInCodeIntro"]" Name="SetFilterInCode">
<div class="mb-2">
<Button Text="@FilterLocalizer["SetFilterInCodeButtonText1"]" OnClickWithoutRender="SetFilterInCode" />
<Button Text="@FilterLocalizer["SetFilterInCodeButtonText2"]" OnClickWithoutRender="ResetAllFilters" />
</div>
<Table TItem="Foo" @ref="TableSetFilter"
IsPagination="true" PageItemsSource="@PageItemsSource"
IsStriped="true" IsBordered="true" IsMultipleSelect="true"
ShowSkeleton="true" ShowFilterHeader="true"
OnQueryAsync="@OnQueryAsync">
<TableColumns>
<TableColumn @bind-Field="@context.DateTime" Width="180" Sortable="true" />
<TableColumn @bind-Field="@context.Name" Width="100" Sortable="true" Filterable="true" />
<TableColumn @bind-Field="@context.Address" Sortable="true" />
<TableColumn @bind-Field="@context.Complete" Width="100" Sortable="true" Filterable="true" />
<TableColumn @bind-Field="@context.Education" Width="100" Sortable="true" Filterable="true" />
<TableColumn @bind-Field="@context.Count" Width="150" Sortable="true" />
</TableColumns>
</Table>
</DemoBlock>
// Copyright (c) Argo Zhang (argo@163.com). All rights reserved.
// Licensed under the Apache License, Version 2.0. See License.txt in the project root for license information.
// Website: https://www.blazor.zone or https://argozhang.github.io/
using BootstrapBlazor.Components;
using Microsoft.AspNetCore.Components;
using Microsoft.Extensions.Localization;
using Microsoft.Extensions.Options;
namespace BootstrapBlazor.Shared.Samples.Table;
/// <summary>
/// 过滤示例代码
/// </summary>
public partial class TablesFilter
{
private static IEnumerable<int> PageItemsSource => new int[] { 4, 10, 20 };
[NotNull]
private List<Foo>? Items { get; set; }
[Inject]
[NotNull]
private IStringLocalizer<Foo>? Localizer { get; set; }
[Inject]
[NotNull]
private IStringLocalizer<TablesFilter>? FilterLocalizer { get; set; }
[Inject]
[NotNull]
private IOptionsMonitor<WebsiteOptions>? WebsiteOption { get; set; }
private string SortString { get; set; } = "DateTime desc, Address";
private string ComponentSourceCodeUrl => $"{WebsiteOption.CurrentValue.BootstrapBlazorLink}/blob/main/src/BootstrapBlazor.Shared/Samples/Table/CustomerFilter.razor";
/// <summary>
/// OnInitialized 方法
/// </summary>
protected override void OnInitialized()
{
base.OnInitialized();
Items = Foo.GenerateFoo(Localizer);
}
private Task<QueryData<Foo>> OnQueryAsync(QueryPageOptions options)
{
IEnumerable<Foo> items = Items;
// 过滤
var isFiltered = false;
if (options.Filters.Any())
{
items = items.Where(options.Filters.GetFilterFunc<Foo>());
isFiltered = true;
}
// 排序
var isSorted = false;
// 此段代码可不写，组件内部自行处理
if (options.SortName == nameof(Foo.DateTime) && options.SortList != null)
{
var sortInvoker = Utility.GetSortListFunc<Foo>();
items = sortInvoker(items, options.SortList);
isSorted = true;
}
else if (!string.IsNullOrEmpty(options.SortName))
{
// 外部未进行排序，内部自动进行排序处理
var invoker = Utility.GetSortFunc<Foo>();
items = invoker(items, options.SortName, options.SortOrder);
isSorted = true;
}
// 设置记录总数
var total = items.Count();
// 内存分页
items = items.Skip((options.PageIndex - 1) * options.PageItems).Take(options.PageItems).ToList();
return Task.FromResult(new QueryData<Foo>()
{
Items = items,
TotalCount = total,
IsSorted = isSorted,
IsFiltered = isFiltered
});
}
private static string OnSort(string sortName, SortOrder sortOrder)
{
string sortString = "";
if (sortName == nameof(Foo.DateTime))
{
if (sortOrder == SortOrder.Asc)
{
sortString = "DateTime, Count";
}
else if (sortOrder == SortOrder.Desc)
{
sortString = "DateTime desc, Count desc";
}
else
{
sortString = "DateTime desc, Count";
}
}
return sortString;
}
[NotNull]
private Table<Foo>? TableSetFilter { get; set; }
private async Task SetFilterInCode()
{
//Find Column
var column = TableSetFilter.Columns.First(x => x.GetFieldName() == nameof(Foo.Name));
//Build Filter
var filters = new List<FilterKeyValueAction>()
{
new FilterKeyValueAction { FieldValue = "01", FilterAction = FilterAction.Contains }
};
//Set Filter
var filterAction = column.Filter?.FilterAction;
if (filterAction != null)
{
await filterAction.SetFilterConditionsAsync(filters);
}
}
private Task ResetAllFilters() => TableSetFilter.ResetFilters();
}
