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

    The PostStreamScrubber component displays a scrubber which can be used to navigate/scrub through a post stream.

    • stream
    • className

    Hierarchy (View Summary)

    Index

    Constructors

    Properties

    adjustingHeight: boolean | undefined

    The attributes passed into the component.

    dragging: boolean | undefined
    element: Element

    The root DOM element for the component.

    handlers: {} | undefined
    indexStart: any
    mouseStart: any
    scrollListener: ScrollListener | undefined
    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.

    stream: any

    Methods

    • 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

    • Update the scrollbar's position to reflect the current values of the index/visible properties.

      Parameters

      • options: Partial<{ animate: boolean; forceHeightChange: boolean; fromScroll: boolean }> = {}

      Returns void