Skip to content

Commit df81495

Browse files
committed
* copy-btn: update documentation to reflect changes in attribute names from 'data-toggle' to 'zui-toggle' and 'data-content' to 'data-copy' for improved clarity and consistency
1 parent 6085139 commit df81495

File tree

1 file changed

+22
-22
lines changed
  • lib/copy-btn/docs/lib/components

1 file changed

+22
-22
lines changed

lib/copy-btn/docs/lib/components/index.md

Lines changed: 22 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -4,22 +4,22 @@
44

55
## 使用方法
66

7-
为按钮元素添加 `data-toggle="copyBtn"` 属性即可激活复制按钮功能。通过 `data-content` 属性指定要复制的文本内容。
7+
为按钮元素添加 `zui-toggle="copyBtn"` 属性即可激活复制按钮功能。通过 `data-copy` 属性指定要复制的文本内容。
88

99
::: tabs
1010

1111
== 示例
1212

1313
<Example class="flex gap-4">
14-
<button type="button" class="btn" data-toggle="copyBtn" data-content="这是要复制的文本">
14+
<button type="button" class="btn" zui-toggle="copyBtn" data-copy="这是要复制的文本">
1515
<i class="icon icon-copy"></i> 复制文本
1616
</button>
1717
</Example>
1818

1919
== HTML
2020

2121
```html
22-
<button type="button" class="btn" data-toggle="copyBtn" data-content="这是要复制的文本">
22+
<button type="button" class="btn" zui-toggle="copyBtn" data-copy="这是要复制的文本">
2323
<i class="icon icon-copy"></i> 复制文本
2424
</button>
2525
```
@@ -36,18 +36,18 @@
3636

3737
<Example class="col gap-4">
3838
<div id="copyTarget" class="p-4 surface rounded">这是目标元素中的内容,点击下方按钮复制此内容。</div>
39-
<button type="button" class="btn" data-toggle="copyBtn" href="#copyTarget">
39+
<a class="btn" zui-toggle="copyBtn" href="#copyTarget">
4040
<i class="icon icon-copy"></i> 复制目标内容
41-
</button>
41+
</a>
4242
</Example>
4343

4444
== HTML
4545

4646
```html
4747
<div id="copyTarget" class="p-4 surface rounded">这是目标元素中的内容,点击下方按钮复制此内容。</div>
48-
<button type="button" class="btn" data-toggle="copyBtn" href="#copyTarget">
48+
<a class="btn" zui-toggle="copyBtn" href="#copyTarget">
4949
<i class="icon icon-copy"></i> 复制目标内容
50-
</button>
50+
</a>
5151
```
5252

5353
:::
@@ -65,15 +65,15 @@
6565
== 示例
6666

6767
<Example class="flex gap-4">
68-
<button type="button" class="btn" data-toggle="copyBtn" data-mode="tooltip" data-content="工具提示模式">
68+
<button type="button" class="btn" zui-toggle="copyBtn" data-mode="tooltip" data-copy="工具提示模式">
6969
<i class="icon icon-copy"></i> 工具提示
7070
</button>
7171
</Example>
7272

7373
== HTML
7474

7575
```html
76-
<button type="button" class="btn" data-toggle="copyBtn" data-mode="tooltip" data-content="工具提示模式">
76+
<button type="button" class="btn" zui-toggle="copyBtn" data-mode="tooltip" data-copy="工具提示模式">
7777
<i class="icon icon-copy"></i> 工具提示
7878
</button>
7979
```
@@ -89,16 +89,16 @@
8989
== 示例
9090

9191
<Example class="flex gap-4">
92-
<button type="button" class="btn" data-toggle="copyBtn" data-mode="overlay" data-content="内容覆盖模式" data-copied-icon="check">
93-
<i class="icon icon-copy"></i> 内容覆盖
92+
<button type="button" class="btn" zui-toggle="copyBtn" data-mode="overlay" data-copy="内容覆盖模式" data-copied-icon="check">
93+
<i class="icon icon-copy"></i> <span class="text">内容覆盖</span>
9494
</button>
9595
</Example>
9696

9797
== HTML
9898

