convex-component-authoring

Create self-contained Convex components with isolated schemas and exports.

1|Updated Jan 22, 2026
One-click install
npx skills add https://github.com/blocknavi/convex-batch-processor --skill convex-component-authoring
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: convex-component-authoring
Source: https://github.com/blocknavi/convex-batch-processor/tree/main/.claude/skills/convex-component-authoring
Command: npx skills add https://github.com/blocknavi/convex-batch-processor --skill convex-component-authoring

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This skill guides developers to create, structure, publish self-contained Convex components that are isolated from host apps and easy to reuse, while maintaining clean exports and dependency management.

Core Features & Use Cases

  • Isolated component schema and exports: Each component is self-contained with its own schema, functions, and types.
  • Publish and reuse across apps: Components can be versioned and consumed in multiple Convex apps.
  • Guidelines and best practices: Clear structure, isolation boundaries, and documentation for maintainability.

Quick Start

  • Install or create a new component project with a Convex component configuration.
  • Define a component schema, exports, and configuration, then publish to npm.
  • Consume the component in a host app by importing it and wiring it into the convex config.

Frequently Asked Questions about convex-component-authoring

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

FAQPage Schema
How do I create reusable Convex components with proper isolation?

To create reusable Convex components, you define a self-contained schema, functions, and exports, then publish them to npm. This isolation ensures your component's tables and logic remain separated from the host app's data.

What's the best way to structure a Convex component for publishing?

The best way to structure a Convex component for publishing is to ensure it is self-contained with its own schema, isolated tables, clear exports, and proper dependency management, followed by documentation for distribution.

Do I need TypeScript to build and share Convex components?

Yes, you need a TypeScript project setup with a Convex component configuration to build and share components. This setup ensures proper typing, isolation of schemas, and correct export management for distribution.

How does component isolation work when consuming Convex components in a host app?

Component isolation works by keeping the component's tables, schema, and functions self-contained and separated from the host app's data. The host app imports and wires the component into its Convex configuration without direct table access.

Can I version and reuse Convex components across multiple apps?

Yes, you can version and reuse Convex components across multiple apps. By publishing the isolated component package to npm, different host applications can consume the specific version and wire it into their Convex configuration.