diff --git a/Havit.Blazor.Components.Web.Bootstrap/Chips/ChipItem.cs b/Havit.Blazor.Components.Web.Bootstrap/Chips/ChipItem.cs index c565d876f..7bdfaed80 100644 --- a/Havit.Blazor.Components.Web.Bootstrap/Chips/ChipItem.cs +++ b/Havit.Blazor.Components.Web.Bootstrap/Chips/ChipItem.cs @@ -1,7 +1,7 @@ namespace Havit.Blazor.Components.Web.Bootstrap; /// -/// Chip item to be rendered in UI. +/// Chip item to be rendered in the UI. /// public class ChipItem { @@ -16,7 +16,7 @@ public class ChipItem public bool Removable { get; init; } = false; /// - /// Remove action called when chip should be removed. + /// Remove action called when the chip should be removed. /// It receives the model from which the chip should be removed. /// It is not the same instance as the one from which the chip was generated! /// diff --git a/Havit.Blazor.Components.Web.Bootstrap/Chips/ChipListSettings.cs b/Havit.Blazor.Components.Web.Bootstrap/Chips/ChipListSettings.cs index 8148afd59..3f5d0d050 100644 --- a/Havit.Blazor.Components.Web.Bootstrap/Chips/ChipListSettings.cs +++ b/Havit.Blazor.Components.Web.Bootstrap/Chips/ChipListSettings.cs @@ -1,5 +1,8 @@ namespace Havit.Blazor.Components.Web.Bootstrap; +/// +/// Settings for the component. +/// public class ChipListSettings { /// @@ -13,7 +16,7 @@ public class ChipListSettings public string CssClass { get; set; } /// - /// Enables/disables the reset button. + /// Enables or disables the reset button. /// public bool? ShowResetButton { get; set; } } diff --git a/Havit.Blazor.Components.Web.Bootstrap/Chips/HxChipList.razor.cs b/Havit.Blazor.Components.Web.Bootstrap/Chips/HxChipList.razor.cs index 065c36fc6..49b64abf5 100644 --- a/Havit.Blazor.Components.Web.Bootstrap/Chips/HxChipList.razor.cs +++ b/Havit.Blazor.Components.Web.Bootstrap/Chips/HxChipList.razor.cs @@ -2,13 +2,13 @@ /// /// Presents a list of chips as badges.
-/// Usually being used to present filter-criteria gathered by .
+/// Usually used to present filter criteria gathered by .
/// Full documentation and demos: https://havit.blazor.eu/components/HxChipList ///
public partial class HxChipList { /// - /// Application-wide defaults for the . + /// Application-wide defaults for the component. /// public static ChipListSettings Defaults { get; set; } @@ -25,8 +25,8 @@ static HxChipList() } /// - /// Returns application-wide defaults for the component. - /// Enables overriding defaults in descendants (use separate set of defaults). + /// Returns the application-wide defaults for the component. + /// Enables overriding defaults in descendants (use a separate set of defaults). /// protected virtual ChipListSettings GetDefaults() => Defaults; @@ -36,10 +36,10 @@ static HxChipList() [Parameter] public ChipListSettings Settings { get; set; } /// - /// Returns optional set of component settings. + /// Returns an optional set of component settings. /// /// - /// Similar to , enables defining wider in components descendants (by returning a derived settings class). + /// Similar to , enables defining wider in component descendants (by returning a derived settings class). /// protected virtual ChipListSettings GetSettings() => this.Settings; @@ -50,7 +50,7 @@ static HxChipList() /// /// Settings for the used to render chips. - /// Default brings Color="". + /// The default brings Color="". /// [Parameter] public BadgeSettings ChipBadgeSettings { get; set; } protected BadgeSettings ChipBadgeSettingsEffective => this.ChipBadgeSettings ?? this.GetSettings()?.ChipBadgeSettings ?? this.GetDefaults().ChipBadgeSettings ?? throw new InvalidOperationException(nameof(ChipBadgeSettings) + " default for " + nameof(HxChipList) + " has to be set."); @@ -62,7 +62,7 @@ static HxChipList() protected string CssClassEffective => this.CssClass ?? this.GetSettings()?.CssClass ?? GetDefaults().CssClass; /// - /// Called when chip remove button is clicked. + /// Called when the chip remove button is clicked. /// [Parameter] public EventCallback OnChipRemoveClick { get; set; } @@ -82,8 +82,8 @@ static HxChipList() protected virtual Task InvokeOnResetClickAsync() => OnResetClick.InvokeAsync(); /// - /// Enables/disables the reset button. - /// Default is false (can be changed with HxChipList.Defaults.ShowResetButton. + /// Enables or disables the reset button. + /// The default is false (can be changed with HxChipList.Defaults.ShowResetButton). /// [Parameter] public bool? ShowResetButton { get; set; } protected bool ShowResetButtonEffective => this.ShowResetButton ?? this.GetSettings()?.ShowResetButton ?? GetDefaults().ShowResetButton ?? throw new InvalidOperationException(nameof(ShowResetButton) + " default for " + nameof(HxChipList) + " has to be set."); @@ -95,7 +95,7 @@ static HxChipList() /// /// Template for the reset button. - /// If used, the is ignored and the callback is not triggered (you are expected to wire the reset logic on you own). + /// If used, the is ignored and the callback is not triggered (you are expected to wire the reset logic on your own). /// [Parameter] public RenderFragment ResetButtonTemplate { get; set; } -} \ No newline at end of file +} diff --git a/Havit.Blazor.Components.Web.Bootstrap/Chips/IHxChipGenerator.cs b/Havit.Blazor.Components.Web.Bootstrap/Chips/IHxChipGenerator.cs index 08cf58486..948bccd43 100644 --- a/Havit.Blazor.Components.Web.Bootstrap/Chips/IHxChipGenerator.cs +++ b/Havit.Blazor.Components.Web.Bootstrap/Chips/IHxChipGenerator.cs @@ -1,7 +1,7 @@ namespace Havit.Blazor.Components.Web.Bootstrap; /// -/// Used in a component which can generate chips. +/// Used in a component that can generate chips. /// public interface IHxChipGenerator { @@ -9,4 +9,4 @@ public interface IHxChipGenerator /// Get chips from the component. ///
IEnumerable GetChips(); -} \ No newline at end of file +} diff --git a/Havit.Blazor.Components.Web.Bootstrap/HxSetup.cs b/Havit.Blazor.Components.Web.Bootstrap/HxSetup.cs index a4995e077..1239c66b7 100644 --- a/Havit.Blazor.Components.Web.Bootstrap/HxSetup.cs +++ b/Havit.Blazor.Components.Web.Bootstrap/HxSetup.cs @@ -8,11 +8,11 @@ namespace Havit.Blazor.Components.Web.Bootstrap; public static class HxSetup { /// - /// Renders <script< tag referencing corresponding Bootstrap JavaScript bundle with Popper.
+ /// Renders <script< tag referencing the corresponding Bootstrap JavaScript bundle with Popper.
/// To be used in _Layout.cshtml as @Html.Raw(HxSetup.RenderBootstrapJavaScriptReference()). ///
/// - /// We do not want to use TagHelper nor HTML Helper here as we do not want to introduce dependency on server-side ASP.NET Core (MVC/Razor) to our library (separate NuGet package would have to be created). + /// We do not want to use TagHelper or HTML Helper here as we do not want to introduce a dependency on server-side ASP.NET Core (MVC/Razor) to our library (a separate NuGet package would have to be created). /// public static string RenderBootstrapJavaScriptReference() { @@ -20,11 +20,11 @@ public static string RenderBootstrapJavaScriptReference() } /// - /// Renders <link< tag referencing corresponding Bootstrap CSS.
+ /// Renders <link< tag referencing the corresponding Bootstrap CSS.
/// To be used in _Layout.cshtml as @Html.Raw(HxSetup.RenderBootstrapCssReference()). ///
/// - /// We do not want to use TagHelper nor HTML Helper here as we do not want to introduce dependency on server-side ASP.NET Core (MVC/Razor) to our library (separate NuGet package would have to be created). + /// We do not want to use TagHelper or HTML Helper here as we do not want to introduce a dependency on server-side ASP.NET Core (MVC/Razor) to our library (a separate NuGet package would have to be created). /// public static string RenderBootstrapCssReference(BootstrapFlavor bootstrapFlavor = BootstrapFlavor.HavitDefault) { diff --git a/Havit.Blazor.Components.Web.Bootstrap/Icons/BootstrapIcon.cs b/Havit.Blazor.Components.Web.Bootstrap/Icons/BootstrapIcon.cs index 041ce13f8..420c4222b 100644 --- a/Havit.Blazor.Components.Web.Bootstrap/Icons/BootstrapIcon.cs +++ b/Havit.Blazor.Components.Web.Bootstrap/Icons/BootstrapIcon.cs @@ -4,7 +4,7 @@ /// Bootstrap icon. /// /// -/// To bootstrap icons update you need: +/// To update bootstrap icons, perform the following steps: /// - Update wwwroot\fonts\bootstrap-icons.woff /// - Update wwwroot\fonts\bootstrap-icons.woff2 /// - Update wwwroot\bootstrap-icons.css @@ -22,7 +22,7 @@ public partial class BootstrapIcon : IconBase public string Name { get; set; } /// - /// Constructor. Private. + /// Private constructor. /// private BootstrapIcon(string name) { @@ -30,5 +30,5 @@ private BootstrapIcon(string name) } // Next members are generated using a source generator. - // Tho source for the generator is the bootstrap-icons.json file located next to this one. + // The source for the generator is the bootstrap-icons.json file located next to this one. } diff --git a/Havit.Blazor.Components.Web.Bootstrap/Icons/HxBootstrapIcon.cs b/Havit.Blazor.Components.Web.Bootstrap/Icons/HxBootstrapIcon.cs index 7ee01c895..c0705af97 100644 --- a/Havit.Blazor.Components.Web.Bootstrap/Icons/HxBootstrapIcon.cs +++ b/Havit.Blazor.Components.Web.Bootstrap/Icons/HxBootstrapIcon.cs @@ -1,17 +1,18 @@ namespace Havit.Blazor.Components.Web.Bootstrap; /// -/// Displays bootstrap icon. See https://icons.getbootstrap.com/. +/// Displays a bootstrap icon. See https://icons.getbootstrap.com/. +/// You usually don't use this component directly, but instead use . /// internal class HxBootstrapIcon : ComponentBase { /// - /// Icon to display. + /// The icon to display. /// [Parameter] public BootstrapIcon Icon { get; set; } /// - /// CSS Class to combine with basic icon CSS class. + /// The CSS class to combine with the basic icon CSS class. /// [Parameter] public string CssClass { get; set; } diff --git a/Havit.Blazor.Components.Web.Bootstrap/Layouts/HxListLayout.nongeneric.cs b/Havit.Blazor.Components.Web.Bootstrap/Layouts/HxListLayout.nongeneric.cs index 5195ccd8d..0b24131a6 100644 --- a/Havit.Blazor.Components.Web.Bootstrap/Layouts/HxListLayout.nongeneric.cs +++ b/Havit.Blazor.Components.Web.Bootstrap/Layouts/HxListLayout.nongeneric.cs @@ -29,7 +29,7 @@ static HxListLayout() } /// - /// Can be used for TFilterModelType to express there is no filter in the component. + /// Can be used for TFilterModelType to indicate that there is no filter in the component. /// public sealed class NoFilter { } } diff --git a/Havit.Blazor.Components.Web.Bootstrap/Layouts/HxListLayout.razor.cs b/Havit.Blazor.Components.Web.Bootstrap/Layouts/HxListLayout.razor.cs index b209b6be6..45ee31979 100644 --- a/Havit.Blazor.Components.Web.Bootstrap/Layouts/HxListLayout.razor.cs +++ b/Havit.Blazor.Components.Web.Bootstrap/Layouts/HxListLayout.razor.cs @@ -3,15 +3,15 @@ namespace Havit.Blazor.Components.Web.Bootstrap; /// -/// Data presentation component composed of for data, for manual filtering and for pre-defined filters.
+/// Data presentation component composed of for data, for manual filtering, and for pre-defined filters.
/// Full documentation and demos: https://havit.blazor.eu/components/HxListLayout ///
/// public partial class HxListLayout { /// - /// Returns defaults. - /// Enables overriding defaults in descendants (use separate set of defaults). + /// Returns the defaults. + /// Enables overriding defaults in descendants (use a separate set of defaults). /// protected virtual ListLayoutSettings GetDefaults() => HxListLayout.Defaults; @@ -21,10 +21,10 @@ public partial class HxListLayout [Parameter] public ListLayoutSettings Settings { get; set; } /// - /// Returns optional set of component settings. + /// Returns an optional set of component settings. /// /// - /// Similar to , enables defining wider in components descendants (by returning a derived settings class). + /// Similar to , enables defining wider in component descendants (by returning a derived settings class). /// protected virtual ListLayoutSettings GetSettings() => this.Settings; @@ -58,7 +58,7 @@ public partial class HxListLayout protected CardSettings CardSettingsEffective => this.CardSettings ?? GetSettings()?.CardSettings ?? GetDefaults().CardSettings ?? throw new InvalidOperationException(nameof(CardSettings) + " default for " + nameof(HxListLayout) + " has to be set."); /// - /// Settings for the opening filtering offcanvas. + /// Settings for the opening the filtering offcanvas. /// [Parameter] public ButtonSettings FilterOpenButtonSettings { get; set; } protected ButtonSettings FilterOpenButtonSettingsEffective => this.FilterOpenButtonSettings ?? GetSettings()?.FilterOpenButtonSettings ?? GetDefaults().FilterOpenButtonSettings ?? throw new InvalidOperationException(nameof(FilterOpenButtonSettings) + " default for " + nameof(HxListLayout) + " has to be set."); @@ -92,7 +92,7 @@ protected override void OnParametersSet() { base.OnParametersSet(); - Contract.Requires((FilterTemplate is null) || (FilterModel is not null), $"{nameof(HxListLayout)} requires {nameof(FilterModel)} to be set if {nameof(FilterTemplate)} is used."); + Contract.Requires((FilterTemplate is null) || (FilterModel is not null), $"{nameof(HxListLayout)} requires {nameof(FilterModel)} to be set if {nameof(FilterTemplate)} is used."); } private void HandleChipUpdated(ChipItem[] chips) diff --git a/Havit.Blazor.Components.Web.Bootstrap/Layouts/ILayoutColumnComponent.cs b/Havit.Blazor.Components.Web.Bootstrap/Layouts/ILayoutColumnComponent.cs index 535ef2740..293329a20 100644 --- a/Havit.Blazor.Components.Web.Bootstrap/Layouts/ILayoutColumnComponent.cs +++ b/Havit.Blazor.Components.Web.Bootstrap/Layouts/ILayoutColumnComponent.cs @@ -6,38 +6,38 @@ public interface ILayoutColumnComponent { /// - /// Number of template columns to span. Responsive setting for all devices including the extra-small ones (XS) bellow "small" breakpoint (576px).
+ /// Number of template columns to span. Responsive setting for all devices including the extra-small ones (XS) below "small" breakpoint (576px).
/// The value can be any integer number between 1 and 12 (.col-1), auto (.col-auto) or true (.col). ///
string Columns { get; set; } /// - /// Number of template columns to span for viewports above "small" breakpoint (576px).
- /// The value can be any integer number between 1 and 12, auto or true. + /// Number of template columns to span for viewports above the "small" breakpoint (576px).
+ /// The value can be any integer number between 1 and 12, auto, or true. ///
string ColumnsSmallUp { get; set; } /// - /// Number of template columns to span for viewports above "medium" breakpoint (768px).
- /// The value can be any integer number between 1 and 12, auto or true. + /// Number of template columns to span for viewports above the "medium" breakpoint (768px).
+ /// The value can be any integer number between 1 and 12, auto, or true. ///
string ColumnsMediumUp { get; set; } /// - /// Number of template columns to span for viewports above "large" breakpoint (992px).
- /// The value can be any integer number between 1 and 12, auto or true. + /// Number of template columns to span for viewports above the "large" breakpoint (992px).
+ /// The value can be any integer number between 1 and 12, auto, or true. ///
string ColumnsLargeUp { get; set; } /// - /// Number of template columns to span for viewports above "large" breakpoint (1200px).
- /// The value can be any integer number between 1 and 12, auto or true. + /// Number of template columns to span for viewports above the "extra-large" breakpoint (1200px).
+ /// The value can be any integer number between 1 and 12, auto, or true. ///
string ColumnsExtraLargeUp { get; set; } /// - /// Number of template columns to span for viewports above "XXL" breakpoint (1400px).
- /// The value can be any integer number between 1 and 12, auto or true. + /// Number of template columns to span for viewports above the "XXL" breakpoint (1400px).
+ /// The value can be any integer number between 1 and 12, auto, or true. ///
string ColumnsXxlUp { get; set; } } diff --git a/Havit.Blazor.Components.Web.Bootstrap/Layouts/LayoutColumnComponentExtensions.cs b/Havit.Blazor.Components.Web.Bootstrap/Layouts/LayoutColumnComponentExtensions.cs index ed106c190..56d2e6aa9 100644 --- a/Havit.Blazor.Components.Web.Bootstrap/Layouts/LayoutColumnComponentExtensions.cs +++ b/Havit.Blazor.Components.Web.Bootstrap/Layouts/LayoutColumnComponentExtensions.cs @@ -3,7 +3,7 @@ public static class LayoutColumnComponentExtensions { /// - /// Returns CSS classes representing column layout of the component. + /// Returns CSS classes representing the column layout of the component. /// public static string GetColumnsCssClasses(this ILayoutColumnComponent columnComponent) { diff --git a/Havit.Blazor.Components.Web.Bootstrap/Layouts/ListLayoutSettings.cs b/Havit.Blazor.Components.Web.Bootstrap/Layouts/ListLayoutSettings.cs index 6a79e9da5..28696196f 100644 --- a/Havit.Blazor.Components.Web.Bootstrap/Layouts/ListLayoutSettings.cs +++ b/Havit.Blazor.Components.Web.Bootstrap/Layouts/ListLayoutSettings.cs @@ -16,12 +16,12 @@ public record ListLayoutSettings public CardSettings CardSettings { get; set; } /// - /// Settings for the opening filtering offcanvas. + /// Settings for the that opens the filtering offcanvas. /// public ButtonSettings FilterOpenButtonSettings { get; set; } /// - /// Settings for the submitting the filter. + /// Settings for the that submits the filter. /// public ButtonSettings FilterSubmitButtonSettings { get; set; } diff --git a/Havit.Blazor.Components.Web.Bootstrap/ListGroups/HxListGroupItem.razor.cs b/Havit.Blazor.Components.Web.Bootstrap/ListGroups/HxListGroupItem.razor.cs index 15a724953..fad1cc50b 100644 --- a/Havit.Blazor.Components.Web.Bootstrap/ListGroups/HxListGroupItem.razor.cs +++ b/Havit.Blazor.Components.Web.Bootstrap/ListGroups/HxListGroupItem.razor.cs @@ -11,13 +11,13 @@ public partial class HxListGroupItem [Parameter] public RenderFragment ChildContent { get; set; } /// - /// Indicates the current active selection. + /// Indicates the currently active selection. /// [Parameter] public bool Active { get; set; } /// - /// Make the item appear disabled by setting to false. - /// Default is true. + /// Make the item appear disabled by setting it to false. + /// The default value is true. /// [Parameter] public bool Enabled { get; set; } = true; diff --git a/Havit.Blazor.Components.Web.Bootstrap/ListGroups/ListGroupHorizontal.cs b/Havit.Blazor.Components.Web.Bootstrap/ListGroups/ListGroupHorizontal.cs index 0eb9df862..c2c1dd3ef 100644 --- a/Havit.Blazor.Components.Web.Bootstrap/ListGroups/ListGroupHorizontal.cs +++ b/Havit.Blazor.Components.Web.Bootstrap/ListGroups/ListGroupHorizontal.cs @@ -2,37 +2,37 @@ /// /// Responsive horizontal setting (breakpoint) for . -/// Default is . +/// Default is . /// public enum ListGroupHorizontal { /// - /// Never Horizontal, always vertical. + /// Never horizontal, always vertical. /// Never = 0, /// - /// Horizontal for viewports above "small" breakpoint (576px). + /// Horizontal for viewports above the "small" breakpoint (576px). /// SmallUp, /// - /// Horizontal for viewports above "medium" breakpoint (768px). + /// Horizontal for viewports above the "medium" breakpoint (768px). /// MediumUp, /// - /// Horizontal for viewports above "large" breakpoint (992px). + /// Horizontal for viewports above the "large" breakpoint (992px). /// LargeUp, /// - /// Horizontal for viewports above "extra-large" breakpoint (1200px). + /// Horizontal for viewports above the "extra-large" breakpoint (1200px). /// ExtraLargeUp, /// - /// Horizontal for viewports above "XXL" breakpoint (1400px). + /// Horizontal for viewports above the "XXL" breakpoint (1400px). /// XxlUp, diff --git a/Havit.Blazor.Components.Web.Bootstrap/Modals/DialogResult.cs b/Havit.Blazor.Components.Web.Bootstrap/Modals/DialogResult.cs index 8c71f18e4..5e11f53a3 100644 --- a/Havit.Blazor.Components.Web.Bootstrap/Modals/DialogResult.cs +++ b/Havit.Blazor.Components.Web.Bootstrap/Modals/DialogResult.cs @@ -6,19 +6,19 @@ public sealed class DialogResult { /// - /// True when the dialog has successful result, false then it was cancelled. + /// True when the dialog has a successful result, false when it was cancelled. /// public bool Successful { get; } /// /// The value of the successful result. /// - /// When the dialog is not successful. + /// Thrown when the dialog is not successful. public TValue Value { get { - Contract.Assert(Successful, $"{nameof(Value)} property can be read only when {nameof(Successful)} is True."); + Contract.Assert(Successful, $"{nameof(Value)} property can only be read when {nameof(Successful)} is True."); return value; } } @@ -34,12 +34,12 @@ private DialogResult(bool successful, TValue value = default) } /// - /// Returns new instance for cancelled dialog. + /// Returns a new instance for a cancelled dialog. /// internal static DialogResult CreateCancelled() => new DialogResult(false); /// - /// Returns new instance for successful dialog. + /// Returns a new instance for a successful dialog. /// internal static DialogResult CreateSuccessful(TValue value) => new DialogResult(true, value); -} \ No newline at end of file +} diff --git a/Havit.Blazor.Components.Web.Bootstrap/Modals/HxDialogBase.cs b/Havit.Blazor.Components.Web.Bootstrap/Modals/HxDialogBase.cs index 2d07ca4a7..995e581e4 100644 --- a/Havit.Blazor.Components.Web.Bootstrap/Modals/HxDialogBase.cs +++ b/Havit.Blazor.Components.Web.Bootstrap/Modals/HxDialogBase.cs @@ -11,7 +11,7 @@ public abstract class HxDialogBase : ComponentBase #pragma warning restore SA1307 // Accessible fields must begin with upper-case letter /// - /// Returns the component which this component control. Override when you do not want to use modal field set using @ref. + /// Returns the component that this component controls. Override this method when you do not want to use the modal field set using @ref. /// protected virtual HxModal Modal => modal; @@ -24,7 +24,7 @@ public abstract class HxDialogBase : ComponentBase /// public async Task> ShowAsync() { - Contract.Assert(firstRendered, "Cannot show dialog before it is rendered."); // otherwise we do not have Modal/modal value from @ref. + Contract.Assert(firstRendered, "Cannot show the dialog before it is rendered."); // otherwise, we do not have the Modal/modal value from @ref. resultCompletion = new TaskCompletionSource>(); setResultOnModalClosed = true; #pragma warning disable BL0005 // Component parameter should not be set outside of its component. @@ -37,7 +37,7 @@ public async Task> ShowAsync() #pragma warning disable BL0005 // Component parameter should not be set outside of its component. Modal.OnClosed = EventCallback.Empty; #pragma warning restore BL0005 // Component parameter should not be set outside of its component. - this.resultCompletion = null; // do not hold task with a value + this.resultCompletion = null; // do not hold the task with a value return result; } @@ -47,7 +47,7 @@ public async Task> ShowAsync() /// protected internal async Task HideAsync(TResult value) { - setResultOnModalClosed = false; // do not fire event in HandleModalClosed + setResultOnModalClosed = false; // do not fire the event in HandleModalClosed await Modal.HideAsync(); resultCompletion.SetResult(DialogResult.CreateSuccessful(value)); // finish ShowAsync with a value } @@ -57,7 +57,7 @@ protected internal async Task HideAsync(TResult value) /// protected internal async Task HideAsCancelledAsync() { - setResultOnModalClosed = false; // do not fire event in HandleModalClosed + setResultOnModalClosed = false; // do not fire the event in HandleModalClosed await Modal.HideAsync(); resultCompletion.SetResult(DialogResult.CreateCancelled()); // finish ShowAsync with no value } @@ -66,8 +66,8 @@ private void HandleModalClosed() { if (setResultOnModalClosed) { - // we expect this only when dialog closed out od HideAsync/HideAsCancelledAsync methods - // ie. escape key or close but in top-right corner + // we expect this only when the dialog is closed out of the HideAsync/HideAsCancelledAsync methods + // i.e. escape key or close button in the top-right corner resultCompletion.SetResult(DialogResult.CreateCancelled()); } } @@ -75,7 +75,7 @@ private void HandleModalClosed() protected override void OnAfterRender(bool firstRender) { base.OnAfterRender(firstRender); - Contract.Assert(Modal != null, $"Dialog must contain {nameof(HxModal)} component with @ref=\"{nameof(modal)}\"."); + Contract.Assert(Modal != null, $"The dialog must contain the {nameof(HxModal)} component with @ref=\"{nameof(modal)}\"."); firstRendered = true; } } diff --git a/Havit.Blazor.Components.Web.Bootstrap/Modals/HxMessageBox.razor.cs b/Havit.Blazor.Components.Web.Bootstrap/Modals/HxMessageBox.razor.cs index 1c307beff..8eb681801 100644 --- a/Havit.Blazor.Components.Web.Bootstrap/Modals/HxMessageBox.razor.cs +++ b/Havit.Blazor.Components.Web.Bootstrap/Modals/HxMessageBox.razor.cs @@ -3,7 +3,7 @@ namespace Havit.Blazor.Components.Web.Bootstrap; /// -/// Component to display message-boxes.
+/// Component for displaying message boxes.
/// Usually used via and .
/// Full documentation and demos: https://havit.blazor.eu/components/HxMessageBox ///
@@ -34,8 +34,8 @@ static HxMessageBox() } /// - /// Returns defaults. - /// Enables overriding defaults in descendants (use separate set of defaults). + /// Returns the defaults for . + /// Enables overriding defaults in descendants (use a separate set of defaults). /// protected virtual MessageBoxSettings GetDefaults() => Defaults; @@ -66,12 +66,12 @@ static HxMessageBox() /// /// Indicates whether to show the close button. - /// Default is taken from the underlying (true). + /// The default is taken from the underlying (true). /// [Parameter] public bool? ShowCloseButton { get; set; } /// - /// Buttons to show. Default is . + /// Buttons to show. The default is . /// [Parameter] public MessageBoxButtons Buttons { get; set; } = MessageBoxButtons.Ok; @@ -98,7 +98,7 @@ static HxMessageBox() protected ButtonSettings SecondaryButtonSettingsEffective => this.SecondaryButtonSettings ?? GetDefaults().SecondaryButtonSettings ?? throw new InvalidOperationException(nameof(SecondaryButtonSettings) + " default for " + nameof(HxMessageBox) + " has to be set."); /// - /// Settings for underlying component. + /// Settings for the underlying component. /// [Parameter] public ModalSettings ModalSettings { get; set; } protected ModalSettings ModalSettingsEffective => this.ModalSettings ?? GetDefaults().ModalSettings ?? throw new InvalidOperationException(nameof(ModalSettings) + " default for " + nameof(HxMessageBox) + " has to be set."); diff --git a/Havit.Blazor.Components.Web.Bootstrap/Modals/HxMessageBoxHost.razor.cs b/Havit.Blazor.Components.Web.Bootstrap/Modals/HxMessageBoxHost.razor.cs index 2ec1090ee..e6155f857 100644 --- a/Havit.Blazor.Components.Web.Bootstrap/Modals/HxMessageBoxHost.razor.cs +++ b/Havit.Blazor.Components.Web.Bootstrap/Modals/HxMessageBoxHost.razor.cs @@ -2,7 +2,7 @@ /// /// Displays message boxes initiated through . -/// To be placed in root application component / main layout. +/// To be placed in the root application component / main layout. /// public partial class HxMessageBoxHost : ComponentBase { diff --git a/Havit.Blazor.Components.Web.Bootstrap/Modals/HxModal.razor.cs b/Havit.Blazor.Components.Web.Bootstrap/Modals/HxModal.razor.cs index f1bc96217..da9b28f32 100644 --- a/Havit.Blazor.Components.Web.Bootstrap/Modals/HxModal.razor.cs +++ b/Havit.Blazor.Components.Web.Bootstrap/Modals/HxModal.razor.cs @@ -3,18 +3,19 @@ namespace Havit.Blazor.Components.Web.Bootstrap; /// -/// Component to render modal dialog as a Bootstrap Modal.
-/// Full documentation and demos: https://havit.blazor.eu/components/HxModal +/// Component for rendering a modal dialog as a Bootstrap Modal. +/// Visit Bootstrap Modal for more information. +/// Full documentation and demos available at https://havit.blazor.eu/components/HxModal ///
public partial class HxModal : IAsyncDisposable { /// - /// A value that is passed to the data-bs-backdrop data attribute when is set to . + /// Specifies a value for the data-bs-backdrop attribute when is set to . /// private const string StaticBackdropValue = "static"; /// - /// Application-wide defaults for the . + /// Application-wide default settings for the . /// public static ModalSettings Defaults { get; } @@ -34,18 +35,18 @@ static HxModal() } /// - /// Returns application-wide defaults for the component. - /// Enables overriding defaults in descendants (use separate set of defaults). + /// Provides application-wide default settings for the component. + /// Allows descendants to override these defaults with a separate set of values. /// protected virtual ModalSettings GetDefaults() => Defaults; /// - /// Set of settings to be applied to the component instance (overrides , overridden by individual parameters). + /// A set of settings applied to this component instance. Overrides and is itself overridden by individual parameters. /// [Parameter] public ModalSettings Settings { get; set; } /// - /// For modals that simply appear rather than fade in to view, setting false removes the .fade class from your modal markup. + /// Determines whether modals appear without fading in. Setting to false removes the .fade class from the modal markup. /// Default value is true. /// [Parameter] public bool? Animated { get; set; } @@ -171,34 +172,34 @@ static HxModal() protected string FooterCssClassEffective => this.FooterCssClass ?? this.GetSettings()?.FooterCssClass ?? GetDefaults().FooterCssClass; /// - /// This event is fired immediately when the hide instance method has been called.
- /// This can be caused by , close-button, Esc key or other interaction. - /// Hiding can be cancelled by setting = true + /// Fired immediately when the 'hide' instance method is called. + /// This can be triggered by , the close button, the Esc key, or other interactions. + /// To cancel hiding, set to true. ///
/// - /// There is intentionally no virtual InvokeOnHidingAsync() method to override as we want to avoid confusion. - /// The hide.bs.modal event is subscribed only when callback is set. + /// There is intentionally no virtual InvokeOnHidingAsync() method to override to avoid confusion. + /// The hide.bs.modal event is only subscribed to when the callback is set. /// [Parameter] public EventCallback OnHiding { get; set; } /// - /// This event is fired when the modal has finished being hidden from the user (will wait for CSS transitions to complete).
- /// This can be caused by , close-button, Esc key or other interaction. + /// Fired when the modal has finished hiding from the user, after CSS transitions complete. + /// Triggered by , the close button, the Esc key, or other interactions. ///
[Parameter] public EventCallback OnClosed { get; set; } /// - /// Triggers the event. Allows interception of the event in derived components. + /// Triggers the event. Enables derived components to intercept the event. /// protected virtual Task InvokeOnClosedAsync() => OnClosed.InvokeAsync(); /// - /// This event is fired when an modal element has been made visible to the user (will wait for CSS transitions to complete). + /// Fired when a modal element becomes visible to the user, after CSS transitions complete. /// [Parameter] public EventCallback OnShown { get; set; } /// - /// Triggers the event. Allows interception of the event in derived components. + /// Triggers the event. Enables derived components to intercept the event. /// protected virtual Task InvokeOnShownAsync() => OnShown.InvokeAsync(); @@ -291,10 +292,8 @@ protected override async Task OnAfterRenderAsync(bool firstRender) } /// - /// Formats a for supplying the value via the data-bs-backdrop data attribute. + /// Formats a value for use in the data-bs-backdrop attribute. /// - /// - /// private string GetBackdropSetupValue(ModalBackdrop backdrop) { return backdrop switch diff --git a/Havit.Blazor.Components.Web.Bootstrap/Modals/MessageBoxSettings.cs b/Havit.Blazor.Components.Web.Bootstrap/Modals/MessageBoxSettings.cs index ee4a60f17..f4197b67f 100644 --- a/Havit.Blazor.Components.Web.Bootstrap/Modals/MessageBoxSettings.cs +++ b/Havit.Blazor.Components.Web.Bootstrap/Modals/MessageBoxSettings.cs @@ -6,17 +6,17 @@ public record MessageBoxSettings { /// - /// Settings for the dialog primary button. + /// Settings for the primary dialog button. /// public ButtonSettings PrimaryButtonSettings { get; set; } /// - /// Settings for dialog secondary button(s). + /// Settings for the secondary dialog button(s). /// public ButtonSettings SecondaryButtonSettings { get; set; } /// - /// Settings for underlying component. + /// Settings for the underlying component. /// public ModalSettings ModalSettings { get; set; } } diff --git a/Havit.Blazor.Components.Web.Bootstrap/Modals/ModalBackdrop.cs b/Havit.Blazor.Components.Web.Bootstrap/Modals/ModalBackdrop.cs index c7ee11d50..d5ff33795 100644 --- a/Havit.Blazor.Components.Web.Bootstrap/Modals/ModalBackdrop.cs +++ b/Havit.Blazor.Components.Web.Bootstrap/Modals/ModalBackdrop.cs @@ -6,7 +6,7 @@ public enum ModalBackdrop { /// - /// A backdrop will be rendered. Modal will be closed upon clicking on the backdrop. + /// A backdrop will be rendered. The modal will be closed upon clicking on the backdrop. /// True = 0, @@ -16,7 +16,7 @@ public enum ModalBackdrop False = 1, /// - /// A static backdrop will be rendered. Modal will not be closed upon clicking on the backdrop. + /// A static backdrop will be rendered. The modal will not be closed upon clicking on the backdrop. /// Static = 2 } diff --git a/Havit.Blazor.Components.Web.Bootstrap/Modals/ModalFullscreen.cs b/Havit.Blazor.Components.Web.Bootstrap/Modals/ModalFullscreen.cs index dec2b7662..67a28e3e2 100644 --- a/Havit.Blazor.Components.Web.Bootstrap/Modals/ModalFullscreen.cs +++ b/Havit.Blazor.Components.Web.Bootstrap/Modals/ModalFullscreen.cs @@ -6,7 +6,7 @@ public enum ModalFullscreen { /// - /// Fullscreen mode disabled, + /// Fullscreen mode disabled. /// Disabled = 0, @@ -16,27 +16,27 @@ public enum ModalFullscreen Always = 1, /// - /// Fullscreen for viewports bellow "small" breakpoint (576px). + /// Fullscreen for viewports below the "small" breakpoint (576px). /// SmallDown = 2, /// - /// Fullscreen for viewports bellow "medium" breakpoint (768px). + /// Fullscreen for viewports below the "medium" breakpoint (768px). /// MediumDown = 3, /// - /// Fullscreen for viewports bellow "large" breakpoint (992px). + /// Fullscreen for viewports below the "large" breakpoint (992px). /// LargeDown = 4, /// - /// Fullscreen for viewports bellow "extra-large" breakpoint (1200px). + /// Fullscreen for viewports below the "extra-large" breakpoint (1200px). /// ExtraLargeDown = 5, /// - /// Fullscreen for viewports bellow "XXL" breakpoint (1400px). + /// Fullscreen for viewports below the "XXL" breakpoint (1400px). /// XxlDown = 6, -} \ No newline at end of file +} diff --git a/Havit.Blazor.Components.Web.Bootstrap/Modals/ModalHidingEventArgs.cs b/Havit.Blazor.Components.Web.Bootstrap/Modals/ModalHidingEventArgs.cs index 69d99bbcd..c95c022d0 100644 --- a/Havit.Blazor.Components.Web.Bootstrap/Modals/ModalHidingEventArgs.cs +++ b/Havit.Blazor.Components.Web.Bootstrap/Modals/ModalHidingEventArgs.cs @@ -1,10 +1,9 @@ namespace Havit.Blazor.Components.Web.Bootstrap; public class ModalHidingEventArgs - { /// - /// Set true to cancel modal hiding. + /// Set true to prevent modal hiding. /// public bool Cancel { get; set; } -} \ No newline at end of file +} diff --git a/Havit.Blazor.Components.Web.Bootstrap/Modals/ModalSettings.cs b/Havit.Blazor.Components.Web.Bootstrap/Modals/ModalSettings.cs index d33cfea29..283f1b07a 100644 --- a/Havit.Blazor.Components.Web.Bootstrap/Modals/ModalSettings.cs +++ b/Havit.Blazor.Components.Web.Bootstrap/Modals/ModalSettings.cs @@ -7,44 +7,44 @@ public record ModalSettings { /// /// For modals that simply appear rather than fade in to view, setting false removes the .fade class from your modal markup. - /// Default value is true. + /// The default value is true. /// public bool? Animated { get; set; } /// - /// Indicates whether the modal shows close button in header. + /// Indicates whether the modal shows a close button in the header. /// public bool? ShowCloseButton { get; set; } /// - /// Close icon to be used in header. + /// The close icon to be used in the header. /// public IconBase CloseButtonIcon { get; set; } /// - /// Indicates whether the modal closes when escape key is pressed. + /// Indicates whether the modal closes when the escape key is pressed. /// public bool? CloseOnEscape { get; set; } /// - /// Size of the modal. + /// The size of the modal. /// public ModalSize? Size { get; set; } /// - /// Fullscreen behavior of the modal. + /// The fullscreen behavior of the modal. /// public ModalFullscreen? Fullscreen { get; set; } /// - /// Indicates whether to apply a backdrop on body while the modal is open. + /// Indicates whether to apply a backdrop to the body while the modal is open. /// If set to , the modal cannot be closed by clicking on the backdrop. - /// Default value (from ) is . + /// The default value (from ) is . /// public ModalBackdrop? Backdrop { get; set; } /// - /// Allows scrolling the modal body. + /// Allows scrolling of the modal body. /// public bool? Scrollable { get; set; } diff --git a/Havit.Blazor.Components.Web.Bootstrap/NamedViews/HxNamedViewList.razor.cs b/Havit.Blazor.Components.Web.Bootstrap/NamedViews/HxNamedViewList.razor.cs index 783ceae03..99c3bc81b 100644 --- a/Havit.Blazor.Components.Web.Bootstrap/NamedViews/HxNamedViewList.razor.cs +++ b/Havit.Blazor.Components.Web.Bootstrap/NamedViews/HxNamedViewList.razor.cs @@ -1,7 +1,7 @@ namespace Havit.Blazor.Components.Web.Bootstrap; /// -/// List of named-views for .
+/// List of named views for .
/// Full documentation and demos: https://havit.blazor.eu/components/HxNamedViewList ///
@@ -28,7 +28,7 @@ protected async Task HandleNamedViewClick(NamedView namedView) TFilterModel newFilter = namedView.Filter(); if (newFilter != null) { - FilterModel = newFilter; // BEWARE, filter has to be cloned + FilterModel = newFilter; // BEWARE, the filter has to be cloned await InvokeFilterModelChangedAsync(newFilter); } diff --git a/Havit.Blazor.Components.Web.Bootstrap/Navigation/AnchorFragmentNavigationAutomationMode.cs b/Havit.Blazor.Components.Web.Bootstrap/Navigation/AnchorFragmentNavigationAutomationMode.cs index 1f88278e7..6ff281251 100644 --- a/Havit.Blazor.Components.Web.Bootstrap/Navigation/AnchorFragmentNavigationAutomationMode.cs +++ b/Havit.Blazor.Components.Web.Bootstrap/Navigation/AnchorFragmentNavigationAutomationMode.cs @@ -6,21 +6,21 @@ public enum AnchorFragmentNavigationAutomationMode { /// - /// Scrolls to anchor on firstRender and whenever location changes (). - /// With this mode is suitable only for static pages (where the size/offset of individual sections remains the same from the very beginning). - /// Use or for when the page contents load asynchronously and the layout changes. + /// Scrolls to the anchor on firstRender and whenever the location changes (). + /// With , this mode is suitable only for static pages (where the size/offset of individual sections remains the same from the very beginning). + /// Use or when the page contents load asynchronously and the layout changes. /// Full = 0, /// - /// Explicit calls to or needed. + /// Explicit calls to or are needed. /// Use this mode with when you need scrollspy to call to recalculate the target offsets before scrolling (scrollspy does not work properly on scrolled content). /// Manual = 1, /// - /// Same as but scrolls to anchor on if the page remains the same (just the #fragment portion changed). + /// Same as , but scrolls to the anchor on if the page remains the same (just the #fragment portion changed). /// Works for most scenarios when you refresh the after data load and then you just need to navigate over the page. /// SamePage = 2 -} \ No newline at end of file +} diff --git a/Havit.Blazor.Components.Web.Bootstrap/Navigation/HxAnchorFragmentNavigation.cs b/Havit.Blazor.Components.Web.Bootstrap/Navigation/HxAnchorFragmentNavigation.cs index b2a67afb5..638c9237c 100644 --- a/Havit.Blazor.Components.Web.Bootstrap/Navigation/HxAnchorFragmentNavigation.cs +++ b/Havit.Blazor.Components.Web.Bootstrap/Navigation/HxAnchorFragmentNavigation.cs @@ -4,7 +4,7 @@ namespace Havit.Blazor.Components.Web.Bootstrap; /// -/// Temporarily (?) compensates Blazor deficiency in anchor-fragments (scrolling to page#id URLs). Supports navigation with component. +/// Temporarily (?) compensates for a Blazor deficiency in anchor fragments (scrolling to page#id URLs). Supports navigation with the component. /// GitHub Issue: Blazor 0.8.0: hash routing to named element #8393.
/// Full documentation and demos: https://havit.blazor.eu/components/HxAnchorFragmentNavigation ///
@@ -15,8 +15,8 @@ namespace Havit.Blazor.Components.Web.Bootstrap; public class HxAnchorFragmentNavigation : ComponentBase, IAsyncDisposable { /// - /// Level of automation. - /// Default is . + /// The level of automation. + /// The default is . /// [Parameter] public AnchorFragmentNavigationAutomationMode Automation { get; set; } = AnchorFragmentNavigationAutomationMode.Full; diff --git a/Havit.Blazor.Components.Web.Bootstrap/Navigation/HxBreadcrumb/HxBreadcrumb.razor.cs b/Havit.Blazor.Components.Web.Bootstrap/Navigation/HxBreadcrumb/HxBreadcrumb.razor.cs index 420107f73..f2b010022 100644 --- a/Havit.Blazor.Components.Web.Bootstrap/Navigation/HxBreadcrumb/HxBreadcrumb.razor.cs +++ b/Havit.Blazor.Components.Web.Bootstrap/Navigation/HxBreadcrumb/HxBreadcrumb.razor.cs @@ -2,7 +2,7 @@ /// /// Bootstrap 5 Breadcrumb component.
-/// Indicates the current page’s location within a navigational hierarchy.
+/// Indicates the current page's location within a navigational hierarchy.
/// Full documentation and demos: https://havit.blazor.eu/components/HxBreadcrumb ///
public partial class HxBreadcrumb @@ -20,7 +20,7 @@ public partial class HxBreadcrumb [Parameter] public string Divider { get; set; } = "/"; /// - /// Indicates whether the Divider is an image or a text. + /// Indicates whether the divider is an image or text. /// private bool IsDividerImage() { diff --git a/Havit.Blazor.Components.Web.Bootstrap/Navigation/HxBreadcrumb/HxBreadcrumbItem.razor.cs b/Havit.Blazor.Components.Web.Bootstrap/Navigation/HxBreadcrumb/HxBreadcrumbItem.razor.cs index 822f2b2a5..b7bfbcca1 100644 --- a/Havit.Blazor.Components.Web.Bootstrap/Navigation/HxBreadcrumb/HxBreadcrumbItem.razor.cs +++ b/Havit.Blazor.Components.Web.Bootstrap/Navigation/HxBreadcrumb/HxBreadcrumbItem.razor.cs @@ -6,17 +6,17 @@ public partial class HxBreadcrumbItem { /// - /// Item text (usually a name of the page). + /// Item text (usually the name of the page). /// [Parameter] public string Text { get; set; } /// - /// The link of the breadcrumb (a page where the user will be led on click). + /// The link of the breadcrumb (the page where the user will be led on click). /// [Parameter] public string Href { get; set; } /// - /// Determines whether the HxBreadcrumbItem is active (use for a page that the user is currently on). + /// Determines whether the HxBreadcrumbItem is active (used for a page that the user is currently on). /// [Parameter] public bool Active { get; set; } diff --git a/Havit.Blazor.Components.Web.Bootstrap/Navigation/HxNav.razor.cs b/Havit.Blazor.Components.Web.Bootstrap/Navigation/HxNav.razor.cs index 12ef9df98..3891c94c4 100644 --- a/Havit.Blazor.Components.Web.Bootstrap/Navigation/HxNav.razor.cs +++ b/Havit.Blazor.Components.Web.Bootstrap/Navigation/HxNav.razor.cs @@ -8,13 +8,13 @@ public partial class HxNav { /// /// Orientation of the nav. - /// Default is . + /// The default value is . /// [Parameter] public NavOrientation Orientation { get; set; } = NavOrientation.Horizontal; /// /// The visual variant of the nav items. - /// Default is . + /// The default value is . /// [Parameter] public NavVariant Variant { get; set; } = NavVariant.Standard; diff --git a/Havit.Blazor.Components.Web.Bootstrap/Navigation/HxNavbar.razor.cs b/Havit.Blazor.Components.Web.Bootstrap/Navigation/HxNavbar.razor.cs index 055caba9c..07ac0a7f2 100644 --- a/Havit.Blazor.Components.Web.Bootstrap/Navigation/HxNavbar.razor.cs +++ b/Havit.Blazor.Components.Web.Bootstrap/Navigation/HxNavbar.razor.cs @@ -1,33 +1,33 @@ namespace Havit.Blazor.Components.Web.Bootstrap; /// -/// Bootstrap 5 Navbar component - responsive navigation header.
-/// With support for branding, navigation, and more, including support for the collapse plugin.
-/// Full documentation and demos: https://havit.blazor.eu/components/HxNavbar +/// Bootstrap 5 Navbar component - a responsive navigation header.
+/// Provides support for branding, navigation, and more, including support for the collapse plugin.
+/// For full documentation and demos, visit: https://havit.blazor.eu/components/HxNavbar ///
public partial class HxNavbar { /// /// Color (background). - /// Default is . + /// The default value is . /// [Parameter] public ThemeColor Color { get; set; } = ThemeColor.None; /// /// Bootstrap theme (color mode) applied to the navbar. - /// Default is (none). + /// The default value is (none). /// [Parameter] public ColorMode ColorMode { get; set; } /// /// Responsive expand setting (breakpoint) for .
- /// Default is . + /// The default value is . ///
[Parameter] public NavbarExpand Expand { get; set; } = NavbarExpand.LargeUp; /// /// Element ID. - /// (Autogenerated GUID if not set explicitly.) + /// (An autogenerated GUID is used if not set explicitly.) /// [Parameter] public string Id { get; set; } = "hx" + Guid.NewGuid().ToString("N"); @@ -37,7 +37,7 @@ public partial class HxNavbar [Parameter] public string CssClass { get; set; } /// - /// Container CSS class. Default is container-fluid. + /// Container CSS class. The default value is container-fluid. /// [Parameter] public string ContainerCssClass { get; set; } = "container-fluid"; @@ -62,7 +62,7 @@ protected virtual string GetExpandCssClass() NavbarExpand.ExtraLargeUp => "navbar-expand-xl", NavbarExpand.XxlUp => "navbar-expand-xxl", NavbarExpand.Never => null, - _ => throw new InvalidOperationException($"Unknow {nameof(NavbarExpand)} value {this.Expand}.") + _ => throw new InvalidOperationException($"Unknown {nameof(NavbarExpand)} value {this.Expand}.") }; } diff --git a/Havit.Blazor.Components.Web.Bootstrap/Navigation/HxNavbarToggler.cs b/Havit.Blazor.Components.Web.Bootstrap/Navigation/HxNavbarToggler.cs index 43e0089c2..6a6daf339 100644 --- a/Havit.Blazor.Components.Web.Bootstrap/Navigation/HxNavbarToggler.cs +++ b/Havit.Blazor.Components.Web.Bootstrap/Navigation/HxNavbarToggler.cs @@ -12,7 +12,7 @@ public override async Task SetParametersAsync(ParameterView parameters) { await base.SetParametersAsync(parameters); - Contract.Requires(NavbarContainer is not null, $"{nameof(HxNavbarToggler)} requires parent {nameof(HxNavbar)}."); + Contract.Requires(NavbarContainer is not null, $"{nameof(HxNavbarToggler)} requires the parent {nameof(HxNavbar)}."); CollapseTarget = parameters.GetValueOrDefault(nameof(CollapseTarget), "#" + NavbarContainer.GetDefaultCollapseId()); Color = parameters.GetValueOrDefault(nameof(Color), ThemeColor.None); diff --git a/Havit.Blazor.Components.Web.Bootstrap/Navigation/HxScrollspy.razor.cs b/Havit.Blazor.Components.Web.Bootstrap/Navigation/HxScrollspy.razor.cs index 5a48be786..4124f97e6 100644 --- a/Havit.Blazor.Components.Web.Bootstrap/Navigation/HxScrollspy.razor.cs +++ b/Havit.Blazor.Components.Web.Bootstrap/Navigation/HxScrollspy.razor.cs @@ -14,12 +14,12 @@ public partial class HxScrollspy : IAsyncDisposable [Parameter, EditorRequired] public string TargetId { get; set; } /// - /// Scrollspy additional CSS class. Added to main div (.hx-scrollspy). + /// Scrollspy additional CSS class. Added to the main div (.hx-scrollspy). /// [Parameter] public string CssClass { get; set; } /// - /// Content to be spied. Elements with IDs are required (corresponding IDs to be used in ). + /// Content to be spied on. Elements with IDs are required (corresponding IDs to be used in ). /// [Parameter] public RenderFragment ChildContent { get; set; } @@ -48,7 +48,7 @@ protected override async Task OnAfterRenderAsync(bool firstRender) } /// - /// When using scrollspy in conjunction with adding or removing of elements from the DOM (e.g. asynchronous data load), you’ll need to refresh the scrollspy explicitly. + /// When using scrollspy in conjunction with adding or removing elements from the DOM (e.g. asynchronous data load), you’ll need to refresh the scrollspy explicitly. /// /// public async Task RefreshAsync() @@ -64,7 +64,7 @@ public async Task RefreshAsync() } else { - // NOOP - will be initialized OnAfterRenderAsync (a therefor the refresh is not needed) + // NOOP - will be initialized OnAfterRenderAsync (and therefore the refresh is not needed) } } diff --git a/Havit.Blazor.Components.Web.Bootstrap/Navigation/HxSidebar.razor.cs b/Havit.Blazor.Components.Web.Bootstrap/Navigation/HxSidebar.razor.cs index c8ed8d70e..a8dda0229 100644 --- a/Havit.Blazor.Components.Web.Bootstrap/Navigation/HxSidebar.razor.cs +++ b/Havit.Blazor.Components.Web.Bootstrap/Navigation/HxSidebar.razor.cs @@ -19,15 +19,15 @@ public partial class HxSidebar : ComponentBase [Parameter] public RenderFragment ItemsTemplate { get; set; } /// - /// ExpandIcon is obsolete and will be removed in future release. Use if you want to render an icon. + /// ExpandIcon is obsolete and will be removed in a future release. Use if you want to render an icon. /// - [Obsolete("ExpandIcon is obsolete and will be removed in future release. Use TogglerTemplate if you want to render an icon.")] + [Obsolete("ExpandIcon is obsolete and will be removed in a future release. Use TogglerTemplate if you want to render an icon.")] [Parameter] public IconBase ExpandIcon { get; set; } /// - /// CollapseIcon is obsolete and will be removed in future release. Use if you want to render an icon. + /// CollapseIcon is obsolete and will be removed in a future release. Use if you want to render an icon. /// - [Obsolete("CollapseIcon is obsolete and will be removed in future release. Use TogglerTemplate if you want to render an icon.")] + [Obsolete("CollapseIcon is obsolete and will be removed in a future release. Use TogglerTemplate if you want to render an icon.")] [Parameter] public IconBase CollapseIcon { get; set; } /// @@ -65,15 +65,15 @@ public partial class HxSidebar : ComponentBase protected virtual Task InvokeCollapsedChangedAsync(bool collapsed) => CollapsedChanged.InvokeAsync(collapsed); /// - /// Whether multiple items can be in expanded state at once. + /// Whether multiple items can be in the expanded state at once. /// If set to false, upon item expansion, all other items are collapsed. - /// Default is true. + /// The default is true. /// [Parameter] public bool MultipleItemsExpansion { get; set; } = true; /// - /// Breakpoint below which the sidebar switches to mobile version (exclusive).
- /// Default is . + /// The breakpoint below which the sidebar switches to the mobile version (exclusive).
+ /// The default is . ///
[Parameter] public SidebarResponsiveBreakpoint ResponsiveBreakpoint { get; set; } = SidebarResponsiveBreakpoint.Medium; @@ -82,7 +82,7 @@ public partial class HxSidebar : ComponentBase protected internal string NavContentElementId => Id + "-nav-content"; /// - /// Id of the immediate parent of the contained components. + /// The ID of the immediate parent of the contained components. /// internal string navId = "hx" + Guid.NewGuid().ToString("N"); diff --git a/Havit.Blazor.Components.Web.Bootstrap/Navigation/HxSidebarBrand.razor.cs b/Havit.Blazor.Components.Web.Bootstrap/Navigation/HxSidebarBrand.razor.cs index 8178f0780..de2d8eae4 100644 --- a/Havit.Blazor.Components.Web.Bootstrap/Navigation/HxSidebarBrand.razor.cs +++ b/Havit.Blazor.Components.Web.Bootstrap/Navigation/HxSidebarBrand.razor.cs @@ -6,22 +6,22 @@ public partial class HxSidebarBrand { /// - /// Brand long name. + /// The long name of the brand. /// [Parameter] public string BrandName { get; set; } /// - /// Brand logo. + /// The logo of the brand. /// [Parameter] public RenderFragment LogoTemplate { get; set; } /// - /// Brand short name. + /// The short name of the brand. /// [Parameter] public string BrandNameShort { get; set; } /// - /// containing the . + /// The containing the . /// [CascadingParameter] protected HxSidebar ParentSidebar { get; set; } diff --git a/Havit.Blazor.Components.Web.Bootstrap/Navigation/HxSidebarFooter.razor.cs b/Havit.Blazor.Components.Web.Bootstrap/Navigation/HxSidebarFooter.razor.cs index 363514cfd..276ba81b3 100644 --- a/Havit.Blazor.Components.Web.Bootstrap/Navigation/HxSidebarFooter.razor.cs +++ b/Havit.Blazor.Components.Web.Bootstrap/Navigation/HxSidebarFooter.razor.cs @@ -24,13 +24,13 @@ public partial class HxSidebarFooter /// /// URL matching behavior for the underlying . - /// Default is . + /// The default value is . /// [Parameter] public NavLinkMatch? Match { get; set; } = NavLinkMatch.Prefix; /// /// Allows you to disable the item with false. - /// Default is true. + /// The default value is true. /// [Parameter] public string CssClass { get; set; } diff --git a/Havit.Blazor.Components.Web.Bootstrap/Navigation/NavOrientation.cs b/Havit.Blazor.Components.Web.Bootstrap/Navigation/NavOrientation.cs index 84286de04..4926465fb 100644 --- a/Havit.Blazor.Components.Web.Bootstrap/Navigation/NavOrientation.cs +++ b/Havit.Blazor.Components.Web.Bootstrap/Navigation/NavOrientation.cs @@ -11,4 +11,4 @@ public enum NavOrientation /// https://getbootstrap.com/docs/5.3/components/navs-tabs/#vertical. ///
Vertical = 1 -} \ No newline at end of file +} diff --git a/Havit.Blazor.Components.Web.Bootstrap/Navigation/NavVariant.cs b/Havit.Blazor.Components.Web.Bootstrap/Navigation/NavVariant.cs index 776b79853..ac3466d96 100644 --- a/Havit.Blazor.Components.Web.Bootstrap/Navigation/NavVariant.cs +++ b/Havit.Blazor.Components.Web.Bootstrap/Navigation/NavVariant.cs @@ -12,7 +12,7 @@ public enum NavVariant /// /// Tabs. https://getbootstrap.com/docs/5.3/components/navs-tabs/#tabs - /// Remember to set active tab (). + /// Remember to set the active tab (). /// Tabs = 1, diff --git a/Havit.Blazor.Components.Web.Bootstrap/Navigation/NavbarExpand.cs b/Havit.Blazor.Components.Web.Bootstrap/Navigation/NavbarExpand.cs index fec848f4d..fcdf93a8e 100644 --- a/Havit.Blazor.Components.Web.Bootstrap/Navigation/NavbarExpand.cs +++ b/Havit.Blazor.Components.Web.Bootstrap/Navigation/NavbarExpand.cs @@ -11,27 +11,27 @@ public enum NavbarExpand Always, /// - /// Expanded for viewports above "small" breakpoint (576px). + /// Expanded for viewports above the "small" breakpoint (576px). /// SmallUp, /// - /// Expanded for viewports above "medium" breakpoint (768px). + /// Expanded for viewports above the "medium" breakpoint (768px). /// MediumUp, /// - /// Expanded for viewports above "large" breakpoint (992px). + /// Expanded for viewports above the "large" breakpoint (992px). /// LargeUp, /// - /// Expanded for viewports above "extra-large" breakpoint (1200px). + /// Expanded for viewports above the "extra-large" breakpoint (1200px). /// ExtraLargeUp, /// - /// Expanded for viewports above "XXL" breakpoint (1400px). + /// Expanded for viewports above the "XXL" breakpoint (1400px). /// XxlUp, diff --git a/Havit.Blazor.Components.Web.Bootstrap/Navigation/SidebarItemContentTemplateContext.cs b/Havit.Blazor.Components.Web.Bootstrap/Navigation/SidebarItemContentTemplateContext.cs index 8008d8c88..f1f5d2510 100644 --- a/Havit.Blazor.Components.Web.Bootstrap/Navigation/SidebarItemContentTemplateContext.cs +++ b/Havit.Blazor.Components.Web.Bootstrap/Navigation/SidebarItemContentTemplateContext.cs @@ -6,7 +6,7 @@ public class SidebarItemContentTemplateContext { /// - /// Indicates whether a is collapsed or expanded. Is null when item has no expandable content. + /// Indicates whether a is collapsed or expanded. Is null when the item has no expandable content. /// public bool? ItemExpanded { get; set; } } diff --git a/Havit.Blazor.Components.Web.Bootstrap/Navigation/SidebarMobileBreakpoint.cs b/Havit.Blazor.Components.Web.Bootstrap/Navigation/SidebarMobileBreakpoint.cs index 5e021415c..d47547061 100644 --- a/Havit.Blazor.Components.Web.Bootstrap/Navigation/SidebarMobileBreakpoint.cs +++ b/Havit.Blazor.Components.Web.Bootstrap/Navigation/SidebarMobileBreakpoint.cs @@ -3,32 +3,32 @@ public enum SidebarResponsiveBreakpoint { /// - /// Mobile mode disabled, always render as sidebar. + /// Mobile mode disabled, always render as a sidebar. /// None = 0, /// - /// Mobile for viewports bellow "small" breakpoint (576px, exclusive). + /// Mobile for viewports below the "small" breakpoint (576px, exclusive). /// Small = 1, /// - /// Mobile for viewports bellow "medium" breakpoint (768px, exclusive). + /// Mobile for viewports below the "medium" breakpoint (768px, exclusive). /// Medium = 3, /// - /// Mobile for viewports bellow "large" breakpoint (992px, exclusive). + /// Mobile for viewports below the "large" breakpoint (992px, exclusive). /// Large = 4, /// - /// Mobile for viewports bellow "extra-large" breakpoint (1200px, exclusive). + /// Mobile for viewports below the "extra-large" breakpoint (1200px, exclusive). /// ExtraLarge = 5, /// - /// Mobile for viewports bellow "XXL" breakpoint (1400px, exclusive). + /// Mobile for viewports below the "XXL" breakpoint (1400px, exclusive). /// Xxl = 6, -} \ No newline at end of file +} diff --git a/Havit.Blazor.Components.Web.Bootstrap/Offcanvas/HxOffcanvas.razor.cs b/Havit.Blazor.Components.Web.Bootstrap/Offcanvas/HxOffcanvas.razor.cs index 243ea4c1e..f65275a7f 100644 --- a/Havit.Blazor.Components.Web.Bootstrap/Offcanvas/HxOffcanvas.razor.cs +++ b/Havit.Blazor.Components.Web.Bootstrap/Offcanvas/HxOffcanvas.razor.cs @@ -52,14 +52,14 @@ static HxOffcanvas() protected virtual OffcanvasSettings GetSettings() => this.Settings; /// - /// Text for the title in header. - /// (Is rendered into <h5 class="offcanvas-title"> - in opposite to which is rendered directly into offcanvas-header). + /// Text for the title in the header. + /// (Is rendered into <h5 class="offcanvas-title"> - in contrast to which is rendered directly into offcanvas-header). /// [Parameter] public string Title { get; set; } /// /// Content for the header. - /// (Is rendered directly into offcanvas-header - in opposite to which is rendered into <h5 class="offcanvas-title">). + /// (Is rendered directly into offcanvas-header - in contrast to which is rendered into <h5 class="offcanvas-title">). /// [Parameter] public RenderFragment HeaderTemplate { get; set; } @@ -74,7 +74,7 @@ static HxOffcanvas() [Parameter] public RenderFragment FooterTemplate { get; set; } /// - /// Placement of the offcanvas. Default is (right). + /// Placement of the offcanvas. The default is (right). /// [Parameter] public OffcanvasPlacement? Placement { get; set; } protected OffcanvasPlacement PlacementEffective => this.Placement ?? this.GetSettings()?.Placement ?? GetDefaults().Placement ?? throw new InvalidOperationException(nameof(Placement) + " default for " + nameof(HxOffcanvas) + " has to be set."); @@ -87,50 +87,50 @@ static HxOffcanvas() /// /// Determines whether the content is always rendered or only if the offcanvas is open.
- /// Default is .
+ /// The default is .
/// Please note, this setting applies only when is set. For all other values, the content is always rendered (to be available for the mobile version). ///
[Parameter] public OffcanvasRenderMode RenderMode { get; set; } = OffcanvasRenderMode.OpenOnly; /// - /// Size of the offcanvas. Default is . + /// Size of the offcanvas. The default is . /// [Parameter] public OffcanvasSize? Size { get; set; } protected OffcanvasSize SizeEffective => this.Size ?? this.GetSettings()?.Size ?? GetDefaults().Size ?? throw new InvalidOperationException(nameof(Size) + " default for " + nameof(HxOffcanvas) + " has to be set."); /// - /// Indicates whether the modal shows close button in header. - /// Default value is true. - /// Use to change shape of the button. + /// Indicates whether the modal shows a close button in the header. + /// The default value is true. + /// Use to change the shape of the button. /// [Parameter] public bool? ShowCloseButton { get; set; } protected bool ShowCloseButtonEffective => this.ShowCloseButton ?? this.GetSettings()?.ShowCloseButton ?? GetDefaults().ShowCloseButton ?? throw new InvalidOperationException(nameof(ShowCloseButton) + " default for " + nameof(HxOffcanvas) + " has to be set."); /// - /// Indicates whether the offcanvas closes when escape key is pressed. - /// Default value is true. + /// Indicates whether the offcanvas closes when the escape key is pressed. + /// The default value is true. /// [Parameter] public bool? CloseOnEscape { get; set; } protected bool CloseOnEscapeEffective => this.CloseOnEscape ?? this.GetSettings()?.CloseOnEscape ?? GetDefaults().CloseOnEscape ?? throw new InvalidOperationException(nameof(CloseOnEscape) + " default for " + nameof(HxOffcanvas) + " has to be set."); /// - /// Close icon to be used in header. - /// If set to null, Bootstrap default close-button will be used. + /// The close icon to be used in the header. + /// If set to null, the Bootstrap default close button will be used. /// [Parameter] public IconBase CloseButtonIcon { get; set; } protected IconBase CloseButtonIconEffective => this.CloseButtonIcon ?? this.GetSettings()?.CloseButtonIcon ?? GetDefaults().CloseButtonIcon; /// - /// Indicates whether to apply a backdrop on body while offcanvas is open. + /// Indicates whether to apply a backdrop on the body while the offcanvas is open. /// If set to , the offcanvas cannot be closed by clicking on the backdrop. - /// Default value (from ) is . + /// The default value (from ) is . /// [Parameter] public OffcanvasBackdrop? Backdrop { get; set; } protected OffcanvasBackdrop BackdropEffective => this.Backdrop ?? this.GetSettings()?.Backdrop ?? GetDefaults().Backdrop ?? throw new InvalidOperationException(nameof(Backdrop) + " default for " + nameof(HxOffcanvas) + " has to be set."); /// - /// Indicates whether body (page) scrolling is allowed while offcanvas is open. - /// Default value (from ) is false. + /// Indicates whether body (page) scrolling is allowed while the offcanvas is open. + /// The default value (from ) is false. /// [Parameter] public bool? ScrollingEnabled { get; set; } protected bool ScrollingEnabledEffective => this.ScrollingEnabled ?? this.GetSettings()?.ScrollingEnabled ?? GetDefaults().ScrollingEnabled ?? throw new InvalidOperationException(nameof(ScrollingEnabled) + " default for " + nameof(HxOffcanvas) + " has to be set."); diff --git a/Havit.Blazor.Components.Web.Bootstrap/Offcanvas/OffcanvasBackdrop.cs b/Havit.Blazor.Components.Web.Bootstrap/Offcanvas/OffcanvasBackdrop.cs index 646c57ed0..28350fe10 100644 --- a/Havit.Blazor.Components.Web.Bootstrap/Offcanvas/OffcanvasBackdrop.cs +++ b/Havit.Blazor.Components.Web.Bootstrap/Offcanvas/OffcanvasBackdrop.cs @@ -6,17 +6,17 @@ public enum OffcanvasBackdrop { /// - /// A backdrop will be rendered. Offcanvas will be closed upon clicking on the backdrop. + /// A backdrop will be rendered. The offcanvas will be closed upon clicking on the backdrop. /// True = 0, /// - /// No backdrop will be rendered. User can interact with other parts of the app while the offcanvas is open. + /// No backdrop will be rendered. Users can interact with other parts of the app while the offcanvas is open. /// False = 1, /// - /// A static backdrop will be rendered. Offcanvas will not be closed upon clicking on the backdrop. + /// A static backdrop will be rendered. The offcanvas will not be closed upon clicking on the backdrop. /// Static = 2 } diff --git a/Havit.Blazor.Components.Web.Bootstrap/Offcanvas/OffcanvasPlacement.cs b/Havit.Blazor.Components.Web.Bootstrap/Offcanvas/OffcanvasPlacement.cs index abef5f333..288c3cd08 100644 --- a/Havit.Blazor.Components.Web.Bootstrap/Offcanvas/OffcanvasPlacement.cs +++ b/Havit.Blazor.Components.Web.Bootstrap/Offcanvas/OffcanvasPlacement.cs @@ -1,9 +1,27 @@ namespace Havit.Blazor.Components.Web.Bootstrap; +/// +/// Represents the placement of an offcanvas. +/// public enum OffcanvasPlacement { + /// + /// Offcanvas is placed at the end. + /// End = 0, + + /// + /// Offcanvas is placed at the start. + /// Start, + + /// + /// Offcanvas is placed at the top. + /// Top, + + /// + /// Offcanvas is placed at the bottom. + /// Bottom } diff --git a/Havit.Blazor.Components.Web.Bootstrap/Offcanvas/OffcanvasRenderMode.cs b/Havit.Blazor.Components.Web.Bootstrap/Offcanvas/OffcanvasRenderMode.cs index f94af3503..75f9584a8 100644 --- a/Havit.Blazor.Components.Web.Bootstrap/Offcanvas/OffcanvasRenderMode.cs +++ b/Havit.Blazor.Components.Web.Bootstrap/Offcanvas/OffcanvasRenderMode.cs @@ -6,8 +6,8 @@ public enum OffcanvasRenderMode { /// - /// Offcanvas content is rendered only when it is open.
- /// Suitable for item-detail, item-edit, etc.
+ /// Offcanvas content is rendered only when it is open. + /// Suitable for item-detail, item-edit, etc. /// This setting applies only when is set. For all other values, the content is always rendered (to be available for the mobile version). ///
OpenOnly = 0, @@ -17,4 +17,4 @@ public enum OffcanvasRenderMode /// Needed for HxFilterForm with HxChipList. /// Always = 1 -} \ No newline at end of file +} diff --git a/Havit.Blazor.Components.Web.Bootstrap/Offcanvas/OffcanvasResponsiveBreakpoint.cs b/Havit.Blazor.Components.Web.Bootstrap/Offcanvas/OffcanvasResponsiveBreakpoint.cs index 08c6d2cdd..a0f821643 100644 --- a/Havit.Blazor.Components.Web.Bootstrap/Offcanvas/OffcanvasResponsiveBreakpoint.cs +++ b/Havit.Blazor.Components.Web.Bootstrap/Offcanvas/OffcanvasResponsiveBreakpoint.cs @@ -26,12 +26,12 @@ public enum OffcanvasResponsiveBreakpoint Large = 4, /// - /// Render contents outside the viewport in an offcanvas when bellow "extra-large" breakpoint (1200px, exclusive). + /// Render contents outside the viewport in an offcanvas when below the "extra-large" breakpoint (1200px, exclusive). /// ExtraLarge = 5, /// - /// Render contents outside the viewport in an offcanvas when bellow "XXL" breakpoint (1400px, exclusive). + /// Render contents outside the viewport in an offcanvas when below the "XXL" breakpoint (1400px, exclusive). /// Xxl = 6, } diff --git a/Havit.Blazor.Components.Web.Bootstrap/Offcanvas/OffcanvasSettings.cs b/Havit.Blazor.Components.Web.Bootstrap/Offcanvas/OffcanvasSettings.cs index f207adc12..b2cb3abea 100644 --- a/Havit.Blazor.Components.Web.Bootstrap/Offcanvas/OffcanvasSettings.cs +++ b/Havit.Blazor.Components.Web.Bootstrap/Offcanvas/OffcanvasSettings.cs @@ -6,67 +6,67 @@ public record OffcanvasSettings { /// - /// Close icon to be used in header. - /// If set to null, Bootstrap default close-button will be used. + /// Close icon to be used in the header. + /// If set to null, the Bootstrap default close button will be used. /// public IconBase CloseButtonIcon { get; set; } /// - /// Indicates whether the modal shows close button in header. - /// Use to change shape of the button. + /// Indicates whether the modal shows a close button in the header. + /// Use the property to change the shape of the button. /// public bool? ShowCloseButton { get; set; } /// - /// Indicates whether to apply a backdrop on body while offcanvas is open. + /// Indicates whether to apply a backdrop on the body while the offcanvas is open. /// public OffcanvasBackdrop? Backdrop { get; set; } /// - /// Breakpoint below which the contents are rendered outside the viewport in an offcanvas (above this breakpoint, the offcanvas body is rendered inside the viewport). + /// The breakpoint below which the contents are rendered outside the viewport in an offcanvas (above this breakpoint, the offcanvas body is rendered inside the viewport). /// public OffcanvasResponsiveBreakpoint? ResponsiveBreakpoint { get; set; } /// - /// Placement of the offcanvas. + /// The placement of the offcanvas. /// public OffcanvasPlacement? Placement { get; set; } /// - /// Size of the offcanvas.
+ /// The size of the offcanvas. ///
/// - /// Consider customization of the offcanvas CSS variables instead of changing the Size application-wide. + /// Consider customizing the offcanvas CSS variables instead of changing the size application-wide. /// public OffcanvasSize? Size { get; set; } /// - /// Indicates whether the offcanvas closes when escape key is pressed. + /// Indicates whether the offcanvas closes when the escape key is pressed. /// public bool? CloseOnEscape { get; set; } /// - /// Indicates whether body (page) scrolling is allowed while offcanvas is open. + /// Indicates whether body (page) scrolling is allowed while the offcanvas is open. /// public bool? ScrollingEnabled { get; set; } /// - /// Offcanvas additional CSS class. Added to root div (.offcanvas). + /// Additional CSS class for the offcanvas. Added to the root div (.offcanvas). /// public string CssClass { get; set; } /// - /// Additional header CSS class. + /// Additional CSS class for the header. /// public string HeaderCssClass { get; set; } /// - /// Additional body CSS class. + /// Additional CSS class for the body. /// public string BodyCssClass { get; set; } /// - /// Additional footer CSS class. + /// Additional CSS class for the footer. /// public string FooterCssClass { get; set; } } diff --git a/Havit.Blazor.Components.Web.Bootstrap/Offcanvas/OffcanvasSize.cs b/Havit.Blazor.Components.Web.Bootstrap/Offcanvas/OffcanvasSize.cs index ed866c515..2e7b1dfb7 100644 --- a/Havit.Blazor.Components.Web.Bootstrap/Offcanvas/OffcanvasSize.cs +++ b/Havit.Blazor.Components.Web.Bootstrap/Offcanvas/OffcanvasSize.cs @@ -1,8 +1,22 @@ namespace Havit.Blazor.Components.Web.Bootstrap; +/// +/// Represents the size options for the Offcanvas component. +/// public enum OffcanvasSize { + /// + /// Regular size. + /// Regular = 0, + + /// + /// Small size. + /// Small, + + /// + /// Large size. + /// Large -} \ No newline at end of file +} diff --git a/Havit.Blazor.Components.Web.Bootstrap/Placeholders/HxPlaceholder.razor.cs b/Havit.Blazor.Components.Web.Bootstrap/Placeholders/HxPlaceholder.razor.cs index 5df8ef9c6..8067b32c0 100644 --- a/Havit.Blazor.Components.Web.Bootstrap/Placeholders/HxPlaceholder.razor.cs +++ b/Havit.Blazor.Components.Web.Bootstrap/Placeholders/HxPlaceholder.razor.cs @@ -1,8 +1,8 @@ namespace Havit.Blazor.Components.Web.Bootstrap; /// -/// Bootstrap 5 Placeholder component, aka Skeleton.
-/// Use loading placeholders for your components or pages to indicate something may still be loading.
+/// Bootstrap 5 Placeholder component, also known as Skeleton.
+/// Use loading placeholders for your components or pages to indicate that something may still be loading.
/// Full documentation and demos: https://havit.blazor.eu/components/HxPlaceholder ///
public partial class HxPlaceholder : ILayoutColumnComponent @@ -23,7 +23,7 @@ static HxPlaceholder() /// /// Returns application-wide defaults for the component. - /// Enables overriding defaults in descendants (use separate set of defaults). + /// Enables overriding defaults in descendants (use a separate set of defaults). /// protected virtual PlaceholderSettings GetDefaults() => Defaults; @@ -33,10 +33,10 @@ static HxPlaceholder() [Parameter] public PlaceholderSettings Settings { get; set; } /// - /// Returns optional set of component settings. + /// Returns an optional set of component settings. /// /// - /// Similar to , enables defining wider in components descendants (by returning a derived settings class). + /// Similar to , enables defining wider in component descendants (by returning a derived settings class). /// protected virtual PlaceholderSettings GetSettings() => this.Settings; diff --git a/Havit.Blazor.Components.Web.Bootstrap/Placeholders/HxPlaceholderButton.cs b/Havit.Blazor.Components.Web.Bootstrap/Placeholders/HxPlaceholderButton.cs index cbe5f7087..0ecaafcef 100644 --- a/Havit.Blazor.Components.Web.Bootstrap/Placeholders/HxPlaceholderButton.cs +++ b/Havit.Blazor.Components.Web.Bootstrap/Placeholders/HxPlaceholderButton.cs @@ -1,8 +1,8 @@ namespace Havit.Blazor.Components.Web.Bootstrap; /// -/// Bootstrap 5 placeholder in form of a button.
-/// Derives from (adds placeholder class and changes Enabled default to false).
+/// Bootstrap 5 placeholder in the form of a button.
+/// Derives from (adds the placeholder class and changes the default value of Enabled to false).
/// Set the size of the button by using the parameter. ///
public class HxPlaceholderButton : HxButton, ILayoutColumnComponent diff --git a/Havit.Blazor.Components.Web.Bootstrap/Placeholders/HxPlaceholderContainer.razor.cs b/Havit.Blazor.Components.Web.Bootstrap/Placeholders/HxPlaceholderContainer.razor.cs index f4c04a413..ea9f41074 100644 --- a/Havit.Blazor.Components.Web.Bootstrap/Placeholders/HxPlaceholderContainer.razor.cs +++ b/Havit.Blazor.Components.Web.Bootstrap/Placeholders/HxPlaceholderContainer.razor.cs @@ -21,7 +21,7 @@ static HxPlaceholderContainer() /// /// Returns application-wide defaults for the component. - /// Enables overriding defaults in descendants (use separate set of defaults). + /// Enables overriding defaults in descendants (use a separate set of defaults). /// protected virtual PlaceholderContainerSettings GetDefaults() => Defaults; @@ -31,16 +31,16 @@ static HxPlaceholderContainer() [Parameter] public PlaceholderContainerSettings Settings { get; set; } /// - /// Returns optional set of component settings. + /// Returns an optional set of component settings. /// /// - /// Similar to , enables defining wider in components descendants (by returning a derived settings class). + /// Similar to , enables defining wider in component descendants (by returning a derived settings class). /// protected virtual PlaceholderContainerSettings GetSettings() => this.Settings; /// - /// Animation of the placeholders in container. + /// Animation of the placeholders in the container. /// [Parameter] public PlaceholderAnimation? Animation { get; set; } protected PlaceholderAnimation AnimationEffective => this.Animation ?? this.GetSettings()?.Animation ?? GetDefaults().Animation ?? throw new InvalidOperationException(nameof(Animation) + " default for " + nameof(HxPlaceholderContainer) + " has to be set."); diff --git a/Havit.Blazor.Components.Web.Bootstrap/Placeholders/PlaceholderAnimation.cs b/Havit.Blazor.Components.Web.Bootstrap/Placeholders/PlaceholderAnimation.cs index bda940cd5..fc9dc2a82 100644 --- a/Havit.Blazor.Components.Web.Bootstrap/Placeholders/PlaceholderAnimation.cs +++ b/Havit.Blazor.Components.Web.Bootstrap/Placeholders/PlaceholderAnimation.cs @@ -11,12 +11,12 @@ public enum PlaceholderAnimation None = 0, /// - /// Glow animation. + /// Animation with a glowing effect. /// Glow = 1, /// - /// Wave animation. + /// Animation with a waving effect. /// Wave = 2 -} \ No newline at end of file +} diff --git a/Havit.Blazor.Components.Web.Bootstrap/Placeholders/PlaceholderContainerSettings.cs b/Havit.Blazor.Components.Web.Bootstrap/Placeholders/PlaceholderContainerSettings.cs index 12e528207..ab0e10737 100644 --- a/Havit.Blazor.Components.Web.Bootstrap/Placeholders/PlaceholderContainerSettings.cs +++ b/Havit.Blazor.Components.Web.Bootstrap/Placeholders/PlaceholderContainerSettings.cs @@ -6,12 +6,12 @@ public record PlaceholderContainerSettings { /// - /// Animation of the placeholders in container. + /// Animation of the placeholders in the container. /// public PlaceholderAnimation? Animation { get; set; } /// - /// Additional CSS class for . + /// Additional CSS class for the . /// public string CssClass { get; set; } } diff --git a/Havit.Blazor.Components.Web.Bootstrap/Placeholders/PlaceholderSize.cs b/Havit.Blazor.Components.Web.Bootstrap/Placeholders/PlaceholderSize.cs index ac05cb79d..c3290884c 100644 --- a/Havit.Blazor.Components.Web.Bootstrap/Placeholders/PlaceholderSize.cs +++ b/Havit.Blazor.Components.Web.Bootstrap/Placeholders/PlaceholderSize.cs @@ -1,7 +1,7 @@ namespace Havit.Blazor.Components.Web.Bootstrap; /// -/// Size for component. +/// Represents the size for the component. /// public enum PlaceholderSize { diff --git a/Havit.Blazor.Components.Web.Bootstrap/Progress/HxProgress.razor.cs b/Havit.Blazor.Components.Web.Bootstrap/Progress/HxProgress.razor.cs index ba3405638..514ba3581 100644 --- a/Havit.Blazor.Components.Web.Bootstrap/Progress/HxProgress.razor.cs +++ b/Havit.Blazor.Components.Web.Bootstrap/Progress/HxProgress.razor.cs @@ -18,27 +18,27 @@ public partial class HxProgress [Parameter] public string CssClass { get; set; } /// - /// Height of all inner progress bars. Default is 15px. + /// Height of all inner progress bars. The default value is 15px. /// [Parameter] public int Height { get; set; } = 15; /// - /// Lowest possible value. Default is 0. + /// Lowest possible value. The default value is 0. /// [Parameter] public float MinValue { get; set; } = 0; /// - /// Highest possible value. Default is 100. + /// Highest possible value. The default value is 100. /// [Parameter] public float MaxValue { get; set; } = 100; /// - /// If true, applies a stripe via CSS gradient over the progress bar's background color. + /// If true, applies a stripe via CSS gradient over the background color of the progress bar. /// [Parameter] public bool Striped { get; set; } /// - /// If true, stripes are animated right to left via CSS3 animations, stripes are automatically switched on. + /// If true, the stripes are animated right to left using CSS3 animations. The stripes are automatically switched on. /// [Parameter] public bool Animated { get; set; } } diff --git a/Havit.Blazor.Components.Web.Bootstrap/Progress/HxProgressBar.razor.cs b/Havit.Blazor.Components.Web.Bootstrap/Progress/HxProgressBar.razor.cs index b9052100d..295e496b1 100644 --- a/Havit.Blazor.Components.Web.Bootstrap/Progress/HxProgressBar.razor.cs +++ b/Havit.Blazor.Components.Web.Bootstrap/Progress/HxProgressBar.razor.cs @@ -16,7 +16,7 @@ public partial class HxProgressBar [Parameter] public string CssClass { get; set; } /// - /// Current value (proportion of the progress bar that is taken up). + /// Current value (proportion of the progress bar that is filled). /// [Parameter] public float Value { get; set; } @@ -80,7 +80,7 @@ private int GetNormalizedValue() return (int)Value; } - float normalized = (float)((100f / (MaxValueEffective - MinValueEffective) * (Value - MaxValueEffective)) + 100f); + float normalized = (float)((100f / (MaxValueEffective - MinValueEffective) * (Value - MinValueEffective)) + 100f); return (int)normalized; } } diff --git a/Havit.Blazor.Components.Web.Bootstrap/Progress/HxProgressIndicator.razor.cs b/Havit.Blazor.Components.Web.Bootstrap/Progress/HxProgressIndicator.razor.cs index f99722e95..cfc34e6d7 100644 --- a/Havit.Blazor.Components.Web.Bootstrap/Progress/HxProgressIndicator.razor.cs +++ b/Havit.Blazor.Components.Web.Bootstrap/Progress/HxProgressIndicator.razor.cs @@ -21,7 +21,7 @@ static HxProgressIndicator() /// /// Returns application-wide defaults for the component. - /// Enables overriding defaults in descendants (use separate set of defaults). + /// Enables overriding defaults in descendants (use a separate set of defaults). /// protected virtual ProgressIndicatorSettings GetDefaults() => Defaults; @@ -31,10 +31,10 @@ static HxProgressIndicator() [Parameter] public ProgressIndicatorSettings Settings { get; set; } /// - /// Returns optional set of component settings. + /// Returns an optional set of component settings. /// /// - /// Similar to , enables defining wider in components descendants (by returning a derived settings class). + /// Similar to , enables defining wider in component descendants (by returning a derived settings class). /// protected virtual ProgressIndicatorSettings GetSettings() => this.Settings; @@ -44,7 +44,7 @@ static HxProgressIndicator() [Parameter] public bool InProgress { get; set; } /// - /// Debounce delay in milliseconds. Default is 300 ms. + /// Debounce delay in milliseconds. The default is 300 ms. /// [Parameter] public int? Delay { get; set; } protected int DelayEffective => this.Delay ?? GetSettings()?.Delay ?? GetDefaults()?.Delay ?? throw new InvalidOperationException(nameof(Delay) + " default for " + nameof(HxProgressIndicator) + " has to be set."); @@ -66,7 +66,7 @@ protected override async Task OnParametersSetAsync() if (shouldBeProgressIndicatorVisible && !progressIndicatorVisible) { - // start showing progress indicator (when not already started) + // start showing the progress indicator (when not already started) if (DelayEffective == 0) { await StartInProgressAsync(); @@ -81,7 +81,7 @@ protected override async Task OnParametersSetAsync() timer?.Stop(); if (progressIndicatorVisible) { - // hide progress indicator if visible + // hide the progress indicator if visible progressIndicatorVisible = false; await ProgressIndicatorVisibleChanged.InvokeAsync(progressIndicatorVisible); } @@ -105,8 +105,8 @@ private void StartInProgressWithDelay() _ = InvokeAsync(async () => { // condition InProgress: - // Critical for times around TimerDelay - timer can rise elapsed and InvokeAsync "plan" the action to run. - // But before it is run, OnParametersSetAsync can be called and switch of the progress bar. + // Critical for times around TimerDelay - the timer can rise elapsed and InvokeAsync "plan" the action to run. + // But before it is run, OnParametersSetAsync can be called and switch off the progress bar. if (InProgress) { await StartInProgressAsync(); diff --git a/Havit.Blazor.Components.Web.Bootstrap/Progress/HxSpinner.razor.cs b/Havit.Blazor.Components.Web.Bootstrap/Progress/HxSpinner.razor.cs index b6fd15996..2e39a7d15 100644 --- a/Havit.Blazor.Components.Web.Bootstrap/Progress/HxSpinner.razor.cs +++ b/Havit.Blazor.Components.Web.Bootstrap/Progress/HxSpinner.razor.cs @@ -3,18 +3,18 @@ namespace Havit.Blazor.Components.Web.Bootstrap; /// -/// Bootstrap Spinner (usually indicates operation in progress).
+/// Bootstrap Spinner (usually indicates an operation in progress).
/// Full documentation and demos: https://havit.blazor.eu/components/HxSpinner ///
public partial class HxSpinner { /// - /// Spinner type. Spinner type - Border (default) or Grow. + /// Spinner type. The spinner type can be Border (default) or Grow. /// [Parameter] public SpinnerType Type { get; set; } = SpinnerType.Border; /// - /// Spinner size. You can also use custom to change the dimensions as needed. + /// Spinner size. You can also use a custom to change the dimensions as needed. /// [Parameter] public SpinnerSize Size { get; set; } = SpinnerSize.Regular; diff --git a/Havit.Blazor.Components.Web.Bootstrap/Progress/SpinnerSize.cs b/Havit.Blazor.Components.Web.Bootstrap/Progress/SpinnerSize.cs index 6be5b9ef9..6ca842630 100644 --- a/Havit.Blazor.Components.Web.Bootstrap/Progress/SpinnerSize.cs +++ b/Havit.Blazor.Components.Web.Bootstrap/Progress/SpinnerSize.cs @@ -1,10 +1,10 @@ namespace Havit.Blazor.Components.Web.Bootstrap; /// -/// Size for . +/// Represents the size for . /// public enum SpinnerSize { Regular = 0, Small = 1 -} \ No newline at end of file +} diff --git a/Havit.Blazor.Components.Web.Bootstrap/Progress/SpinnerType.cs b/Havit.Blazor.Components.Web.Bootstrap/Progress/SpinnerType.cs index de9578fb3..b6789dbc2 100644 --- a/Havit.Blazor.Components.Web.Bootstrap/Progress/SpinnerType.cs +++ b/Havit.Blazor.Components.Web.Bootstrap/Progress/SpinnerType.cs @@ -1,14 +1,17 @@ namespace Havit.Blazor.Components.Web.Bootstrap; +/// +/// Represents a spinner type. +/// public enum SpinnerType { /// - /// https://getbootstrap.com/docs/5.3/components/spinners/#border-spinner + /// Represents a border spinner. For more information, see: https://getbootstrap.com/docs/5.3/components/spinners/#border-spinner /// Border = 1, /// - /// https://getbootstrap.com/docs/5.3/components/spinners/#growing-spinner + /// Represents a growing spinner. For more information, see: https://getbootstrap.com/docs/5.3/components/spinners/#growing-spinner /// Grow = 2 -} \ No newline at end of file +} diff --git a/Havit.Blazor.Components.Web.Bootstrap/Tabs/HxTabPanel.razor.cs b/Havit.Blazor.Components.Web.Bootstrap/Tabs/HxTabPanel.razor.cs index d49fd886b..23a7a895a 100644 --- a/Havit.Blazor.Components.Web.Bootstrap/Tabs/HxTabPanel.razor.cs +++ b/Havit.Blazor.Components.Web.Bootstrap/Tabs/HxTabPanel.razor.cs @@ -26,7 +26,7 @@ public partial class HxTabPanel : ComponentBase, IAsyncDisposable [Parameter] public TabPanelVariant Variant { get; set; } = TabPanelVariant.Standard; /// - /// Determines whether the content all tabs is always rendered or only if the tab is active.
+ /// Determines whether the content of all tabs is always rendered or only if the tab is active.
/// Default is . ///
[Parameter] public TabPanelRenderMode RenderMode { get; set; } = TabPanelRenderMode.AllTabs; @@ -43,7 +43,7 @@ public partial class HxTabPanel : ComponentBase, IAsyncDisposable [Parameter] public string ActiveTabId { get; set; } /// - /// Raised when ID of the active tab changes. + /// Raised when the ID of the active tab changes. /// [Parameter] public EventCallback ActiveTabIdChanged { get; set; } /// @@ -97,7 +97,7 @@ protected override async Task OnParametersSetAsync() internal async Task SetActiveTabIdAsync(string newId) { - if (this.ActiveTabId != newId) + if (ActiveTabId != newId) { ActiveTabId = newId; await InvokeActiveTabIdChangedAsync(newId); @@ -133,7 +133,7 @@ protected override async Task OnAfterRenderAsync(bool firstRender) if (firstRender) { - // when no tab is active after initial render, activate the first visible & enabled tab + // when no tab is active after the initial render, activate the first visible & enabled tab if (!tabsList.Any(tab => IsActive(tab)) && (tabsList.Count > 0)) { HxTab tabToActivate = tabsList.FirstOrDefault(tab => CascadeEnabledComponent.EnabledEffective(tab) && tab.Visible); @@ -146,7 +146,7 @@ protected override async Task OnAfterRenderAsync(bool firstRender) } /// - /// Handle click on tab title to activate tab. + /// Handle click on the tab title to activate the tab. /// protected async Task HandleTabClick(HxTab tab) { diff --git a/Havit.Blazor.Components.Web.Bootstrap/Tabs/TabPanelRenderMode.cs b/Havit.Blazor.Components.Web.Bootstrap/Tabs/TabPanelRenderMode.cs index 48bb17863..e2a5ad756 100644 --- a/Havit.Blazor.Components.Web.Bootstrap/Tabs/TabPanelRenderMode.cs +++ b/Havit.Blazor.Components.Web.Bootstrap/Tabs/TabPanelRenderMode.cs @@ -6,7 +6,7 @@ public enum TabPanelRenderMode { /// - /// Content of all tabs is always rendered (and visibility set with CSS). + /// Content of all tabs is always rendered (and visibility is set with CSS). /// AllTabs = 0, diff --git a/Havit.Blazor.Components.Web.Bootstrap/Tags/HxInputTags.cs b/Havit.Blazor.Components.Web.Bootstrap/Tags/HxInputTags.cs index 616e7bb53..c4f43402d 100644 --- a/Havit.Blazor.Components.Web.Bootstrap/Tags/HxInputTags.cs +++ b/Havit.Blazor.Components.Web.Bootstrap/Tags/HxInputTags.cs @@ -59,58 +59,51 @@ static HxInputTags() [Parameter] public bool AllowCustomTags { get; set; } = true; /// - /// Set to method providing data for tags' suggestions. + /// Set to a method providing data for tag suggestions. /// [Parameter] public InputTagsDataProviderDelegate DataProvider { get; set; } /// - /// Minimal number of characters to start suggesting. Default is 2. + /// The minimum number of characters to start suggesting. The default is 2. /// [Parameter] public int? SuggestMinimumLength { get; set; } protected int SuggestMinimumLengthEffective => this.SuggestMinimumLength ?? this.GetSettings()?.SuggestMinimumLength ?? this.GetDefaults().SuggestMinimumLength ?? throw new InvalidOperationException(nameof(SuggestMinimumLength) + " default for " + nameof(HxInputTags) + " has to be set."); /// - /// Debounce delay in milliseconds. Default is 300 ms. + /// The debounce delay in milliseconds. The default is 300 ms. /// [Parameter] public int? SuggestDelay { get; set; } protected int SuggestDelayEffective => this.SuggestDelay ?? this.GetSettings()?.SuggestDelay ?? this.GetDefaults().SuggestDelay ?? throw new InvalidOperationException(nameof(SuggestDelay) + " default for " + nameof(HxInputTags) + " has to be set."); /// - /// Characters, when typed, divide the current input into separate tags. - /// Default is comma, semicolon and space. + /// Characters that divide the current input into separate tags when typed. The default is comma, semicolon, and space. /// [Parameter] public List Delimiters { get; set; } protected List DelimitersEffective => this.Delimiters ?? this.GetSettings()?.Delimiters ?? this.GetDefaults().Delimiters ?? throw new InvalidOperationException(nameof(Delimiters) + " default for " + nameof(HxInputTags) + " has to be set."); /// - /// Indicates whether the add-icon (+) should be displayed. - /// Default is false. + /// Indicates whether the add icon (+) should be displayed. The default is false. /// [Parameter] public bool? ShowAddButton { get; set; } protected bool ShowAddButtonEffective => this.ShowAddButton ?? this.GetSettings()?.ShowAddButton ?? this.GetDefaults().ShowAddButton ?? throw new InvalidOperationException(nameof(ShowAddButton) + " default for " + nameof(HxInputTags) + " has to be set."); /// - /// Optional text for the add-button. - /// Displayed only when there are no tags (the Value is empty). - /// Default is null (none). + /// The optional text for the add button. Displayed only when there are no tags (the Value is empty). The default is null (none). /// [Parameter] public string AddButtonText { get; set; } /// - /// Indicates whether a "naked" variant should be displayed (no border). - /// Default is false. - /// Consider enabling when using Naked. + /// Indicates whether a "naked" variant should be displayed (no border). The default is false. Consider enabling when using Naked. /// [Parameter] public bool Naked { get; set; } = false; /// - /// Short hint displayed in the input field before the user enters a value. + /// A short hint displayed in the input field before the user enters a value. /// [Parameter] public string Placeholder { get; set; } /// - /// Settings for the used to render tags. - /// Default is Color="" and TextColor="". + /// The settings for the used to render tags. The default is Color="" and TextColor="". /// [Parameter] public BadgeSettings TagBadgeSettings { get; set; } protected BadgeSettings TagBadgeSettingsEffective => this.TagBadgeSettings ?? this.GetSettings()?.TagBadgeSettings ?? this.GetDefaults().TagBadgeSettings ?? throw new InvalidOperationException(nameof(TagBadgeSettings) + " default for " + nameof(HxInputTags) + " has to be set."); @@ -119,7 +112,7 @@ static HxInputTags() [Parameter] public LabelType? LabelType { get; set; } /// - /// Size of the input. + /// The size of the input. /// [Parameter] public InputSize? InputSize { get; set; } protected InputSize InputSizeEffective => this.InputSize ?? GetSettings()?.InputSize ?? GetDefaults()?.InputSize ?? throw new InvalidOperationException(nameof(InputSize) + " default for " + nameof(HxInputTags) + " has to be set."); @@ -130,27 +123,27 @@ static HxInputTags() private protected override string CoreCssClass => "hx-input-tags position-relative"; /// - /// Custom CSS class to render with input-group span. + /// The custom CSS class to render with the input-group span. /// [Parameter] public string InputGroupCssClass { get; set; } /// - /// Input-group at the beginning of the input. + /// The input-group at the beginning of the input. /// [Parameter] public string InputGroupStartText { get; set; } /// - /// Input-group at the beginning of the input. + /// The input-group at the beginning of the input. /// [Parameter] public RenderFragment InputGroupStartTemplate { get; set; } /// - /// Input-group at the end of the input. + /// The input-group at the end of the input. /// [Parameter] public string InputGroupEndText { get; set; } /// - /// Input-group at the end of the input. + /// The input-group at the end of the input. /// [Parameter] public RenderFragment InputGroupEndTemplate { get; set; } diff --git a/Havit.Blazor.Components.Web.Bootstrap/Tags/InputTagsDataProviderRequest.cs b/Havit.Blazor.Components.Web.Bootstrap/Tags/InputTagsDataProviderRequest.cs index d02bfaf72..cad6a94a5 100644 --- a/Havit.Blazor.Components.Web.Bootstrap/Tags/InputTagsDataProviderRequest.cs +++ b/Havit.Blazor.Components.Web.Bootstrap/Tags/InputTagsDataProviderRequest.cs @@ -11,7 +11,7 @@ public class InputTagsDataProviderRequest public string UserInput { get; init; } /// - /// The used to relay cancellation of the request. + /// The used to indicate cancellation of the request. /// public CancellationToken CancellationToken { get; init; } -} \ No newline at end of file +} diff --git a/Havit.Blazor.Components.Web.Bootstrap/Tags/InputTagsDataProviderResult.cs b/Havit.Blazor.Components.Web.Bootstrap/Tags/InputTagsDataProviderResult.cs index 5f3b4bc67..9030736aa 100644 --- a/Havit.Blazor.Components.Web.Bootstrap/Tags/InputTagsDataProviderResult.cs +++ b/Havit.Blazor.Components.Web.Bootstrap/Tags/InputTagsDataProviderResult.cs @@ -6,7 +6,7 @@ public class InputTagsDataProviderResult { /// - /// The provided items by the request. + /// The items provided by the request. /// public IEnumerable Data { get; set; } -} \ No newline at end of file +} diff --git a/Havit.Blazor.Components.Web.Bootstrap/Tags/InputTagsSettings.cs b/Havit.Blazor.Components.Web.Bootstrap/Tags/InputTagsSettings.cs index 9e2485bdc..44b42e833 100644 --- a/Havit.Blazor.Components.Web.Bootstrap/Tags/InputTagsSettings.cs +++ b/Havit.Blazor.Components.Web.Bootstrap/Tags/InputTagsSettings.cs @@ -8,7 +8,7 @@ namespace Havit.Blazor.Components.Web.Bootstrap; public record InputTagsSettings : InputSettings, IInputSettingsWithSize { /// - /// Minimal number of characters to start suggesting. + /// Minimum number of characters to start suggesting. /// public int? SuggestMinimumLength { get; set; } @@ -23,7 +23,7 @@ public record InputTagsSettings : InputSettings, IInputSettingsWithSize public InputSize? InputSize { get; set; } /// - /// Characters, when typed, divide the current input into separate tags. + /// Characters that, when typed, divide the current input into separate tags. /// public List Delimiters { get; set; } diff --git a/Havit.Blazor.Components.Web.Bootstrap/ThemeColor.cs b/Havit.Blazor.Components.Web.Bootstrap/ThemeColor.cs index e0e6e81c7..0b93b236d 100644 --- a/Havit.Blazor.Components.Web.Bootstrap/ThemeColor.cs +++ b/Havit.Blazor.Components.Web.Bootstrap/ThemeColor.cs @@ -1,8 +1,8 @@ namespace Havit.Blazor.Components.Web.Bootstrap; /// -/// Bootstrap theme colors https://getbootstrap.com/docs/5.3/customize/color/#theme-colors -/// (+ Link from predefined button styles https://getbootstrap.com/docs/5.3/components/buttons/) +/// Bootstrap theme colors. For more information, see https://getbootstrap.com/docs/5.3/customize/color/#theme-colors. +/// Also, refer to the predefined button styles at https://getbootstrap.com/docs/5.3/components/buttons/. /// public enum ThemeColor { @@ -16,7 +16,7 @@ public enum ThemeColor Light, Dark, /// - /// To be used for buttons only. + /// This color is intended to be used for buttons only. /// Link } diff --git a/Havit.Blazor.Components.Web.Bootstrap/Toasts/BootstrapMessengerMessage.cs b/Havit.Blazor.Components.Web.Bootstrap/Toasts/BootstrapMessengerMessage.cs index af4e7bc70..fe272ef3b 100644 --- a/Havit.Blazor.Components.Web.Bootstrap/Toasts/BootstrapMessengerMessage.cs +++ b/Havit.Blazor.Components.Web.Bootstrap/Toasts/BootstrapMessengerMessage.cs @@ -3,7 +3,7 @@ public class BootstrapMessengerMessage : MessengerMessage { /// - /// Color-scheme of the message. + /// Color scheme of the message. /// public ThemeColor Color { get; set; } } diff --git a/Havit.Blazor.Components.Web.Bootstrap/Toasts/HxMessenger.razor.cs b/Havit.Blazor.Components.Web.Bootstrap/Toasts/HxMessenger.razor.cs index 9b229d302..c35cd0d9b 100644 --- a/Havit.Blazor.Components.Web.Bootstrap/Toasts/HxMessenger.razor.cs +++ b/Havit.Blazor.Components.Web.Bootstrap/Toasts/HxMessenger.razor.cs @@ -7,7 +7,7 @@ public partial class HxMessenger : ComponentBase, IDisposable { /// - /// Position of the messages. Default is . + /// Position of the messages. The default value is . /// [Parameter] public ToastContainerPosition Position { get; set; } = ToastContainerPosition.None; @@ -48,7 +48,7 @@ private void HandleClear() } /// - /// Receive notification from when message is hidden. + /// Receive notification from when the message is hidden. /// private void HandleToastHidden(MessengerMessage message) { diff --git a/Havit.Blazor.Components.Web.Bootstrap/Toasts/HxMessengerServiceExtensions.cs b/Havit.Blazor.Components.Web.Bootstrap/Toasts/HxMessengerServiceExtensions.cs index 217857752..669d807dd 100644 --- a/Havit.Blazor.Components.Web.Bootstrap/Toasts/HxMessengerServiceExtensions.cs +++ b/Havit.Blazor.Components.Web.Bootstrap/Toasts/HxMessengerServiceExtensions.cs @@ -11,7 +11,7 @@ public static class HxMessengerServiceExtensions public static MessengerServiceExtensionsSettings Defaults { get; } = new MessengerServiceExtensionsSettings(); /// - /// Adds and shows an informational message. Message is automatically hidden 5 seconds after showing up. + /// Adds and shows an informational message. The message is automatically hidden 5 seconds after showing up. /// public static void AddInformation(this IHxMessengerService messenger, string message) { @@ -19,7 +19,7 @@ public static void AddInformation(this IHxMessengerService messenger, string mes } /// - /// Adds and shows an informational message. Message is automatically hidden 5 seconds after showing up. + /// Adds and shows an informational message. The message is automatically hidden 5 seconds after showing up. /// public static void AddInformation(this IHxMessengerService messenger, string title, string message) { diff --git a/Havit.Blazor.Components.Web.Bootstrap/Toasts/HxToast.cs b/Havit.Blazor.Components.Web.Bootstrap/Toasts/HxToast.cs index d60e942a6..6cb745a42 100644 --- a/Havit.Blazor.Components.Web.Bootstrap/Toasts/HxToast.cs +++ b/Havit.Blazor.Components.Web.Bootstrap/Toasts/HxToast.cs @@ -4,28 +4,23 @@ namespace Havit.Blazor.Components.Web.Bootstrap; /// /// Bootstrap Toast component. Not intended to be used in user code, use . -/// After first render component never updates.
+/// After the first render, the component never updates.
/// Full documentation and demos: https://havit.blazor.eu/components/HxToast ///
public partial class HxToast : ComponentBase, IAsyncDisposable { /// - /// JS Runtime. - /// - [Inject] protected IJSRuntime JSRuntime { get; set; } - - /// - /// Color-scheme. + /// Color scheme. /// [Parameter] public ThemeColor? Color { get; set; } /// - /// Delay in milliseconds to automatically hide toast. + /// Delay in milliseconds to automatically hide the toast. /// [Parameter] public int? AutohideDelay { get; set; } /// - /// Css class to render with toast. + /// CSS class to render with the toast. /// [Parameter] public string CssClass { get; set; } @@ -55,12 +50,12 @@ public partial class HxToast : ComponentBase, IAsyncDisposable [Parameter] public RenderFragment ContentTemplate { get; set; } /// - /// Indicates whether to show close button. + /// Indicates whether to show the close button. /// [Parameter] public bool ShowCloseButton { get; set; } = true; /// - /// Fires when toast is hidden (button or autohide). + /// Fires when the toast is hidden (button or autohide). /// [Parameter] public EventCallback OnToastHidden { get; set; } /// @@ -68,6 +63,8 @@ public partial class HxToast : ComponentBase, IAsyncDisposable /// protected virtual Task InvokeOnToastHiddenAsync() => OnToastHidden.InvokeAsync(); + [Inject] protected IJSRuntime JSRuntime { get; set; } + private ElementReference toastElement; private DotNetObjectReference dotnetObjectReference; private IJSObjectReference jsModule; diff --git a/Havit.Blazor.Components.Web.Bootstrap/Toasts/HxToastContainer.razor.cs b/Havit.Blazor.Components.Web.Bootstrap/Toasts/HxToastContainer.razor.cs index d39cc435f..2b929a3db 100644 --- a/Havit.Blazor.Components.Web.Bootstrap/Toasts/HxToastContainer.razor.cs +++ b/Havit.Blazor.Components.Web.Bootstrap/Toasts/HxToastContainer.razor.cs @@ -3,7 +3,7 @@ public partial class HxToastContainer : ComponentBase { /// - /// Positioning of the toasts on screen. + /// Positioning of the toasts on the screen. /// [Parameter] public ToastContainerPosition Position { get; set; } diff --git a/Havit.Blazor.Components.Web.Bootstrap/Toasts/MessengerServiceExtensionsSettings.cs b/Havit.Blazor.Components.Web.Bootstrap/Toasts/MessengerServiceExtensionsSettings.cs index ea02648dd..034deec05 100644 --- a/Havit.Blazor.Components.Web.Bootstrap/Toasts/MessengerServiceExtensionsSettings.cs +++ b/Havit.Blazor.Components.Web.Bootstrap/Toasts/MessengerServiceExtensionsSettings.cs @@ -6,7 +6,7 @@ public record MessengerServiceExtensionsSettings { /// - /// Color-scheme of informational messages. + /// Color scheme of informational messages. /// public ThemeColor InformationColor { get; set; } = ThemeColor.Primary; @@ -16,7 +16,7 @@ public record MessengerServiceExtensionsSettings public int? InformationAutohideDelay { get; set; } = 5000; /// - /// Color-scheme of informational messages. + /// Color scheme of warning messages. /// public ThemeColor WarningColor { get; set; } = ThemeColor.Warning; @@ -26,7 +26,7 @@ public record MessengerServiceExtensionsSettings public int? WarningAutohideDelay { get; set; } = null; /// - /// Color-scheme of informational messages. + /// Color scheme of error messages. /// public ThemeColor ErrorColor { get; set; } = ThemeColor.Danger; diff --git a/Havit.Blazor.Components.Web.Bootstrap/Tooltips/HxPopover.cs b/Havit.Blazor.Components.Web.Bootstrap/Tooltips/HxPopover.cs index 6400d0fca..ada8b272d 100644 --- a/Havit.Blazor.Components.Web.Bootstrap/Tooltips/HxPopover.cs +++ b/Havit.Blazor.Components.Web.Bootstrap/Tooltips/HxPopover.cs @@ -25,7 +25,7 @@ static HxPopover() /// /// Returns application-wide defaults for the component. - /// Enables overriding defaults in descendants (use separate set of defaults). + /// Enables overriding defaults in descendants (use a separate set of defaults). /// protected override PopoverSettings GetDefaults() => Defaults; @@ -35,10 +35,10 @@ static HxPopover() [Parameter] public PopoverSettings Settings { get; set; } /// - /// Returns optional set of component settings. + /// Returns an optional set of component settings. /// /// - /// Similar to , enables defining wider in components descendants (by returning a derived settings class). + /// Similar to , enables defining wider in component descendants (by returning a derived settings class). /// protected override PopoverSettings GetSettings() => this.Settings; @@ -63,7 +63,7 @@ public string Content } /// - /// Popover placement. Default is . + /// Popover placement. The default is . /// [Parameter] public PopoverPlacement Placement @@ -73,7 +73,7 @@ public PopoverPlacement Placement } /// - /// Popover trigger(s). Default is . + /// Popover trigger(s). The default is . /// [Parameter] public PopoverTrigger Trigger diff --git a/Havit.Blazor.Components.Web.Bootstrap/Tooltips/HxTooltip.cs b/Havit.Blazor.Components.Web.Bootstrap/Tooltips/HxTooltip.cs index 41a35e88c..1bf627cdc 100644 --- a/Havit.Blazor.Components.Web.Bootstrap/Tooltips/HxTooltip.cs +++ b/Havit.Blazor.Components.Web.Bootstrap/Tooltips/HxTooltip.cs @@ -25,7 +25,7 @@ static HxTooltip() /// /// Returns application-wide defaults for the component. - /// Enables overriding defaults in descendants (use separate set of defaults). + /// Enables overriding defaults in descendants (use a separate set of defaults). /// protected override TooltipSettings GetDefaults() => Defaults; @@ -35,10 +35,10 @@ static HxTooltip() [Parameter] public TooltipSettings Settings { get; set; } /// - /// Returns optional set of component settings. + /// Returns an optional set of component settings. /// /// - /// Similar to , enables defining wider in components descendants (by returning a derived settings class). + /// Similar to , enables defining wider in component descendants (by returning a derived settings class). /// protected override TooltipSettings GetSettings() => this.Settings; @@ -53,7 +53,7 @@ public string Text } /// - /// Tooltip placement. Default is . + /// Tooltip placement. The default is . /// [Parameter] public TooltipPlacement Placement @@ -63,7 +63,7 @@ public TooltipPlacement Placement } /// - /// Tooltip trigger(s). Default is | . + /// Tooltip trigger(s). The default is | . /// [Parameter] public TooltipTrigger Trigger diff --git a/Havit.Blazor.Components.Web.Bootstrap/Tooltips/PopoverPlacement.cs b/Havit.Blazor.Components.Web.Bootstrap/Tooltips/PopoverPlacement.cs index cca630865..7de23f247 100644 --- a/Havit.Blazor.Components.Web.Bootstrap/Tooltips/PopoverPlacement.cs +++ b/Havit.Blazor.Components.Web.Bootstrap/Tooltips/PopoverPlacement.cs @@ -11,7 +11,7 @@ public enum PopoverPlacement Right = TooltipPlacement.Right, /// - /// When is specified, it will dynamically reorient the popover. + /// When specified, it will dynamically reorient the popover. /// Auto = TooltipPlacement.Auto } diff --git a/Havit.Blazor.Components.Web.Bootstrap/Tooltips/PopoverTrigger.cs b/Havit.Blazor.Components.Web.Bootstrap/Tooltips/PopoverTrigger.cs index aff08c267..f3ed65ea8 100644 --- a/Havit.Blazor.Components.Web.Bootstrap/Tooltips/PopoverTrigger.cs +++ b/Havit.Blazor.Components.Web.Bootstrap/Tooltips/PopoverTrigger.cs @@ -6,8 +6,23 @@ [Flags] public enum PopoverTrigger { + /// + /// Specifies that the popover should be triggered by a click event. + /// Click = TooltipTrigger.Click, + + /// + /// Specifies that the popover should be triggered by a hover event. + /// Hover = TooltipTrigger.Hover, + + /// + /// Specifies that the popover should be triggered by a focus event. + /// Focus = TooltipTrigger.Focus, + + /// + /// Specifies that the popover should be triggered manually. + /// Manual = TooltipTrigger.Manual } diff --git a/Havit.Blazor.Components.Web.Bootstrap/Tooltips/TooltipPlacement.cs b/Havit.Blazor.Components.Web.Bootstrap/Tooltips/TooltipPlacement.cs index 980104d11..86d041114 100644 --- a/Havit.Blazor.Components.Web.Bootstrap/Tooltips/TooltipPlacement.cs +++ b/Havit.Blazor.Components.Web.Bootstrap/Tooltips/TooltipPlacement.cs @@ -11,7 +11,7 @@ public enum TooltipPlacement Right = 3, /// - /// When is specified, it will dynamically reorient the tooltip. + /// When specified, it will dynamically reorient the tooltip. /// Auto = 4 } diff --git a/Havit.Blazor.Components.Web.Bootstrap/TreeViews/HxTreeView.razor.cs b/Havit.Blazor.Components.Web.Bootstrap/TreeViews/HxTreeView.razor.cs index 8fb7747ca..148fa0948 100644 --- a/Havit.Blazor.Components.Web.Bootstrap/TreeViews/HxTreeView.razor.cs +++ b/Havit.Blazor.Components.Web.Bootstrap/TreeViews/HxTreeView.razor.cs @@ -1,14 +1,14 @@ namespace Havit.Blazor.Components.Web.Bootstrap; /// -/// Component to display hierarchy data structure.
+/// Component to display a hierarchy data structure.
/// Full documentation and demos: https://havit.blazor.eu/components/HxTreeView ///
/// Type of tree data item. public partial class HxTreeView : ComponentBase { /// - /// Collection of hierarchy data to display. + /// Collection of hierarchical data to display. /// [Parameter, EditorRequired] public IEnumerable Items { get; set; } @@ -18,16 +18,16 @@ public partial class HxTreeView : ComponentBase [Parameter] public TItem SelectedItem { get; set; } /// - /// Event fires when selected data item changes. + /// Event fired when the selected data item changes. /// [Parameter] public EventCallback SelectedItemChanged { get; set; } /// - /// Event fires when expanding an item. + /// Event fired when an item is expanded. /// [Parameter] public EventCallback OnItemExpanded { get; set; } /// - /// Event fires when collapsing an item. + /// Event fired when an item is collapsed. /// [Parameter] public EventCallback OnItemCollapsed { get; set; } @@ -37,18 +37,18 @@ public partial class HxTreeView : ComponentBase protected virtual Task InvokeSelectedDataItemChangedAsync(TItem selectedDataItem) => SelectedItemChanged.InvokeAsync(selectedDataItem); /// - /// Selector to display item title from data item. + /// Selector to display the item title from the data item. /// [Parameter] public Func ItemTitleSelector { get; set; } /// - /// Selector to display icon from data item. + /// Selector to display the icon from the data item. /// [Parameter] public Func ItemIconSelector { get; set; } /// - /// Selector for initial expansion state for data item.
- /// Default state is false (collapsed). + /// Selector for the initial expansion state of the data item.
+ /// The default state is false (collapsed). ///
[Parameter] public Func ItemInitialExpandedSelector { get; set; } @@ -58,12 +58,12 @@ public partial class HxTreeView : ComponentBase [Parameter] public string ItemCssClass { get; set; } /// - /// Selector for item CSS class. + /// Selector for the item CSS class. /// [Parameter] public Func ItemCssClassSelector { get; set; } /// - /// Selector to display children collection for current data item. Children collection should have same type as current item. + /// Selector to display the children collection for the current data item. The children collection should have the same type as the current item. /// [Parameter] public Func> ItemChildrenSelector { get; set; } @@ -82,4 +82,4 @@ private async Task HandleItemSelected(TItem newSelectedItem) this.SelectedItem = newSelectedItem; await InvokeSelectedDataItemChangedAsync(this.SelectedItem); } -} \ No newline at end of file +} diff --git a/Havit.Blazor.Documentation/XmlDoc/Havit.Blazor.Components.Web.Bootstrap.xml b/Havit.Blazor.Documentation/XmlDoc/Havit.Blazor.Components.Web.Bootstrap.xml index 49c457534..cd71c6e42 100644 --- a/Havit.Blazor.Documentation/XmlDoc/Havit.Blazor.Components.Web.Bootstrap.xml +++ b/Havit.Blazor.Documentation/XmlDoc/Havit.Blazor.Components.Web.Bootstrap.xml @@ -1139,7 +1139,7 @@ - Chip item to be rendered in UI. + Chip item to be rendered in the UI. @@ -1154,11 +1154,16 @@ - Remove action called when chip should be removed. + Remove action called when the chip should be removed. It receives the model from which the chip should be removed. It is not the same instance as the one from which the chip was generated! + + + Settings for the component. + + Settings for the used to render chips. @@ -1171,7 +1176,7 @@ - Enables/disables the reset button. + Enables or disables the reset button. @@ -1183,19 +1188,19 @@ Presents a list of chips as badges.
- Usually being used to present filter-criteria gathered by .
+ Usually used to present filter criteria gathered by .
Full documentation and demos: https://havit.blazor.eu/components/HxChipList
- Application-wide defaults for the . + Application-wide defaults for the component. - Returns application-wide defaults for the component. - Enables overriding defaults in descendants (use separate set of defaults). + Returns the application-wide defaults for the component. + Enables overriding defaults in descendants (use a separate set of defaults). @@ -1205,10 +1210,10 @@ - Returns optional set of component settings. + Returns an optional set of component settings. - Similar to , enables defining wider in components descendants (by returning a derived settings class). + Similar to , enables defining wider in component descendants (by returning a derived settings class). @@ -1219,7 +1224,7 @@ Settings for the used to render chips. - Default brings Color="". + The default brings Color="". @@ -1229,7 +1234,7 @@ - Called when chip remove button is clicked. + Called when the chip remove button is clicked. @@ -1249,8 +1254,8 @@ - Enables/disables the reset button. - Default is false (can be changed with HxChipList.Defaults.ShowResetButton. + Enables or disables the reset button. + The default is false (can be changed with HxChipList.Defaults.ShowResetButton). @@ -1261,12 +1266,12 @@ Template for the reset button. - If used, the is ignored and the callback is not triggered (you are expected to wire the reset logic on you own). + If used, the is ignored and the callback is not triggered (you are expected to wire the reset logic on your own). - Used in a component which can generate chips. + Used in a component that can generate chips. @@ -6758,20 +6763,20 @@ - Renders <script< tag referencing corresponding Bootstrap JavaScript bundle with Popper.
+ Renders <script< tag referencing the corresponding Bootstrap JavaScript bundle with Popper.
To be used in _Layout.cshtml as @Html.Raw(HxSetup.RenderBootstrapJavaScriptReference()).
- We do not want to use TagHelper nor HTML Helper here as we do not want to introduce dependency on server-side ASP.NET Core (MVC/Razor) to our library (separate NuGet package would have to be created). + We do not want to use TagHelper or HTML Helper here as we do not want to introduce a dependency on server-side ASP.NET Core (MVC/Razor) to our library (a separate NuGet package would have to be created).
- Renders <link< tag referencing corresponding Bootstrap CSS.
+ Renders <link< tag referencing the corresponding Bootstrap CSS.
To be used in _Layout.cshtml as @Html.Raw(HxSetup.RenderBootstrapCssReference()).
- We do not want to use TagHelper nor HTML Helper here as we do not want to introduce dependency on server-side ASP.NET Core (MVC/Razor) to our library (separate NuGet package would have to be created). + We do not want to use TagHelper or HTML Helper here as we do not want to introduce a dependency on server-side ASP.NET Core (MVC/Razor) to our library (a separate NuGet package would have to be created).
@@ -6779,7 +6784,7 @@ Bootstrap icon.
- To bootstrap icons update you need: + To update bootstrap icons, perform the following steps: - Update wwwroot\fonts\bootstrap-icons.woff - Update wwwroot\fonts\bootstrap-icons.woff2 - Update wwwroot\bootstrap-icons.css @@ -6797,22 +6802,23 @@
- Constructor. Private. + Private constructor. - Displays bootstrap icon. See https://icons.getbootstrap.com/. + Displays a bootstrap icon. See https://icons.getbootstrap.com/. + You usually don't use this component directly, but instead use . - Icon to display. + The icon to display. - CSS Class to combine with basic icon CSS class. + The CSS class to combine with the basic icon CSS class. @@ -6835,20 +6841,20 @@ - Can be used for TFilterModelType to express there is no filter in the component. + Can be used for TFilterModelType to indicate that there is no filter in the component. - Data presentation component composed of for data, for manual filtering and for pre-defined filters.
+ Data presentation component composed of for data, for manual filtering, and for pre-defined filters.
Full documentation and demos: https://havit.blazor.eu/components/HxListLayout
- Returns defaults. - Enables overriding defaults in descendants (use separate set of defaults). + Returns the defaults. + Enables overriding defaults in descendants (use a separate set of defaults). @@ -6858,10 +6864,10 @@ - Returns optional set of component settings. + Returns an optional set of component settings. - Similar to , enables defining wider in components descendants (by returning a derived settings class). + Similar to , enables defining wider in component descendants (by returning a derived settings class). @@ -6876,7 +6882,7 @@ - Settings for the opening filtering offcanvas. + Settings for the opening the filtering offcanvas. @@ -6901,43 +6907,43 @@ - Number of template columns to span. Responsive setting for all devices including the extra-small ones (XS) bellow "small" breakpoint (576px).
+ Number of template columns to span. Responsive setting for all devices including the extra-small ones (XS) below "small" breakpoint (576px).
The value can be any integer number between 1 and 12 (.col-1), auto (.col-auto) or true (.col).
- Number of template columns to span for viewports above "small" breakpoint (576px).
- The value can be any integer number between 1 and 12, auto or true. + Number of template columns to span for viewports above the "small" breakpoint (576px).
+ The value can be any integer number between 1 and 12, auto, or true.
- Number of template columns to span for viewports above "medium" breakpoint (768px).
- The value can be any integer number between 1 and 12, auto or true. + Number of template columns to span for viewports above the "medium" breakpoint (768px).
+ The value can be any integer number between 1 and 12, auto, or true.
- Number of template columns to span for viewports above "large" breakpoint (992px).
- The value can be any integer number between 1 and 12, auto or true. + Number of template columns to span for viewports above the "large" breakpoint (992px).
+ The value can be any integer number between 1 and 12, auto, or true.
- Number of template columns to span for viewports above "large" breakpoint (1200px).
- The value can be any integer number between 1 and 12, auto or true. + Number of template columns to span for viewports above the "extra-large" breakpoint (1200px).
+ The value can be any integer number between 1 and 12, auto, or true.
- Number of template columns to span for viewports above "XXL" breakpoint (1400px).
- The value can be any integer number between 1 and 12, auto or true. + Number of template columns to span for viewports above the "XXL" breakpoint (1400px).
+ The value can be any integer number between 1 and 12, auto, or true.
- Returns CSS classes representing column layout of the component. + Returns CSS classes representing the column layout of the component. @@ -6957,12 +6963,12 @@ - Settings for the opening filtering offcanvas. + Settings for the that opens the filtering offcanvas. - Settings for the submitting the filter. + Settings for the that submits the filter. @@ -7019,13 +7025,13 @@ - Indicates the current active selection. + Indicates the currently active selection. - Make the item appear disabled by setting to false. - Default is true. + Make the item appear disabled by setting it to false. + The default value is true. @@ -7111,32 +7117,32 @@ - Never Horizontal, always vertical. + Never horizontal, always vertical. - Horizontal for viewports above "small" breakpoint (576px). + Horizontal for viewports above the "small" breakpoint (576px). - Horizontal for viewports above "medium" breakpoint (768px). + Horizontal for viewports above the "medium" breakpoint (768px). - Horizontal for viewports above "large" breakpoint (992px). + Horizontal for viewports above the "large" breakpoint (992px). - Horizontal for viewports above "extra-large" breakpoint (1200px). + Horizontal for viewports above the "extra-large" breakpoint (1200px). - Horizontal for viewports above "XXL" breakpoint (1400px). + Horizontal for viewports above the "XXL" breakpoint (1400px). @@ -7151,14 +7157,14 @@ - True when the dialog has successful result, false then it was cancelled. + True when the dialog has a successful result, false when it was cancelled. The value of the successful result. - When the dialog is not successful. + Thrown when the dialog is not successful. @@ -7167,12 +7173,12 @@ - Returns new instance for cancelled dialog. + Returns a new instance for a cancelled dialog. - Returns new instance for successful dialog. + Returns a new instance for a successful dialog. @@ -7183,7 +7189,7 @@ - Returns the component which this component control. Override when you do not want to use modal field set using @ref. + Returns the component that this component controls. Override this method when you do not want to use the modal field set using @ref. @@ -7203,7 +7209,7 @@ - Component to display message-boxes.
+ Component for displaying message boxes.
Usually used via and .
Full documentation and demos: https://havit.blazor.eu/components/HxMessageBox
@@ -7215,8 +7221,8 @@
- Returns defaults. - Enables overriding defaults in descendants (use separate set of defaults). + Returns the defaults for . + Enables overriding defaults in descendants (use a separate set of defaults). @@ -7242,12 +7248,12 @@ Indicates whether to show the close button. - Default is taken from the underlying (true). + The default is taken from the underlying (true). - Buttons to show. Default is . + Buttons to show. The default is . @@ -7272,7 +7278,7 @@ - Settings for underlying component. + Settings for the underlying component. @@ -7299,39 +7305,40 @@ Displays message boxes initiated through . - To be placed in root application component / main layout. + To be placed in the root application component / main layout. - Component to render modal dialog as a Bootstrap Modal.
- Full documentation and demos: https://havit.blazor.eu/components/HxModal + Component for rendering a modal dialog as a Bootstrap Modal. + Visit Bootstrap Modal for more information. + Full documentation and demos available at https://havit.blazor.eu/components/HxModal
- A value that is passed to the data-bs-backdrop data attribute when is set to . + Specifies a value for the data-bs-backdrop attribute when is set to . - Application-wide defaults for the . + Application-wide default settings for the . - Returns application-wide defaults for the component. - Enables overriding defaults in descendants (use separate set of defaults). + Provides application-wide default settings for the component. + Allows descendants to override these defaults with a separate set of values. - Set of settings to be applied to the component instance (overrides , overridden by individual parameters). + A set of settings applied to this component instance. Overrides and is itself overridden by individual parameters. - For modals that simply appear rather than fade in to view, setting false removes the .fade class from your modal markup. + Determines whether modals appear without fading in. Setting to false removes the .fade class from the modal markup. Default value is true. @@ -7441,34 +7448,34 @@
- This event is fired immediately when the hide instance method has been called.
- This can be caused by , close-button, Esc key or other interaction. - Hiding can be cancelled by setting = true + Fired immediately when the 'hide' instance method is called. + This can be triggered by , the close button, the Esc key, or other interactions. + To cancel hiding, set to true.
- There is intentionally no virtual InvokeOnHidingAsync() method to override as we want to avoid confusion. - The hide.bs.modal event is subscribed only when callback is set. + There is intentionally no virtual InvokeOnHidingAsync() method to override to avoid confusion. + The hide.bs.modal event is only subscribed to when the callback is set.
- This event is fired when the modal has finished being hidden from the user (will wait for CSS transitions to complete).
- This can be caused by , close-button, Esc key or other interaction. + Fired when the modal has finished hiding from the user, after CSS transitions complete. + Triggered by , the close button, the Esc key, or other interactions.
- Triggers the event. Allows interception of the event in derived components. + Triggers the event. Enables derived components to intercept the event. - This event is fired when an modal element has been made visible to the user (will wait for CSS transitions to complete). + Fired when a modal element becomes visible to the user, after CSS transitions complete. - Triggers the event. Allows interception of the event in derived components. + Triggers the event. Enables derived components to intercept the event. @@ -7498,10 +7505,8 @@ - Formats a for supplying the value via the data-bs-backdrop data attribute. + Formats a value for use in the data-bs-backdrop attribute. - - @@ -7510,17 +7515,17 @@ - Settings for the dialog primary button. + Settings for the primary dialog button. - Settings for dialog secondary button(s). + Settings for the secondary dialog button(s). - Settings for underlying component. + Settings for the underlying component. @@ -7530,7 +7535,7 @@ - A backdrop will be rendered. Modal will be closed upon clicking on the backdrop. + A backdrop will be rendered. The modal will be closed upon clicking on the backdrop. @@ -7540,7 +7545,7 @@ - A static backdrop will be rendered. Modal will not be closed upon clicking on the backdrop. + A static backdrop will be rendered. The modal will not be closed upon clicking on the backdrop. @@ -7550,7 +7555,7 @@ - Fullscreen mode disabled, + Fullscreen mode disabled. @@ -7560,32 +7565,32 @@ - Fullscreen for viewports bellow "small" breakpoint (576px). + Fullscreen for viewports below the "small" breakpoint (576px). - Fullscreen for viewports bellow "medium" breakpoint (768px). + Fullscreen for viewports below the "medium" breakpoint (768px). - Fullscreen for viewports bellow "large" breakpoint (992px). + Fullscreen for viewports below the "large" breakpoint (992px). - Fullscreen for viewports bellow "extra-large" breakpoint (1200px). + Fullscreen for viewports below the "extra-large" breakpoint (1200px). - Fullscreen for viewports bellow "XXL" breakpoint (1400px). + Fullscreen for viewports below the "XXL" breakpoint (1400px). - Set true to cancel modal hiding. + Set true to prevent modal hiding. @@ -7596,44 +7601,44 @@ For modals that simply appear rather than fade in to view, setting false removes the .fade class from your modal markup. - Default value is true. + The default value is true. - Indicates whether the modal shows close button in header. + Indicates whether the modal shows a close button in the header. - Close icon to be used in header. + The close icon to be used in the header. - Indicates whether the modal closes when escape key is pressed. + Indicates whether the modal closes when the escape key is pressed. - Size of the modal. + The size of the modal. - Fullscreen behavior of the modal. + The fullscreen behavior of the modal. - Indicates whether to apply a backdrop on body while the modal is open. + Indicates whether to apply a backdrop to the body while the modal is open. If set to , the modal cannot be closed by clicking on the backdrop. - Default value (from ) is . + The default value (from ) is . - Allows scrolling the modal body. + Allows scrolling of the modal body. @@ -7698,7 +7703,7 @@ - List of named-views for .
+ List of named views for .
Full documentation and demos: https://havit.blazor.eu/components/HxNamedViewList
@@ -7719,40 +7724,40 @@
- Scrolls to anchor on firstRender and whenever location changes (). - With this mode is suitable only for static pages (where the size/offset of individual sections remains the same from the very beginning). - Use or for when the page contents load asynchronously and the layout changes. + Scrolls to the anchor on firstRender and whenever the location changes (). + With , this mode is suitable only for static pages (where the size/offset of individual sections remains the same from the very beginning). + Use or when the page contents load asynchronously and the layout changes. - Explicit calls to or needed. + Explicit calls to or are needed. Use this mode with when you need scrollspy to call to recalculate the target offsets before scrolling (scrollspy does not work properly on scrolled content). - Same as but scrolls to anchor on if the page remains the same (just the #fragment portion changed). + Same as , but scrolls to the anchor on if the page remains the same (just the #fragment portion changed). Works for most scenarios when you refresh the after data load and then you just need to navigate over the page. - Temporarily (?) compensates Blazor deficiency in anchor-fragments (scrolling to page#id URLs). Supports navigation with component. + Temporarily (?) compensates for a Blazor deficiency in anchor fragments (scrolling to page#id URLs). Supports navigation with the component. GitHub Issue: Blazor 0.8.0: hash routing to named element #8393.
Full documentation and demos: https://havit.blazor.eu/components/HxAnchorFragmentNavigation
- Level of automation. - Default is . + The level of automation. + The default is . Bootstrap 5 Breadcrumb component.
- Indicates the current page’s location within a navigational hierarchy.
+ Indicates the current page's location within a navigational hierarchy.
Full documentation and demos: https://havit.blazor.eu/components/HxBreadcrumb
@@ -7770,7 +7775,7 @@ - Indicates whether the Divider is an image or a text. + Indicates whether the divider is an image or text. @@ -7780,17 +7785,17 @@ - Item text (usually a name of the page). + Item text (usually the name of the page). - The link of the breadcrumb (a page where the user will be led on click). + The link of the breadcrumb (the page where the user will be led on click). - Determines whether the HxBreadcrumbItem is active (use for a page that the user is currently on). + Determines whether the HxBreadcrumbItem is active (used for a page that the user is currently on). @@ -7807,13 +7812,13 @@ Orientation of the nav. - Default is . + The default value is . The visual variant of the nav items. - Default is . + The default value is . @@ -7833,33 +7838,33 @@ - Bootstrap 5 Navbar component - responsive navigation header.
- With support for branding, navigation, and more, including support for the collapse plugin.
- Full documentation and demos: https://havit.blazor.eu/components/HxNavbar + Bootstrap 5 Navbar component - a responsive navigation header.
+ Provides support for branding, navigation, and more, including support for the collapse plugin.
+ For full documentation and demos, visit: https://havit.blazor.eu/components/HxNavbar
Color (background). - Default is . + The default value is . Bootstrap theme (color mode) applied to the navbar. - Default is (none). + The default value is (none). Responsive expand setting (breakpoint) for .
- Default is . + The default value is .
Element ID. - (Autogenerated GUID if not set explicitly.) + (An autogenerated GUID is used if not set explicitly.) @@ -7869,7 +7874,7 @@ - Container CSS class. Default is container-fluid. + Container CSS class. The default value is container-fluid. @@ -7983,12 +7988,12 @@ - Scrollspy additional CSS class. Added to main div (.hx-scrollspy). + Scrollspy additional CSS class. Added to the main div (.hx-scrollspy). - Content to be spied. Elements with IDs are required (corresponding IDs to be used in ). + Content to be spied on. Elements with IDs are required (corresponding IDs to be used in ). @@ -7996,7 +8001,7 @@ - When using scrollspy in conjunction with adding or removing of elements from the DOM (e.g. asynchronous data load), you’ll need to refresh the scrollspy explicitly. + When using scrollspy in conjunction with adding or removing elements from the DOM (e.g. asynchronous data load), you’ll need to refresh the scrollspy explicitly. @@ -8048,12 +8053,12 @@
- ExpandIcon is obsolete and will be removed in future release. Use if you want to render an icon. + ExpandIcon is obsolete and will be removed in a future release. Use if you want to render an icon. - CollapseIcon is obsolete and will be removed in future release. Use if you want to render an icon. + CollapseIcon is obsolete and will be removed in a future release. Use if you want to render an icon. @@ -8094,20 +8099,20 @@ - Whether multiple items can be in expanded state at once. + Whether multiple items can be in the expanded state at once. If set to false, upon item expansion, all other items are collapsed. - Default is true. + The default is true. - Breakpoint below which the sidebar switches to mobile version (exclusive).
- Default is . + The breakpoint below which the sidebar switches to the mobile version (exclusive).
+ The default is .
- Id of the immediate parent of the contained components. + The ID of the immediate parent of the contained components. @@ -8117,22 +8122,22 @@ - Brand long name. + The long name of the brand. - Brand logo. + The logo of the brand. - Brand short name. + The short name of the brand. - containing the . + The containing the . @@ -8158,13 +8163,13 @@ URL matching behavior for the underlying . - Default is . + The default value is . Allows you to disable the item with false. - Default is true. + The default value is true. @@ -8249,27 +8254,27 @@ - Expanded for viewports above "small" breakpoint (576px). + Expanded for viewports above the "small" breakpoint (576px). - Expanded for viewports above "medium" breakpoint (768px). + Expanded for viewports above the "medium" breakpoint (768px). - Expanded for viewports above "large" breakpoint (992px). + Expanded for viewports above the "large" breakpoint (992px). - Expanded for viewports above "extra-large" breakpoint (1200px). + Expanded for viewports above the "extra-large" breakpoint (1200px). - Expanded for viewports above "XXL" breakpoint (1400px). + Expanded for viewports above the "XXL" breakpoint (1400px). @@ -8300,7 +8305,7 @@ Tabs. https://getbootstrap.com/docs/5.3/components/navs-tabs/#tabs - Remember to set active tab (). + Remember to set the active tab (). @@ -8340,37 +8345,37 @@ - Indicates whether a is collapsed or expanded. Is null when item has no expandable content. + Indicates whether a is collapsed or expanded. Is null when the item has no expandable content. - Mobile mode disabled, always render as sidebar. + Mobile mode disabled, always render as a sidebar. - Mobile for viewports bellow "small" breakpoint (576px, exclusive). + Mobile for viewports below the "small" breakpoint (576px, exclusive). - Mobile for viewports bellow "medium" breakpoint (768px, exclusive). + Mobile for viewports below the "medium" breakpoint (768px, exclusive). - Mobile for viewports bellow "large" breakpoint (992px, exclusive). + Mobile for viewports below the "large" breakpoint (992px, exclusive). - Mobile for viewports bellow "extra-large" breakpoint (1200px, exclusive). + Mobile for viewports below the "extra-large" breakpoint (1200px, exclusive). - Mobile for viewports bellow "XXL" breakpoint (1400px, exclusive). + Mobile for viewports below the "XXL" breakpoint (1400px, exclusive). @@ -8420,14 +8425,14 @@ - Text for the title in header. - (Is rendered into <h5 class="offcanvas-title"> - in opposite to which is rendered directly into offcanvas-header). + Text for the title in the header. + (Is rendered into <h5 class="offcanvas-title"> - in contrast to which is rendered directly into offcanvas-header). Content for the header. - (Is rendered directly into offcanvas-header - in opposite to which is rendered into <h5 class="offcanvas-title">). + (Is rendered directly into offcanvas-header - in contrast to which is rendered into <h5 class="offcanvas-title">). @@ -8442,7 +8447,7 @@ - Placement of the offcanvas. Default is (right). + Placement of the offcanvas. The default is (right). @@ -8453,45 +8458,45 @@ Determines whether the content is always rendered or only if the offcanvas is open.
- Default is .
+ The default is .
Please note, this setting applies only when is set. For all other values, the content is always rendered (to be available for the mobile version).
- Size of the offcanvas. Default is . + Size of the offcanvas. The default is . - Indicates whether the modal shows close button in header. - Default value is true. - Use to change shape of the button. + Indicates whether the modal shows a close button in the header. + The default value is true. + Use to change the shape of the button. - Indicates whether the offcanvas closes when escape key is pressed. - Default value is true. + Indicates whether the offcanvas closes when the escape key is pressed. + The default value is true. - Close icon to be used in header. - If set to null, Bootstrap default close-button will be used. + The close icon to be used in the header. + If set to null, the Bootstrap default close button will be used. - Indicates whether to apply a backdrop on body while offcanvas is open. + Indicates whether to apply a backdrop on the body while the offcanvas is open. If set to , the offcanvas cannot be closed by clicking on the backdrop. - Default value (from ) is . + The default value (from ) is . - Indicates whether body (page) scrolling is allowed while offcanvas is open. - Default value (from ) is false. + Indicates whether body (page) scrolling is allowed while the offcanvas is open. + The default value (from ) is false. @@ -8574,17 +8579,42 @@ - A backdrop will be rendered. Offcanvas will be closed upon clicking on the backdrop. + A backdrop will be rendered. The offcanvas will be closed upon clicking on the backdrop. - No backdrop will be rendered. User can interact with other parts of the app while the offcanvas is open. + No backdrop will be rendered. Users can interact with other parts of the app while the offcanvas is open. - A static backdrop will be rendered. Offcanvas will not be closed upon clicking on the backdrop. + A static backdrop will be rendered. The offcanvas will not be closed upon clicking on the backdrop. + + + + + Represents the placement of an offcanvas. + + + + + Offcanvas is placed at the end. + + + + + Offcanvas is placed at the start. + + + + + Offcanvas is placed at the top. + + + + + Offcanvas is placed at the bottom. @@ -8594,8 +8624,8 @@ - Offcanvas content is rendered only when it is open.
- Suitable for item-detail, item-edit, etc.
+ Offcanvas content is rendered only when it is open. + Suitable for item-detail, item-edit, etc. This setting applies only when is set. For all other values, the content is always rendered (to be available for the mobile version).
@@ -8632,12 +8662,12 @@
- Render contents outside the viewport in an offcanvas when bellow "extra-large" breakpoint (1200px, exclusive). + Render contents outside the viewport in an offcanvas when below the "extra-large" breakpoint (1200px, exclusive). - Render contents outside the viewport in an offcanvas when bellow "XXL" breakpoint (1400px, exclusive). + Render contents outside the viewport in an offcanvas when below the "XXL" breakpoint (1400px, exclusive). @@ -8647,73 +8677,93 @@ - Close icon to be used in header. - If set to null, Bootstrap default close-button will be used. + Close icon to be used in the header. + If set to null, the Bootstrap default close button will be used. - Indicates whether the modal shows close button in header. - Use to change shape of the button. + Indicates whether the modal shows a close button in the header. + Use the property to change the shape of the button. - Indicates whether to apply a backdrop on body while offcanvas is open. + Indicates whether to apply a backdrop on the body while the offcanvas is open. - Breakpoint below which the contents are rendered outside the viewport in an offcanvas (above this breakpoint, the offcanvas body is rendered inside the viewport). + The breakpoint below which the contents are rendered outside the viewport in an offcanvas (above this breakpoint, the offcanvas body is rendered inside the viewport). - Placement of the offcanvas. + The placement of the offcanvas. - Size of the offcanvas.
+ The size of the offcanvas.
- Consider customization of the offcanvas CSS variables instead of changing the Size application-wide. + Consider customizing the offcanvas CSS variables instead of changing the size application-wide.
- Indicates whether the offcanvas closes when escape key is pressed. + Indicates whether the offcanvas closes when the escape key is pressed. - Indicates whether body (page) scrolling is allowed while offcanvas is open. + Indicates whether body (page) scrolling is allowed while the offcanvas is open. - Offcanvas additional CSS class. Added to root div (.offcanvas). + Additional CSS class for the offcanvas. Added to the root div (.offcanvas). - Additional header CSS class. + Additional CSS class for the header. - Additional body CSS class. + Additional CSS class for the body. - Additional footer CSS class. + Additional CSS class for the footer. + + + + + Represents the size options for the Offcanvas component. + + + + + Regular size. + + + + + Small size. + + + + + Large size. - Bootstrap 5 Placeholder component, aka Skeleton.
- Use loading placeholders for your components or pages to indicate something may still be loading.
+ Bootstrap 5 Placeholder component, also known as Skeleton.
+ Use loading placeholders for your components or pages to indicate that something may still be loading.
Full documentation and demos: https://havit.blazor.eu/components/HxPlaceholder
@@ -8725,7 +8775,7 @@ Returns application-wide defaults for the component. - Enables overriding defaults in descendants (use separate set of defaults). + Enables overriding defaults in descendants (use a separate set of defaults). @@ -8735,10 +8785,10 @@ - Returns optional set of component settings. + Returns an optional set of component settings. - Similar to , enables defining wider in components descendants (by returning a derived settings class). + Similar to , enables defining wider in component descendants (by returning a derived settings class). @@ -8786,8 +8836,8 @@ - Bootstrap 5 placeholder in form of a button.
- Derives from (adds placeholder class and changes Enabled default to false).
+ Bootstrap 5 placeholder in the form of a button.
+ Derives from (adds the placeholder class and changes the default value of Enabled to false).
Set the size of the button by using the parameter.
@@ -8823,7 +8873,7 @@ Returns application-wide defaults for the component. - Enables overriding defaults in descendants (use separate set of defaults). + Enables overriding defaults in descendants (use a separate set of defaults). @@ -8833,15 +8883,15 @@ - Returns optional set of component settings. + Returns an optional set of component settings. - Similar to , enables defining wider in components descendants (by returning a derived settings class). + Similar to , enables defining wider in component descendants (by returning a derived settings class). - Animation of the placeholders in container. + Animation of the placeholders in the container. @@ -8881,12 +8931,12 @@ - Glow animation. + Animation with a glowing effect. - Wave animation. + Animation with a waving effect. @@ -8896,12 +8946,12 @@ - Animation of the placeholders in container. + Animation of the placeholders in the container. - Additional CSS class for . + Additional CSS class for the . @@ -8926,7 +8976,7 @@ - Size for component. + Represents the size for the component. @@ -8948,27 +8998,27 @@ - Height of all inner progress bars. Default is 15px. + Height of all inner progress bars. The default value is 15px. - Lowest possible value. Default is 0. + Lowest possible value. The default value is 0. - Highest possible value. Default is 100. + Highest possible value. The default value is 100. - If true, applies a stripe via CSS gradient over the progress bar's background color. + If true, applies a stripe via CSS gradient over the background color of the progress bar. - If true, stripes are animated right to left via CSS3 animations, stripes are automatically switched on. + If true, the stripes are animated right to left using CSS3 animations. The stripes are automatically switched on. @@ -8988,7 +9038,7 @@ - Current value (proportion of the progress bar that is taken up). + Current value (proportion of the progress bar that is filled). @@ -9035,7 +9085,7 @@ Returns application-wide defaults for the component. - Enables overriding defaults in descendants (use separate set of defaults). + Enables overriding defaults in descendants (use a separate set of defaults). @@ -9045,10 +9095,10 @@ - Returns optional set of component settings. + Returns an optional set of component settings. - Similar to , enables defining wider in components descendants (by returning a derived settings class). + Similar to , enables defining wider in component descendants (by returning a derived settings class). @@ -9058,7 +9108,7 @@ - Debounce delay in milliseconds. Default is 300 ms. + Debounce delay in milliseconds. The default is 300 ms. @@ -9068,18 +9118,18 @@ - Bootstrap Spinner (usually indicates operation in progress).
+ Bootstrap Spinner (usually indicates an operation in progress).
Full documentation and demos: https://havit.blazor.eu/components/HxSpinner
- Spinner type. Spinner type - Border (default) or Grow. + Spinner type. The spinner type can be Border (default) or Grow. - Spinner size. You can also use custom to change the dimensions as needed. + Spinner size. You can also use a custom to change the dimensions as needed. @@ -9104,17 +9154,22 @@ - Size for . + Represents the size for . + + + + + Represents a spinner type. - https://getbootstrap.com/docs/5.3/components/spinners/#border-spinner + Represents a border spinner. For more information, see: https://getbootstrap.com/docs/5.3/components/spinners/#border-spinner - https://getbootstrap.com/docs/5.3/components/spinners/#growing-spinner + Represents a growing spinner. For more information, see: https://getbootstrap.com/docs/5.3/components/spinners/#growing-spinner @@ -9230,7 +9285,7 @@ - Determines whether the content all tabs is always rendered or only if the tab is active.
+ Determines whether the content of all tabs is always rendered or only if the tab is active.
Default is .
@@ -9247,7 +9302,7 @@
- Raised when ID of the active tab changes. + Raised when the ID of the active tab changes. @@ -9275,7 +9330,7 @@ - Handle click on tab title to activate tab. + Handle click on the tab title to activate the tab. @@ -9288,7 +9343,7 @@ - Content of all tabs is always rendered (and visibility set with CSS). + Content of all tabs is always rendered (and visibility is set with CSS). @@ -9345,54 +9400,47 @@ - Set to method providing data for tags' suggestions. + Set to a method providing data for tag suggestions. - Minimal number of characters to start suggesting. Default is 2. + The minimum number of characters to start suggesting. The default is 2. - Debounce delay in milliseconds. Default is 300 ms. + The debounce delay in milliseconds. The default is 300 ms. - Characters, when typed, divide the current input into separate tags. - Default is comma, semicolon and space. + Characters that divide the current input into separate tags when typed. The default is comma, semicolon, and space. - Indicates whether the add-icon (+) should be displayed. - Default is false. + Indicates whether the add icon (+) should be displayed. The default is false. - Optional text for the add-button. - Displayed only when there are no tags (the Value is empty). - Default is null (none). + The optional text for the add button. Displayed only when there are no tags (the Value is empty). The default is null (none). - Indicates whether a "naked" variant should be displayed (no border). - Default is false. - Consider enabling when using Naked. + Indicates whether a "naked" variant should be displayed (no border). The default is false. Consider enabling when using Naked. - Short hint displayed in the input field before the user enters a value. + A short hint displayed in the input field before the user enters a value. - Settings for the used to render tags. - Default is Color="" and TextColor="". + The settings for the used to render tags. The default is Color="" and TextColor="". @@ -9400,32 +9448,32 @@ - Size of the input. + The size of the input. - Custom CSS class to render with input-group span. + The custom CSS class to render with the input-group span. - Input-group at the beginning of the input. + The input-group at the beginning of the input. - Input-group at the beginning of the input. + The input-group at the beginning of the input. - Input-group at the end of the input. + The input-group at the end of the input. - Input-group at the end of the input. + The input-group at the end of the input. @@ -9460,7 +9508,7 @@ - The used to relay cancellation of the request. + The used to indicate cancellation of the request. @@ -9470,7 +9518,7 @@ - The provided items by the request. + The items provided by the request. @@ -9480,7 +9528,7 @@ - Minimal number of characters to start suggesting. + Minimum number of characters to start suggesting. @@ -9495,7 +9543,7 @@ - Characters, when typed, divide the current input into separate tags. + Characters that, when typed, divide the current input into separate tags. @@ -9510,18 +9558,18 @@ - Bootstrap theme colors https://getbootstrap.com/docs/5.3/customize/color/#theme-colors - (+ Link from predefined button styles https://getbootstrap.com/docs/5.3/components/buttons/) + Bootstrap theme colors. For more information, see https://getbootstrap.com/docs/5.3/customize/color/#theme-colors. + Also, refer to the predefined button styles at https://getbootstrap.com/docs/5.3/components/buttons/. - To be used for buttons only. + This color is intended to be used for buttons only. - Color-scheme of the message. + Color scheme of the message. @@ -9532,7 +9580,7 @@ - Position of the messages. Default is . + Position of the messages. The default value is . @@ -9542,7 +9590,7 @@ - Receive notification from when message is hidden. + Receive notification from when the message is hidden. @@ -9557,12 +9605,12 @@ - Adds and shows an informational message. Message is automatically hidden 5 seconds after showing up. + Adds and shows an informational message. The message is automatically hidden 5 seconds after showing up. - Adds and shows an informational message. Message is automatically hidden 5 seconds after showing up. + Adds and shows an informational message. The message is automatically hidden 5 seconds after showing up. @@ -9588,28 +9636,23 @@ Bootstrap Toast component. Not intended to be used in user code, use . - After first render component never updates.
+ After the first render, the component never updates.
Full documentation and demos: https://havit.blazor.eu/components/HxToast
- - - JS Runtime. - - - Color-scheme. + Color scheme. - Delay in milliseconds to automatically hide toast. + Delay in milliseconds to automatically hide the toast. - Css class to render with toast. + CSS class to render with the toast. @@ -9639,12 +9682,12 @@ - Indicates whether to show close button. + Indicates whether to show the close button. - Fires when toast is hidden (button or autohide). + Fires when the toast is hidden (button or autohide). @@ -9668,7 +9711,7 @@ - Positioning of the toasts on screen. + Positioning of the toasts on the screen. @@ -9688,7 +9731,7 @@ - Color-scheme of informational messages. + Color scheme of informational messages. @@ -9698,7 +9741,7 @@ - Color-scheme of informational messages. + Color scheme of warning messages. @@ -9708,7 +9751,7 @@ - Color-scheme of informational messages. + Color scheme of error messages. @@ -9731,7 +9774,7 @@ Returns application-wide defaults for the component. - Enables overriding defaults in descendants (use separate set of defaults). + Enables overriding defaults in descendants (use a separate set of defaults). @@ -9741,10 +9784,10 @@ - Returns optional set of component settings. + Returns an optional set of component settings. - Similar to , enables defining wider in components descendants (by returning a derived settings class). + Similar to , enables defining wider in component descendants (by returning a derived settings class). @@ -9759,12 +9802,12 @@ - Popover placement. Default is . + Popover placement. The default is . - Popover trigger(s). Default is . + Popover trigger(s). The default is . @@ -9782,7 +9825,7 @@ Returns application-wide defaults for the component. - Enables overriding defaults in descendants (use separate set of defaults). + Enables overriding defaults in descendants (use a separate set of defaults). @@ -9792,10 +9835,10 @@ - Returns optional set of component settings. + Returns an optional set of component settings. - Similar to , enables defining wider in components descendants (by returning a derived settings class). + Similar to , enables defining wider in component descendants (by returning a derived settings class). @@ -9805,12 +9848,12 @@ - Tooltip placement. Default is . + Tooltip placement. The default is . - Tooltip trigger(s). Default is | . + Tooltip trigger(s). The default is | . @@ -9820,7 +9863,7 @@ - When is specified, it will dynamically reorient the popover. + When specified, it will dynamically reorient the popover. @@ -9828,6 +9871,26 @@ Triggers for .
+ + + Specifies that the popover should be triggered by a click event. + + + + + Specifies that the popover should be triggered by a hover event. + + + + + Specifies that the popover should be triggered by a focus event. + + + + + Specifies that the popover should be triggered manually. + + Placement of the tooltip for . @@ -9835,7 +9898,7 @@ - When is specified, it will dynamically reorient the tooltip. + When specified, it will dynamically reorient the tooltip. @@ -9845,14 +9908,14 @@ - Component to display hierarchy data structure.
+ Component to display a hierarchy data structure.
Full documentation and demos: https://havit.blazor.eu/components/HxTreeView
Type of tree data item.
- Collection of hierarchy data to display. + Collection of hierarchical data to display. @@ -9862,17 +9925,17 @@ - Event fires when selected data item changes. + Event fired when the selected data item changes. - Event fires when expanding an item. + Event fired when an item is expanded. - Event fires when collapsing an item. + Event fired when an item is collapsed. @@ -9882,18 +9945,18 @@ - Selector to display item title from data item. + Selector to display the item title from the data item. - Selector to display icon from data item. + Selector to display the icon from the data item. - Selector for initial expansion state for data item.
- Default state is false (collapsed). + Selector for the initial expansion state of the data item.
+ The default state is false (collapsed).
@@ -9903,12 +9966,12 @@ - Selector for item CSS class. + Selector for the item CSS class. - Selector to display children collection for current data item. Children collection should have same type as current item. + Selector to display the children collection for the current data item. The children collection should have the same type as the current item.