9999
```html
100-
<button type="button" class="btn" data-toggle="copyBtn" data-mode="overlay" data-content="内容覆盖模式" data-copied-icon="check">
101-
<i class="icon icon-copy"></i> 内容覆盖
100+
<button type="button" class="btn" zui-toggle="copyBtn" data-mode="overlay" data-copy="内容覆盖模式" data-copied-icon="check">
101+
<i class="icon icon-copy"></i> <span class="text">内容覆盖</span>
102102
</button>
103103
```
104104

@@ -113,15 +113,15 @@
113113
== 示例
114114

115115
<Example class="flex gap-4">
116-
<button type="button" class="btn" data-toggle="copyBtn" data-content="自定义提示" data-copied-text="复制成功!">
116+
<button type="button" class="btn" zui-toggle="copyBtn" data-copy="自定义提示" data-copied-text="复制成功!">
117117
<i class="icon icon-copy"></i> 自定义提示文本
118118
</button>
119119
</Example>
120120

121121
== HTML
122122

123123
```html
124-
<button type="button" class="btn" data-toggle="copyBtn" data-content="自定义提示" data-copied-text="复制成功!">
124+
<button type="button" class="btn" zui-toggle="copyBtn" data-copy="自定义提示" data-copied-text="复制成功!">
125125
<i class="icon icon-copy"></i> 自定义提示文本
126126
</button>
127127
```
@@ -137,21 +137,21 @@
137137
== 示例
138138

139139
<Example class="flex gap-4">
140-
<button type="button" class="btn" data-toggle="copyBtn" data-content="短暂提示" data-duration="1000">
140+
<button type="button" class="btn" zui-toggle="copyBtn" data-copy="短暂提示" data-duration="1000">
141141
<i class="icon icon-copy"></i> 1秒提示
142142
</button>
143-
<button type="button" class="btn" data-toggle="copyBtn" data-content="较长提示" data-duration="5000">
143+
<button type="button" class="btn" zui-toggle="copyBtn" data-copy="较长提示" data-duration="5000">
144144
<i class="icon icon-copy"></i> 5秒提示
145145
</button>
146146
</Example>
147147

148148
== HTML
149149

150150
```html
151-
<button type="button" class="btn" data-toggle="copyBtn" data-content="短暂提示" data-duration="1000">
151+
<button type="button" class="btn" zui-toggle="copyBtn" data-copy="短暂提示" data-duration="1000">
152152
<i class="icon icon-copy"></i> 1秒提示
153153
</button>
154-
<button type="button" class="btn" data-toggle="copyBtn" data-content="较长提示" data-duration="5000">
154+
<button type="button" class="btn" zui-toggle="copyBtn" data-copy="较长提示" data-duration="5000">
155155
<i class="icon icon-copy"></i> 5秒提示
156156
</button>
157157
```
@@ -169,7 +169,7 @@ import {CopyBtn} from '@zui/copy-btn';
169169

170170
// 创建复制按钮实例
171171
const copyBtn = new CopyBtn('#myBtn', {
172-
content: '要复制的内容',
172+
copy: '要复制的内容',
173173
copiedText: '已复制到剪贴板',
174174
});
175175
```
@@ -203,7 +203,7 @@ const copyBtn = new CopyBtn('#myBtn', {
203203
import {CopyBtn} from '@zui/copy-btn';
204204

205205
const copyBtn = new CopyBtn('#myBtn', {
206-
content: '要复制的内容',
206+
copy: '要复制的内容',
207207
});
208208

209209
// 主动触发复制
@@ -214,7 +214,7 @@ copyBtn.copy();
214214

215215
<Props>
216216
mode?: 'tooltip' | 'overlay'; // 提示方式,可选值为工具提示('tooltip')或内容覆盖('overlay'),默认为 'tooltip'
217-
content?: string | {text?: string, html?: string}; // 要复制的内容,可以是字符串或包含 text 和 html 的对象
217+
copy?: string | {text?: string, html?: string}; // 要复制的内容,可以是字符串或包含 text 和 html 的对象
218218
target?: string | HTMLElement; // 复制目标元素的选择器或元素,用于复制目标元素的内容
219219
copiedText?: string; // 复制成功后显示的文本,默认为 '已复制'
220220
copiedIcon?: string; // 复制成功后显示的图标名称(仅在 overlay 模式下有效)

0 commit comments

Comments
 (0)