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


  • stream
  • className




adjustingHeight: undefined | boolean

The attributes passed into the component.

dragging: undefined | boolean
element: Element

The root DOM element for the component.

handlers: undefined | {}

Type declaration

    indexStart: any
    mouseStart: any
    scrollListener: undefined | ScrollListener
    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


    • 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


    • Get the percentage of the height of the scrubber that should be allocated to each post.

      Returns {
          index: number;
          visible: number;

      • index: number
      • visible: number

    Generated using TypeDoc v0.24.8