TASLibStandard 2.0.27

TASLibStandard

A .NET library for Web projects by True Arrow Software: data-grid HTML generation, SQL Server / MySQL data access, and everyday helpers, built for ASP.NET (net8.0).

Install

dotnet add package TASLibStandard

What's included

Setup

Register the library once in Program.cs: UseTASCore registers IGridFactory, and you register the IDatabase it (and your code) uses:

using TASLibStandard.Data;
using TASLibStandard.Utility;

builder.Services.UseTASCore(connectionString, DBUtilityProvider.SqlServer); // or DBUtilityProvider.MySQL
builder.Services.AddScoped<IDatabase>(_ => DBUtility.CreateDatabase(DBUtilityProvider.SqlServer, connectionString));

Then inject IDatabase for queries and IGridFactory for grids:

using TASLibStandard.Data;
using TASLibStandard.Grid;

public class ItemsController(IDatabase db, IGridFactory grids) : Controller
{
    public IActionResult Index()
    {
        // Typed query with parameters
        List<Item> items = db.GetData<Item>(
            "select Id, Name, Price from Items where Price > @min",
            [new Parameter("@min", 10)]);

        // Grid from the factory (already wired to the same database); configure it as shown below
        var grid = grids.Create<Item>();
        return Content(grid.GetGrid(), "text/html");
    }
}

Grid

The Grid<T> component (TASLibStandard.Grid namespace) generates a fully-featured HTML table from a SQL query or an API data source.

Key Features

Quick Start

using TASLibStandard.Grid;

var grid = new Grid<MyModel>
{
    PrimaryKeyFieldName = "Id",
    GridURL = "/items",
    AllowPagination = true,
    IsColumnSortable = true,
    PageSize = 25,
    Columns = new List<GridColumns>
    {
        new GridColumns { Header = "Name",       SortColumn = "Name",      FieldType = FieldType.STRING },
        new GridColumns { Header = "Price",      SortColumn = "Price",     FieldType = FieldType.CURRENCY },
        new GridColumns { Header = "Created",    SortColumn = "CreatedOn", FieldType = FieldType.DATE }
    },
    Icons = new List<GridAction>
    {
        new GridAction("data-action='edit'", ActionIcon.Edit.GetDescriptionfromValue()) { URL = "/items/edit/", RollOverText = "Edit" },
        new GridAction("data-action='delete'", ActionIcon.Delete.GetDescriptionfromValue()) { URL = "/items/delete/", RollOverText = "Delete" }
    }
};

// SQL data source (default)
grid.Query.SelectFrom = "Items";
grid.Query.SelectColumn = "Id, Name, Price, CreatedOn";
string html = grid.GetGrid();

Using an API Data Source

grid.DataSource = GridDataSource.API;
grid.ApiDataFetcher = (page, size, sortCol, sortDir) =>
{
    var result = myService.GetItems(page, size, sortCol, sortDir);
    return new ApiDataResult<MyModel>(result.Items, result.Total);
};

string html = grid.GetGrid();

Secondary value in a cell

A column can carry a second column drawn under its value, e.g. Company Code in grey under Company Name. Select both as plain columns (no HTML in the SQL); each part keeps its own sort and filter.

new GridColumns
{
    Header = "Company", SortColumn = "c.Name", FieldType = FieldType.STRING,
    Secondary = new GridColumns { Header = "Code", SortColumn = "c.Code", FieldType = FieldType.STRING }
}

• Cell: <div class="gridcell-main"> and <div class="gridcell-sub"> (left out when the value is empty); the <td> gets gridhassub. The library sets no colours: style .gridcell-sub in your CSS.
• Header: the column header, with (Code) below it (gridhead-sub). Each is its own sort link (by=c.Name / by=c.Code).
• Filter row (EnableFilters): one cell, the main filter with the secondary's under it, posted as grid-{UniqueName}-Name and grid-{UniqueName}-Code (the field names). As always the grid does not filter: read GetFilterValue("Code") and add a Query.Conditions entry on c.Code. Secondary.DisableFilter / Secondary.Filter work as on any column. Two filters with one name throw when GenericSettings.ThrowException is on.
• Totals: ShowRowTotal only totals the main column; the secondary's total is not shown.
• Only one level: a Secondary's own Secondary is ignored.

Sort column safety

With the SQL data source, Directionby (the by of the URL) goes into ORDER BY. Only column names are accepted (Name, c.Name, [Name] or a comma list of them); anything else is dropped and the default sort is used.

Core Types

License

MIT © True Arrow Software