Skip to content

mt-ui PC 端组件

Vue 3 PC 端组件库,对应 npm 包 @mingto/mt-ui

安装

bash
pnpm add @mingto/mt-ui

也可以使用 npm 或 yarn:

bash
npm install @mingto/mt-ui
bash
yarn add @mingto/mt-ui

需要项目中已安装 Vue 3,当前 peer dependency 为 vue@^3.5.13

快速开始

全量引入

typescript
import MtUi from '@mingto/mt-ui'
import { createApp } from 'vue'
import App from './App.vue'

const app = createApp(App)

app.use(MtUi)
app.mount('#app')

按需引入

typescript
import { MtButton, MtDialog, MtMessage } from '@mingto/mt-ui'
import { createApp } from 'vue'
import App from './App.vue'

const app = createApp(App)

app.use(MtButton)
app.use(MtDialog)
app.use(MtMessage)
app.mount('#app')

在 setup 中使用

vue
<script setup lang="ts">
import { MtMessage } from '@mingto/mt-ui'

function submit() {
  MtMessage.success('操作成功')
}
</script>

<template>
  <MtButton
    type="primary"
    @click="submit"
  >
    提交
  </MtButton>
</template>

导出

typescript
import MtUi from '@mingto/mt-ui'

包主入口默认导出 Vue 插件,同时按需导出各个组件、函数式入口和关联布局。组件、函数式能力、关联布局三类的具体说明详见每个组件的文档页。

注意事项

  • 组件基于 Vue 3,依赖 vue@^3.5.13,不兼容 Vue 2。
  • 表格相关组件(MtTable / MtTableColumn)依赖 Element Plus,需保证项目已引入对应样式。
  • 文档 demo 使用连字符形式 <mt-xxx>,依赖 .vitepress/theme/index.js 的全局注册;业务项目使用 PascalCase 或连字符均可。