Skip to content
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

InputNumber formatting for decimal numbers #60112

Open
wants to merge 16 commits into
base: main
Choose a base branch
from
+336 −24
Open

InputNumber formatting for decimal numbers #60112

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
16 commits
Select commit Hold shift + click to select a range
94a4781
Format : Float
Jan 30, 2025
4326250
Format : Double
Jan 30, 2025
07e5185
Format : Decimal
Jan 30, 2025
4b4cf33
Documentation of additional format param.
Jan 30, 2025
835cd1d
InputNumber - Add parameter `Format`
Jan 30, 2025
c229d0c
Fix Docs
Jan 30, 2025
a75422e
Fix nullable Value
Jan 30, 2025
1cbd541
Binders
Jan 30, 2025
75bd939
BinderConverter - BindParserWithFormat
Jan 30, 2025
2b98c9f
Complete Bind-Converter
Jan 30, 2025
a0c2130
Realign format
Jan 30, 2025
7b7657b
Add API Docs
Jan 30, 2025
86bccd7
Add BindConverter Tests
Jan 30, 2025
a3200ce
Nullable format
Jan 30, 2025
26b513d
InputNumber
Jan 30, 2025
bcc65fd
Tests for input
Jan 30, 2025
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
196 changes: 189 additions & 7 deletions src/Components/Components/src/BindConverter.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,6 @@ public static class BindConverter
private static readonly object BoxedFalse = false;

private delegate object? BindFormatter<T>(T value, CultureInfo? culture);

internal delegate bool BindParser<T>(object? obj, CultureInfo? culture, [MaybeNullWhen(false)] out T value);
internal delegate bool BindParserWithFormat<T>(object? obj, CultureInfo? culture, string? format, [MaybeNullWhen(false)] out T value);

Expand Down Expand Up @@ -212,7 +211,29 @@ private static string FormatShortValueCore(short value, CultureInfo? culture)
/// </param>
/// <returns>The formatted value.</returns>
[SuppressMessage("ApiDesign", "RS0026:Do not add multiple public overloads with optional parameters", Justification = "Required to maintain compatibility")]
public static string FormatValue(float value, CultureInfo? culture = null) => FormatFloatValueCore(value, culture);
public static string FormatValue(float value, CultureInfo? culture = null) => FormatFloatValueCore(value, culture, format: null);

/// <summary>
/// Formats the provided <paramref name="value"/> for inclusion in an attribute.
/// </summary>
/// <param name="value">The value to format.</param>
/// <param name="culture">
/// The <see cref="CultureInfo"/> to use while formatting. Defaults to <see cref="CultureInfo.CurrentCulture"/>.
/// </param>
/// <param name="format">The format to use. Provided to <see cref="float.ToString(string, IFormatProvider)"/>.</param>
/// <returns>The formatted value.</returns>
[SuppressMessage("ApiDesign", "RS0026:Do not add multiple public overloads with optional parameters", Justification = "Required to maintain compatibility")]
public static string FormatValue(float value, [StringSyntax(StringSyntaxAttribute.NumericFormat)] string? format, CultureInfo? culture = null) => FormatFloatValueCore(value, culture, format);

private static string FormatFloatValueCore(float value, CultureInfo? culture, string? format)
{
if (format != null)
{
return value.ToString(format, culture ?? CultureInfo.CurrentCulture);
}

return value.ToString(culture ?? CultureInfo.CurrentCulture);
}

