Skip to content

Commit 3eb635d

Browse files
committed
docs: update
1 parent 6364b70 commit 3eb635d

File tree

10 files changed

+88
-54
lines changed

10 files changed

+88
-54
lines changed

website/docs/community/merge/cva-and-variants.mdx

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,9 @@ button({ tone: 'outline', size: 'sm' })
5959
```ts
6060
import { create } from '@weapp-tailwindcss/cva'
6161

62-
const { cva: cvaForWeb } = create({ escape: false, unescape: false })
62+
// 跨平台框架请自行判断是否为 H5 构建,通常可从环境变量读取。
63+
const isH5 = true
64+
const { cva: cvaForWeb } = create({ escape: !isH5, unescape: !isH5 })
6365
```
6466

6567
### Live Demo
@@ -139,9 +141,11 @@ mergeLater({ twMerge: false })
139141
```ts
140142
import { create } from '@weapp-tailwindcss/variants'
141143

144+
// 跨平台框架请自行判断是否为 H5 构建,通常可从环境变量读取。
145+
const isH5 = true
142146
const { tv: tvForWeb, cn: cnForWeb } = create({
143-
escape: false,
144-
unescape: false,
147+
escape: !isH5,
148+
unescape: !isH5,
145149
})
146150
```
147151

website/docs/community/merge/overview.mdx

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -117,16 +117,17 @@ badge({ tone: 'success' })
117117
```ts
118118
import { create } from '@weapp-tailwindcss/merge'
119119

120-
const { twMerge: mergeForMiniProgram } = create()
121-
const { twMerge: mergeForWeb } = create({
122-
escape: false,
123-
unescape: false,
120+
// 跨平台框架请自行判断是否为 H5 构建,通常可从环境变量读取。
121+
const isH5 = false
122+
const { twMerge } = create({
123+
escape: !isH5,
124+
unescape: !isH5,
124125
})
125126

126-
mergeForMiniProgram('text-[#ececec]', 'text-[#ECECEC]') // → 'text-_b_hECECEC_B'
127-
mergeForWeb('text-[#ececec]', 'text-[#ECECEC]') // → 'text-[#ECECEC]'
127+
twMerge('text-[#ececec]', 'text-[#ECECEC]') // → 小程序时得到转义结果
128128
```
129129

130+
- H5 环境只需将 `isH5` 设为 `true`,即可关闭 escape/unescape。
130131
- `escape: false` 表示结果保持原样(适合 Web 或同构渲染)。
131132
- `unescape: false` 可跳过运行前的「反转义」,用于确保输入不会被改写。
132133
- 如果只想自定义映射表,传入 `escape: { map: { '#': '__hash__' } }` 即可;运行时会把自定义映射与默认映射合并,保证编译期和运行时的行为一致。

website/docs/community/merge/runtime-api.mdx

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -152,8 +152,9 @@ const raw = weappTwIgnore`
152152
`create` 会根据传入的 `options` 返回一组隔离的运行时函数(`twMerge``twJoin``createTailwindMerge``extendTailwindMerge`),用于控制转义行为:
153153

154154
```ts
155-
const { twMerge: mergeForWeb } = create({ escape: false, unescape: false })
156-
const { twMerge: mergeForMiniProgram } = create()
155+
// 跨平台框架请自行判断是否为 H5 构建,通常可从环境变量读取。
156+
const isH5 = false
157+
const { twMerge } = create({ escape: !isH5, unescape: !isH5 })
157158
```
158159

159160
### CreateOptions

website/docs/community/packages-runtime/cva.mdx

Lines changed: 10 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -51,12 +51,14 @@ const className = button({ tone: 'outline', size: 'sm' })
5151
```ts
5252
import { create } from '@weapp-tailwindcss/cva'
5353

