Merge pull request #4786 from michael-hawker/llama/tokenizingtextbox-…

…fix4749 Fix Text initialization and updating for TokenizingTextBox
CommunityToolkit · Oct 18, 2022 · 2233ac6 · 2233ac6
2 parents 5d90149 + cd1afd0
commit 2233ac6
Show file tree

Hide file tree

Showing 11 changed files with 376 additions and 82 deletions.
diff --git a/Microsoft.Toolkit.Uwp.UI.Controls.Input/TokenizingTextBox/TokenizingTextBox.Properties.cs b/Microsoft.Toolkit.Uwp.UI.Controls.Input/TokenizingTextBox/TokenizingTextBox.Properties.cs
@@ -109,6 +109,10 @@ private static void TextPropertyChanged(DependencyObject d, DependencyPropertyCh
             if (d is TokenizingTextBox ttb && ttb._currentTextEdit != null)
             {
                 ttb._currentTextEdit.Text = e.NewValue as string;
+
+                // Notify inner container of text change, see issue #4749
+                var item = ttb.ContainerFromItem(ttb._currentTextEdit) as TokenizingTextBoxItem;
+                item?.UpdateText(ttb._currentTextEdit.Text);
             }
         }
 

diff --git a/Microsoft.Toolkit.Uwp.UI.Controls.Input/TokenizingTextBox/TokenizingTextBox.cs b/Microsoft.Toolkit.Uwp.UI.Controls.Input/TokenizingTextBox/TokenizingTextBox.cs
@@ -89,7 +89,8 @@ private void ItemsSource_PropertyChanged(DependencyObject sender, DependencyProp
                     }
                 }
 
-                _currentTextEdit = _lastTextEdit = new PretokenStringContainer(true);
+                // Add our text box at the end of items and set its default value to our initial text, fix for #4749
+                _currentTextEdit = _lastTextEdit = new PretokenStringContainer(true) { Text = Text };
                 _innerItemsSource.Insert(_innerItemsSource.Count, _currentTextEdit);
                 ItemsSource = _innerItemsSource;
             }

diff --git a/...t.Toolkit.Uwp.UI.Controls.Input/TokenizingTextBox/TokenizingTextBoxItem.AutoSuggestBox.cs b/...t.Toolkit.Uwp.UI.Controls.Input/TokenizingTextBox/TokenizingTextBoxItem.AutoSuggestBox.cs
@@ -2,6 +2,7 @@
 // The .NET Foundation licenses this file to you under the MIT license.
 // See the LICENSE file in the project root for more information.
 
+using System.Collections.Generic;
 using Windows.Foundation;
 using Windows.System;
 using Windows.UI;
@@ -100,29 +101,36 @@ private void OnApplyTemplateAutoSuggestBox(AutoSuggestBox auto)
                 _autoSuggestBox.LostFocus += AutoSuggestBox_LostFocus;
 
                 // Setup a binding to the QueryIcon of the Parent if we're the last box.
-                if (Content is ITokenStringContainer str && str.IsLast)
+                if (Content is ITokenStringContainer str)
                 {
-                    // Workaround for https://github.com/microsoft/microsoft-ui-xaml/issues/2568
-                    if (Owner.QueryIcon is FontIconSource fis &&
-                        fis.ReadLocalValue(FontIconSource.FontSizeProperty) == DependencyProperty.UnsetValue)
-                    {
-                        // This can be expensive, could we optimize?
-                        // Also, this is changing the FontSize on the IconSource (which could be shared?)
-                        fis.FontSize = Owner.TryFindResource("TokenizingTextBoxIconFontSize") as double? ?? 16;
-                    }
+                    // We need to set our initial text in all cases.
+                    _autoSuggestBox.Text = str.Text;
 
-                    var iconBinding = new Binding()
+                    // We only set/bind some properties on the last textbox to mimic the autosuggestbox look
+                    if (str.IsLast)
                     {
-                        Source = Owner,
-                        Path = new PropertyPath(nameof(Owner.QueryIcon)),
-                        RelativeSource = new RelativeSource() { Mode = RelativeSourceMode.TemplatedParent }
-                    };
+                        // Workaround for https://github.com/microsoft/microsoft-ui-xaml/issues/2568
+                        if (Owner.QueryIcon is FontIconSource fis &&
+                            fis.ReadLocalValue(FontIconSource.FontSizeProperty) == DependencyProperty.UnsetValue)
+                        {
+                            // This can be expensive, could we optimize?
+                            // Also, this is changing the FontSize on the IconSource (which could be shared?)
+                            fis.FontSize = Owner.TryFindResource("TokenizingTextBoxIconFontSize") as double? ?? 16;
+                        }
 
-                    var iconSourceElement = new IconSourceElement();
+                        var iconBinding = new Binding()
+                        {
+                            Source = Owner,
+                            Path = new PropertyPath(nameof(Owner.QueryIcon)),
+                            RelativeSource = new RelativeSource() { Mode = RelativeSourceMode.TemplatedParent }
+                        };
+
+                        var iconSourceElement = new IconSourceElement();
 
-                    iconSourceElement.SetBinding(IconSourceElement.IconSourceProperty, iconBinding);
+                        iconSourceElement.SetBinding(IconSourceElement.IconSourceProperty, iconBinding);
 
-                    _autoSuggestBox.QueryIcon = iconSourceElement;
+                        _autoSuggestBox.QueryIcon = iconSourceElement;
+                    }
                 }
             }
         }
