diff --git a/BlazorBootstrap.Demo.RCL/Components/Pages/Docs/SortableList/SortableList_Doc_01_Documentation.razor b/BlazorBootstrap.Demo.RCL/Components/Pages/Docs/SortableList/SortableList_Doc_01_Documentation.razor index 14ded19db..270439e47 100644 --- a/BlazorBootstrap.Demo.RCL/Components/Pages/Docs/SortableList/SortableList_Doc_01_Documentation.razor +++ b/BlazorBootstrap.Demo.RCL/Components/Pages/Docs/SortableList/SortableList_Doc_01_Documentation.razor @@ -15,19 +15,21 @@
- +
- +
@code { - private const string componentName = nameof(SortableList); + private const string componentName = nameof(SortableList); private const string pageUrl = DemoRouteConstants.Docs_URL_SortableList; private const string pageTitle = componentName; private const string pageDescription = $"This documentation provides a comprehensive reference for the {componentName} 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_SortableList; -} \ No newline at end of file + + public class TItem : object { } +} diff --git a/blazorbootstrap/Components/SortableList/SortableList.razor.cs b/blazorbootstrap/Components/SortableList/SortableList.razor.cs index 63f454fce..700ce28cb 100644 --- a/blazorbootstrap/Components/SortableList/SortableList.razor.cs +++ b/blazorbootstrap/Components/SortableList/SortableList.razor.cs @@ -80,151 +80,205 @@ public async Task OnUpdateJS(int oldIndex, int newIndex) /// /// Gets or sets a value indicating whether sorting is allowed for the list. + /// + /// Default value is . + /// /// - /// - /// Default value is true. - /// + [AddedVersion("2.2.0")] + [DefaultValue(true)] + [Description("Gets or sets a value indicating whether sorting is allowed for the list.")] [Parameter] public bool AllowSorting { get; set; } = true; /// /// Gets or sets the content to be rendered within the component. + /// + /// Default value is . + /// /// - /// - /// Default value is null. - /// + [AddedVersion("2.2.0")] + [DefaultValue(null)] + [Description("Gets or sets the content to be rendered within the component.")] [Parameter] - public RenderFragment ChildContent { get; set; } = default!; + public RenderFragment? ChildContent { get; set; } /// /// Gets or sets the items. + /// + /// Default value is . + /// /// - /// - /// Default value is null. - /// + [AddedVersion("2.2.0")] + [DefaultValue(null)] + [Description("Gets or sets the items.")] [Parameter] - public List Data { get; set; } = default!; + public List? Data { get; set; } /// /// Gets or sets the CSS class applied to disabled items. + /// + /// Default value is . + /// /// - /// - /// Default value is null. - /// + [AddedVersion("2.2.0")] + [DefaultValue(null)] + [Description("Gets or sets the CSS class applied to disabled items.")] [Parameter] - public string? DisabledItemCssClass { get; set; } = default!; + public string? DisabledItemCssClass { get; set; } /// /// Gets or sets a delegate that determines whether an item should be disabled. + /// + /// Default value is . + /// /// + [AddedVersion("2.2.0")] + [DefaultValue(null)] + [Description("Gets or sets a delegate that determines whether an item should be disabled.")] [Parameter] - public Func DisableItem { get; set; } = default!; + public Func? DisableItem { get; set; } /// /// Gets or sets the empty data template. + /// + /// Default value is . + /// /// - /// - /// Default value is null. - /// + [AddedVersion("2.2.0")] + [DefaultValue(null)] + [Description("Gets or sets the empty data template.")] [Parameter] - public RenderFragment EmptyDataTemplate { get; set; } = default!; + public RenderFragment? EmptyDataTemplate { get; set; } /// /// Gets or sets the text to display when there are no records in the list. - /// - /// + /// /// Default value is `No records to display`. - /// + /// + /// + [AddedVersion("2.2.0")] + [DefaultValue("No records to display")] + [Description("Gets or sets the text to display when there are no records in the list.")] [Parameter] public string EmptyText { get; set; } = "No records to display"; /// /// Gets or sets the group name associated with the list. + /// + /// Default value is . + /// /// - /// - /// Default value is null. - /// + [AddedVersion("2.2.0")] + [DefaultValue(null)] + [Description("Gets or sets the group name associated with the list.")] [Parameter] public string? Group { get; set; } /// /// Gets or sets the CSS selector for the drag handle element. + /// + /// Default value is . + /// /// - /// - /// Default value is null. - /// + [AddedVersion("2.2.0")] + [DefaultValue(null)] + [Description("Gets or sets the CSS selector for the drag handle element.")] [Parameter] public string? Handle { get; set; } /// /// Gets or sets the loading state. + /// + /// Default value is . + /// /// - /// - /// Default value is false. - /// + [AddedVersion("2.2.0")] + [DefaultValue(false)] + [Description("Gets or sets the loading state.")] [Parameter] public bool IsLoading { get; set; } /// /// Gets or sets the template used to render individual items in the list. + /// + /// Default value is . + /// /// - /// - /// Default value is null. - /// + [AddedVersion("2.2.0")] + [DefaultValue(null)] + [Description("Gets or sets the template used to render individual items in the list.")] [Parameter] public RenderFragment? ItemTemplate { get; set; } /// /// Gets or sets the loading template. + /// + /// Default value is . + /// /// - /// - /// Default value is null. - /// + [AddedVersion("2.2.0")] + [DefaultValue(null)] + [Description("Gets or sets the loading template.")] [Parameter] public RenderFragment LoadingTemplate { get; set; } = default!; /// /// Gets or sets the name of the component. + /// + /// Default value is . + /// /// - /// - /// Default value is null. - /// + [AddedVersion("2.2.0")] + [DefaultValue(null)] + [Description("Gets or sets the name of the SortableList{TItem} component.")] [Parameter] public string? Name { get; set; } /// /// Gets or sets an event callback that fires when an item is added to the list. /// + [AddedVersion("2.2.0")] + [Description("Gets or sets an event callback that fires when an item is added to the list.")] [Parameter] public EventCallback OnAdd { get; set; } /// /// Gets or sets an event callback that fires when an item is removed from the list. /// + [AddedVersion("2.2.0")] + [Description("Gets or sets an event callback that fires when an item is removed from the list.")] [Parameter] public EventCallback OnRemove { get; set; } /// /// Gets or sets an event callback that fires when an item is updated in the list. /// + [AddedVersion("2.2.0")] + [Description("Gets or sets an event callback that fires when an item is updated in the list.")] [Parameter] public EventCallback OnUpdate { get; set; } /// /// Gets or sets the pull mode for the sortable list. - /// - /// + /// /// Default value is . - /// + /// + /// + [AddedVersion("2.2.0")] + [DefaultValue(SortableListPullMode.True)] + [Description("Gets or sets the pull mode for the sortable list.")] [Parameter] public SortableListPullMode Pull { get; set; } = SortableListPullMode.True; /// /// Gets or sets the put mode for the sortable list. - /// - /// + /// /// Default value is . - /// + /// + /// + [AddedVersion("2.2.0")] + [DefaultValue(SortableListPutMode.True)] + [Description("Gets or sets the put mode for the sortable list.")] [Parameter] public SortableListPutMode Put { get; set; } = SortableListPutMode.True;