54-
const { cva: cvaWeb } = create({
55-
escape: false,
56-
unescape: false,
54+
// 跨平台框架请自行判断是否为 H5 构建,通常可从环境变量读取。
55+
const isH5 = true
56+
const { cva: cvaRuntime } = create({
57+
escape: !isH5,
58+
unescape: !isH5,
5759
})
5860

59-
const badge = cvaWeb('text-[#0F172A] bg-[#E2E8F0]')
61+
const badge = cvaRuntime('text-[#0F172A] bg-[#E2E8F0]')
6062
```
6163

6264
## Demo:跨端变体工厂
@@ -77,8 +79,10 @@ const config = {
7779
}
7880

7981
const pill = cva('inline-flex items-center rounded-full px-2 text-xs font-medium', config)
80-
const { cva: cvaWeb } = create({ escape: false, unescape: false })
81-
const pillWeb = cvaWeb('inline-flex items-center rounded-full px-2 text-xs font-medium', config)
82+
// 跨平台框架请自行判断是否为 H5 构建,通常可从环境变量读取。
83+
const isH5 = true
84+
const { cva: cvaRuntime } = create({ escape: !isH5, unescape: !isH5 })
85+
const pillWeb = cvaRuntime('inline-flex items-center rounded-full px-2 text-xs font-medium', config)
8286
```
8387

8488
## 常见注意事项

website/docs/community/packages-runtime/index.mdx

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -32,10 +32,11 @@ description: 'runtime 系列包的版本选择、能力矩阵与多端使用心
3232
```ts
3333
import { create } from '@weapp-tailwindcss/merge'
3434

35-
const { twMerge: mergeForMiniProgram } = create()
36-
const { twMerge: mergeForWeb } = create({
37-
escape: false,
38-
unescape: false,
35+
// 跨平台框架请自行判断是否为 H5 构建,通常可从环境变量读取。
36+
const isH5 = false
37+
const { twMerge } = create({
38+
escape: !isH5,
39+
unescape: !isH5,
3940
})
4041
```
4142

website/docs/community/packages-runtime/merge-v3.mdx

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -26,12 +26,14 @@ const className = twMerge('p-2 p-4', 'bg-[#0F172A]')
2626
```ts
2727
import { create } from '@weapp-tailwindcss/merge-v3'
2828

29-
const { twMerge: twMergeWeb } = create({
30-
escape: false,
31-
unescape: false,
29+
// 跨平台框架请自行判断是否为 H5 构建,通常可从环境变量读取。
30+
const isH5 = true
31+
const { twMerge } = create({
32+
escape: !isH5,
33+
unescape: !isH5,
3234
})
3335

34-
twMergeWeb('text-[#2563EB]', 'text-[#1D4ED8]')
36+
twMerge('text-[#2563EB]', 'text-[#1D4ED8]')
3537
// => 'text-[#1D4ED8]'
3638
```
3739

website/docs/community/packages-runtime/merge.mdx

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -67,12 +67,14 @@ const buttonClass = twMerge(
6767
```ts
6868
import { create } from '@weapp-tailwindcss/merge'
6969

70-
const { twMerge: twMergeWeb } = create({
71-
escape: false,
72-
unescape: false,
70+
// 跨平台框架请自行判断是否为 H5 构建,通常可从环境变量读取。
71+
const isH5 = true
72+
const { twMerge } = create({
73+
escape: !isH5,
74+
unescape: !isH5,
7375
})
7476

75-
const className = twMergeWeb('text-[#2563EB]', 'text-[#1D4ED8]')
77+
const className = twMerge('text-[#2563EB]', 'text-[#1D4ED8]')
7678
// => 'text-[#1D4ED8]'
7779
```
7880

website/docs/community/packages-runtime/multi-platform-demos.mdx

Lines changed: 23 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -8,12 +8,14 @@ description: '基于 packages-runtime 的跨端示例:uni-app + Web、Taro + W
88

99
## Demo 1:uni-app + Web(Vue + TS)
1010

11+
同一份 `tv` 实例即可覆盖小程序与 H5,通过环境变量决定是否关闭 escape/unescape。
12+
1113
### 共享变体(`src/ui/button.variants.ts`
1214

1315
```ts
14-
import { tv, create } from '@weapp-tailwindcss/variants'
16+
import { create } from '@weapp-tailwindcss/variants'
1517

16-
type ButtonConfig = Parameters<typeof tv>[0]
18+
type ButtonConfig = Parameters<ReturnType<typeof create>['tv']>[0]
1719

1820
const config: ButtonConfig = {
1921
base: 'inline-flex items-center justify-center rounded-md px-3 py-2 text-sm font-medium',
@@ -33,14 +35,18 @@ const config: ButtonConfig = {
3335
},
3436
}
3537

36-
let tvRuntime = tv
37-
38+
// 跨平台框架请自行判断是否为 H5 构建,通常可从环境变量读取。
39+
let isH5 = false
3840
// #ifdef H5
39-
const { tv: tvWeb } = create({ escape: false, unescape: false })
40-
tvRuntime = tvWeb
41+
isH5 = true
4142
// #endif
4243

43-
export const button = tvRuntime(config)
44+
const { tv } = create({
45+
escape: !isH5,
46+
unescape: !isH5,
47+
})
48+
49+
export const button = tv(config)
4450
```
4551

4652
### 小程序 / H5 共用页面(`src/pages/index/index.vue`
@@ -65,12 +71,14 @@ import { button } from '@/ui/button.variants'
6571

6672
## Demo 2:Taro + Web(React + TSX)
6773

74+
同一份 `tv` 实例即可覆盖小程序与 H5,通过环境变量决定是否关闭 escape/unescape。
75+
6876
### 共享变体(`src/ui/card.variants.ts`
6977

7078
```ts
71-
import { tv, create } from '@weapp-tailwindcss/variants'
79+
import { create } from '@weapp-tailwindcss/variants'
7280

73-
type CardConfig = Parameters<typeof tv>[0]
81+
type CardConfig = Parameters<ReturnType<typeof create>['tv']>[0]
7482

7583
const config: CardConfig = {
7684
base: 'rounded-xl border border-[#E2E8F0] bg-white p-4 shadow-sm',
@@ -85,11 +93,14 @@ const config: CardConfig = {
8593
},
8694
}
8795

96+
// 跨平台框架请自行判断是否为 H5 构建,通常可从环境变量读取。
8897
const isH5 = process.env.TARO_ENV === 'h5'
89-
const { tv: tvWeb } = create({ escape: false, unescape: false })
90-
const tvRuntime = isH5 ? tvWeb : tv
98+
const { tv } = create({
99+
escape: !isH5,
100+
unescape: !isH5,
101+
})
91102

92-
export const card = tvRuntime(config)
103+
export const card = tv(config)
93104
```
94105

95106
### 小程序页面(`src/pages/index/index.tsx`

website/docs/community/packages-runtime/variants-v3.mdx

Lines changed: 10 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -49,12 +49,14 @@ const tvBase = createTV({ twMerge: false })
4949
```ts
5050
import { create } from '@weapp-tailwindcss/variants-v3'
5151

52-
const { tv: tvWeb } = create({
53-
escape: false,
54-
unescape: false,
52+
// 跨平台框架请自行判断是否为 H5 构建,通常可从环境变量读取。
53+
const isH5 = true
54+
const { tv } = create({
55+
escape: !isH5,
56+
unescape: !isH5,
5557
})
5658

57-
const card = tvWeb({
59+
const card = tv({
5860
base: 'rounded-xl border border-[#E2E8F0] bg-white',
5961
})
6062
```
@@ -78,8 +80,10 @@ const config = {
7880
}
7981

8082
const button = tv(config)
81-
const { tv: tvWeb } = create({ escape: false, unescape: false })
82-
const buttonWeb = tvWeb(config)
83+
// 跨平台框架请自行判断是否为 H5 构建,通常可从环境变量读取。
84+
const isH5 = true
85+
const { tv: tvRuntime } = create({ escape: !isH5, unescape: !isH5 })
86+
const buttonWeb = tvRuntime(config)
8387
```
8488

8589
## 常见注意事项

website/docs/community/packages-runtime/variants.mdx

Lines changed: 11 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -60,16 +60,18 @@ mergeLater({ twMerge: false }) // => 仅 escape,不合并
6060
```ts
6161
import { create } from '@weapp-tailwindcss/variants'
6262

63-
const { tv: tvWeb, cn: cnWeb } = create({
64-
escape: false,
65-
unescape: false,
63+
// 跨平台框架请自行判断是否为 H5 构建,通常可从环境变量读取。
64+
const isH5 = true
65+
const { tv, cn } = create({
66+
escape: !isH5,
67+
unescape: !isH5,
6668
})
6769

68-
const card = tvWeb({
70+
const card = tv({
6971
base: 'rounded-xl border border-[#E2E8F0] bg-white',
7072
})
7173

72-
const className = cnWeb('text-[#0F172A]', 'text-[#1E293B]')()
74+
const className = cn('text-[#0F172A]', 'text-[#1E293B]')()
7375
```
7476

7577
## Demo:复用同一配置
@@ -91,8 +93,10 @@ const buttonConfig = {
9193
}
9294

9395
const button = tv(buttonConfig)
94-
const { tv: tvWeb } = create({ escape: false, unescape: false })
95-
const buttonWeb = tvWeb(buttonConfig)
96+
// 跨平台框架请自行判断是否为 H5 构建,通常可从环境变量读取。
97+
const isH5 = true
98+
const { tv: tvRuntime } = create({ escape: !isH5, unescape: !isH5 })
99+
const buttonWeb = tvRuntime(buttonConfig)
96100
```
97101

98102
## 常见注意事项

0 commit comments

Comments
 (0)