Skip to content

Update grid docs, metadata, and add new screenshots #1235

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
gvreddy04 merged 4 commits into from
Jan 4, 2026
Merged

Update grid docs, metadata, and add new screenshots #1235

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
0e398c4
Update grid docs, metadata, and add new screenshots
gvreddy04 Jan 3, 2026
1c3a3c1
Update AdditionalAttributes to nullable; fix docs section order
gvreddy04 Jan 3, 2026
5402910
Add API metadata attributes and improve null-safety
gvreddy04 Jan 4, 2026
4b76294
Improve Grid docs, type safety, and API clarity
gvreddy04 Jan 4, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 22 additions & 10 deletions BlazorBootstrap.Demo.RCL/Components/Pages/Docs/Grid/Grid_Doc_01_Documentation.razor
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,43 +15,55 @@
</Section>

<Section Class="p-0" Size="HeadingSize.H3" Name="Grid Parameters" PageUrl="@pageUrl" Link="grid-parameters">
<DocxTable TItem="Grid<object>" DocType="DocType.Parameters" />
<DocxTable TItem="Grid<TItem>" DocType="DocType.Parameters" />
</Section>

<Section Class="p-0" Size="HeadingSize.H3" Name="Grid Methods" PageUrl="@pageUrl" Link="grid-methods">
<DocxTable TItem="Grid<object>" DocType="DocType.Methods" />
<DocxTable TItem="Grid<TItem>" DocType="DocType.Methods" />
</Section>

<Section Class="p-0" Size="HeadingSize.H3" Name="Grid Events" PageUrl="@pageUrl" Link="grid-events">
<DocxTable TItem="Grid<object>" DocType="DocType.Events" />
<DocxTable TItem="Grid<TItem>" DocType="DocType.Events" />
</Section>

<Section Class="p-0" Size="HeadingSize.H3" Name="GridColumn Parameters" PageUrl="@pageUrl" Link="grid-column-parameters">
<DocxTable TItem="GridColumn<object>" DocType="DocType.Parameters" />
<Section Class="p-0" Size="HeadingSize.H3" Name="GridSettings Properties" PageUrl="@pageUrl" Link="grid-settings-properties">
<DocxTable TItem="GridSettings" DocType="DocType.Properties" />
</Section>

<Section Class="p-0" Size="HeadingSize.H3" Name="GridColumns Parameters" PageUrl="@pageUrl" Link="grid-columns-parameters">
<DocxTable TItem="GridColumns" DocType="DocType.Parameters" />
</Section>

<Section Class="p-0" Size="HeadingSize.H3" Name="GridColumn Parameters" PageUrl="@pageUrl" Link="grid-column-parameters">
<DocxTable TItem="GridColumn<object>" DocType="DocType.Parameters" />
<DocxTable TItem="GridColumn<TItem>" DocType="DocType.Parameters" />
</Section>

<Section Class="p-0" Size="HeadingSize.H3" Name="GridDetailView Parameters" PageUrl="@pageUrl" Link="grid-detailview-parameters">
<DocxTable TItem="GridDetailView<object>" DocType="DocType.Parameters" />
<DocxTable TItem="GridDetailView<TItem>" DocType="DocType.Parameters" />
</Section>

<Section Class="p-0" Size="HeadingSize.H3" Name="GridSettings Properties" PageUrl="@pageUrl" Link="grid-settings-properties">
<DocxTable TItem="GridSettings" DocType="DocType.Properties" />
<Section Class="p-0" Size="HeadingSize.H3" Name="GridTemplates Parameters" PageUrl="@pageUrl" Link="grid-templates-parameters">
<DocxTable TItem="GridTemplates" DocType="DocType.Parameters" />
</Section>

<Section Class="p-0" Size="HeadingSize.H3" Name="GridEmptyDataTemplate Parameters" PageUrl="@pageUrl" Link="grid-empty-data-templates-parameters">
<DocxTable TItem="GridEmptyDataTemplate<TItem>" DocType="DocType.Parameters" />
</Section>

<Section Class="p-0" Size="HeadingSize.H3" Name="GridLoadingTemplate Parameters" PageUrl="@pageUrl" Link="grid-loading-template-parameters">
<DocxTable TItem="GridLoadingTemplate<TItem>" DocType="DocType.Parameters" />
</Section>

