Skip to content

安装

环境要求

  • Node.js 20 及以上版本
  • Vue 3.5 及以上版本

安装命令

bash
npm install moongate-vue
# 或
pnpm add moongate-vue
# 或
yarn add moongate-vue

样式引入

组件库的默认样式是非侵入式的(不会重置你的全局样式,* 等元素默认行为保持不变):

ts
// 默认引入:仅包含组件样式,无副作用
import 'moongate-vue/style.css'

如需统一盒模型基线(所有元素 box-sizing: border-box),可按需额外引入可选重置:

ts
// 可选:全局盒模型统一(保留浏览器默认 margin/padding)
import 'moongate-vue/reset.css'

按需导入

vue
<script setup>
import { Button, useMessage } from 'moongate-vue'
import 'moongate-vue/style.css'
</script>

TypeScript 类型

所有组件均导出其 Props 类型,可直接从包入口导入(支持 Tree Shaking 与类型推导):

ts
import type { ButtonProps, TableProps, SelectValue, DropdownOption } from 'moongate-vue'

// 泛型组件类型支持
function renderTable<T>(props: TableProps<T>) {
  // ...
}

可用的类型列表

类别类型
组件 PropsButtonProps CardProps BadgeProps DividerProps InputProps TextareaProps CheckboxProps RadioProps SwitchProps SelectProps PaginationProps ModalProps ToastProps MessageProps TabsProps SkeletonProps TooltipProps PopoverProps DrawerProps DropdownProps ContainerProps HeaderProps HeroProps FormItemProps FormProps TableProps
组件相关SelectValue SelectOption TabItem DropdownOption DropdownPlacement
TableTableColumn SortParams CellSlotProps ColumnSlotProps
配置Config LocaleTexts
ComposableRule FieldRules UseFormOptions MenuItemBase

样式引入方式见上文样式引入

Released under the MIT License