
dedsi-vue3-coding
Vue 3 coding guidelines and best practices with Dedsi UI components
Vue 3 coding guidelines and best practices with Dedsi UI components
Dedsi Vue3 Coding Skills
1. 技术栈 (Technology Stack)
- Framework: Vue 3 (Composition API)
- Language: TypeScript
- UI Library: Dedsi UI
- Prefix:
dedsi-(e.g.,dedsi-button,dedsi-table)
- Prefix:
- Icons:
@ant-design/icons-vue - Date Handling:
dayjs - HTTP Client: Custom
AxiosRequestwrapper
2. 项目结构 (Project Structure)
src/apiServices/: API 服务层,包含接口定义和 DTO 类型。identitys/: 身份认证相关服务 (User, Role, Permission 等)。index.ts: 导出所有服务。types.ts: 定义请求/响应接口 (DTO)。
src/views/: 页面视图层。user/index.vue: 标准的 CURD 页面示例。
3. 开发规范 (Development Guidelines)
3.1 API Service Layer
- 位置:
src/apiServices/{module}/ - 类定义: 使用 class 定义 Service,内部实例化
AxiosRequest。 - 单例导出: 导出 Service 的实例 (e.g.,
export const userApiService = new UserApiService()). - 类型定义: DTO (Data Transfer Objects) 必须定义在同级或公共的
types.ts中。 - 标准方法:
pagedQuery(data: InputDto): 分页查询get(id: string): 获取详情create(data: CreateResult): 创建update(id: string, data: UpdateRequest): 更新delete(id: string): 删除
Example:
export class UserApiService {
private request = new AxiosRequest(IdentityApiServiceUrl)
public pagedQuery(data: UserPagedInputDto) {
return this.request.post<UserPagedResultDto, UserPagedInputDto>('/api/Identity/User/PagedQuery', data)
}
}
3.2 View Components
页面开发需遵循 Composition API (<script setup lang="ts">) 风格。
页面布局结构
- Search Card: 顶部搜索栏,使用
dedsi-card包裹dedsi-form(layout="inline")。 - Table Card: 数据表格,使用
dedsi-card包裹dedsi-table。 - Modal: 新增/编辑弹窗,使用
dedsi-modal包裹dedsi-form(layout="vertical")。
核心状态定义
// 表格数据
const tableLoading = ref(false)
const tableData = ref<Dto[]>()
// 分页配置
const pagination = reactive({
current: 1,
pageSize: 10,
total: 0,
showSizeChanger: true,
showTotal: (total: number) => `共 ${total} 条`,
})
// 查询参数
const queryParam = reactive<Partial<InputDto>>({ ... })
// 弹窗表单
const modalVisible = ref(false)
const formState = reactive<any>({ ... })
常用组件对照表
| Standard Component | Dedsi Component | Key Props/Events |
|---|---|---|
| Card | dedsi-card |
:bordered="false" |
| Button | dedsi-button |
type="primary", @click |
| Table | dedsi-table |
:columns, :data, :total, @page-change |
| Form | dedsi-form |
:model, layout, @finish |
| Input | dedsi-input |
v-model |
| Modal | dedsi-modal |
v-model:visible, @cancel |
| Message | DedsiMessage |
DedsiMessage.success(), DedsiMessage.error() |
| Space | dedsi-space |
用于按钮组间距 |
4. 最佳实践 (Best Practices)
-
Table Columns 定义:
- 时间字段使用
customRender+dayjs格式化。 - 操作列使用
template #action插槽。
- 时间字段使用
-
数据加载 (Fetch Data):
- 统一封装
fetchData方法。 try-catch包裹 API 请求。finally中重置tableLoading.value = false。
- 统一封装
-
表单处理:
- 编辑时使用
Object.assign(formState, detail)回填数据。 - 新增时需重置
formState。 - 提交时根据是否有
id判断是 Create 还是 Update。
- 编辑时使用
-
删除操作:
- 使用
dedsi-popconfirm包裹删除按钮,防止误操作。
- 使用
5. 代码模板 (Code Snippets)
Service Template
import { AxiosRequest } from '../../utils/axiosRequest'
// import types...
export class MyApiService {
private request = new AxiosRequest(ServiceUrl)
public pagedQuery(data: PagedInputDto) {
return this.request.post<PagedResultDto, PagedInputDto>('/api/Path/PagedQuery', data)
}
}
export const myApiService = new MyApiService()
View Script Template
<script setup lang="ts">
import { reactive, ref, onMounted } from 'vue'
import { myApiService } from '@/apiServices'
import { DedsiMessage } from 'dedsi-vue-ui'
// State & Methods...
const fetchData = async () => {
tableLoading.value = true
try {
const res = await myApiService.pagedQuery({ ...queryParam, pageIndex: pagination.current, pageSize: pagination.pageSize })
tableData.value = res.items
pagination.total = res.totalCount
} finally {
tableLoading.value = false
}
}
</script>
You Might Also Like
Related Skills

cache-components
Expert guidance for Next.js Cache Components and Partial Prerendering (PPR). **PROACTIVE ACTIVATION**: Use this skill automatically when working in Next.js projects that have `cacheComponents: true` in their next.config.ts/next.config.js. When this config is detected, proactively apply Cache Components patterns and best practices to all React Server Component implementations. **DETECTION**: At the start of a session in a Next.js project, check for `cacheComponents: true` in next.config. If enabled, this skill's patterns should guide all component authoring, data fetching, and caching decisions. **USE CASES**: Implementing 'use cache' directive, configuring cache lifetimes with cacheLife(), tagging cached data with cacheTag(), invalidating caches with updateTag()/revalidateTag(), optimizing static vs dynamic content boundaries, debugging cache issues, and reviewing Cache Component implementations.
vercel
component-refactoring
Refactor high-complexity React components in Dify frontend. Use when `pnpm analyze-component --json` shows complexity > 50 or lineCount > 300, when the user asks for code splitting, hook extraction, or complexity reduction, or when `pnpm analyze-component` warns to refactor before testing; avoid for simple/well-structured components, third-party wrappers, or when the user explicitly wants testing without refactoring.
langgenius
web-artifacts-builder
Suite of tools for creating elaborate, multi-component claude.ai HTML artifacts using modern frontend web technologies (React, Tailwind CSS, shadcn/ui). Use for complex artifacts requiring state management, routing, or shadcn/ui components - not for simple single-file HTML/JSX artifacts.
anthropics
frontend-design
Create distinctive, production-grade frontend interfaces with high design quality. Use this skill when the user asks to build web components, pages, artifacts, posters, or applications (examples include websites, landing pages, dashboards, React components, HTML/CSS layouts, or when styling/beautifying any web UI). Generates creative, polished code and UI design that avoids generic AI aesthetics.
anthropics
react-modernization
Upgrade React applications to latest versions, migrate from class components to hooks, and adopt concurrent features. Use when modernizing React codebases, migrating to React Hooks, or upgrading to latest React versions.
wshobson
tailwind-design-system
Build scalable design systems with Tailwind CSS v4, design tokens, component libraries, and responsive patterns. Use when creating component libraries, implementing design systems, or standardizing UI patterns.
wshobson