Merge branch 'main' into marquee

Author: Avid29

labs/MarqueeText/samples/MarqueeText.Samples/MarqueeText.md

@@ -12,7 +12,9 @@ subcategory: StatusAndInfo
 # MarqueeText
 
 For more information about this experiment see:
+
 - Discussion: https://github.com/CommunityToolkit/Labs-Windows/discussions/231
+
 - Issue: TODO: PASTE LINK HERE
 
 The MarqueeText control allows text to scroll in a marquee fashion. The control is heavily templated and many changes can be made by modifying the style.

labs/MarqueeText/src/MarqueeBehavior.cs

@@ -22,8 +22,10 @@ public enum MarqueeBehavior
     /// </remarks>
     Looping,
 
+#if !HAS_UNO
     /// <summary>
     /// The text bounces back and forth across the screen.
     /// </summary>
     Bouncing,
+#endif
 }

labs/MarqueeText/src/MarqueeText.Events.cs

@@ -33,21 +33,24 @@ private void MarqueeText_Unloaded(object sender, RoutedEventArgs e)
             _marqueeContainer.SizeChanged -= Container_SizeChanged;
         }
 
-        if (this._marqueeStoryboard is not null)
+        if (_marqueeStoryboard is not null)
         {
-            this._marqueeStoryboard.Completed -= StoryBoard_Completed;
+            _marqueeStoryboard.Completed -= StoryBoard_Completed;
         }
     }
 
     private void Container_SizeChanged(object sender, SizeChangedEventArgs e)
     {
         if (_marqueeContainer is not null)
         {
-            RectangleGeometry clip = new RectangleGeometry();
-            clip.Rect = new Rect(0, 0, e.NewSize.Width, e.NewSize.Height);
-            _marqueeContainer.Clip = clip;
+            // Clip the marquee within its bounds
+            _marqueeContainer.Clip = new RectangleGeometry
+            {
+                Rect = new Rect(0, 0, e.NewSize.Width, e.NewSize.Height)
+            };
         }
 
+        // The marquee should run when the size changes in case the text gets cutoff
         StartMarquee();
     }
 

labs/MarqueeText/src/MarqueeText.Properties.cs

@@ -69,23 +69,27 @@ public MarqueeBehavior Behavior
 
     private bool IsLooping => Behavior == MarqueeBehavior.Looping;
 
+#if !HAS_UNO
     private bool IsBouncing => Behavior == MarqueeBehavior.Bouncing;
+#else
+    private bool IsBouncing => false;
+#endif
 
     /// <summary>
     /// Gets or sets a value indicating whether or not the marquee text wraps.
     /// </summary>
     /// <remarks>
-    /// Wrappping text won't scroll if the text can already fit in the screen.
+    /// Wrapping text won't scroll if the text can already fit in the screen.
     /// </remarks>
     public MarqueeDirection Direction
     {
         get => (MarqueeDirection)GetValue(DirectionProperty);
         set => SetValue(DirectionProperty, value);
     }
 
-    private bool IsDirectionHorizontal => Direction == MarqueeDirection.Left || Direction == MarqueeDirection.Right;
+    private bool IsDirectionHorizontal => Direction is MarqueeDirection.Left or MarqueeDirection.Right;
 
-    private bool IsDirectionInverse => Direction == MarqueeDirection.Up || Direction == MarqueeDirection.Right;
+    private bool IsDirectionInverse => Direction is MarqueeDirection.Up or MarqueeDirection.Right;
 
     /// <summary>
     /// Gets or sets a value that indicates what decorations are applied to the text.
@@ -125,8 +129,8 @@ private static void DirectionPropertyChanged(DependencyObject d, DependencyPrope
         bool active = control._isActive;
         var oldDirection = (MarqueeDirection)e.OldValue;
         var newDirection = (MarqueeDirection)e.NewValue;
-        bool oldAxisX = oldDirection == MarqueeDirection.Left || oldDirection == MarqueeDirection.Right;
-        bool newAxisX = newDirection == MarqueeDirection.Left || newDirection == MarqueeDirection.Right;
+        bool oldAxisX = oldDirection is MarqueeDirection.Left or MarqueeDirection.Right;
+        bool newAxisX = newDirection is MarqueeDirection.Left or MarqueeDirection.Right;
 
         VisualStateManager.GoToState(control, GetVisualStateName(newDirection), true);
 

labs/MarqueeText/src/MarqueeText.cs

@@ -93,7 +93,9 @@ private static string GetVisualStateName(MarqueeBehavior behavior)
         {
             MarqueeBehavior.Ticker => TickerVisualStateName,
             MarqueeBehavior.Looping => LoopingVisualStateName,
+#if !HAS_UNO
             MarqueeBehavior.Bouncing => BouncingVisualStateName,
+#endif
             _ => TickerVisualStateName,
         };
     }
