Interface AnchorProps

interface AnchorProps {
    affix?: boolean;
    bounds?: number;
    children?: ReactNode;
    className?: string;
    direction?: AnchorDirection;
    getContainer?: (() => AnchorContainer);
    getCurrentAnchor?: ((activeLink) => string);
    items?: AnchorLinkItemProps[];
    offsetTop?: number;
    onChange?: ((currentActiveLink) => void);
    onClick?: ((e, link) => void);
    prefixCls?: string;
    replace?: boolean;
    rootClassName?: string;
    showInkInFixed?: boolean;
    style?: CSSProperties;
    targetOffset?: number;
}

Properties

affix? bounds? children? className? direction? getContainer? getCurrentAnchor? items? offsetTop? onChange? onClick? prefixCls? replace? rootClassName? showInkInFixed? style? targetOffset?

Properties

Optional affix

affix?: boolean

Optional bounds

bounds?: number

Optional children

children?: ReactNode

Deprecated

Please use items instead.

Optional className

className?: string

Optional direction

direction?: AnchorDirection

Optional getContainer

getContainer?: (() => AnchorContainer)

Type declaration

    • (): AnchorContainer

    • Returns AnchorContainer

Optional getCurrentAnchor

getCurrentAnchor?: ((activeLink) => string)

Return customize highlight anchor

Type declaration

    • (activeLink): string

    • Return customize highlight anchor

      Parameters

      • activeLink: string

      Returns string

Optional items

items?: AnchorLinkItemProps[]

Optional offsetTop

offsetTop?: number

Optional onChange

onChange?: ((currentActiveLink) => void)

Listening event when scrolling change active link

Type declaration

    • (currentActiveLink): void

    • Listening event when scrolling change active link

      Parameters

      • currentActiveLink: string

      Returns void

Optional onClick

onClick?: ((e, link) => void)

Type declaration

    • (e, link): void

    • Parameters

      • e: MouseEvent<HTMLElement, MouseEvent>
      • link: {
            href: string;
            title: ReactNode;
        }
        • href: string
        • title: ReactNode

      Returns void

Optional prefixCls

prefixCls?: string

Optional replace

replace?: boolean

Optional rootClassName

rootClassName?: string

Optional showInkInFixed

showInkInFixed?: boolean

Optional style

style?: CSSProperties

Optional targetOffset

targetOffset?: number

Scroll to target offset value, if none, it's offsetTop prop value or 0.

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc