Add NumberBox<T> control

Author: xoofx

doc/controls/index.md

@@ -9,6 +9,7 @@ This section documents the built-in controls provided by XenoAtom.Terminal.UI.
 - `doc/controls/textbox.md`
 - `doc/controls/textarea.md`
 - `doc/controls/maskedinput.md`
+- `doc/controls/numberbox.md`
 
 ## Buttons & toggles
 

doc/controls/numberbox.md

@@ -0,0 +1,55 @@
+# NumberBox
+
+`NumberBox<T>` is a single-line numeric editor built on the `TextEditorCore` infrastructure. It provides caret/selection/clipboard support like `TextBox`, while keeping a bindable numeric `Value`.
+
+> Screenshots: `docs/images/numberbox-basic.png` (placeholder)
+
+## Basic usage
+
+```csharp
+var age = new State<int>(42);
+
+var ui = new NumberBox<int>()
+    .Value(age);
+```
+
+## Validation
+
+Validation runs on each text change:
+
+- If the text parses successfully (as `T`) and `ValidateValue` returns `null`, the `Value` is updated.
+- Otherwise `Value` is not updated and a validation message is shown below the editor.
+
+```csharp
+var port = new State<int>(8080);
+
+var ui = new NumberBox<int>
+{
+    ValueValidator = v => v is >= 1 and <= 65535 ? null : "Port must be in [1..65535]",
+}.Value(port);
+```
+
+## Parsing settings
+
+You can control parsing via:
+
+- `ParseStyles` (default: `NumberStyles.Number`)
+- `FormatProvider` (default: `null` meaning current culture behavior for parsing/formatting)
+
+```csharp
+var ui = new NumberBox<double>()
+    .ParseStyles(NumberStyles.Float)
+    .FormatProvider(CultureInfo.InvariantCulture);
+```
+
+## Styling
+
+The validation message is styled via `NumberBoxStyle` (`NumberBoxStyle.Key`).
+
+```csharp
+var ui = new NumberBox<int>()
+    .Style(NumberBoxStyle.Default with
+    {
+        ValidationPrefix = "Error: ",
+    });
+```

samples/ControlsDemo/Demos/NumberBoxDemo.cs

@@ -0,0 +1,41 @@
+using System.Globalization;
+using XenoAtom.Terminal.UI;
+using XenoAtom.Terminal.UI.Controls;
+
+namespace XenoAtom.Terminal.UI.ControlsDemo.Demos;
+
+[Demo("NumberBox", "Input", Description = "Numeric editor with validation and bindable Value.")]
+public sealed class NumberBoxDemo : ControlsDemoBase
+{
+    public NumberBoxDemo() : base(DemoSource.Get())
+    {
+    }
+
+    public override Visual Build(DemoContext context)
+    {
+        var port = new State<int>(8080);
+        var factor = new State<double>(1.25);
+
+        return new VStack(
+                DemoUi.Hint("NumberBox<T> updates Value when input parses and validation succeeds."),
+                new HStack(
+                        new VStack(
+                                "Port (1..65535):",
+                                new NumberBox<int>
+                                {
+                                    ValueValidator = v => v is >= 1 and <= 65535 ? null : "Port must be in [1..65535]",
+                                }.Value(port))
+                            .Spacing(1),
+                        new VStack(
+                                "Factor (invariant culture):",
+                                new NumberBox<double>()
+                                    .Value(factor)
+                                    .ParseStyles(NumberStyles.Float)
+                                    .FormatProvider(CultureInfo.InvariantCulture))
+                            .Spacing(1))
+                    .Spacing(4),
+                new TextBlock(() => $"Port: {port.Value} | Factor: {factor.Value:0.###}"),
+                new Button("Log").Click(() => context.Log($"Port={port.Value}, Factor={factor.Value:0.###}")))
+            .Spacing(1);
+    }
+}

samples/FullscreenDemo/Program.cs

@@ -10,6 +10,7 @@
 var statusState = new State<string>("ready");
 var progressState = new State<double>(0.0);
 var sliderState = new State<double>(0.35);
+var portState = new State<int>(8080);
 var switcherIndexState = new State<int>(0);
 var switchState = new State<bool>(false);
 var chartTickState = new State<int>(0);
@@ -186,6 +187,14 @@ void ShowModalDialog()
                     .ValueChanged((_, e) => sliderState.Value = e.NewValue))
             .Spacing(1)
             .HorizontalAlignment(HorizontalAlignment.Stretch),
+        new VStack(
+                "Port (1..65535):",
+                new NumberBox<int>
+                {
+                    ValueValidator = v => v is >= 1 and <= 65535 ? null : "Port must be in [1..65535]",
+                }.Value(portState))
+            .Spacing(1)
+            .HorizontalAlignment(HorizontalAlignment.Stretch),
         progressBars)
     .Spacing(0)
     .HorizontalAlignment(HorizontalAlignment.Stretch)
@@ -411,7 +420,7 @@ void ShowModalDialog()
                         .HorizontalAlignment(HorizontalAlignment.Stretch))
             })
             .HorizontalAlignment(HorizontalAlignment.Stretch),
-        new TextBlock().Text(() => $"Status: {statusState.Value} | Slider: {sliderState.Value:0.00}"))
+        new TextBlock().Text(() => $"Status: {statusState.Value} | Slider: {sliderState.Value:0.00} | Port: {portState.Value}"))
     .Spacing(1)
     .HorizontalAlignment(HorizontalAlignment.Stretch)
     .VerticalAlignment(VerticalAlignment.Stretch);

src/XenoAtom.Terminal.UI.SourceGen/TerminalUiGenerator.cs

@@ -87,6 +87,7 @@ private sealed record BindablePropertyInfo(
         string ContainingTypeDisplayName,
         string PropertyName,
         string PropertyTypeFullyQualified,
+        bool IsDelegateProperty,
         bool IsParentVisual,
         bool IsVisualChildProperty,
         bool GenerateImplementation,
@@ -163,6 +164,7 @@ public static BindablePropertyResult TryCreate(GeneratorAttributeSyntaxContext c
                 SymbolDisplayFormat.FullyQualifiedFormat.MiscellaneousOptions | SymbolDisplayMiscellaneousOptions.IncludeNullableReferenceTypeModifier);
 
             var propertyTypeFullyQualified = propertySymbol.Type.ToDisplayString(typeFormat);
+            var isDelegateProperty = propertySymbol.Type.TypeKind == TypeKind.Delegate;
             var isVisualChildProperty = ComputeIsVisualChildProperty(context.SemanticModel.Compilation, containingType, propertySymbol.Type);
             var isVisual = InheritsFromVisual(context.SemanticModel.Compilation, containingType);
 
@@ -182,6 +184,7 @@ public static BindablePropertyResult TryCreate(GeneratorAttributeSyntaxContext c
                 ContainingTypeDisplayName: containingTypeDisplayName,
                 PropertyName: propertyName,
                 PropertyTypeFullyQualified: propertyTypeFullyQualified,
+                IsDelegateProperty: isDelegateProperty,
                 IsParentVisual: isVisual,
                 IsVisualChildProperty: isVisualChildProperty,
                 GenerateImplementation: generateImplementation,
@@ -518,43 +521,49 @@ private static string GenerateFluentExtensionsSource(INamedTypeSymbol containing
 
                 if (p.IsParentVisual)
                 {
-                    sb.Append(methodIndent).AppendLine("/// <summary>");
-                    sb.Append(methodIndent).Append("/// Registers a dynamic update that assigns <see cref=\"").Append(receiverTypeXml).Append('.').Append(EscapeIdentifier(propName)).AppendLine("\"/> from a computed value and returns the same instance.");
-                    sb.Append(methodIndent).AppendLine("/// </summary>");
-                    sb.Append(methodIndent).AppendLine("/// <remarks>");
-                    sb.Append(methodIndent).AppendLine("/// The delegate is evaluated during the dynamic update pass; accessed bindings are tracked so only affected visuals are refreshed.");
-                    sb.Append(methodIndent).AppendLine("/// </remarks>");
-                    sb.Append(methodIndent).AppendLine("/// <param name=\"obj\">The instance to configure.</param>");
-                    sb.Append(methodIndent).Append("/// <param name=\"").Append(EscapeIdentifier(argName)).AppendLine("\">A delegate that computes the current value.</param>");
-                    sb.Append(methodIndent).AppendLine("/// <returns>The same instance for chaining.</returns>");
-                    sb.Append(methodIndent).AppendLine("[global::System.CodeDom.Compiler.GeneratedCode(\"XenoAtom.Terminal.UI.SourceGen\", \"0.1.0\")]");
-                    if (canUseGeneric)
-                    {
-                        sb.Append(methodIndent).Append("public static T ").Append(EscapeIdentifier(propName)).Append("<T>(this T obj, global::System.Func<").Append(argType).Append("> ").Append(EscapeIdentifier(argName))
-                            .Append(") where T : ").Append(receiverType).AppendLine();
-                        sb.Append(methodIndent).Append("    => global::XenoAtom.Terminal.UI.VisualExtensions.Update(obj, x => x.").Append(EscapeIdentifier(propName)).Append(" = ").Append(EscapeIdentifier(argName)).AppendLine("());");
-                    }
-                    else
+                    // If the property itself is a delegate (e.g. Func<...>), avoid generating an overload taking
+                    // Func<PropertyType>. It would compete with the natural "set the delegate" overload and complicate
+                    // method resolution for lambdas.
+                    if (!p.IsDelegateProperty)
                     {
-                        sb.Append(methodIndent).Append("public static ").Append(receiverType).Append(' ').Append(EscapeIdentifier(propName));
-                        if (needsTypeParameters)
-                        {
-                            AppendTypeParameters(sb, containingType);
-                        }
-                        sb.Append("(this ").Append(receiverType).Append(" obj, global::System.Func<").Append(argType)
-                            .Append("> ").Append(EscapeIdentifier(argName)).Append(')');
-                        if (needsTypeParameters)
+                        sb.Append(methodIndent).AppendLine("/// <summary>");
+                        sb.Append(methodIndent).Append("/// Registers a dynamic update that assigns <see cref=\"").Append(receiverTypeXml).Append('.').Append(EscapeIdentifier(propName)).AppendLine("\"/> from a computed value and returns the same instance.");
+                        sb.Append(methodIndent).AppendLine("/// </summary>");
+                        sb.Append(methodIndent).AppendLine("/// <remarks>");
+                        sb.Append(methodIndent).AppendLine("/// The delegate is evaluated during the dynamic update pass; accessed bindings are tracked so only affected visuals are refreshed.");
+                        sb.Append(methodIndent).AppendLine("/// </remarks>");
+                        sb.Append(methodIndent).AppendLine("/// <param name=\"obj\">The instance to configure.</param>");
+                        sb.Append(methodIndent).Append("/// <param name=\"").Append(EscapeIdentifier(argName)).AppendLine("\">A delegate that computes the current value.</param>");
+                        sb.Append(methodIndent).AppendLine("/// <returns>The same instance for chaining.</returns>");
+                        sb.Append(methodIndent).AppendLine("[global::System.CodeDom.Compiler.GeneratedCode(\"XenoAtom.Terminal.UI.SourceGen\", \"0.1.0\")]");
+                        if (canUseGeneric)
                         {
-                            AppendTypeParameterConstraints(sb, containingType, methodIndent);
+                            sb.Append(methodIndent).Append("public static T ").Append(EscapeIdentifier(propName)).Append("<T>(this T obj, global::System.Func<").Append(argType).Append("> ").Append(EscapeIdentifier(argName))
+                                .Append(") where T : ").Append(receiverType).AppendLine();
+                            sb.Append(methodIndent).Append("    => global::XenoAtom.Terminal.UI.VisualExtensions.Update(obj, x => x.").Append(EscapeIdentifier(propName)).Append(" = ").Append(EscapeIdentifier(argName)).AppendLine("());");
                         }
                         else
                         {
-                            sb.AppendLine();
+                            sb.Append(methodIndent).Append("public static ").Append(receiverType).Append(' ').Append(EscapeIdentifier(propName));
+                            if (needsTypeParameters)
+                            {
+                                AppendTypeParameters(sb, containingType);
+                            }
+                            sb.Append("(this ").Append(receiverType).Append(" obj, global::System.Func<").Append(argType)
+                                .Append("> ").Append(EscapeIdentifier(argName)).Append(')');
+                            if (needsTypeParameters)
+                            {
+                                AppendTypeParameterConstraints(sb, containingType, methodIndent);
+                            }
+                            else
+                            {
+                                sb.AppendLine();
+                            }
+                            sb.Append(methodIndent).Append("    => global::XenoAtom.Terminal.UI.VisualExtensions.Update(obj, x => x.").Append(EscapeIdentifier(propName)).Append(" = ").Append(EscapeIdentifier(argName)).AppendLine("());");
                         }
-                        sb.Append(methodIndent).Append("    => global::XenoAtom.Terminal.UI.VisualExtensions.Update(obj, x => x.").Append(EscapeIdentifier(propName)).Append(" = ").Append(EscapeIdentifier(argName)).AppendLine("());");
-                    }
 
-                    sb.AppendLine();
+                        sb.AppendLine();
+                    }
 
                     sb.Append(methodIndent).AppendLine("/// <summary>");
                     sb.Append(methodIndent).Append("/// Configures <see cref=\"").Append(receiverTypeXml).Append('.').Append(EscapeIdentifier(propName)).AppendLine("\"/> from a <see cref=\"global::XenoAtom.Terminal.UI.State{T}\"/> and returns the same instance.");

src/XenoAtom.Terminal.UI.Tests/NumberBoxInputTests.cs

@@ -0,0 +1,82 @@
+// Copyright (c) Alexandre Mutel. All rights reserved.
+// Licensed under the BSD-Clause 2 license.
+// See license.txt file in the project root for full license information.
+
+using XenoAtom.Terminal;
+using XenoAtom.Terminal.UI.Controls;
+using XenoAtom.Terminal.UI.Hosting;
+
+namespace XenoAtom.Terminal.UI.Tests;
+
+[TestClass]
+public sealed class NumberBoxInputTests
+{
+    [TestMethod]
+    public void NumberBox_Updates_Bound_State_When_Typing_Valid_Number()
+    {
+        var state = new State<int>(8080);
+        var numberBox = new NumberBox<int>().Value(state);
+        var root = new VStack { numberBox };
+
+        using var driver = new TerminalAppTestDriver(root, TerminalHostKind.Fullscreen, new TerminalSize(40, 6));
+        driver.Tick();
+
+        driver.App.Focus(numberBox);
+        driver.Backend.PushEvent(new TerminalKeyEvent { Key = TerminalKey.Unknown, Char = TerminalChar.CtrlA, Modifiers = TerminalModifiers.Ctrl });
+        driver.Backend.PushEvent(new TerminalTextEvent { Text = "42" });
+
+        driver.TickUntil(() => state.Value == 42);
+        Assert.AreEqual(42, state.Value);
+    }
+
+    [TestMethod]
+    public void NumberBox_DoesNot_Update_Value_When_Text_Is_Not_A_Number()
+    {
+        var state = new State<int>(10);
+        var numberBox = new NumberBox<int>()
+            .Value(state)
+            .InvalidNumberMessage("Not a number");
+        var root = new VStack { numberBox };
+
+        using var driver = new TerminalAppTestDriver(root, TerminalHostKind.Fullscreen, new TerminalSize(40, 6));
+        driver.Tick();
+
+        driver.App.Focus(numberBox);
+        driver.Backend.PushEvent(new TerminalKeyEvent { Key = TerminalKey.Unknown, Char = TerminalChar.CtrlA, Modifiers = TerminalModifiers.Ctrl });
+        driver.Backend.PushEvent(new TerminalTextEvent { Text = "abc" });
+
+        driver.TickUntil(() => numberBox.Text == "abc");
+        Assert.AreEqual(10, state.Value);
+
+        var screen = new AnsiTestScreen(40, 6);
+        screen.Apply(driver.Backend.GetOutText());
+        var rendered = screen.GetText();
+        StringAssert.Contains(rendered, "Not a number");
+    }
+
+    [TestMethod]
+    public void NumberBox_Uses_Custom_Value_Validator_Message()
+    {
+        var state = new State<int>(5);
+        var numberBox = new NumberBox<int>
+        {
+            ValueValidator = v => v is >= 0 and <= 9 ? null : "Must be a single digit",
+        }.Value(state);
+        var root = new VStack { numberBox };
+
+        using var driver = new TerminalAppTestDriver(root, TerminalHostKind.Fullscreen, new TerminalSize(40, 6));
+        driver.Tick();
+
+        driver.App.Focus(numberBox);
+        driver.Backend.PushEvent(new TerminalKeyEvent { Key = TerminalKey.Unknown, Char = TerminalChar.CtrlA, Modifiers = TerminalModifiers.Ctrl });
+        driver.Backend.PushEvent(new TerminalTextEvent { Text = "12" });
+
+        driver.TickUntil(() => numberBox.Text == "12");
+        Assert.AreEqual(5, state.Value, "Invalid input should not update the bound state.");
+
+        var screen = new AnsiTestScreen(40, 6);
+        screen.Apply(driver.Backend.GetOutText());
+        var rendered = screen.GetText();
+        StringAssert.Contains(rendered, "Must be a single digit");
+    }
+}