@@ -134,6 +136,10 @@ private void StopMarquee(bool stopping)
         }
     }
 
+    /// <summary>
+    /// Updates the animation to match the current control state.
+    /// </summary>
+    /// <param name="resume">True if animation should resume from its current position, false if it should restart.</param>
     /// <returns>True if the Animation is now playing</returns>
     private bool UpdateAnimation(bool resume = true)
     {
@@ -171,22 +177,30 @@ _segment1 is null ||
         {
             containerSize = _marqueeContainer.ActualHeight;
             segmentSize = _segment1.ActualHeight;
-            value = this._marqueeTransform.Y;
+            value = _marqueeTransform.Y;
             property = "(TranslateTransform.Y)";
         }
 
         if (IsLooping && segmentSize < containerSize)
         {
+            // If the text segment is smaller than the area provided,
+            // it does not need to run in looping mode.
             StopMarquee(resume);
             _segment2.Visibility = Visibility.Collapsed;
             return false;
         }
 
-        double start = IsLooping || IsBouncing ? 0 : containerSize;
+        // The start position is offset 100% if ticker
+        // Otherwise it's 0
+        double start = IsTicker ? containerSize : 0;
+        // The end is when the end of the text reaches the border if bounding
+        // Otherwise it is when the first set of text is 100% out of view
         double end = IsBouncing ? containerSize - segmentSize : -segmentSize;
+
+        // The distance is used for calculating the duration and the progress if resuming
         double distance = Math.Abs(start - end);
 
-        if (distance == 0)
+        if (distance is 0)
         {
             return false;
         }
@@ -197,29 +211,34 @@ _segment1 is null ||
             (start, end) = (end, start);
         }
 
+        // The second segment of text should be hidden if the marquee is not in looping mode.
         _segment2.Visibility = IsLooping ? Visibility.Visible : Visibility.Collapsed;
 
         TimeSpan duration = TimeSpan.FromSeconds(distance / Speed);
 
-        if (this._marqueeStoryboard is not null)
+        if (_marqueeStoryboard is not null)
         {
-            this._marqueeStoryboard.Completed -= StoryBoard_Completed;
+            _marqueeStoryboard.Completed -= StoryBoard_Completed;
         }
 
-        this._marqueeStoryboard = new Storyboard()
+        _marqueeStoryboard = new Storyboard()
         {
             Duration = duration,
             RepeatBehavior = RepeatBehavior,
+#if !HAS_UNO
             AutoReverse = IsBouncing,
+#endif
         };
 
-        this._marqueeStoryboard.Completed += StoryBoard_Completed;
+        _marqueeStoryboard.Completed += StoryBoard_Completed;
 
         var animation = new DoubleAnimationUsingKeyFrames
         {
             Duration = duration,
             RepeatBehavior = RepeatBehavior,
+#if !HAS_UNO
             AutoReverse = IsBouncing,
+#endif
         };
         var frame1 = new DiscreteDoubleKeyFrame
         {
@@ -234,17 +253,18 @@ _segment1 is null ||
 
         animation.KeyFrames.Add(frame1);
         animation.KeyFrames.Add(frame2);
-        this._marqueeStoryboard.Children.Add(animation);
-        Storyboard.SetTarget(animation, this._marqueeTransform);
+        _marqueeStoryboard.Children.Add(animation);
+        Storyboard.SetTarget(animation, _marqueeTransform);
         Storyboard.SetTargetProperty(animation, property);
 
         VisualStateManager.GoToState(this, MarqueeActiveState, true);
-        this._marqueeStoryboard.Begin();
+        _marqueeStoryboard.Begin();
 
         if (resume)
         {
+            // Seek the animation so the text is in the same position.
             double progress = Math.Abs(start - value) / distance;
-            this._marqueeStoryboard.Seek(TimeSpan.FromTicks((long)(duration.Ticks * progress)));
+            _marqueeStoryboard.Seek(TimeSpan.FromTicks((long)(duration.Ticks * progress)));
         }
 
         return true;