convex-component-authoring

Create, structure, and publish self-contained Convex components with exports and dependency management.

Updated Aug 23, 2026
One-click install
npx skills add https://github.com/JuanQuenga/piggies-ts --skill convex-component-authoring-juanquenga
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: convex-component-authoring
Source: https://github.com/JuanQuenga/piggies-ts/tree/main/.agents/skills/convex-component-authoring
Command: npx skills add https://github.com/JuanQuenga/piggies-ts --skill convex-component-authoring-juanquenga

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This guide helps teams build modular Convex components that are isolated, reusable, and easy to publish across projects, reducing coupling and duplication.

Core Features & Use Cases

  • Isolated component architecture: Define schemas, functions, types, and optional frontend hooks within a self-contained package.
  • Publish-ready packaging: Provide clear exports, versioning, and documentation to enable consumption by other projects.
  • Reusable across projects: Scaffolds and patterns that support multiple instances and easy integration while preventing cross-references to main app tables.

Quick Start

Scaffold a new convex component using the recommended folder structure, implement schema, functions, and exports, then publish to your component registry.

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 and publish reusable Convex components for multiple projects?

To create reusable Convex components, scaffold a self-contained package with proper isolation, schemas, functions, and optional frontend hooks. Export and document public APIs for consumers, then publish to your component registry with versioning to enable distribution across multiple projects.

What is the recommended folder structure for a self-contained Convex component?

A self-contained Convex component requires scaffolding with package.json, tsconfig.json, and convex.config.ts. This structure isolates schemas, functions, types, and optional frontend hooks, preventing cross-references to main application tables and ensuring clean distribution.

How do I export public APIs from a Convex component without coupling it to my main app?

Export public APIs from a Convex component by defining clear exports within the isolated package structure. This prevents cross-references to main app tables and ensures the component remains self-contained, allowing consumers to integrate it without tight coupling to your application's schema.

Can I include frontend hooks when building an isolated Convex component?

Yes, you can include optional frontend hooks when building an isolated Convex component. The component architecture supports defining schemas, functions, types, and these optional hooks within a self-contained package for consumption by other projects.

What's the best way to manage dependencies when distributing Convex components?

Manage dependencies when distributing Convex components by enforcing proper isolation within the self-contained package. Use the provided component scaffolding to structure dependency management, ensuring clean exports and preventing cross-references to main application tables during versioning and publishing.

Why should I isolate my Convex component schema from the main application database?

Isolating your Convex component schema prevents cross-references to main app tables, ensuring the component is self-contained and reusable across multiple projects. This reduces coupling and duplication, enabling clean integration and publish-ready packaging for consumers.