Category Overview
| Category | Count | Index | Component Examples |
|---|---|---|---|
| Forms | 25 | categories/form.md | form, input, select, date-picker |
| Data Display | 12 | categories/data-display.md | table, tree, list, paginator |
| Feedback Notifications | 10 | categories/feedback.md | message, dialog, drawer, loading |
| Navigation | 7 | categories/navigation.md | menu, tabs, breadcrumb |
| Layout Containers | 4 | categories/layout.md | layout, card, scroll |
| Editors | 6 | categories/editor.md | code-editor, table-editor |
| General | 7 | categories/general.md | button, icon, action |
- Full catalog table:catalog.md
- Per-component type snippets:
generated/components/<name>.md - Shared types:shared-types.md
Run in the root directory bun run sync-veltra-desktop or bun run sync-skills to regenerate generated/。
Import Conventions
Automatic on-demand import (recommended)
unplugin-components + U prefix resolution; in templates, <u-button> and <UButton> are equivalent, and the resolver will import the corresponding style.ts。
Manual Import
import type { ButtonProps, TableColumn, FormExposed } from '@veltra/desktop'
import { FormModel, DynamicFormModel, defineTableColumns, message } from '@veltra/desktop'
import { Edit, Delete, Search } from '@veltra/icons/normal'
Core Patterns (Summary)
- v-model: form components uniformly use
modelValue/update:modelValue。 - FormModel +
<u-form field>:model.validate()、resetData()、setData()、clearValidate()。 - Table Columns:
defineTableColumns, column slots#column:<key>; trees use#defaultand other scoped slots. - Exposed:
shallowRef<TreeExposed>()and other methods to access the instance.
For more complete usage and edge cases, see references/dev-patterns.md。
Reference Index
| Path | Content |
|---|---|
generated/catalog.md |
Component catalog table (including links to each components/*.md) |
generated/categories/*.md |
Category → Component Documentation Links |
generated/components/*.md |
Single-Component Type Definitions |
generated/shared-types.md |
Shared types |
generated/manifest.json |
Synchronized Metadata |
references/dev-patterns.md |
Usage Patterns and Troubleshooting |