Skip to content

组件命名规范及使用

DANGER

警告 components 组件命名规范
此文档需要仔细查看

components 组件命名规范

DANGER

组件注册流程组件是需要先新建一个文件夹,文件夹名称为你需要起的组件名称,例如:fx-btn,文件夹名称则为FxBtn,然后创建一个文件,每个组件文件夹必须拥有一个 index.vue 主要文件
文件结构为

sh
src
├─ components
   └─ FxBtn
       └─ index.vue

需遵循驼峰命名法

如:想要写一个组件<fx-btn/> 组件 需为 FxBtn

组件名称起名规范

如果组件是一个对话框功能的组件 需要添加 Dialog 后缀 例如: FxDialog 则组件使用为 <fx-dialog/>
如果组件是一个抽屉功能的组件 需要添加 Drawer 后缀 例如: FxDrawer 则组件使用为 <fx-drawer/>
如果组件是一个气泡弹窗卡片的组件 需要添加 Popover 后缀 例如: FxPopover 则组件使用为 <fx-popover/>

组件使用规范

由于项目使用了 vite 的自动导入,所以组件使用的方式不需要进行 import 方式导入组件,直接使用即可
如:<fx-btn/>

在MIT许可下发布    备案号: 晋ICP备2024051569号-1