convex-component-authoring

Featured

How to create, structure, and publish self-contained Convex components with proper isolation, exports, and dependency management

API & Backend 391 stars 30 forks Updated 3 months ago Apache-2.0

Install

View on GitHub

Quality Score: 91/100

Stars 20%
86
Recency 20%
50
Frontmatter 20%
70
Documentation 15%
100
Issue Health 10%
50
License 10%
100
Description 5%
100

Skill Content

# Convex Component Authoring Create self-contained, reusable Convex components with proper isolation, exports, and dependency management for sharing across projects. ## Documentation Sources Before implementing, do not assume; fetch the latest documentation: - Primary: https://docs.convex.dev/components - Component Authoring: https://docs.convex.dev/components/authoring - For broader context: https://docs.convex.dev/llms.txt ## Instructions ### What Are Convex Components? Convex components are self-contained packages that include: - Database tables (isolated from the main app) - Functions (queries, mutations, actions) - TypeScript types and validators - Optional frontend hooks ### Component Structure ``` my-convex-component/ ├── package.json ├── tsconfig.json ├── README.md ├── src/ │ ├── index.ts # Main exports │ ├── component.ts # Component definition │ ├── schema.ts # Component schema │ └── functions/ │ ├── queries.ts │ ├── mutations.ts │ └── actions.ts └── convex.config.ts # Component configuration ``` ### Creating a Component #### 1. Component Configuration ```typescript // convex.config.ts import { defineComponent } from "convex/server"; export default defineComponent("myComponent"); ``` #### 2. Component Schema ```typescript // src/schema.ts import { defineSchema, defineTable } from "convex/server"; import { v } from "convex/values"; export default defineSchema({ // Tables are isolated to this co...

Details

Author
waynesutton
Repository
waynesutton/convexskills
Created
4 months ago
Last Updated
3 months ago
Language
JavaScript
License
Apache-2.0

Integrates with

Similar Skills

Semantically similar based on skill content — not just same category