Interface AffixProps

interface AffixProps {
    children: ReactNode;
    className?: string;
    offsetBottom?: number;
    offsetTop?: number;
    onChange?: ((affixed?) => void);
    prefixCls?: string;
    rootClassName?: string;
    style?: CSSProperties;
    target?: (() => null | Window | HTMLElement);
}

Properties

children className? offsetBottom? offsetTop? onChange? prefixCls? rootClassName? style? target?

Properties

children

children: ReactNode

Optional className

className?: string

Optional offsetBottom

offsetBottom?: number

Triggered when the specified offset is reached from the bottom of the window

Optional offsetTop

offsetTop?: number

Triggered when the specified offset is reached from the top of the window

Optional onChange

onChange?: ((affixed?) => void)

Callback function triggered when fixed state changes

Type declaration

    • (affixed?): void

    • Callback function triggered when fixed state changes

      Parameters

      • Optional affixed: boolean

      Returns void

Optional prefixCls

prefixCls?: string

Optional rootClassName

rootClassName?: string

Optional style

style?: CSSProperties

Optional target

target?: (() => null | Window | HTMLElement)

Set the element that Affix needs to listen to its scroll event, the value is a function that returns the corresponding DOM element

Type declaration

    • (): null | Window | HTMLElement

    • Set the element that Affix needs to listen to its scroll event, the value is a function that returns the corresponding DOM element

      Returns null | Window | HTMLElement

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc