ant-design-vue/components/affix/index.en-US.md
2021-12-05 01:06:31 +08:00

1.6 KiB
Raw Blame History

category type title cover
Components Navigation Affix https://gw.alipayobjects.com/zos/alicdn/tX6-md4H6/Affix.svg

Wrap Affix around another component to make it stick the viewport.

When To Use

On longer web pages, its helpful for some content to stick to the viewport. This is common for menus and actions.

Please note that Affix should not cover other content on the page, especially when the size of the viewport is small.

API

Property Description Type Default Version
offsetBottom Offset from the bottom of the viewport (in pixels) number -
offsetTop Offset from the top of the viewport (in pixels) number 0
target Specifies the scrollable area DOM node () => HTMLElement () => window

events

Events Name Description Arguments Version
change Callback for when Affix state is changed Function(affixed)

Note: Children of Affix must not have the property position: absolute, but you can set position: absolute on Affix itself:

<a-affix :style="{ position: 'absolute', top: y, left: x}">...</a-affix>

FAQ

Affix bind container with target, sometime move out of container.

We don't listen window scroll for performance consideration.

Related issues#3938 #5642 #16120