The PostStream component displays an infinitely-scrollable wall of posts in a discussion. Posts that have not loaded will be displayed as placeholders.

Attrs

  • discussion
  • stream
  • targetPost
  • onPositionChange

Hierarchy

Constructors

Properties

The attributes passed into the component.

calculatePositionTimeout: undefined | Timeout
discussion: any
element: Element

The root DOM element for the component.

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

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

    • Optional selector: string

      a jQuery-compatible selector string

    Returns JQuery<HTMLElement>

    the jQuery object for the DOM node

    Final

  • Scroll down to a certain post by index.

    Parameters

    • index: number
    • animate: boolean
    • reply: boolean

      Whether or not to scroll to the reply placeholder.

    Returns JQueryDeferred<any>

  • Scroll down to the given post.

    Parameters

    • $item: JQuery<HTMLElement>
    • animate: boolean
    • force: boolean

      Whether or not to force scrolling to the item, even if it is already in the viewport.

    • reply: boolean

      Whether or not to scroll to the reply placeholder.

    Returns JQueryDeferred<any>

Generated using TypeDoc v0.24.8