---
title: 安装与引入
description: 安装 Tuffex 并按组件、按套件或从根入口引入
category: Foundations
status: beta
since: 0.4.0
tags: [install, imports, entries, styles]
syncStatus: reviewed
verified: false
---

## 安装

Vue 3 是 peer dependency。

:::TuffCodeBlock{lang="bash"}
---
code: |
  pnpm add @talex-touch/tuffex
---
:::

## 用法

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

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

### 按组件引入（推荐）

:::TuffCodeBlock{lang="typescript"}
---
code: |
  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` 入口。

:::TuffCodeBlock{lang="typescript"}
---
code: |
  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)
---
:::

:::TuffCodeBlock{lang="typescript"}
---
code: |
  import { TxTimeseriesChart } from '@talex-touch/tuffex/charts'
  import '@talex-touch/tuffex/charts/style.css'
---
:::

### 根入口（迁移用）

:::TuffCodeBlock{lang="typescript"}
---
code: |
  import TuffUI from '@talex-touch/tuffex'
  import '@talex-touch/tuffex/style.css'

  app.use(TuffUI)
---
:::

### 样式

样式不会随 JavaScript 自动注入，覆盖 token 见《[主题定制](./theming.zh.mdc)》。

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

### 工具函数

:::TuffCodeBlock{lang="typescript"}
---
code: |
  import { nextZIndex, toast } from '@talex-touch/tuffex/utils'
---
:::

完整 API 见《[Utils 工具函数](./utils.zh.mdc)》。

## 技术实现

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