convex-component-authoring

Author, structure, and publish self-contained Convex components with isolated data and functions.

33|2|Updated Feb 21, 2025
One-click install
npx skills add https://github.com/yspreen/dotfiles --skill convex-component-authoring-yspreen
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: convex-component-authoring
Source: https://github.com/yspreen/dotfiles/tree/main/.agents/skills/convex-component-authoring
Command: npx skills add https://github.com/yspreen/dotfiles --skill convex-component-authoring-yspreen

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Helps developers author, structure, and publish self-contained Convex components with isolated data and functions, enabling safe reuse across multiple apps.

Core Features & Use Cases

  • Self-contained components include schema, server-side functions (queries, mutations, actions), TypeScript types, and optional frontend hooks.
  • Isolation from main app data ensures components can be deployed and versioned independently.
  • Clear publishing workflow with exports and documentation, plus example templates and patterns for common use cases like rate limiting, component composition, and multi-instance deployments.

Quick Start

Create a new Convex component by defining its schema, implementing functions, exporting the component, and publishing it with the documented configuration.

Frequently Asked Questions about convex-component-authoring

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

FAQPage Schema
How do I publish self-contained Convex components with isolated data and functions?

To publish self-contained Convex components, you define the schema, implement server functions and TypeScript types, configure the component exports, and use the documented workflow to distribute it across projects.

What is a Convex component and how does its data isolation work?

A Convex component is a modular, reusable package containing schema, server functions, and optional hooks. Data isolation works by separating the component's data from the main app, ensuring components can be deployed and versioned independently.

How do I structure a Convex component schema with server functions and hooks?

You structure a Convex component by defining its schema, implementing server-side queries and mutations, adding TypeScript types, and including optional frontend hooks, then exporting the component for publishing.

When do I need to build reusable Convex components for multiple apps?

You need to build reusable Convex components when you require modular, versioned packages with isolated data and functions that can be safely distributed and composed across multiple applications.

Can I use Convex components for rate limiting and multi-instance deployments?

Yes, Convex components support patterns for common use cases like rate limiting and multi-instance deployments, providing clear configuration and templates for component composition.

Does publishing Convex components require TypeScript types and server functions?

Publishing Convex components involves TypeScript types and server functions, which are structured alongside the schema and optional hooks to create a complete, self-contained package for distribution.