docs(Marquee): added resetMarquee and toggleMarquee descriptions to M…

…etadataBase and TextBox
rdkcentral · Nov 21, 2023 · 17e2966 · 17e2966
1 parent d2c29dd
commit 17e2966
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 0 deletions.
diff --git a/packages/@lightningjs/ui-components/src/components/MetadataBase/MetadataBase.mdx b/packages/@lightningjs/ui-components/src/components/MetadataBase/MetadataBase.mdx
@@ -96,3 +96,9 @@ class Example extends lng.Component {
 | logoPadding          | number           | spacing between logo and secondLine                             |
 | logoWidth            | number           | width for logo                                                  |
 | titleTextStyle       | string \| object | text style for title                                            |
+
+### Methods
+
+#### resetMarquee(): void
+
+This will call [TextBox](?path=/docs/components-textbox--docs)'s `toggleMarquee` method in order to restart or stop marquee scrolling if the marquee flag has changed.
diff --git a/packages/@lightningjs/ui-components/src/components/TextBox/TextBox.mdx b/packages/@lightningjs/ui-components/src/components/TextBox/TextBox.mdx
@@ -76,3 +76,9 @@ TextBox also supports rendering as an InlineContent component. See [InlineConten
 | offsetX   | number           | Used to ensure text is positioned correctly                                                                                                                                                                                                             |
 | offsetY   | number           | Used to ensure text is positioned correctly                                                                                                                                                                                                             |
 | textStyle | string \| object | Default style of text to be displayed. Object should come from the current theme or contain any properties that the [Lightning text texture supports](https://lightningjs.io/docs/#/lightning-core-reference/RenderEngine/Textures/Text?id=properties). |
+
+### Methods
+
+#### toggleMarquee(): void
+
+This will restart or stop marquee scrolling to match the marquee flag in case it has changed.