The AffixedSidebar component uses Bootstrap's "affix" plugin to keep a sidebar navigation at the top of the viewport when scrolling.


The component must wrap an element that itself wraps an

    element, which will be "affixed".




The attributes passed into the component.

bottom: undefined | number
boundOnresize: undefined | (() => void)

Type declaration

    • (): void
    • Returns void

element: Element

The root DOM element for the component.

state: undefined

Class component state that is persisted between redraws.

Updating this will not automatically trigger a redraw, unlike other frameworks.

This is different to Vnode state, which is always an instance of your class component.

This is undefined by default.


  • Returns a jQuery object for this component's element. If you pass in a selector string, this method will return a jQuery object, using the current element as its buffer.

    For example, calling component.$('li') will return a jQuery object containing all of the li elements inside the DOM element of this component.


    • Optional selector: string

      a jQuery-compatible selector string

    Returns JQuery<HTMLElement>

    the jQuery object for the DOM node


Generated using TypeDoc v0.24.8