@@ -156,11 +164,35 @@ private void AutoSuggestBox_SuggestionChosen(AutoSuggestBox sender, AutoSuggestB
             Owner.RaiseSuggestionChosen(sender, args);
         }
 
-        private void AutoSuggestBox_TextChanged(AutoSuggestBox sender, AutoSuggestBoxTextChangedEventArgs args)
+        // Called to update text by link:TokenizingTextBox.Properties.cs:TextPropertyChanged
+        internal void UpdateText(string text)
         {
-            var t = sender.Text.Trim();
+            if (_autoSuggestBox != null)
+            {
+                _autoSuggestBox.Text = text;
+            }
+            else
+            {
+                void WaitForLoad(object s, RoutedEventArgs eargs)
+                {
+                    if (_autoSuggestTextBox != null)
+                    {
+                        _autoSuggestTextBox.Text = text;
+                    }
 
-            Owner.Text = sender.Text; // Update parent text property
+                    AutoSuggestTextBoxLoaded -= WaitForLoad;
+                }
+
+                AutoSuggestTextBoxLoaded += WaitForLoad;
+            }
+        }
+
+        private void AutoSuggestBox_TextChanged(AutoSuggestBox sender, AutoSuggestBoxTextChangedEventArgs args)
+        {
+            if (!EqualityComparer<string>.Default.Equals(sender.Text, Owner.Text))
+            {
+                Owner.Text = sender.Text; // Update parent text property, if different
+            }
 
             // Override our programmatic manipulation as we're redirecting input for the user
             if (UseCharacterAsUser)
@@ -172,6 +204,8 @@ private void AutoSuggestBox_TextChanged(AutoSuggestBox sender, AutoSuggestBoxTex
 
             Owner.RaiseTextChanged(sender, args);
 
+            var t = sender.Text?.Trim() ?? string.Empty;
+
             // Look for Token Delimiters to create new tokens when text changes.
             if (!string.IsNullOrEmpty(Owner.TokenDelimiter) && t.Contains(Owner.TokenDelimiter))
             {
@@ -195,7 +229,7 @@ private void AutoSuggestBox_TextChanged(AutoSuggestBox sender, AutoSuggestBoxTex
                 }
                 else
                 {
-                    sender.Text = tokens[tokens.Length - 1];
+                    sender.Text = tokens[tokens.Length - 1].Trim();
                 }
             }
         }

diff --git a/...Toolkit.Uwp.UI.Controls.Input/TokenizingTextBox/TokenizingTextBoxItem.AutoSuggestBox.xaml b/...Toolkit.Uwp.UI.Controls.Input/TokenizingTextBox/TokenizingTextBoxItem.AutoSuggestBox.xaml
@@ -314,7 +314,6 @@
                                     ItemsSource="{Binding Path=Owner.SuggestedItemsSource, RelativeSource={RelativeSource Mode=TemplatedParent}}"
                                     PlaceholderText="{Binding Path=Owner.PlaceholderText, RelativeSource={RelativeSource Mode=TemplatedParent}}"
                                     Style="{StaticResource SystemAutoSuggestBoxStyle}"
-                                    Text="{Binding Text, Mode=TwoWay}"
                                     TextBoxStyle="{StaticResource TokenizingTextBoxTextBoxStyle}"/>
                 </ControlTemplate>
             </Setter.Value>

diff --git a/UITests/UITests.Tests.MSTest/UITests.Tests.MSTest.csproj b/UITests/UITests.Tests.MSTest/UITests.Tests.MSTest.csproj
@@ -16,7 +16,7 @@
     <PackageReference Include="Microsoft.Toolkit" Version="7.1.2" />
     <PackageReference Include="MSTest.TestAdapter" Version="2.1.2" />
     <PackageReference Include="MSTest.TestFramework" Version="2.1.2" />
-    <PackageReference Include="Microsoft.NET.Test.Sdk" Version="16.10.0" />
+    <PackageReference Include="Microsoft.NET.Test.Sdk" Version="16.11.0" />
     <!-- Microsoft.UI.Xaml MSTest Extension -->
     <PackageReference Include="MUXTestInfra.MSTest" Version="0.0.4" />
     <!-- System packages -->

diff --git a/UnitTests/UnitTests.Notifications.NetCore/UnitTests.Notifications.NetCore.csproj b/UnitTests/UnitTests.Notifications.NetCore/UnitTests.Notifications.NetCore.csproj
@@ -11,7 +11,7 @@
   <ItemGroup>
     <PackageReference Include="MSTest.TestAdapter" Version="2.1.2" />
     <PackageReference Include="MSTest.TestFramework" Version="2.1.2" />
-    <PackageReference Include="Microsoft.NET.Test.Sdk" Version="16.10.0" />
+    <PackageReference Include="Microsoft.NET.Test.Sdk" Version="16.11.0" />
   </ItemGroup>
 
   <Import Project="..\UnitTests.Notifications.Shared\UnitTests.Notifications.Shared.projitems" Label="Shared" />

diff --git a/UnitTests/UnitTests.Notifications.UWP/UnitTests.Notifications.UWP.csproj b/UnitTests/UnitTests.Notifications.UWP/UnitTests.Notifications.UWP.csproj
@@ -122,7 +122,7 @@
     <PackageReference Include="MSTest.TestFramework">
       <Version>2.1.2</Version>
     </PackageReference>
-    <PackageReference Include="Microsoft.NET.Test.Sdk" Version="16.10.0" />
+    <PackageReference Include="Microsoft.NET.Test.Sdk" Version="16.11.0" />
     <PackageReference Include="System.ValueTuple">
       <Version>4.5.0</Version>
     </PackageReference>