private static string FormatFloatValueCore(float value, CultureInfo? culture)
{
Expand All @@ -228,7 +249,34 @@ private static string FormatFloatValueCore(float value, CultureInfo? culture)
/// </param>
/// <returns>The formatted value.</returns>
[SuppressMessage("ApiDesign", "RS0026:Do not add multiple public overloads with optional parameters", Justification = "Required to maintain compatibility")]
public static string? FormatValue(float? value, CultureInfo? culture = null) => FormatNullableFloatValueCore(value, culture);
public static string? FormatValue(float? value, CultureInfo? culture = null) => FormatNullableFloatValueCore(value, culture, format: null);

/// <summary>
/// Formats the provided <paramref name="value"/> for inclusion in an attribute.
/// </summary>
/// <param name="value">The value to format.</param>
/// <param name="culture">
/// The <see cref="CultureInfo"/> to use while formatting. Defaults to <see cref="CultureInfo.CurrentCulture"/>.
/// </param>
/// <param name="format">The format to use. Provided to <see cref="float.ToString(string, IFormatProvider)"/>.</param>
/// <returns>The formatted value.</returns>
[SuppressMessage("ApiDesign", "RS0026:Do not add multiple public overloads with optional parameters", Justification = "Required to maintain compatibility")]
public static string? FormatValue(float? value, [StringSyntax(StringSyntaxAttribute.NumericFormat)] string? format, CultureInfo? culture = null) => FormatNullableFloatValueCore(value, culture, format);

private static string? FormatNullableFloatValueCore(float? value, CultureInfo? culture, string? format)
{
if (value == null)
{
return null;
}

if (format != null)
{
return value.Value.ToString(format, culture ?? CultureInfo.CurrentCulture);
}

return value.Value.ToString(culture ?? CultureInfo.CurrentCulture);
}

private static string? FormatNullableFloatValueCore(float? value, CultureInfo? culture)
{
Expand All @@ -249,7 +297,29 @@ private static string FormatFloatValueCore(float value, CultureInfo? culture)
/// </param>
/// <returns>The formatted value.</returns>
[SuppressMessage("ApiDesign", "RS0026:Do not add multiple public overloads with optional parameters", Justification = "Required to maintain compatibility")]
public static string? FormatValue(double value, CultureInfo? culture = null) => FormatDoubleValueCore(value, culture);
public static string? FormatValue(double value, CultureInfo? culture = null) => FormatDoubleValueCore(value, culture, format: null);

/// <summary>
/// Formats the provided <paramref name="value"/> for inclusion in an attribute.
/// </summary>
/// <param name="value">The value to format.</param>
/// <param name="culture">
/// The <see cref="CultureInfo"/> to use while formatting. Defaults to <see cref="CultureInfo.CurrentCulture"/>.
/// </param>
/// <param name="format">The format to use. Provided to <see cref="double.ToString(string, IFormatProvider)"/>.</param>
/// <returns>The formatted value.</returns>
[SuppressMessage("ApiDesign", "RS0026:Do not add multiple public overloads with optional parameters", Justification = "Required to maintain compatibility")]
public static string? FormatValue(double value, [StringSyntax(StringSyntaxAttribute.NumericFormat)] string? format, CultureInfo? culture = null) => FormatDoubleValueCore(value, culture, format);

private static string FormatDoubleValueCore(double value, CultureInfo? culture, string? format)
{
if (format != null)
{
return value.ToString(format, culture ?? CultureInfo.CurrentCulture);
}

return value.ToString(culture ?? CultureInfo.CurrentCulture);
}

private static string FormatDoubleValueCore(double value, CultureInfo? culture)
{
Expand All @@ -265,7 +335,19 @@ private static string FormatDoubleValueCore(double value, CultureInfo? culture)
/// </param>
/// <returns>The formatted value.</returns>
[SuppressMessage("ApiDesign", "RS0026:Do not add multiple public overloads with optional parameters", Justification = "Required to maintain compatibility")]
public static string? FormatValue(double? value, CultureInfo? culture = null) => FormatNullableDoubleValueCore(value, culture);
public static string? FormatValue(double? value, CultureInfo? culture = null) => FormatNullableDoubleValueCore(value, culture, format: null);

/// <summary>
/// Formats the provided <paramref name="value"/> for inclusion in an attribute.
/// </summary>
/// <param name="value">The value to format.</param>
/// <param name="culture">
/// The <see cref="CultureInfo"/> to use while formatting. Defaults to <see cref="CultureInfo.CurrentCulture"/>.
/// </param>
/// <param name="format">The format to use. Provided to <see cref="double.ToString(string, IFormatProvider)"/>.</param>
/// <returns>The formatted value.</returns>
[SuppressMessage("ApiDesign", "RS0026:Do not add multiple public overloads with optional parameters", Justification = "Required to maintain compatibility")]
public static string? FormatValue(double? value, [StringSyntax(StringSyntaxAttribute.NumericFormat)] string? format, CultureInfo? culture = null) => FormatNullableDoubleValueCore(value, culture, format);

private static string? FormatNullableDoubleValueCore(double? value, CultureInfo? culture)
{
Expand All @@ -277,6 +359,21 @@ private static string FormatDoubleValueCore(double value, CultureInfo? culture)
return value.Value.ToString(culture ?? CultureInfo.CurrentCulture);
}

private static string? FormatNullableDoubleValueCore(double? value, CultureInfo? culture, string? format)
{
if (value == null)
{
return null;
}

if (format != null)
{
return value.Value.ToString(format, culture ?? CultureInfo.CurrentCulture);
}

return value.Value.ToString(culture ?? CultureInfo.CurrentCulture);
}

/// <summary>
/// Formats the provided <paramref name="value"/> for inclusion in an attribute.
/// </summary>
Expand All @@ -286,23 +383,57 @@ private static string FormatDoubleValueCore(double value, CultureInfo? culture)
/// </param>
/// <returns>The formatted value.</returns>
[SuppressMessage("ApiDesign", "RS0026:Do not add multiple public overloads with optional parameters", Justification = "Required to maintain compatibility")]
public static string FormatValue(decimal value, CultureInfo? culture = null) => FormatDecimalValueCore(value, culture);
public static string FormatValue(decimal value, CultureInfo? culture = null) => FormatDecimalValueCore(value, culture, format: null);

/// <summary>
/// Formats the provided <paramref name="value"/> for inclusion in an attribute.
/// </summary>
/// <param name="value">The value to format.</param>
/// <param name="culture">
/// The <see cref="CultureInfo"/> to use while formatting. Defaults to <see cref="CultureInfo.CurrentCulture"/>.
/// </param>
/// <param name="format">The format to use. Provided to <see cref="decimal.ToString(string, IFormatProvider)"/>.</param>
/// <returns>The formatted value.</returns>
[SuppressMessage("ApiDesign", "RS0026:Do not add multiple public overloads with optional parameters", Justification = "Required to maintain compatibility")]
public static string FormatValue(decimal value, [StringSyntax(StringSyntaxAttribute.NumericFormat)] string? format, CultureInfo? culture = null) => FormatDecimalValueCore(value, culture, format);

private static string FormatDecimalValueCore(decimal value, CultureInfo? culture)
{
return value.ToString(culture ?? CultureInfo.CurrentCulture);
}

private static string FormatDecimalValueCore(decimal value, CultureInfo? culture, string? format)
{
if (format != null)
{
return value.ToString(format, culture ?? CultureInfo.CurrentCulture);
}

return value.ToString(culture ?? CultureInfo.CurrentCulture);
}

/// <summary>
/// Formats the provided <paramref name="value"/> as a <see cref="System.String"/>.
/// </summary>
/// <param name="value">The value to format.</param>
/// <param name="culture">
/// The <see cref="CultureInfo"/> to use while formatting. Defaults to <see cref="CultureInfo.CurrentCulture"/>.
/// </param>
/// <returns>The formatted value.</returns>
[SuppressMessage("ApiDesign", "RS0026:Do not add multiple public overloads with optional parameters", Justification = "Required to maintain compatibility")]
public static string? FormatValue(decimal? value, CultureInfo? culture = null) => FormatNullableDecimalValueCore(value, culture, format: null);

/// <summary>
/// Formats the provided <paramref name="value"/> as a <see cref="System.String"/>.
/// </summary>
/// <param name="value">The value to format.</param>
/// <param name="culture">
/// The <see cref="CultureInfo"/> to use while formatting. Defaults to <see cref="CultureInfo.CurrentCulture"/>.
/// </param>
/// <param name="format">The format to use. Provided to <see cref="decimal.ToString(string, IFormatProvider)"/>.</param>
/// <returns>The formatted value.</returns>
[SuppressMessage("ApiDesign", "RS0026:Do not add multiple public overloads with optional parameters", Justification = "Required to maintain compatibility")]
public static string? FormatValue(decimal? value, CultureInfo? culture = null) => FormatNullableDecimalValueCore(value, culture);
public static string? FormatValue(decimal? value, [StringSyntax(StringSyntaxAttribute.NumericFormat)] string? format, CultureInfo? culture = null) => FormatNullableDecimalValueCore(value, culture, format);

private static string? FormatNullableDecimalValueCore(decimal? value, CultureInfo? culture)
{
Expand All @@ -314,6 +445,21 @@ private static string FormatDecimalValueCore(decimal value, CultureInfo? culture
return value.Value.ToString(culture ?? CultureInfo.CurrentCulture);
}

private static string? FormatNullableDecimalValueCore(decimal? value, CultureInfo? culture, string? format)
{
if (value == null)
{
return null;
}

if (format != null)
{
return value.Value.ToString(format, culture ?? CultureInfo.CurrentCulture);
}

return value.Value.ToString(culture ?? CultureInfo.CurrentCulture);
}

/// <summary>
/// Formats the provided <paramref name="value"/> as a <see cref="System.String"/>.
/// </summary>
Expand Down Expand Up @@ -969,9 +1115,16 @@ public static bool TryConvertToNullableFloat(object? obj, CultureInfo? culture,
}

internal static BindParser<float> ConvertToFloat = ConvertToFloatCore;
internal static BindParserWithFormat<float> ConvertToFloatWithFormat = ConvertToFloatCore;
internal static BindParser<float?> ConvertToNullableFloat = ConvertToNullableFloatCore;
internal static BindParserWithFormat<float?> ConvertToNullableFloatWithFormat = ConvertToNullableFloatCore;

private static bool ConvertToFloatCore(object? obj, CultureInfo? culture, out float value)
{
return ConvertToFloatCore(obj, culture, format: null, out value);
}

private static bool ConvertToFloatCore(object? obj, CultureInfo? culture, string? format, out float value)
{
var text = (string?)obj;
if (string.IsNullOrEmpty(text))
Expand All @@ -997,6 +1150,11 @@ private static bool ConvertToFloatCore(object? obj, CultureInfo? culture, out fl
}

private static bool ConvertToNullableFloatCore(object? obj, CultureInfo? culture, out float? value)
{
return ConvertToNullableFloatCore(obj, culture, format: null, out value);
}

private static bool ConvertToNullableFloatCore(object? obj, CultureInfo? culture, string? format, out float? value)
{
var text = (string?)obj;
if (string.IsNullOrEmpty(text))
Expand Down Expand Up @@ -1046,9 +1204,16 @@ public static bool TryConvertToNullableDouble(object? obj, CultureInfo? culture,
}

internal static BindParser<double> ConvertToDoubleDelegate = ConvertToDoubleCore;
internal static BindParserWithFormat<double> ConvertToDoubleWithFormat = ConvertToDoubleCore;
internal static BindParser<double?> ConvertToNullableDoubleDelegate = ConvertToNullableDoubleCore;
internal static BindParserWithFormat<double?> ConvertToNullableDoubleWithFormat = ConvertToNullableDoubleCore;

private static bool ConvertToDoubleCore(object? obj, CultureInfo? culture, out double value)
{
return ConvertToDoubleCore(obj, culture, format: null, out value);
}

private static bool ConvertToDoubleCore(object? obj, CultureInfo? culture, string? format, out double value)
{
var text = (string?)obj;
if (string.IsNullOrEmpty(text))
Expand All @@ -1074,6 +1239,11 @@ private static bool ConvertToDoubleCore(object? obj, CultureInfo? culture, out d
}

private static bool ConvertToNullableDoubleCore(object? obj, CultureInfo? culture, out double? value)
{
return ConvertToNullableDoubleCore(obj, culture, format: null, out value);
}

private static bool ConvertToNullableDoubleCore(object? obj, CultureInfo? culture, string? format, out double? value)
{
var text = (string?)obj;
if (string.IsNullOrEmpty(text))
Expand Down Expand Up @@ -1123,9 +1293,16 @@ public static bool TryConvertToNullableDecimal(object? obj, CultureInfo? culture
}

internal static BindParser<decimal> ConvertToDecimal = ConvertToDecimalCore;
internal static BindParserWithFormat<decimal> ConvertToDecimalWithFormat = ConvertToDecimalCore;
internal static BindParser<decimal?> ConvertToNullableDecimal = ConvertToNullableDecimalCore;
internal static BindParserWithFormat<decimal?> ConvertToNullableDecimalWithFormat = ConvertToNullableDecimalCore;

private static bool ConvertToDecimalCore(object? obj, CultureInfo? culture, out decimal value)
{
return ConvertToDecimalCore(obj, culture, format: null, out value);
}

private static bool ConvertToDecimalCore(object? obj, CultureInfo? culture, string? format, out decimal value)
{
var text = (string?)obj;
if (string.IsNullOrEmpty(text))
Expand All @@ -1145,6 +1322,11 @@ private static bool ConvertToDecimalCore(object? obj, CultureInfo? culture, out
}

private static bool ConvertToNullableDecimalCore(object? obj, CultureInfo? culture, out decimal? value)
{
return ConvertToNullableDecimalCore(obj, culture, format: null, out value);
}

private static bool ConvertToNullableDecimalCore(object? obj, CultureInfo? culture, string? format, out decimal? value)
{
var text = (string?)obj;
if (string.IsNullOrEmpty(text))
Expand Down
6 changes: 6 additions & 0 deletions src/Components/Components/src/PublicAPI.Unshipped.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1 +1,7 @@
#nullable enable
static Microsoft.AspNetCore.Components.BindConverter.FormatValue(decimal value, string? format, System.Globalization.CultureInfo? culture = null) -> string!
static Microsoft.AspNetCore.Components.BindConverter.FormatValue(decimal? value, string? format, System.Globalization.CultureInfo? culture = null) -> string?
static Microsoft.AspNetCore.Components.BindConverter.FormatValue(double value, string? format, System.Globalization.CultureInfo? culture = null) -> string?
static Microsoft.AspNetCore.Components.BindConverter.FormatValue(double? value, string? format, System.Globalization.CultureInfo? culture = null) -> string?
static Microsoft.AspNetCore.Components.BindConverter.FormatValue(float value, string? format, System.Globalization.CultureInfo? culture = null) -> string!
static Microsoft.AspNetCore.Components.BindConverter.FormatValue(float? value, string? format, System.Globalization.CultureInfo? culture = null) -> string?
Loading
Loading