Skip to content

docs: [anchor] Add offsetTop API documentation and optimize example documentation #3298

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
zzcr merged 1 commit into from
Apr 15, 2025
Merged

docs: [anchor] Add offsetTop API documentation and optimize example documentation #3298

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 15 additions & 0 deletions examples/sites/demos/apis/anchor.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,21 @@ export default {
pcDemo: 'set-container',
mfDemo: 'set-container'
},
// 添加offset-top属性文档
{
name: 'offset-top',
type: 'number',
defaultValue: '0',
desc: {
'zh-CN': '锚点距离顶部的偏移量，用于调整滚动定位的位置',
'en-US': 'Offset from the top of the anchor, used to adjust the scroll position'
},
meta: {
stable: '3.19.0'
},
mode: ['pc'],
pcDemo: 'offset-top'
},
{
name: 'type',
type: "'line' | 'dot'",
Expand Down
49 changes: 21 additions & 28 deletions examples/sites/demos/pc/app/anchor/basic-usage-composition-api.vue
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,36 +12,29 @@ import { TinyAnchor, TinySwitch } from '@opentiny/vue'

const links = ref([
{
key: 'demonstrate',
link: '#demonstrate',
title: '演示',
children: [
{
key: 'basic-usage',
link: '#basic-usage',
title: '基本用法'
},
{
key: 'is-affix',
link: '#is-affix',
title: '固定模式'
},
{
key: 'set-container',
link: '#set-container',
title: '滚动容器'
},
{
key: 'on-change',
link: '#change',
title: 'change 事件'
}
]
key: 'basic-usage',
link: '#basic-usage',
title: '基本用法'
},
{
key: 'api',
link: '#API',
title: 'API'
key: 'is-affix',
link: '#is-affix',
title: '固定模式'
},
{
key: 'set-container',
link: '#set-container',
title: '滚动容器'
},
{
key: 'offset-top',
link: '#offset-top',
title: '顶部偏移量'
},
{
key: 'on-change',
link: '#change',
title: 'change 事件'
}
])

Expand Down
6 changes: 3 additions & 3 deletions examples/sites/demos/pc/app/anchor/basic-usage.spec.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,15 +5,15 @@ test('基本用法', async ({ page }) => {
await page.goto('anchor#basic-usage')

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

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

await expect(hash2).not.toEqual(hash1)
await expect(hash2).toContain('#demonstrate')
await expect(hash2).toEqual(hash1)
Copy link

@petercat-assistant petercat-assistant bot Apr 14, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The test expectation has been changed from not.toEqual to toEqual, which might affect the test logic. Please ensure this change is intentional and aligns with the desired test behavior.

await expect(hash2).toContain('#basic-usage')

await link2.click()
const hash3 = await page.evaluate(() => window.location.hash)
Expand Down
49 changes: 21 additions & 28 deletions examples/sites/demos/pc/app/anchor/basic-usage.vue
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,36 +20,29 @@ export default {
return {
links: [
{
key: 'demonstrate',
link: '#demonstrate',
title: '演示',
children: [
{
key: 'basic-usage',
link: '#basic-usage',
title: '基本用法'
},
{
key: 'is-affix',
link: '#is-affix',
title: '固定模式'
},
{
key: 'set-container',
link: '#set-container',
title: '滚动容器'
},
{
key: 'on-change',
link: '#change',
title: 'change 事件'
}
]
key: 'basic-usage',
link: '#basic-usage',
title: '基本用法'
},
{
key: 'api',
link: '#API',
title: 'API'
key: 'is-affix',
link: '#is-affix',
title: '固定模式'
},
{
key: 'set-container',
link: '#set-container',
title: '滚动容器'
},
{
key: 'offset-top',
link: '#offset-top',
title: '顶部偏移量'
},
{
key: 'on-change',
link: '#change',
title: 'change 事件'
}
],
type: 'dot'
Expand Down
49 changes: 21 additions & 28 deletions examples/sites/demos/pc/app/anchor/change-composition-api.vue
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,36 +8,29 @@ import { TinyAnchor } from '@opentiny/vue'

const links = ref([
{
key: 'demonstrate',
link: '#demonstrate',
title: '演示',
children: [
{
key: 'basic-usage',
link: '#basic-usage',
title: '基本用法'
},
{
key: 'is-affix',
link: '#is-affix',
title: '固定模式'
},
{
key: 'set-container',
link: '#set-container',
title: '滚动容器'
},
{
key: 'on-change',
link: '#change',
title: 'change 事件'
}
]
key: 'basic-usage',
link: '#basic-usage',
title: '基本用法'
},
{
key: 'api',
link: '#API',
title: 'API'
key: 'is-affix',
link: '#is-affix',
title: '固定模式'
},
{
key: 'set-container',
link: '#set-container',
title: '滚动容器'
},
{
key: 'offset-top',
link: '#offset-top',
title: '顶部偏移量'
},
{
key: 'on-change',
link: '#change',
title: 'change 事件'
}
])

Expand Down
49 changes: 21 additions & 28 deletions examples/sites/demos/pc/app/anchor/change.vue
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,36 +13,29 @@ export default {
return {
links: [
{
key: 'demonstrate',
link: '#demonstrate',
title: '演示',
children: [
{
key: 'basic-usage',
link: '#basic-usage',
title: '基本用法'
},
{
key: 'is-affix',
link: '#is-affix',
title: '固定模式'
},
{
key: 'set-container',
link: '#set-container',
title: '滚动容器'
},
{
key: 'on-change',
link: '#change',
title: 'change 事件'
}
]
key: 'basic-usage',
link: '#basic-usage',
title: '基本用法'
},
{
key: 'api',
link: '#API',
title: 'API'
key: 'is-affix',
link: '#is-affix',
title: '固定模式'
},
{
key: 'set-container',
link: '#set-container',
title: '滚动容器'
},
{
key: 'offset-top',
link: '#offset-top',
title: '顶部偏移量'
},
{
key: 'on-change',
link: '#change',
title: 'change 事件'
}
]
}
Expand Down
49 changes: 21 additions & 28 deletions examples/sites/demos/pc/app/anchor/is-affix-composition-api.vue
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,36 +15,29 @@ import { TinyAnchor, TinySwitch } from '@opentiny/vue'
const isAffix = ref(false)
const links = ref([
{
key: 'demonstrate',
link: '#demonstrate',
title: '演示',
children: [
{
key: 'basic-usage',
link: '#basic-usage',
title: '基本用法'
},
{
key: 'is-affix',
link: '#is-affix',
title: '固定模式'
},
{
key: 'set-container',
link: '#set-container',
title: '滚动容器'
},
{
key: 'on-change',
link: '#change',
title: 'change 事件'
}
]
key: 'basic-usage',
link: '#basic-usage',
title: '基本用法'
},
{
key: 'api',
link: '#API',
title: 'API'
key: 'is-affix',
link: '#is-affix',
title: '固定模式'
},
{
key: 'set-container',
link: '#set-container',
title: '滚动容器'
},
{
key: 'offset-top',
link: '#offset-top',
title: '顶部偏移量'
},
{
key: 'on-change',
link: '#change',
title: 'change 事件'
}
])
</script>
Expand Down
49 changes: 21 additions & 28 deletions examples/sites/demos/pc/app/anchor/is-affix.vue
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,36 +21,29 @@ export default {
isAffix: false,
links: [
{
key: 'demonstrate',
link: '#demonstrate',
title: '演示',
children: [
{
key: 'basic-usage',
link: '#basic-usage',
title: '基本用法'
},
{
key: 'is-affix',
link: '#is-affix',
title: '固定模式'
},
{
key: 'set-container',
link: '#set-container',
title: '滚动容器'
},
{
key: 'on-change',
link: '#change',
title: 'change 事件'
}
]
key: 'basic-usage',
link: '#basic-usage',
title: '基本用法'
},
{
key: 'api',
link: '#API',
title: 'API'
key: 'is-affix',
link: '#is-affix',
title: '固定模式'
},
{
key: 'set-container',
link: '#set-container',
title: '滚动容器'
},
{
key: 'offset-top',
link: '#offset-top',
title: '顶部偏移量'
},
{
key: 'on-change',
link: '#change',
title: 'change 事件'
}
]
}
Expand Down
Loading
Loading