Skip to content

Commit 542acda

Browse files
chenxi-20chenxi-20
authored
docs: [anchor] 增加offsetTop API文档，并优化示例文档 (#3298)
1 parent 5d68224 commit 542acda

12 files changed

+269
-171
lines changed

‎examples/sites/demos/apis/anchor.js

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -56,6 +56,21 @@ export default {
5656
pcDemo: 'set-container',
5757
mfDemo: 'set-container'
5858
},
59+
// 添加offset-top属性文档
60+
{
61+
name: 'offset-top',
62+
type: 'number',
63+
defaultValue: '0',
64+
desc: {
65+
'zh-CN': '锚点距离顶部的偏移量，用于调整滚动定位的位置',
66+
'en-US': 'Offset from the top of the anchor, used to adjust the scroll position'
67+
},
68+
meta: {
69+
stable: '3.19.0'
70+
},
71+
mode: ['pc'],
72+
pcDemo: 'offset-top'
73+
},
5974
{
6075
name: 'type',
6176
type: "'line' | 'dot'",

‎examples/sites/demos/pc/app/anchor/basic-usage-composition-api.vue

Lines changed: 21 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -12,36 +12,29 @@ import { TinyAnchor, TinySwitch } from '@opentiny/vue'
1212
1313
const links = ref([
1414
{
15-
key: 'demonstrate',
16-
link: '#demonstrate',
17-
title: '演示',
18-
children: [
19-
{
20-
key: 'basic-usage',
21-
link: '#basic-usage',
22-
title: '基本用法'
23-
},
24-
{
25-
key: 'is-affix',
26-
link: '#is-affix',
27-
title: '固定模式'
28-
},
29-
{
30-
key: 'set-container',
31-
link: '#set-container',
32-
title: '滚动容器'
33-
},
34-
{
35-
key: 'on-change',
36-
link: '#change',
37-
title: 'change 事件'
38-
}
39-
]
15+
key: 'basic-usage',
16+
link: '#basic-usage',
17+
title: '基本用法'
4018
},
4119
{
42-
key: 'api',
43-
link: '#API',
44-
title: 'API'
20+
key: 'is-affix',
21+
link: '#is-affix',
22+
title: '固定模式'
23+
},
24+
{
25+
key: 'set-container',
26+
link: '#set-container',
27+
title: '滚动容器'
28+
},
29+
{
30+
key: 'offset-top',
31+
link: '#offset-top',
32+
title: '顶部偏移量'
33+
},
34+
{
35+
key: 'on-change',
36+
link: '#change',
37+
title: 'change 事件'
4538
}
4639
])
4740

‎examples/sites/demos/pc/app/anchor/basic-usage.spec.ts

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,15 +5,15 @@ test('基本用法', async ({ page }) => {
55
await page.goto('anchor#basic-usage')
66

77
const anchor = page.locator('.tiny-anchor')
8-
const link1 = anchor.getByRole('link', { name: '演示' })
8+
const link1 = anchor.getByRole('link', { name: '基本用法' })
99
const link2 = anchor.getByRole('link', { name: 'change 事件' })
1010
const hash1 = await page.evaluate(() => window.location.hash)
1111

1212
await link1.click()
1313
const hash2 = await page.evaluate(() => window.location.hash)
1414

15-
await expect(hash2).not.toEqual(hash1)
16-
await expect(hash2).toContain('#demonstrate')
15+
await expect(hash2).toEqual(hash1)
16+
await expect(hash2).toContain('#basic-usage')
1717

1818
await link2.click()
1919
const hash3 = await page.evaluate(() => window.location.hash)

‎examples/sites/demos/pc/app/anchor/basic-usage.vue

Lines changed: 21 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -20,36 +20,29 @@ export default {
2020
return {
2121
links: [
2222
{
23-
key: 'demonstrate',
24-
link: '#demonstrate',
25-
title: '演示',
26-
children: [
27-
{
28-
key: 'basic-usage',
29-
link: '#basic-usage',
30-
title: '基本用法'
31-
},
32-
{
33-
key: 'is-affix',
34-
link: '#is-affix',
35-
title: '固定模式'
36-
},
37-
{
38-
key: 'set-container',
39-
link: '#set-container',
40-
title: '滚动容器'
41-
},
42-
{
43-
key: 'on-change',
44-
link: '#change',
45-
title: 'change 事件'
46-
}
47-
]
23+
key: 'basic-usage',
24+
link: '#basic-usage',
25+
title: '基本用法'
4826
},
4927
{
50-
key: 'api',
51-
link: '#API',
52-
title: 'API'
28+
key: 'is-affix',
29+
link: '#is-affix',
30+
title: '固定模式'
31+
},
32+
{
33+
key: 'set-container',
34+
link: '#set-container',
35+
title: '滚动容器'
36+
},
37+
{
38+
key: 'offset-top',
39+
link: '#offset-top',
40+
title: '顶部偏移量'
41+
},
42+
{
43+
key: 'on-change',
44+
link: '#change',
45+
title: 'change 事件'
5346
}
5447
],
5548
type: 'dot'

‎examples/sites/demos/pc/app/anchor/change-composition-api.vue

Lines changed: 21 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -8,36 +8,29 @@ import { TinyAnchor } from '@opentiny/vue'
88
99
const links = ref([
1010
{
11-
key: 'demonstrate',
12-
link: '#demonstrate',
13-
title: '演示',
14-
children: [
15-
{
16-
key: 'basic-usage',
17-
link: '#basic-usage',
18-
title: '基本用法'
19-
},
20-
{
21-
key: 'is-affix',
22-
link: '#is-affix',
23-
title: '固定模式'
24-
},
25-
{
26-
key: 'set-container',
27-
link: '#set-container',
28-
title: '滚动容器'
29-
},
30-
{
31-
key: 'on-change',
32-
link: '#change',
33-
title: 'change 事件'
34-
}
35-
]
11+
key: 'basic-usage',
12+
link: '#basic-usage',
13+
title: '基本用法'
3614
},
3715
{
38-
key: 'api',
39-
link: '#API',
40-
title: 'API'
16+
key: 'is-affix',
17+
link: '#is-affix',
18+
title: '固定模式'
19+
},
20+
{
21+
key: 'set-container',
22+
link: '#set-container',
23+
title: '滚动容器'
24+
},
25+
{
26+
key: 'offset-top',
27+
link: '#offset-top',
28+
title: '顶部偏移量'
29+
},
30+
{
31+
key: 'on-change',
32+
link: '#change',
33+
title: 'change 事件'
4134
}
4235
])
4336

‎examples/sites/demos/pc/app/anchor/change.vue

Lines changed: 21 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -13,36 +13,29 @@ export default {
1313
return {
1414
links: [
1515
{
16-
key: 'demonstrate',
17-
link: '#demonstrate',
18-
title: '演示',
19-
children: [
20-
{
21-
key: 'basic-usage',
22-
link: '#basic-usage',
23-
title: '基本用法'
24-
},
25-
{
26-
key: 'is-affix',
27-
link: '#is-affix',
28-
title: '固定模式'
29-
},
30-
{
31-
key: 'set-container',
32-
link: '#set-container',
33-
title: '滚动容器'
34-
},
35-
{
36-
key: 'on-change',
37-
link: '#change',
38-
title: 'change 事件'
39-
}
40-
]
16+
key: 'basic-usage',
17+
link: '#basic-usage',
18+
title: '基本用法'
4119
},
4220
{
43-
key: 'api',
44-
link: '#API',
45-
title: 'API'
21+
key: 'is-affix',
22+
link: '#is-affix',
23+
title: '固定模式'
24+
},
25+
{
26+
key: 'set-container',
27+
link: '#set-container',
28+
title: '滚动容器'
29+
},
30+
{
31+
key: 'offset-top',
32+
link: '#offset-top',
33+
title: '顶部偏移量'
34+
},
35+
{
36+
key: 'on-change',
37+
link: '#change',
38+
title: 'change 事件'
4639
}
4740
]
4841
}

‎examples/sites/demos/pc/app/anchor/is-affix-composition-api.vue

Lines changed: 21 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -15,36 +15,29 @@ import { TinyAnchor, TinySwitch } from '@opentiny/vue'
1515
const isAffix = ref(false)
1616
const links = ref([
1717
{
18-
key: 'demonstrate',
19-
link: '#demonstrate',
20-
title: '演示',
21-
children: [
22-
{
23-
key: 'basic-usage',
24-
link: '#basic-usage',
25-
title: '基本用法'
26-
},
27-
{
28-
key: 'is-affix',
29-
link: '#is-affix',
30-
title: '固定模式'
31-
},
32-
{
33-
key: 'set-container',
34-
link: '#set-container',
35-
title: '滚动容器'
36-
},
37-
{
38-
key: 'on-change',
39-
link: '#change',
40-
title: 'change 事件'
41-
}
42-
]
18+
key: 'basic-usage',
19+
link: '#basic-usage',
20+
title: '基本用法'
4321
},
4422
{
45-
key: 'api',
46-
link: '#API',
47-
title: 'API'
23+
key: 'is-affix',
24+
link: '#is-affix',
25+
title: '固定模式'
26+
},
27+
{
28+
key: 'set-container',
29+
link: '#set-container',
30+
title: '滚动容器'
31+
},
32+
{
33+
key: 'offset-top',
34+
link: '#offset-top',
35+
title: '顶部偏移量'
36+
},
37+
{
38+
key: 'on-change',
39+
link: '#change',
40+
title: 'change 事件'
4841
}
4942
])
5043
</script>

‎examples/sites/demos/pc/app/anchor/is-affix.vue

Lines changed: 21 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -21,36 +21,29 @@ export default {
2121
isAffix: false,
2222
links: [
2323
{
24-
key: 'demonstrate',
25-
link: '#demonstrate',
26-
title: '演示',
27-
children: [
28-
{
29-
key: 'basic-usage',
30-
link: '#basic-usage',
31-
title: '基本用法'
32-
},
33-
{
34-
key: 'is-affix',
35-
link: '#is-affix',
36-
title: '固定模式'
37-
},
38-
{
39-
key: 'set-container',
40-
link: '#set-container',
41-
title: '滚动容器'
42-
},
43-
{
44-
key: 'on-change',
45-
link: '#change',
46-
title: 'change 事件'
47-
}
48-
]
24+
key: 'basic-usage',
25+
link: '#basic-usage',
26+
title: '基本用法'
4927
},
5028
{
51-
key: 'api',
52-
link: '#API',
53-
title: 'API'
29+
key: 'is-affix',
30+
link: '#is-affix',
31+
title: '固定模式'
32+
},
33+
{
34+
key: 'set-container',
35+
link: '#set-container',
36+
title: '滚动容器'
37+
},
38+
{
39+
key: 'offset-top',
40+
link: '#offset-top',
41+
title: '顶部偏移量'
42+
},
43+
{
44+
key: 'on-change',
45+
link: '#change',
46+
title: 'change 事件'
5447
}
5548
]
5649
}

0 commit comments

Comments
 (0)