Skip to content

Latest commit

 

History

History
183 lines (143 loc) · 5.73 KB

README.zh-TW.md

File metadata and controls

183 lines (143 loc) · 5.73 KB

vxe-table

简体中文 | 繁體中文 | English

star npm version NodeJS with Webpack npm downloads issues issues closed pull requests pull requests closed npm license

一個基於 vue 的PC端表格組件,支持增刪改查、虛擬樹、列拖拽、懶加載、快捷菜單、數據校驗、導入/匯出/列印、表單渲染、自定義模板、渲染器、JSON 配置式…

瀏覽器支持

Edge Chrome Firefox Opera Safari
Latest ✔ Latest ✔ Latest ✔ Latest ✔ Latest ✔

功能點

  • 基礎表格
  • 配置式表單
  • 斑馬線條紋
  • 多種邊框
  • 儲存格樣式
  • 列寬拖動
  • 最小/最大高度
  • 自我調整寬高
  • 固定列
  • 多級表頭
  • 錶尾數據
  • 高亮行或列
  • 序號
  • 單選框
  • 核取方塊
  • 排序
  • 多欄位組合排序
  • 篩選
  • 儲存格合併
  • 合併錶尾
  • 導入/匯出/列印
  • 顯示/隱藏列
  • 拖拽/自定義列排序
  • 加載中
  • 格式化內容
  • 自定義插槽 - 範本
  • 快捷選單
  • 展開行
  • 工具列
  • 增删改查
  • 數據校驗
  • 數據代理
  • 鍵盤導航
  • 渲染器
  • 虛擬滾動
  • 虛擬合併
  • CSS 變量主題
  • ((企業版)) 儲存格區域選取
  • ((企業版)) 儲存格複製/粘貼
  • (企業版) 儲存格查找和替換
  • (企業版) 全鍵盤操作

安裝

版本:vue 3.x

npm install vxe-table@next

Get on unpkg and cdnjs

NPM

使用表格

// ...
import VxeTable from 'vxe-table'
import 'vxe-table/lib/style.css'
// ...

createApp(App).use(VxeTable).mount('#app')

使用表格与 UI 库

// ...
import VxeTable from 'vxe-table'
import 'vxe-table/lib/style.css'
// ...

import VxeUI from 'vxe-pc-ui'
import 'vxe-pc-ui/lib/style.css'
// ...

createApp(App).use(VxeUI).use(VxeTable).mount('#app')

CDN

使用第三方 CDN 方式記得鎖定版本號,避免受到非兼容性更新的影響
不建議將第三方的 CDN 地址用於正式環境,因爲該連接隨時都可能會失效

<!-- style -->
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/vxe-pc-ui/lib/style.css">
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/vxe-table@next/lib/style.css">
<!-- vue -->
<script src="https://cdn.jsdelivr.net/npm/vue"></script>
<!-- table -->
<script src="https://cdn.jsdelivr.net/npm/xe-utils"></script>
<script src="https://cdn.jsdelivr.net/npm/vxe-pc-ui"></script>
<script src="https://cdn.jsdelivr.net/npm/vxe-table@next"></script>

示例

<template>
  <div>
    <vxe-table :data="tableData">
      <vxe-column type="seq" title="Seq" width="60"></vxe-column>
      <vxe-column field="name" title="Name"></vxe-column>
      <vxe-column field="role" title="Role"></vxe-column>
      <vxe-colgroup title="Group1">
        <vxe-column field="sex" title="Sex"></vxe-column>
        <vxe-column field="address" title="Address"></vxe-column>
      </vxe-colgroup>
    </vxe-table>
  </div>
</template>

<script lang="ts" setup>
import { ref } from 'vue'

const tableData = ref([
  { id: 10001, name: 'Test1', role: 'Develop', sex: 'Man', address: 'Shenzhen' },
  { id: 10002, name: 'Test2', role: 'Test', sex: 'Man', address: 'Guangzhou' },
  { id: 10003, name: 'Test3', role: 'PM', sex: 'Man', address: 'Shanghai' }
])
</script>

線上檔案

👉 組件文檔
👉 表格文檔

運行項目

安裝依賴

npm run update

啓動本地調試

npm run serve

編譯打包,生成編譯後的目錄:es,lib

npm run lib

Contributors

Thank you to everyone who contributed to this project.

vxe-table

License

MIT © 2019-present, Xu Liangzhan