Type Alias JumpLinksOptions

type JumpLinksOptions = {
    intersectionOptions: IntersectionObserverInit;
    onIntersection: IntersectionCallback;
    onLinkClick: LinkClickCallback;
    onStickyTrigger: string[] | StickyTriggerCallback;
    progress: boolean;
    stickyTriggerEnd: StickyTrigger;
    stickyTriggerEndOffset: number | (() => number);
    stickyTriggerStart: StickyTrigger;
    stickyTriggerStartOffset: number | (() => number);
}

Index

Properties

intersectionOptions onIntersection onLinkClick onStickyTrigger progress stickyTriggerEnd stickyTriggerEndOffset stickyTriggerStart stickyTriggerStartOffset

Properties

intersectionOptions

intersectionOptions: IntersectionObserverInit

onIntersection

onIntersection: IntersectionCallback

onLinkClick

onLinkClick: LinkClickCallback

onStickyTrigger

onStickyTrigger: string[] | StickyTriggerCallback

progress

progress: boolean

Whether to enable the progress UI. This will add a progress bar that tracks a user's progress through the jump-links.

stickyTriggerEnd

stickyTriggerEnd: StickyTrigger

stickyTriggerEndOffset

stickyTriggerEndOffset: number | (() => number)

stickyTriggerStart

stickyTriggerStart: StickyTrigger

stickyTriggerStartOffset

stickyTriggerStartOffset: number | (() => number)