Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/masbicudo/masb.mvc.tablebuilder
Minimalist ASP.NET MVC Html Helper to help rendering tabular data, by creating table templates.
https://github.com/masbicudo/masb.mvc.tablebuilder
Last synced: 3 days ago
JSON representation
Minimalist ASP.NET MVC Html Helper to help rendering tabular data, by creating table templates.
- Host: GitHub
- URL: https://github.com/masbicudo/masb.mvc.tablebuilder
- Owner: masbicudo
- License: apache-2.0
- Created: 2014-07-14T02:45:33.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2015-02-14T02:47:04.000Z (almost 10 years ago)
- Last Synced: 2025-01-10T19:09:43.271Z (8 days ago)
- Language: C#
- Size: 738 KB
- Stars: 1
- Watchers: 3
- Forks: 0
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Masb Mvc TableBuilder
=====================
Minimalist ASP.NET MVC Html Helper to help rendering tabular data, by creating table templates.
The real objective here is not to render any HTML.
This is the programmer's role.
There are so many helpers that render tables...
**[NuGet Package](https://www.nuget.org/packages/Masb.Mvc.TableBuilder)**
PM> Install-Package Masb.Mvc.TableBuilder
It's all about separation
-------------------------
This tool is like a knive, in that it splits these aspects of a table:
- table contents
- table frame
This separation lets you create table components.
What this does not do
---------------------
- doesn't hide the table frame rendering from you... as most helpers already do
- doesn't hide table content rendering... most helpers also do this to some extent
- doesn't hide any HTML rendering from the programmer (or designer)
- little exception: the hidden field for editing collections name like "Collection.Index"
Sample
------
This is a sample `TableTemplateFor`... it creates a template only. Nothing will be rendered yet.
You can place this in your cshtml view file:
```csharp
@{
// creating a table template for the collection "Rows" of my model object
var tableTemplate = this.Html
.TableTemplateFor(m => m.Rows)
// defining two column-level sections
// these must be defined for each column
.SetColumnSections("ColumnGroup", "HeaderHint")
// adding property-specific columns
// the submodel of this column will be the type of the property
.AddColumnFor(m => m.PersonName,
@
@item.Meta.GetDisplayName(), // defining header cells of the column
@@item.Html.EditorFor(m => m), // defining the data cells of the column
@, // defining "ColumnGroup" column-section
@Name of the person) // defining "HeaderHint" column-section
.AddColumnFor(m => m.BirthDate,
@@item.Meta.GetDisplayName(),
@@item.Html.EditorFor(m => m),
null, // you can set a column-section to null
@Date of birth) // null means 'undefined'
.AddColumnFor(m => m.Age,
@@item.Meta.GetDisplayName(),
@@item.Html.EditorFor(m => m),
null,
@Age of person)
// adding a column that is not property-specific
// same as above, but without a property indication
// the submodel of this column will be the type of the items in "Rows" collection
.AddColumn(
@Male/Female property,
@@(item.Model == null || item.Model.Gender == GenderKinds.Male
? item.Html.EditorFor(m => m.MaleProp)
: item.Html.EditorFor(m => m.FemaleProp))
,
@,
@Male or female conditional editor)
// adding a table-level section
.AddSection("Empty", @Table is empty)
;
}
// Continue reading! You still need to render the created template...
```
Next, there is a case use of `Table`, passing the previously created `TableTemplate`.
This is where the template is rendered into a table frame.
This could be defined in another file such as a custom helper (defined in the App_Code folder):
```csharp
@helper MyCustomTable(HtmlHelper html, ITableTemplate tableTemplate)
{
var table = html.Table(tableTemplate);
@{
// getting all items... just testing (so to show that it is possible)
// and rendering these models to JSON
var allItems = table.Items.Select(item => item.Html.ViewData.Model).ToArray();
Models = @(html.Raw(new JavaScriptSerializer().Serialize(allItems)));
var header = table.Header;
@foreach (var headerColumn in header.Cells)
{
// rendering the section "ColumnGroup",
// passing a default HTML to use when the section is not defined
@headerColumn.RenderSection("ColumnGroup", @)
// rendering something using `IsSectionDefined`
if (headerColumn.IsSectionDefined("ColumnGroup"))
{
}
}
@foreach (var headerColumn in header.Cells)
{
// Rendering section "HeaderHint"... this section is required
// since the single parameter overload is used.
// Then we render the content of the header cell with `Render`.
@headerColumn.Render()
}
}
@if (table.Items.Any())
{
// rendering table items, if any
@foreach (var item in table.Items)
{
@item.RenderIndexHiddenField()
@foreach (var itemColumn in item.Cells)
{
// rendering table data cells
@itemColumn.Render()
}
}
@{
// rendering a row that allows new items to be inserted
var newItem = table.NewItem(int.MaxValue, null);
@newItem.RenderIndexHiddenField()
@foreach (var itemColumn in newItem.Cells)
{
@itemColumn.Render()
}
}
}
else
{
// rendering the Empty table-level section
@table.RenderSection("Empty")
}
}
```
Finally, we can use this helper to render a table in the page:
```csharp
@MyCustomTable(this.Html, tableTemplate)
```