Skip to content

Commit 1982bf3

Browse files
gvreddy04gvreddy04
committed
Update docs: correct links & tables for each component
Updated documentation for AutoComplete, CheckboxInput, ConfirmDialog, CurrencyInput, DateInput, Dropdown, and EnumInput: - Demo links now point to the correct component demos. - Parameter, method, and event tables reference the correct component types instead of Alert. - Dropdown docs now include sections for subcomponents (ToggleButton, ActionButton, Menu, Header, Item). - ConfirmDialog docs include ConfirmDialogOptions members. - Updated componentName and pageUrl variables for accuracy. - Added placeholder TEnum in EnumInput docs. These changes improve accuracy and clarity of the component documentation.
1 parent 944e77a commit 1982bf3

7 files changed

Lines changed: 68 additions & 50 deletions

File tree

‎BlazorBootstrap.Demo.RCL/Components/Pages/Docs/ConfirmDialog/ConfirmDialog_Doc_01_Documentation.razor‎

Lines changed: 7 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -8,27 +8,23 @@
88
MetaDescription="@metaDescription"
99
ImageUrl="@imageUrl" />
1010

11-
<DemoLink Href="@DemoRouteConstants.Demos_URL_Alerts" />
11+
<DemoLink Href="@DemoRouteConstants.Demos_URL_ConfirmDialog" />
1212

1313
<Section Class="p-0" Size="HeadingSize.H3" Name="Screenshot" PageUrl="@pageUrl" Link="screenshot">
1414
<img src="@imageUrl" class="img-fluid" alt="@metaTitle" />
1515
</Section>
1616

17-
<Section Class="p-0" Size="HeadingSize.H3" Name="Parameters" PageUrl="@pageUrl" Link="parameters">
18-
<DocxTable TItem="Alert" DocType="DocType.Parameters" />
17+
<Section Class="p-0" Size="HeadingSize.H3" Name="ConfirmDialog Parameters" PageUrl="@pageUrl" Link="confirm-dialog-parameters">
18+
<DocxTable TItem="ConfirmDialog" DocType="DocType.Parameters" />
1919
</Section>
2020

21-
<Section Class="p-0" Size="HeadingSize.H3" Name="Methods" PageUrl="@pageUrl" Link="methods">
22-
<DocxTable TItem="Alert" DocType="DocType.Methods" />
23-
</Section>
24-
25-
<Section Class="p-0" Size="HeadingSize.H3" Name="Events" PageUrl="@pageUrl" Link="events">
26-
<DocxTable TItem="Alert" DocType="DocType.Events" />
21+
<Section Class="p-0" Size="HeadingSize.H3" Name="ConfirmDialogOptions Members" PageUrl="@pageUrl" Link="confirm-dialog-options-parameters">
22+
<DocxTable TItem="ConfirmDialogOptions" DocType="DocType.Parameters" />
2723
</Section>
2824

