The following FlexGrid apps each reside in a standalone Roku project with its own src/, pkg/, and roku-config.ts. The apps are under examples/flex-grid/.

AppDirectoryPurpose
Showcaseshowcase/Interactive sandbox (strategy toggles, performance overlay, shared pool)
Cowboy TVcowboy-tv/App-style chrome with a poster grid and CDN artwork
Fantasy TVfantasy-tv/Heterogeneous grid with tabs, S3 JSON data, and CDN artwork
Plain Gridplain-grid/N by M collection grid stub that builds against the @roku-sdk/flex-grid 2.x maintenance line
Hello Worldhelloworld/A minimal declarative grid (10×20 cells with a focus-highlight plugin)

Running the default Showcase FlexGrid app

To run the FlexGrid apps, follow these steps:

  1. From the repository root, install the dependencies:

    pnpm install
  2. Launch the default Showcase app:

    cd examples/flex-grid
    pnpm start-dev

The start-dev script runs rk dev --config showcase/roku-config.ts; therefore, rk resolves the Showcase app's src/, pkg/, and assets.

Running the other FlexGrid apps

To launch the other apps from examples/flex-grid, run their scripts:

pnpm start-dev:cowboy-tv
pnpm start-dev:fantasy-tv
pnpm start-dev:plain-grid
pnpm start-dev:helloworld

You can also run any of the FlexGrid apps directly from its directory:

cd showcase && npx rk dev --device <ROKU_IP>
cd cowboy-tv && npx rk dev --device <ROKU_IP>
cd fantasy-tv && npx rk dev --device <ROKU_IP>

Tests

You can run the tests for each app and for the package with the following commands, starting from examples/flex-grid:

cd showcase && pnpm test
cd cowboy-tv && pnpm test
cd fantasy-tv && pnpm test
cd ../../packages/flex-grid && pnpm test

For more information

These resources provide more information:


Did this page help you?