Skip to content

Commit 2282efc

Browse files
committed
Updated MarqueeText markdown docs
1 parent fb28b40 commit 2282efc

File tree

1 file changed

+26
-4
lines changed

1 file changed

+26
-4
lines changed

components/MarqueeText/samples/MarqueeText.md

Lines changed: 26 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -13,12 +13,34 @@ issue-id: 0
1313

1414
# MarqueeText
1515

16-
For more information about this experiment see:
16+
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. The control can also be adjusted using the Speed, Behavior, RepeatBehavior, and Direction properties.
1717

18-
- Discussion: https://github.com/CommunityToolkit/Labs-Windows/discussions/231
18+
##Speed
1919

20-
- Issue: TODO: PASTE LINK HERE
20+
The speed property determines how quickly the text moves in pixels per second. The speed can be adjusted mid-animation and handled continously.
2121

22-
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.
22+
##Behavior
23+
24+
The MarqueeText control has 3 behaviors
25+
26+
###Ticker
27+
28+
Ticker mode starts with all text off the screen then scrolls the text across across the screen. When the animation finishes in the mode no text will be on screen.
29+
30+
###Looping
31+
32+
Looping mode will begin with the start of the text fully in frame then scroll towards the end. When the end is reached it will loop back to the start of the text. Nothing will happen if the text fits in frame.
33+
34+
###Bouncing
35+
36+
Looping mode will begin with the start of the text fully in frame then scroll towards the end. When the end is reached it will bounce and scroll backwards to the start of the text. Nothing will happen if the text fits in frame.
37+
38+
##RepeatBehavior
39+
40+
The repeat behavior determines how many times the marquee will loop before the animation finishes. It can be a number of iteration, a duration, or forever.
41+
42+
##Direction
43+
44+
The default direction is left, meaning the text will move leftwards, but this can be changed to right, up, or down. Direction changed between left and right or up and down are handled continously, meaning that the animation will resume from its current position if changed between these directions.
2345

2446
> [!Sample MarqueeTextSample]

0 commit comments

Comments
 (0)