Skip to content
Skip to contents
Skip to reading controls

Search skills⌘K

Setting the file. One moment.

This file

Type

Size

Lines

Position

convex
/
convex/agent-skills

Local Components · Convex Create Component · convex/agent-skills · Skills Docs

Repo No. 41 · Convex Create Component

↖Back to the cover

33 skills · 70 min

Skill 09 · Convex Create Component

Subchapter 9.3

Local Components

references/local-components.mdMarkdown1 KBView on GitHub

Local Convex Components

Read this file when the component should live inside the current app and does not need to be published as an npm package.

When to Choose This

9Up to skill 9Convex Create Component

On this page

Local Convex Components
When to Choose This
Default Layout
Workflow Notes
Checklist

This file

Number: 9.3
Position: 3 of 6
Type: Markdown
Size: 1 KB

Nearby

Previous Hybrid Components
Next Packaged Components

Source

The user wants the simplest path
The component only needs to work in this repo
The goal is extracting app logic into a cleaner boundary

Default Layout

Use this structure unless the repo already has a clear alternative pattern:

convex/
  convex.config.ts
  components/
    <name>/
      convex.config.ts
      schema.ts
      <feature>.ts

Workflow Notes

Define the component with defineComponent("<name>")
Install it from the app with defineApp() and app.use(...)
Keep auth, env access, public API wrappers, and HTTP route mounting in the app
Let the component own isolated tables and reusable backend workflows
Add app wrappers if clients need to call into the component

Checklist

Not done: Component is inside convex/components/<name>/
Not done: App installs it with app.use(...)
Not done: Component owns only its own tables
Not done: App wrappers handle client-facing calls when needed

ReferenceHybrid Components ReferencePackaged Components

references/local-components.md

(opens in a new tab)

Raw file(opens in a new tab)

convex/agent-skills(opens in a new tab)