OpenParable
Skip to content
← Back to skills

Rezi Create Screen

Development
rezi-create-screen

Rezi Create Screen is an Agent Skill for development published in the RtlZeroMemory/Rezi repository on GitHub: a SKILL.md instruction file an AI agent can load to do this task.

Create a new screen/page for a Rezi TUI application. Use when adding views, pages, or screens to an app.

View on GitHub ↗
QUICK START

How to use this skill

Bring this guide into your coding agent with a prompt tailored to the tool you use.

  1. Open your project in Codex.
  2. Copy and paste the prompt below.
  3. Review files and risks before approving any action.
Prompt to paste
Inspect the Agent Skill at https://github.com/RtlZeroMemory/Rezi/blob/HEAD/.claude/skills/rezi-create-screen/SKILL.md and all supporting files. Report provenance, permissions, scripts, dependencies, and security risks. Propose an exact installation into .agents/skills/rezi-create-screen, but wait for my approval before writing files or running scripts.

Copying this prompt does not install or run the skill. Review third-party files before use.

When to use

Use this skill when:

  • Adding a new screen or page to a Rezi application
  • Setting up a view function for an app route
  • Scaffolding a new section of a TUI

Source of truth

  • packages/core/src/widgets/ui.ts — all ui.* factory functions
  • packages/core/src/widgets/composition.ts — defineWidget() and animation hooks
  • packages/core/src/router/ — router and route definitions
  • packages/core/src/keybindings/ — keybinding system
  • packages/create-rezi/templates/starship/ — large-screen routing and animation patterns
  • docs/guide/widget-authoring.md — design system integration patterns

Steps

  1. Create screen file at src/screens/{screen-name}.ts:

    import type { VNode } from "@rezi-ui/core";
    import { ui } from "@rezi-ui/core";
    import type { AppState } from "../types.js";
    
    type ScreenHandlers = Readonly<{
      onPrimaryAction: () => void;
    }>;
    
    export function renderMyScreen(_state: AppState, handlers: ScreenHandlers): VNode {
      return ui.page({
        p: 1,
        gap: 1,
        header: ui.header({ title: "Screen Title" }),
        body: ui.column({ gap: 1 }, [
          ui.text("Screen content"),
          ui.actions([
            ui.button({
              id: "my-screen-action",
              label: "Go",
              intent: "primary",
              onPress: handlers.onPrimaryAction,
            }),
          ]),
        ]),
      });
    }
    

    Prefer intent-based button styling (intent: "primary", "secondary", "danger", "success", "warning", "link"):

    ui.button({
      id: "action",
      label: "Go",
      intent: "primary",
      onPress: handleAction,
    })
    
  2. Use ui.page() or ui.appShell() as the screen root

  3. If the screen needs motion, prefer declarative hooks inside defineWidget:

    import { defineWidget, ui, useAnimatedValue, useTransition } from "@rezi-ui/core";
    
    const AnimatedScreen = defineWidget<{ target: number }>((props, ctx) => {
      const drift = useTransition(ctx, props.target, {
        duration: 180,
        easing: "easeOutCubic",
      });
      const energy = useAnimatedValue(ctx, props.target, {
        mode: "spring",
        spring: {
          stiffness: 190,
          damping: 22,
        },
      });
    
      return ui.box(
        {
          width: Math.round(20 + drift),
          opacity: Math.max(0.35, Math.min(1, energy.value / 100)),
          transition: { duration: 180, easing: "easeInOutCubic", properties: ["size", "opacity"] },
          exitTransition: { duration: 200, easing: "easeInCubic", properties: ["opacity"] },
        },
        [ui.text("Animated screen")],
      );
    });
    
  4. If using router, add a route definition (see rezi-routing skill)

  5. Add keybindings for screen-specific actions in src/helpers/keybindings.ts or your route command resolver

  6. Wire into src/main.ts via a view builder or route factory:

    app.view((state) =>
      renderMyScreen(state, {
        onPrimaryAction: () => dispatch({ type: "open-my-screen" }),
      }),
    );
    

    For routed apps, add the screen to src/screens/index.ts:

    {
      id: "my-screen",
      title: "My Screen",
      screen: (_params, context) =>
        renderMyScreen(context.state, {
          onPrimaryAction: () => dispatch({ type: "open-my-screen" }),
        }),
    }
    

Verification

  • Screen renders without errors
  • Navigation keybindings work
  • State types include any new fields
  • For animated screens: transitions retarget smoothly and no timer leaks occur on unmount