Skip to content

docs(Sticky): add string type to container att #805

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
liweijie0812 merged 2 commits into from
Jan 23, 2026
Merged

docs(Sticky): add string type to container att #805

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
014bd23
docs(Sticky): add string type to container att
anlyyao Jan 22, 2026
14174f1
chore: resolve conflict
github-actions[bot] Jan 23, 2026
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
Binary file modified db/TDesign.db
View file
Open in desktop
Binary file not shown.
2 changes: 1 addition & 1 deletion packages/products/tdesign-mobile-vue/src/sticky/props.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ import { PropType } from 'vue';
export default {
/** 指定容器对应的NodesRef节点为组件的外部容器，滚动时组件会始终保持在容器范围内，当组件即将超出容器底部时，会返回原位置 */
container: {
type: Object as PropType<TdStickyProps['container']>,
type: [String, Object] as PropType<TdStickyProps['container']>,
},
/** 是否禁用组件 */
disabled: Boolean,
Expand Down
4 changes: 2 additions & 2 deletions packages/products/tdesign-mobile-vue/src/sticky/sticky.en-US.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,11 +6,11 @@

name | type | default | description | required
-- | -- | -- | -- | --
container | Object | - | Typescript：`Element` | N
container | String / Object | - | Typescript: `Element` | N
disabled | Boolean | false | \- | N
offsetTop | String / Number | 0 | \- | N
zIndex | Number | 99 | \- | N
onScroll | Function | | Typescript：`(context: { scrollTop: number, isFixed: boolean }) => void`<br/> | N
onScroll | Function | | Typescript: `(context: { scrollTop: number, isFixed: boolean }) => void`<br/> | N

### Sticky Events

Expand Down
2 changes: 1 addition & 1 deletion packages/products/tdesign-mobile-vue/src/sticky/sticky.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

名称 | 类型 | 默认值 | 描述 | 必传
-- | -- | -- | -- | --
container | Object | - | 指定容器对应的NodesRef节点为组件的外部容器，滚动时组件会始终保持在容器范围内，当组件即将超出容器底部时，会返回原位置。TS 类型：`Element` | N
container | String / Object | - | 指定容器对应的NodesRef节点为组件的外部容器，滚动时组件会始终保持在容器范围内，当组件即将超出容器底部时，会返回原位置。TS 类型：`Element` | N
disabled | Boolean | false | 是否禁用组件 | N
offsetTop | String / Number | 0 | 吸顶时与顶部的距离，单位`px` | N
zIndex | Number | 99 | 吸顶时的 z-index | N
Expand Down
2 changes: 2 additions & 0 deletions packages/scripts/api.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -115451,6 +115451,7 @@
"field_category": 1,
"field_name": "container",
"field_type": [
"1",
"8"
],
"field_default_value": "",
Expand All @@ -115476,6 +115477,7 @@
"Vue(Mobile)"
],
"field_type_text": [
"String",
"Object"
]
},
Expand Down