2925
@code {
30-
private const string componentName = nameof(Alert);
31-
private const string pageUrl = DemoRouteConstants.Docs_URL_Alerts;
26+
private const string componentName = nameof(ConfirmDialog);
27+
private const string pageUrl = DemoRouteConstants.Docs_URL_ConfirmDialog;
3228
private const string pageTitle = componentName;
3329
private const string pageDescription = $"This documentation provides a comprehensive reference for the <code>{componentName}</code> component, guiding you through its configuration options.";
3430
private const string metaTitle = $"Blazor {componentName} Component";

‎BlazorBootstrap.Demo.RCL/Components/Pages/Docs/Dropdowns/Dropdown_Doc_01_Documentation.razor‎

Lines changed: 29 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -8,27 +8,47 @@
88
MetaDescription="@metaDescription"
99
ImageUrl="@imageUrl" />
1010

11-
<DemoLink Href="@DemoRouteConstants.Demos_URL_Alerts" />
11+
<DemoLink Href="@DemoRouteConstants.Demos_URL_Dropdown" />
1212

1313
<Section Class="p-0" Size="HeadingSize.H3" Name="Screenshot" PageUrl="@pageUrl" Link="screenshot">
1414
<img src="@imageUrl" class="img-fluid" alt="@metaTitle" />
1515
</Section>
1616

17-
<Section Class="p-0" Size="HeadingSize.H3" Name="Parameters" PageUrl="@pageUrl" Link="parameters">
18-
<DocxTable TItem="Alert" DocType="DocType.Parameters" />
17+
<Section Class="p-0" Size="HeadingSize.H3" Name="Dropdown Parameters" PageUrl="@pageUrl" Link="dropdown-parameters">
18+
<DocxTable TItem="Dropdown" DocType="DocType.Parameters" />
1919
</Section>
2020

21-
<Section Class="p-0" Size="HeadingSize.H3" Name="Methods" PageUrl="@pageUrl" Link="methods">
22-
<DocxTable TItem="Alert" DocType="DocType.Methods" />
21+
<Section Class="p-0" Size="HeadingSize.H3" Name="Dropdown Methods" PageUrl="@pageUrl" Link="dropdown-methods">
22+
<DocxTable TItem="Dropdown" DocType="DocType.Methods" />
2323
</Section>
2424

25-
<Section Class="p-0" Size="HeadingSize.H3" Name="Events" PageUrl="@pageUrl" Link="events">
26-
<DocxTable TItem="Alert" DocType="DocType.Events" />
25+
<Section Class="p-0" Size="HeadingSize.H3" Name="Dropdown Events" PageUrl="@pageUrl" Link="dropdown-events">
26+
<DocxTable TItem="Dropdown" DocType="DocType.Events" />
27+
</Section>
28+
29+
<Section Class="p-0" Size="HeadingSize.H3" Name="DropdownToggleButton Parameters" PageUrl="@pageUrl" Link="dropdown-toggle-button-parameters">
30+
<DocxTable TItem="DropdownToggleButton" DocType="DocType.Parameters" />
31+
</Section>
32+
33+
<Section Class="p-0" Size="HeadingSize.H3" Name="DropdownActionButton Parameters" PageUrl="@pageUrl" Link="dropdown-action-button-parameters">
34+
<DocxTable TItem="DropdownActionButton" DocType="DocType.Parameters" />
35+
</Section>
36+
37+
<Section Class="p-0" Size="HeadingSize.H3" Name="DropdownMenu Parameters" PageUrl="@pageUrl" Link="dropdown-menu-parameters">
38+
<DocxTable TItem="DropdownMenu" DocType="DocType.Parameters" />
39+
</Section>
40+
41+
<Section Class="p-0" Size="HeadingSize.H3" Name="DropdownHeader Parameters" PageUrl="@pageUrl" Link="dropdown-header-parameters">
42+
<DocxTable TItem="DropdownHeader" DocType="DocType.Parameters" />
43+
</Section>
44+
45+
<Section Class="p-0" Size="HeadingSize.H3" Name="Dropdown Parameters" PageUrl="@pageUrl" Link="dropdown-item-parameters">
46+
<DocxTable TItem="DropdownItem" DocType="DocType.Parameters" />
2747
</Section>
2848

2949
@code {
30-
private const string componentName = nameof(Alert);
31-
private const string pageUrl = DemoRouteConstants.Docs_URL_Alerts;
50+
private const string componentName = nameof(Dropdown);
51+
private const string pageUrl = DemoRouteConstants.Docs_URL_Dropdown;
3252
private const string pageTitle = componentName;
3353
private const string pageDescription = $"This documentation provides a comprehensive reference for the <code>{componentName}</code> component, guiding you through its configuration options.";
3454
private const string metaTitle = $"Blazor {componentName} Component";

‎BlazorBootstrap.Demo.RCL/Components/Pages/Docs/Form/AutoComplete/AutoComplete_Doc_01_Documentation.razor‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -8,27 +8,27 @@
88
MetaDescription="@metaDescription"
99
ImageUrl="@imageUrl" />
1010

11-
<DemoLink Href="@DemoRouteConstants.Demos_URL_Alerts" />
11+
<DemoLink Href="@DemoRouteConstants.Demos_URL_AutoComplete" />
1212

1313
<Section Class="p-0" Size="HeadingSize.H3" Name="Screenshot" PageUrl="@pageUrl" Link="screenshot">
1414
<img src="@imageUrl" class="img-fluid" alt="@metaTitle" />
1515
</Section>
1616

1717
<Section Class="p-0" Size="HeadingSize.H3" Name="Parameters" PageUrl="@pageUrl" Link="parameters">
18-
<DocxTable TItem="Alert" DocType="DocType.Parameters" />
18+
<DocxTable TItem="AutoComplete<object>" DocType="DocType.Parameters" />
1919
</Section>
2020

2121
<Section Class="p-0" Size="HeadingSize.H3" Name="Methods" PageUrl="@pageUrl" Link="methods">
22-
<DocxTable TItem="Alert" DocType="DocType.Methods" />
22+
<DocxTable TItem="AutoComplete<object>" DocType="DocType.Methods" />
2323
</Section>
2424

2525
<Section Class="p-0" Size="HeadingSize.H3" Name="Events" PageUrl="@pageUrl" Link="events">
26-
<DocxTable TItem="Alert" DocType="DocType.Events" />
26+
<DocxTable TItem="AutoComplete<object>" DocType="DocType.Events" />
2727
</Section>
2828

2929
@code {
30-
private const string componentName = nameof(Alert);
31-
private const string pageUrl = DemoRouteConstants.Docs_URL_Alerts;
30+
private const string componentName = nameof(AutoComplete<object>);
31+
private const string pageUrl = DemoRouteConstants.Docs_URL_AutoComplete;
3232
private const string pageTitle = componentName;
3333
private const string pageDescription = $"This documentation provides a comprehensive reference for the <code>{componentName}</code> component, guiding you through its configuration options.";
3434
private const string metaTitle = $"Blazor {componentName} Component";

‎BlazorBootstrap.Demo.RCL/Components/Pages/Docs/Form/CheckboxInput/CheckboxInput_Doc_01_Documentation.razor‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -8,27 +8,27 @@
88
MetaDescription="@metaDescription"
99
ImageUrl="@imageUrl" />
1010

11-
<DemoLink Href="@DemoRouteConstants.Demos_URL_Alerts" />
11+
<DemoLink Href="@DemoRouteConstants.Demos_URL_CheckboxInput" />
1212

1313
<Section Class="p-0" Size="HeadingSize.H3" Name="Screenshot" PageUrl="@pageUrl" Link="screenshot">
1414
<img src="@imageUrl" class="img-fluid" alt="@metaTitle" />
1515
</Section>
1616

1717
<Section Class="p-0" Size="HeadingSize.H3" Name="Parameters" PageUrl="@pageUrl" Link="parameters">
18-
<DocxTable TItem="Alert" DocType="DocType.Parameters" />
18+
<DocxTable TItem="CheckboxInput" DocType="DocType.Parameters" />
1919
</Section>
2020

2121
<Section Class="p-0" Size="HeadingSize.H3" Name="Methods" PageUrl="@pageUrl" Link="methods">
22-
<DocxTable TItem="Alert" DocType="DocType.Methods" />
22+
<DocxTable TItem="CheckboxInput" DocType="DocType.Methods" />
2323
</Section>
2424

2525
<Section Class="p-0" Size="HeadingSize.H3" Name="Events" PageUrl="@pageUrl" Link="events">
26-
<DocxTable TItem="Alert" DocType="DocType.Events" />
26+
<DocxTable TItem="CheckboxInput" DocType="DocType.Events" />
2727
</Section>
2828

2929
@code {
30-
private const string componentName = nameof(Alert);
31-
private const string pageUrl = DemoRouteConstants.Docs_URL_Alerts;
30+
private const string componentName = nameof(CheckboxInput);
31+
private const string pageUrl = DemoRouteConstants.Docs_URL_CheckboxInput;
3232
private const string pageTitle = componentName;
3333
private const string pageDescription = $"This documentation provides a comprehensive reference for the <code>{componentName}</code> component, guiding you through its configuration options.";
3434
private const string metaTitle = $"Blazor {componentName} Component";

‎BlazorBootstrap.Demo.RCL/Components/Pages/Docs/Form/CurrencyInput/CurrencyInput_Doc_01_Documentation.razor‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -8,27 +8,27 @@
88
MetaDescription="@metaDescription"
99
ImageUrl="@imageUrl" />
1010

11-
<DemoLink Href="@DemoRouteConstants.Demos_URL_Alerts" />
11+
<DemoLink Href="@DemoRouteConstants.Demos_URL_CurrencyInput" />
1212

1313
<Section Class="p-0" Size="HeadingSize.H3" Name="Screenshot" PageUrl="@pageUrl" Link="screenshot">
1414
<img src="@imageUrl" class="img-fluid" alt="@metaTitle" />
1515
</Section>
1616

1717
<Section Class="p-0" Size="HeadingSize.H3" Name="Parameters" PageUrl="@pageUrl" Link="parameters">
18-
<DocxTable TItem="Alert" DocType="DocType.Parameters" />
18+
<DocxTable TItem="CurrencyInput<object>" DocType="DocType.Parameters" />
1919
</Section>
2020

2121
<Section Class="p-0" Size="HeadingSize.H3" Name="Methods" PageUrl="@pageUrl" Link="methods">
22-
<DocxTable TItem="Alert" DocType="DocType.Methods" />
22+
<DocxTable TItem="CurrencyInput<object>" DocType="DocType.Methods" />
2323
</Section>
2424

2525
<Section Class="p-0" Size="HeadingSize.H3" Name="Events" PageUrl="@pageUrl" Link="events">
26-
<DocxTable TItem="Alert" DocType="DocType.Events" />
26+
<DocxTable TItem="CurrencyInput<object>" DocType="DocType.Events" />
2727
</Section>
2828

2929
@code {
30-
private const string componentName = nameof(Alert);
31-
private const string pageUrl = DemoRouteConstants.Docs_URL_Alerts;
30+
private const string componentName = nameof(CurrencyInput<object>);
31+
private const string pageUrl = DemoRouteConstants.Docs_URL_CurrencyInput;
3232
private const string pageTitle = componentName;
3333
private const string pageDescription = $"This documentation provides a comprehensive reference for the <code>{componentName}</code> component, guiding you through its configuration options.";
3434
private const string metaTitle = $"Blazor {componentName} Component";

‎BlazorBootstrap.Demo.RCL/Components/Pages/Docs/Form/DateInput/DateInput_Doc_01_Documentation.razor‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -8,27 +8,27 @@
88
MetaDescription="@metaDescription"
99
ImageUrl="@imageUrl" />
1010

11-
<DemoLink Href="@DemoRouteConstants.Demos_URL_Alerts" />
11+
<DemoLink Href="@DemoRouteConstants.Demos_URL_DateInput" />
1212

1313
<Section Class="p-0" Size="HeadingSize.H3" Name="Screenshot" PageUrl="@pageUrl" Link="screenshot">
1414
<img src="@imageUrl" class="img-fluid" alt="@metaTitle" />
1515
</Section>
1616

1717
<Section Class="p-0" Size="HeadingSize.H3" Name="Parameters" PageUrl="@pageUrl" Link="parameters">
18-
<DocxTable TItem="Alert" DocType="DocType.Parameters" />
18+
<DocxTable TItem="DateInput<object>" DocType="DocType.Parameters" />
1919
</Section>
2020

2121
<Section Class="p-0" Size="HeadingSize.H3" Name="Methods" PageUrl="@pageUrl" Link="methods">
22-
<DocxTable TItem="Alert" DocType="DocType.Methods" />
22+
<DocxTable TItem="DateInput<object>" DocType="DocType.Methods" />
2323
</Section>
2424

2525
<Section Class="p-0" Size="HeadingSize.H3" Name="Events" PageUrl="@pageUrl" Link="events">
26-
<DocxTable TItem="Alert" DocType="DocType.Events" />
26+
<DocxTable TItem="DateInput<object>" DocType="DocType.Events" />
2727
</Section>
2828

2929
@code {
30-
private const string componentName = nameof(Alert);
31-
private const string pageUrl = DemoRouteConstants.Docs_URL_Alerts;
30+
private const string componentName = nameof(DateInput<object>);
31+
private const string pageUrl = DemoRouteConstants.Docs_URL_DateInput;
3232
private const string pageTitle = componentName;
3333
private const string pageDescription = $"This documentation provides a comprehensive reference for the <code>{componentName}</code> component, guiding you through its configuration options.";
3434
private const string metaTitle = $"Blazor {componentName} Component";

‎BlazorBootstrap.Demo.RCL/Components/Pages/Docs/Form/EnumInput/EnumInput_Doc_01_Documentation.razor‎

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -8,30 +8,32 @@
88
MetaDescription="@metaDescription"
99
ImageUrl="@imageUrl" />
1010

11-
<DemoLink Href="@DemoRouteConstants.Demos_URL_Alerts" />
11+
<DemoLink Href="@DemoRouteConstants.Demos_URL_EnumInput" />
1212

1313
<Section Class="p-0" Size="HeadingSize.H3" Name="Screenshot" PageUrl="@pageUrl" Link="screenshot">
1414
<img src="@imageUrl" class="img-fluid" alt="@metaTitle" />
1515
</Section>
1616

1717
<Section Class="p-0" Size="HeadingSize.H3" Name="Parameters" PageUrl="@pageUrl" Link="parameters">
18-
<DocxTable TItem="Alert" DocType="DocType.Parameters" />
18+
<DocxTable TItem="EnumInput<TEnum>" DocType="DocType.Parameters" />
1919
</Section>
2020

2121
<Section Class="p-0" Size="HeadingSize.H3" Name="Methods" PageUrl="@pageUrl" Link="methods">
22-
<DocxTable TItem="Alert" DocType="DocType.Methods" />
22+
<DocxTable TItem="EnumInput<TEnum>" DocType="DocType.Methods" />
2323
</Section>
2424

2525
<Section Class="p-0" Size="HeadingSize.H3" Name="Events" PageUrl="@pageUrl" Link="events">
26-
<DocxTable TItem="Alert" DocType="DocType.Events" />
26+
<DocxTable TItem="EnumInput<TEnum>" DocType="DocType.Events" />
2727
</Section>
2828

2929
@code {
30-
private const string componentName = nameof(Alert);
31-
private const string pageUrl = DemoRouteConstants.Docs_URL_Alerts;
30+
private const string componentName = nameof(EnumInput<TEnum>);
31+
private const string pageUrl = DemoRouteConstants.Docs_URL_EnumInput;
3232
private const string pageTitle = componentName;
3333
private const string pageDescription = $"This documentation provides a comprehensive reference for the <code>{componentName}</code> component, guiding you through its configuration options.";
3434
private const string metaTitle = $"Blazor {componentName} Component";
3535
private const string metaDescription = $"This documentation provides a comprehensive reference for the {componentName} component, guiding you through its configuration options.";
3636
private const string imageUrl = "https://i.imgur.com/FGgEMp6.jpg";
37+
38+
public enum TEnum {}
3739
}

0 commit comments

Comments
 (0)