Affix

Fix the element to a specific visible area.

Basic usage

Affix is fixed at the top of the page by default.

You can set offset attribute to change the offset top,the default value is 0.

Target Container

You can set target attribute to keep the affix in the container at all times. It will be hidden if out of range.

Please notice that the container avoid having scrollbar.

Fixed Position

The affix component provides two fixed positions: top and bottom.

You can set position attribute to change the fixed position, the default value is top.

Affix Attributes

NameDescriptionTypeDefault
offsetoffset distance.number0
positionposition of affix.top/bottomtop
targettarget container. (CSS selector)string
z-indexz-index of affixnumber100

Affix Events

NameDescriptionType
changetriggers when fixed state changed.(fixed: boolean) => void
scrolltriggers when scrolling.(value: { scrollTop: number, fixed: boolean }) => void

Affix Exposes

MethodDescriptionType
updateupdate affix state manually() => void

Affix Slots

NameDescription
defaultcustomize default content.
Last Updated:
Contributors: Tam Mai