Feed Reader
The Feed Reader engine displays stories from an RSS feed. It shows the feed title and date, then cycles through each story as its content scrolls up the screen.
Pass the feed URL directly when you do not need to customize the display:
feed-reader: https://example.com/news.xmlUse the expanded form to change the title, appearance, refresh timing, or scrolling:
feed-reader: src: https://example.com/news.xml title: Local News refreshInterval: 300 scrollSpeed: 24 scrollDelay: 8 textColor: "#ffff00" backgroundImage: /content/images/news-background.pngProperties
Section titled “Properties”src shorthand required
Section titled “src ”Type: string
Description: URL of the RSS or Atom feed to display. This can be an absolute URL or a path served by the same TVS instance.
Type: string
Default: News
Description: Heading shown at the top of the Feed Reader. This is separate from the title supplied by the feed, which appears beneath it.
backgroundImage
Section titled “backgroundImage”Type: string | boolean
Default: built-in background
Description: URL of a background image to display behind the feed. Set this to false to remove the built-in background image. When omitted, TVS uses its default Feed Reader background.
textColor
Section titled “textColor”Type: CSS color
Default: white
Description: Color used for the Feed Reader text. Accepts CSS color values such as yellow, #ffff00, or rgb(255 255 0).
refreshInterval
Section titled “refreshInterval”Type: number
Description: Number of seconds between feed refreshes. When omitted, TVS loads the feed when the engine starts but does not refresh it automatically.
scrollSpeed
Section titled “scrollSpeed”Type: number
Default: 30
Description: Speed at which story content scrolls vertically, in pixels per second.
scrollDelay
Section titled “scrollDelay”Type: number
Default: 5
Description: Number of seconds to wait before a story begins scrolling. After the story reaches the end, the Feed Reader advances to the next item in the feed.