BlazorSplitGrid 1.2.0
There is a newer version of this package available.
See the version list below for details.
See the version list below for details.
dotnet add package BlazorSplitGrid --version 1.2.0
NuGet\Install-Package BlazorSplitGrid -Version 1.2.0
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="BlazorSplitGrid" Version="1.2.0" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
<PackageVersion Include="BlazorSplitGrid" Version="1.2.0" />
<PackageReference Include="BlazorSplitGrid" />
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 BlazorSplitGrid --version 1.2.0
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
#r "nuget: BlazorSplitGrid, 1.2.0"
#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 BlazorSplitGrid@1.2.0
#: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=BlazorSplitGrid&version=1.2.0
#tool nuget:?package=BlazorSplitGrid&version=1.2.0
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
Blazor Split Grid
A basic Blazor component wrapper around Split Grid.
Getting Started
Quick Installation Guide
- Install the Nuget Package
dotnet add package BlazorSplit - Add namespace reference to your
_Imports.razor@using BlazorSplitGrid
Optional CSS
You can add basic gutter styling by including the following link in your html head section
<link href="_content/BlazorSplitGrid/BlazorSplitGrid.min.css" rel="stylesheet" />
Usage
Blazor Split Grid will automatically generate the track number and classes for your gutters so all you need to specify is whether the gutter is a row or column.
<SplitGrid SnapOffset="0" DragInterval="1" MaxSize="850">
<SplitGridContent></SplitGridContent>
<SplitGridColumn />
<SplitGridContent></SplitGridContent>
<SplitGridContent></SplitGridContent>
<SplitGridRow />
<SplitGridContent></SplitGridContent>
</SplitGrid>
Example
See the example project for a more comprehensive example.
API Reference
SplitGrid
You are able to specify all the Split Grid options on the top level SplitGrid component except the row and column gutters.
| Attribute | Type | Default | Description |
|---|---|---|---|
| MinSize | int | 0 | The minimum size in pixels for all tracks. |
| MaxSize | int | Infinity | The maximum size in pixels for all tracks. |
| ColumnMinSize | int | MinSize | The minimum size in pixels for all tracks. |
| RowMinSize | int | MinSize | The minimum size in pixels for all tracks. |
| ColumnMaxSize | int | MaxSize | The maximum size in pixels for all tracks. |
| RowMaxSize | int | MaxSize | The maximum size in pixels for all tracks. |
| ColumnMinSizes | Dictionary<int, int> | ColumnMinSize | An object keyed by track index, with values set to the minimum size in pixels for the track at that index. Allows individual minSizes to be specified by track. Note this option is plural with an s, while the two fallback options are singular. |
| RowMinSizes | Dictionary<int, int> | RowMinSize | object keyed by track index, with values set to the minimum size in pixels for the track at that index. Allows individual minSizes to be specified by track. Note this option is plural with an s, while the two fallback options are singular. |
| ColumnMaxSizes | Dictionary<int, int> | ColumnMaxSize | An object keyed by track index, with values set to the maximum size in pixels for the track at that index. Allows individual maxSizes to be specified by track. Note this option is plural with an s, while the two fallback options are singular. |
| RowMaxSizes | Dictionary<int, int> | RowMaxSize | An object keyed by track index, with values set to the maximum size in pixels for the track at that index. Allows individual maxSizes to be specified by track. Note this option is plural with an s, while the two fallback options are singular. |
| SnapOffset | int | 30 | Snap to minimum size at this offset in pixels. Set to 0 to disable snap. |
| ColumnSnapOffset | int | SnapOffset | Snap to minimum size at this offset in pixels. Set to 0 to disable snap. |
| RowSnapOffset | int | SnapOffset | Snap to minimum size at this offset in pixels. Set to 0 to disable snap. |
| DragInterval | int | 1 | Drag this number of pixels at a time. Defaults to 1 for smooth dragging, but can be set to a pixel value to give more control over the resulting sizes. |
| ColumnDragInterval | int | DragInterval | Drag this number of pixels at a time. Defaults to 1 for smooth dragging, but can be set to a pixel value to give more control over the resulting sizes. |
| RowDragInterval | int | DragInterval | Drag this number of pixels at a time. Defaults to 1 for smooth dragging, but can be set to a pixel value to give more control over the resulting sizes. |
| Cursor | string | 'col-resize' and 'row-resize' | Cursor to show while dragging. Defaults to 'col-resize' for column gutters and 'row-resize' for row gutters. |
| ColumnCursor | string | 'col-resize' | Cursor to show while dragging. |
| RowCursor | string | 'row-resize' | Cursor to show while dragging. |
| OnDrag | DragEventArgs | - | Called continuously on drag. For process intensive code, add a debounce function to rate limit this callback. gridTemplateStyle is the computed CSS value for grid-template-column or grid-template-row, depending on direction. |
| OnDragStart | DragEventArgs | - | Called on drag start. |
| OnDragEnd | DragEventArgs | - | Called on drag end. |
SplitGridRow / SplitGridColumn
You can specify the MinSize and MaxSize on the gutters which is automatically added to the ColumnMinSizes/RowMinSizes and ColumnMaxSizes/RowMaxSizes properties.
| Attribute | Type | Default | Description |
|---|---|---|---|
| MinSize | int | 0 | The minimum size in pixels for this track. |
| MaxSize | int | Infinity | The maximum size in pixels for this track. |
| Product | Versions Compatible and additional computed target framework versions. |
|---|---|
| .NET | net6.0 is compatible. net6.0-android was computed. net6.0-ios was computed. net6.0-maccatalyst was computed. net6.0-macos was computed. net6.0-tvos was computed. net6.0-windows was computed. net7.0 is compatible. net7.0-android was computed. net7.0-ios was computed. net7.0-maccatalyst was computed. net7.0-macos was computed. net7.0-tvos was computed. net7.0-windows was computed. net8.0 was computed. 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 was computed. 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 was computed. 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.
-
net6.0
- Microsoft.AspNetCore.Components (>= 6.0.16)
- Microsoft.AspNetCore.Components.Web (>= 6.0.16)
-
net7.0
- Microsoft.AspNetCore.Components (>= 7.0.5)
- Microsoft.AspNetCore.Components.Web (>= 7.0.5)
NuGet packages
This package is not used by any NuGet packages.
GitHub repositories
This package is not used by any popular GitHub repositories.