create-view

Create custom view types for Wave Terminal using React and Jotai.

22.0k|1.1k|Updated Jun 8, 2022
One-click install
npx skills add https://github.com/wavetermdev/waveterm --skill create-view
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: create-view
Source: https://github.com/wavetermdev/waveterm/tree/main/.kilocode/skills/create-view
Command: npx skills add https://github.com/wavetermdev/waveterm --skill create-view

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This Skill provides a comprehensive guide for developers looking to extend Wave Terminal by creating and integrating new custom view components.

Core Features & Use Cases

  • View Model Implementation: Learn how to define state and logic for new views using Jotai atoms.
  • View Component Creation: Understand how to build reusable React components for displaying view content.
  • Registration: Discover how to register new view types within the Wave Terminal's BlockRegistry.
  • Use Case: A developer wants to add a new "Markdown Preview" view type to Wave Terminal. They would follow this guide to create the ViewModel and ViewComponent, then register it so users can create blocks with this new view.

Quick Start

Follow the step-by-step guide to create a new view model class for your custom view.

Frequently Asked Questions about create-view

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I create a custom view type in Wave Terminal?

To create a custom view type in Wave Terminal, you define a ViewModel interface, build a React ViewComponent, and register the new type within the BlockRegistry. This enables modular UI extensions and custom content rendering capabilities.

How does Jotai state management work for custom view components?

Jotai state management for custom view components involves defining state and logic using Jotai atoms within your ViewModel class. This approach handles the internal state requirements for your new React UI components in Wave Terminal.

What is the process to register a new React view component in the BlockRegistry?

Registering a new React view component in the BlockRegistry requires mapping your newly created ViewModel and ViewComponent to a specific view type identifier. This step integrates your custom UI component into the Wave Terminal application for user interaction.

Can I use React to build reusable UI components for Wave Terminal views?

Yes, you can use React to build reusable UI components for Wave Terminal views. The implementation guide specifically covers ViewComponent creation using React to handle the display and rendering of custom content blocks.

When do I need to define a ViewModel interface for a Wave Terminal extension?

You need to define a ViewModel interface when adding a new view type like a Markdown Preview to Wave Terminal. The ViewModel manages the state and logic required before the React ViewComponent can render the custom content blocks.