@code {
private const string componentName = nameof(Grid<object>);
private const string componentName = nameof(Grid<TItem>);
private const string pageUrl = DemoRouteConstants.Docs_URL_Grid;
private const string pageTitle = componentName;
private const string pageDescription = $"This documentation provides a comprehensive reference for the <code>{componentName}</code> component, guiding you through its configuration options.";
private const string metaTitle = $"Blazor {componentName} Component";
private const string metaDescription = $"This documentation provides a comprehensive reference for the {componentName} component, guiding you through its configuration options.";
private const string imageUrl = DemoScreenshotSrcConstants.Demos_URL_Grid_Overview;

public class TItem : object
{
}
}
6 changes: 3 additions & 3 deletions BlazorBootstrap.Demo.RCL/Constants/DemoScreenshotSrcConstants.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,15 +50,15 @@ public class DemoScreenshotSrcConstants

#region Grid
public const string Demos_URL_Grid_Prefix = DemoScreenshotSrcPrefix + "grid.png";
public const string Demos_URL_Grid_Overview = DemoScreenshotSrcPrefix + "home.png";
public const string Demos_URL_Grid_Overview = DemoScreenshotSrcPrefix + "grid_fixed_header_freeze_columns.png";
public const string Demos_URL_Grid_Alignment = DemoScreenshotSrcPrefix + "home.png";
public const string Demos_URL_Grid_CustomCSSClass = DemoScreenshotSrcPrefix + "home.png";
public const string Demos_URL_Grid_DataBinding = DemoScreenshotSrcPrefix + "home.png";
public const string Demos_URL_Grid_DetailView = DemoScreenshotSrcPrefix + "home.png";
public const string Demos_URL_Grid_Events = DemoScreenshotSrcPrefix + "home.png";
public const string Demos_URL_Grid_Filters = DemoScreenshotSrcPrefix + "home.png";
public const string Demos_URL_Grid_FixedHeader = DemoScreenshotSrcPrefix + "home.png";
public const string Demos_URL_Grid_FreezeColumns = DemoScreenshotSrcPrefix + "home.png";
public const string Demos_URL_Grid_FixedHeader = DemoScreenshotSrcPrefix + "grid_fixed_header_freeze_columns.png";
public const string Demos_URL_Grid_FreezeColumns = DemoScreenshotSrcPrefix + "grid_fixed_header_freeze_columns.png";
public const string Demos_URL_Grid_Settings = DemoScreenshotSrcPrefix + "home.png";
public const string Demos_URL_Grid_NestedGrid = DemoScreenshotSrcPrefix + "home.png";
public const string Demos_URL_Grid_Paging = DemoScreenshotSrcPrefix + "home.png";
Expand Down
Binary file added BlazorBootstrap.Demo.RCL/wwwroot/images/screenshots/grid_detail_view.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added ...tstrap.Demo.RCL/wwwroot/images/screenshots/grid_fixed_header_freeze_columns.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added BlazorBootstrap.Demo.RCL/wwwroot/images/screenshots/grid_nested_grid.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added BlazorBootstrap.Demo.RCL/wwwroot/images/screenshots/grid_translations.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion blazorbootstrap/Components/Core/BlazorBootstrapComponentBase.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -148,7 +148,7 @@ protected virtual ValueTask DisposeAsyncCore(bool disposing)
[Description("Gets or sets additional attributes that will be applied to the component.")]
[ParameterTypeName("Dictionary<string, object>")]
[Parameter(CaptureUnmatchedValues = true)]
public Dictionary<string, object> AdditionalAttributes { get; set; } = default!;
public Dictionary<string, object>? AdditionalAttributes { get; set; }

/// <summary>
/// Gets or sets the CSS class name(s) to apply to the component.
Expand Down
2 changes: 1 addition & 1 deletion blazorbootstrap/Components/Core/BlazorBootstrapLayoutComponentBase.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -141,7 +141,7 @@ protected virtual ValueTask DisposeAsyncCore(bool disposing)
[Description("Gets or sets additional attributes that will be applied to the component.")]
[Parameter(CaptureUnmatchedValues = true)]
[ParameterTypeName("Dictionary<string, object>")]
public Dictionary<string, object> AdditionalAttributes { get; set; } = default!;
public Dictionary<string, object>? AdditionalAttributes { get; set; }

/// <summary>
/// Gets or sets the CSS class name(s) to apply to the component.
Expand Down
Loading
Loading