Runtime showcase example

An interactive catalog of the runtime APIs exported from @roku-sdk/rsg-ts/runtime.

Purpose

This app lets you browse and try each runtime API and hook. A LabelList lists the APIs; focusing an item shows its documentation (import and usage) in a side panel, and selecting an item opens an interactive showcase for that API. Back returns to the list.

APIs showcased

The app demonstrates these APIs:

crypto, getFontMeasure, useFileSystem, getAppInfo, getAppMemoryMonitor / useAppMemoryMonitor, useCec, getDeviceInfo, useDeviceInfoEvents, useInput, useLaunchConfig, getRegistry, logger, getSignalBeacon, useUiResolution, getAudioGuide, getTextToSpeech, getPerfetto.

Each API has a self-contained demo in src/components/showcases/.

Controls

You can use these keys to navigate the app:

• Up and Down: Browse the API list (the side panel shows the documentation)
• OK: Open the interactive showcase for the selected API
• Back: Return to the list

Development

You can use these commands to build, test, and lint the app:

npx rk dev          # Build + deploy to Roku device
pnpm test           # Run tests
pnpm run lint       # Lint sources