Skip to content

v7 Preparations: Removing Obsolete Parameters #372

New issue

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

Sign up for GitHub

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

Already on GitHub? Sign in to your account

Merged
mckaragoz merged 1 commit into from
Apr 13, 2024
Merged

v7 Preparations: Removing Obsolete Parameters #372

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
156 changes: 106 additions & 50 deletions CodeBeam.MudBlazor.Extensions/Base/MudBaseInputExtended.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,11 @@ namespace MudExtensions
public abstract class MudBaseInputExtended<T> : MudFormComponent<T, string>
{
private bool _isDirty;
private bool _validated;

/// <summary>
///
/// </summary>
protected MudBaseInputExtended() : base(new DefaultConverter<T>()) { }

[CascadingParameter(Name = "ParentDisabled")] private bool ParentDisabled { get; set; }
Expand Down Expand Up @@ -72,7 +76,7 @@ protected MudBaseInputExtended() : base(new DefaultConverter<T>()) { }
/// </summary>
[Parameter]
[Category(CategoryTypes.FormComponent.Behavior)]
public string HelperText { get; set; }
public string? HelperText { get; set; }

/// <summary>
/// If true, the helper text will only be visible on focus.
Expand All @@ -86,14 +90,14 @@ protected MudBaseInputExtended() : base(new DefaultConverter<T>()) { }
/// </summary>
[Parameter]
[Category(CategoryTypes.FormComponent.Behavior)]
public string AdornmentIcon { get; set; }
public string? AdornmentIcon { get; set; }

/// <summary>
/// Text that will be used if Adornment is set to Start or End, the Text overrides Icon.
/// </summary>
[Parameter]
[Category(CategoryTypes.FormComponent.Behavior)]
public string AdornmentText { get; set; }
public string? AdornmentText { get; set; }

/// <summary>
/// The Adornment if used. By default, it is set to None.
Expand All @@ -107,14 +111,21 @@ protected MudBaseInputExtended() : base(new DefaultConverter<T>()) { }
/// </summary>
[Parameter]
[Category(CategoryTypes.FormComponent.Behavior)]
public RenderFragment AdornmentStart { get; set; }
public RenderFragment? AdornmentStart { get; set; }

/// <summary>
/// The Adornment if used. By default, it is set to None.
/// </summary>
[Parameter]
[Category(CategoryTypes.FormComponent.Behavior)]
public RenderFragment AdornmentEnd { get; set; }
public RenderFragment? AdornmentEnd { get; set; }

/// <summary>
/// The aria-label of the adornment.
/// </summary>
[Parameter]
[Category(CategoryTypes.FormComponent.Appearance)]
public string? AdornmentAriaLabel { get; set; } = string.Empty;

/// <summary>
/// The validation is only triggered if the user has changed the input value at least once. By default, it is false
Expand All @@ -128,7 +139,7 @@ protected MudBaseInputExtended() : base(new DefaultConverter<T>()) { }
/// </summary>
[Parameter]
[Category(CategoryTypes.FormComponent.Behavior)]
public bool ForceShrink { get; set; }
public bool ShrinkLabel { get; set; }

/// <summary>
/// The color of the adornment if used. It supports the theme colors.
Expand All @@ -137,13 +148,6 @@ protected MudBaseInputExtended() : base(new DefaultConverter<T>()) { }
[Category(CategoryTypes.FormComponent.Appearance)]
public Color AdornmentColor { get; set; } = Color.Default;

/// <summary>
/// The aria-label of the adornment.
/// </summary>
[Parameter]
[Category(CategoryTypes.FormComponent.Appearance)]
public string AdornmentAriaLabel { get; set; } = string.Empty;

/// <summary>
/// The Icon Size.
/// </summary>
Expand Down Expand Up @@ -175,7 +179,7 @@ protected MudBaseInputExtended() : base(new DefaultConverter<T>()) { }
/// </summary>
[Parameter]
[Category(CategoryTypes.FormComponent.Behavior)]
public string Placeholder { get; set; }
public string? Placeholder { get; set; }

/// <summary>
/// If set, will display the counter, value 0 will display current count but no stop count.
Expand All @@ -196,7 +200,7 @@ protected MudBaseInputExtended() : base(new DefaultConverter<T>()) { }
/// </summary>
[Parameter]
[Category(CategoryTypes.FormComponent.Behavior)]
public string Label { get; set; }
public string? Label { get; set; }

/// <summary>
/// If true the input will focus automatically.
Expand Down Expand Up @@ -242,13 +246,13 @@ protected MudBaseInputExtended() : base(new DefaultConverter<T>()) { }
/// </summary>
[Parameter]
[Category(CategoryTypes.FormComponent.Validation)]
public virtual string Pattern { get; set; }
public virtual string? Pattern { get; set; }

/// <summary>
/// CSS style of the child content.
/// </summary>
[Parameter]
public string ChildContentStyle { get; set; }
public string? ChildContentStyle { get; set; }

/// <summary>
/// Sync the value, values and text, calls validation manually. Useful to call after user changes value or text programmatically.
Expand All @@ -264,11 +268,18 @@ public virtual async Task ForceUpdate()
/// </summary>
internal virtual InputType GetInputType() { return InputType.Text; }

/// <summary>
///
/// </summary>
/// <param name="text"></param>
/// <param name="updateValue"></param>
/// <returns></returns>
protected virtual async Task SetTextAsync(string? text, bool updateValue = true)
{
if (Text != text)
{
Text = text;
_validated = false;
if (!string.IsNullOrWhiteSpace(Text))
Touched = true;
if (updateValue)
Expand Down Expand Up @@ -314,7 +325,7 @@ protected virtual Task UpdateTextPropertyAsync(bool updateValue)
/// <summary>
/// Fired when the text value changes.
/// </summary>
[Parameter] public EventCallback<string> TextChanged { get; set; }
[Parameter] public EventCallback<string?> TextChanged { get; set; }

/// <summary>
/// Fired when the element loses focus.
Expand All @@ -327,16 +338,32 @@ protected virtual Task UpdateTextPropertyAsync(bool updateValue)
[Parameter]
public EventCallback<ChangeEventArgs> OnInternalInputChanged { get; set; }

/// <summary>
///
/// </summary>
protected bool _isFocused;

/// <summary>
///
/// </summary>
/// <param name="obj"></param>
/// <returns></returns>
protected internal virtual async Task OnBlurredAsync(FocusEventArgs obj)
{
if (ReadOnly)
{
return;
}

_isFocused = false;

if (!OnlyValidateIfDirty || _isDirty)
{
Touched = true;
await BeginValidationAfterAsync(OnBlur.InvokeAsync(obj));
if (_validated)
await OnBlur.InvokeAsync(obj);
else
await BeginValidationAfterAsync(OnBlur.InvokeAsync(obj));
}
}

Expand All @@ -345,7 +372,12 @@ protected internal virtual async Task OnBlurredAsync(FocusEventArgs obj)
/// </summary>
[Parameter] public EventCallback<KeyboardEventArgs> OnKeyDown { get; set; }

protected virtual async Task InvokeKeyDown(KeyboardEventArgs obj)
/// <summary>
///
/// </summary>
/// <param name="obj"></param>
/// <returns></returns>
protected virtual async Task InvokeKeyDownAsync(KeyboardEventArgs obj)
{
_isFocused = true;
await OnKeyDown.InvokeAsync(obj);
Expand All @@ -365,30 +397,17 @@ protected virtual async Task InvokeKeyDown(KeyboardEventArgs obj)
[Category(CategoryTypes.FormComponent.Behavior)]
public bool DisablePaste { get; set; }


/// <summary>
/// Fired on the KeyPress event.
/// </summary>
[Parameter] public EventCallback<KeyboardEventArgs> OnKeyPress { get; set; }

protected virtual async Task InvokeKeyPress(KeyboardEventArgs obj)
{
await OnKeyPress.InvokeAsync(obj);
}

/// <summary>
/// Prevent the default action for the KeyPress event.
/// </summary>
[Parameter]
[Category(CategoryTypes.FormComponent.Behavior)]
public bool KeyPressPreventDefault { get; set; }

/// <summary>
/// Fired on the KeyUp event.
/// </summary>
[Parameter] public EventCallback<KeyboardEventArgs> OnKeyUp { get; set; }

protected virtual async Task InvokeKeyUp(KeyboardEventArgs obj)
/// <summary>
///
/// </summary>
/// <param name="obj"></param>
/// <returns></returns>
protected virtual async Task InvokeKeyUpAsync(KeyboardEventArgs obj)
{
_isFocused = true;
await OnKeyUp.InvokeAsync(obj);
Expand Down Expand Up @@ -418,11 +437,19 @@ public T? Value
set => _value = value;
}

/// <summary>
///
/// </summary>
/// <param name="value"></param>
/// <param name="updateText"></param>
/// <param name="force"></param>
/// <returns></returns>
protected virtual async Task SetValueAsync(T? value, bool updateText = true, bool force = false)
{
if (!EqualityComparer<T?>.Default.Equals(Value, value) || force == true)
{
_isDirty = true;
_validated = false;
Value = value;
await ValueChanged.InvokeAsync(Value);
if (updateText)
Expand All @@ -440,6 +467,11 @@ protected virtual Task UpdateValuePropertyAsync(bool updateText)
return SetValueAsync(Converter.Get(Text), updateText);
}

/// <summary>
///
/// </summary>
/// <param name="value"></param>
/// <returns></returns>
protected override bool SetConverter(MudBlazor.Converter<T, string> value)
{
var changed = base.SetConverter(value);
Expand All @@ -449,6 +481,11 @@ protected override bool SetConverter(MudBlazor.Converter<T, string> value)
return changed;
}

/// <summary>
///
/// </summary>
/// <param name="value"></param>
/// <returns></returns>
protected override bool SetCulture(CultureInfo value)
{
var changed = base.SetCulture(value);
Expand All @@ -463,13 +500,18 @@ protected override bool SetCulture(CultureInfo value)
/// </summary>
[Parameter]
[Category(CategoryTypes.FormComponent.Behavior)]
public string Format
public string? Format
{
get => ((Converter<T>)Converter).Format;
set => SetFormat(value);
}

protected virtual bool SetFormat(string value)
/// <summary>
///
/// </summary>
/// <param name="value"></param>
/// <returns></returns>
protected virtual bool SetFormat(string? value)
{
var changed = Format != value;
if (changed)
Expand All @@ -480,12 +522,17 @@ protected virtual bool SetFormat(string value)
return changed;
}

protected override Task ValidateValue()
/// <summary>
///
/// </summary>
/// <returns></returns>
protected override async Task ValidateValue()
{
if (SubscribeToParentFormExtended)
return base.ValidateValue();

return Task.CompletedTask;
{
_validated = true;
await base.ValidateValue();
}
}

/// <summary>
Expand Down Expand Up @@ -516,9 +563,13 @@ public virtual async Task ForceRender(bool forceTextUpdate)
await UpdateTextPropertyAsync(false);
StateHasChanged();
}

/// <summary>
///
/// </summary>
protected bool _forceTextUpdate;

/// <summary>
///
/// </summary>
protected virtual bool SkipUpdateProcessOnSetParameters { get; set; }

/// <summary>
Expand Down Expand Up @@ -582,11 +633,16 @@ protected override void OnParametersSet()
base.OnParametersSet();
}

protected override void ResetValue()
/// <summary>
///
/// </summary>
/// <returns></returns>
protected override async Task ResetValueAsync()
{
SetTextAsync(null, updateValue: true).AndForget();
await SetTextAsync(null, updateValue: true);
_isDirty = false;
base.ResetValueAsync();
_validated = false;
await base.ResetValueAsync();
}

[CascadingParameter(Name = "SubscribeToParentFormExtended")]
Expand Down
1 change: 0 additions & 1 deletion CodeBeam.MudBlazor.Extensions/Components/ChipField/MudChipField.razor
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,6 @@
Immediate="true"
OnKeyDown="HandleKeyDown"
OnKeyUp="HandleKeyUp"
OnKeyPress="@(async() => await OnKeyPress.InvokeAsync())"
OnBlur="@(async() => await OnBlur.InvokeAsync())"
OnClearButtonClick="@(async() => await OnClearButtonClick.InvokeAsync())"
OnDebounceIntervalElapsed="@(async() => await OnDebounceIntervalElapsed.InvokeAsync())"
Expand Down
6 changes: 5 additions & 1 deletion CodeBeam.MudBlazor.Extensions/Components/ChipField/MudChipField.razor.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@ public partial class MudChipField<T> : MudTextFieldExtended<T>
/// CSS styles of the chips.
/// </summary>
[Parameter]
public string StyleChip { get; set; }
public string? StyleChip { get; set; }

/// <summary>
/// Color of the chips.
Expand Down Expand Up @@ -137,6 +137,10 @@ protected async Task HandleKeyUp(KeyboardEventArgs args)
await OnKeyUp.InvokeAsync(args);
}

/// <summary>
///
/// </summary>
/// <returns></returns>
protected async Task SetChips()
{
if (Values == null)
Expand Down
2 changes: 1 addition & 1 deletion CodeBeam.MudBlazor.Extensions/Components/ComboBox/MudComboBox.razor
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@
DisableUnderLine="@DisableUnderLine"
Disabled="@Disabled" ReadOnly="@ReadOnly" Error="@Error" ErrorId="@ErrorId"
Clearable="@Clearable" ForceClearable="@(Clearable && HasValue(Value))" OnClearButtonClick="@ClearButtonClickHandlerAsync"
@attributes="UserAttributes" OnBlur="@HandleOnBlur" ForceShrink="@(HasValue(Value) || _isOpen || ForceShrink)">
@attributes="UserAttributes" OnBlur="@HandleOnBlur" ShrinkLabel="@(HasValue(Value) || _isOpen || ShrinkLabel)">

<AdornmentEnd>
<MudIcon Icon="@_currentIcon" Color="@AdornmentColor" Size="@IconSize" @onclick="OnAdornmentClick" />
Expand Down
Loading