组件/安装与引入

安装与引入

安装 Tuffex 并按组件、按套件或从根入口引入

自 0.4.0BETA

安装

Vue 3 是 peer dependency。

pnpm add @talex-touch/tuffex

用法

三种方式拿到的是同一个组件,区别只在打包体积。

方式引入路径适用场景
按组件@talex-touch/tuffex/button新代码,只打包用到的组件
按套件@talex-touch/tuffex/base一个页面大量使用同一套件
根入口@talex-touch/tuffex仅用于迁移,会引入整个组件库

按组件引入(推荐)

EXAMPLE.TYPESCRIPT
import TxButton from '@talex-touch/tuffex/button'
import TxSwitch from '@talex-touch/tuffex/switch'
import '@talex-touch/tuffex/base.css'
import '@talex-touch/tuffex/button/style.css'
import '@talex-touch/tuffex/switch/style.css'

app.use(TxButton)
app.use(TxSwitch)

按套件引入

base、pro、ai 三个入口互不重叠,套件入口只提供具名导出,动效组件从 pro 引入,图表另有 @talex-touch/tuffex/charts 入口。

EXAMPLE.TYPESCRIPT
import { TxButton, TuffSwitch } from '@talex-touch/tuffex/base'
import '@talex-touch/tuffex/base.css'
import '@talex-touch/tuffex/button/style.css'
import '@talex-touch/tuffex/switch/style.css'

app.use(TxButton)
app.use(TuffSwitch)
EXAMPLE.TYPESCRIPT
import { TxTimeseriesChart } from '@talex-touch/tuffex/charts'
import '@talex-touch/tuffex/charts/style.css'

根入口(迁移用)

EXAMPLE.TYPESCRIPT
import TuffUI from '@talex-touch/tuffex'
import '@talex-touch/tuffex/style.css'

app.use(TuffUI)

样式

样式不会随 JavaScript 自动注入,覆盖 token 见《主题定制》。

样式文件内容是否必需
@talex-touch/tuffex/base.css--tx-* 变量、重置样式、主题选择器必需,全局引入一次
@talex-touch/tuffex/<name>/style.css单个组件的样式用到哪个组件引哪个
@talex-touch/tuffex/style.css全部组件的样式仅根入口

工具函数

EXAMPLE.TYPESCRIPT
import { nextZIndex, toast } from '@talex-touch/tuffex/utils'

完整 API 见《Utils 工具函数》。

技术实现

  • 入口映射:packages/tuffex/package.json 的 exports。
  • 套件入口:packages/tuffex/packages/components/src/{base,pro,ai}/index.ts,由 suite-barrels.test.ts 校验三者恰好划分全部组件。