Flarum (v2.0.0-beta.6)
    Preparing search index...

    Class AffixedSidebar

    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".

    https://getbootstrap.com/docs/3.4/javascript/#affix

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Properties

    attrs bottom boundOnresize element state

    Methods

    $ onbeforeremove onbeforeupdate oncreate oninit onremove onresize onupdate view component initAttrs

    Constructors

    Properties

    attrs: ComponentAttrs

    The attributes passed into the component.

    https://mithril.js.org/components.html#passing-data-to-components

    bottom: number | undefined
    boundOnresize: (() => void) | undefined
    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.

    Methods

    $

    • $(selector?: string): JQuery

      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.

      Parameters

      • Optionalselector: string

        a jQuery-compatible selector string

      Returns JQuery

      the jQuery object for the DOM node

    Settings

    Member Visibility

    On This Page

    Children
    Constructors
    Properties
    Methods