vscode-webview-ui
Develop React applications for VS Code Webview surfaces. Use when working on the `webview-ui` package, creating features, components, or hooks for VS Code extensions. Includes project structure, coding guidelines, and testing instructions.
When & Why to Use This Skill
The vscode-webview-ui skill is a comprehensive development framework designed to streamline the creation of React applications within VS Code Webview surfaces. It provides a standardized architecture using Vite, shadcn/ui, and Tailwind CSS, ensuring that developers can build high-performance, maintainable extension interfaces with consistent coding patterns and robust messaging protocols between the extension host and the webview UI.
Use Cases
- Custom VS Code Extension UI: Building complex, interactive React-based dashboards or sidebars within the VS Code environment.
- Standardized Project Scaffolding: Implementing a scalable directory structure that separates shared components, feature-specific logic, and messaging bridges.
- Bi-directional Messaging Implementation: Setting up secure and efficient communication between the VS Code extension backend and the webview frontend using postMessage and event listeners.
- Quality Assurance for Extensions: Utilizing integrated testing guidelines with Playwright or Cypress and automated linting to ensure UI stability and performance.
| name | vscode-webview-ui |
|---|---|
| description | Develop React applications for VS Code Webview surfaces. Use when working on the `webview-ui` package, creating features, components, or hooks for VS Code extensions. Includes project structure, coding guidelines, and testing instructions. |
VS Code Webview UI
Overview
This skill assists in developing the React application that powers VS Code webview surfaces. It covers the webview-ui workspace, which is bundled with Vite and communicates with the extension host via the bridge/vscode helper.
Project Structure
The webview-ui package follows this structure:
webview-ui/
├── src/
│ ├── components/ # Shared visual components reused across features
│ │ └── ui/ # shadcn/ui component library
│ ├── hooks/ # Shared React hooks
│ ├── features/
│ │ └── {feature}/
│ │ ├── index.tsx # Feature entry component rendered from routing
│ │ ├── components/# Feature-specific components
│ │ └── hooks/ # Feature-specific hooks
│ ├── bridge/ # Messaging helpers for VS Code <-> webview
│ └── index.tsx # Runtime router that mounts the selected feature
├── public/ # Static assets copied verbatim by Vite
├── vite.config.ts # Vite build configuration
└── README.md
Coding Guidelines
- Shared Modules: Prefer shared modules under
src/componentsandsrc/hooksbefore introducing feature-local code. - Feature Boundaries: Add feature-only utilities inside the nested
components/orhooks/directories to keep boundaries clear. - Styling: Keep styling in Tailwind-style utility classes (see
src/app.cssfor base tokens) and avoid inline styles when reusable classes exist. - Messaging: Exchange messages with the extension via
vscode.postMessageand subscribe throughwindow.addEventListener('message', …)inside React effects. - Configuration: When adding new steering or config references, obtain paths through the shared
ConfigManagerutilities from the extension layer.
Testing & Quality
- Integration Tests: Use Playwright or Cypress style integration tests if adding complex interactions (tests live under the repo-level
tests/). - Pre-commit Checks: Run
npm run lintandnpm run buildbefore committing to ensure TypeScript and bundler checks pass.