Class PostStream

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

constructor

Properties

attrs calculatePositionTimeout discussion element scrollListener state stream

Methods

$ calculatePosition flashItem getMarginTop loadPostsIfNeeded onbeforeremove onbeforeupdate oncreate oninit onremove onscroll onupdate scrollToIndex scrollToItem scrollToNumber triggerScroll updateScrubber view component initAttrs

Constructors

constructor

Properties

attrs

attrs: ComponentAttrs

The attributes passed into the component.

See

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

calculatePositionTimeout

calculatePositionTimeout: undefined | Timeout

discussion

discussion: any

element

element: Element

The root DOM element for the component.

scrollListener

scrollListener: undefined | ScrollListener

state

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

stream: any

Methods

$

  • $(selector?: string): JQuery<HTMLElement>

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

    Returns

    the jQuery object for the DOM node

    Final

    Parameters

    • Optional selector: string

      a jQuery-compatible selector string

    Returns JQuery<HTMLElement>

calculatePosition

  • Work out which posts (by number) are currently visible in the viewport, and fire an event with the information.

    Parameters

    • top: number = window.pageYOffset

    Returns void

flashItem

getMarginTop

  • Get the distance from the top of the viewport to the point at which we would consider a post to be the first one visible.

    Returns

    Returns number

loadPostsIfNeeded

  • Check if either extreme of the post stream is in the viewport, and if so, trigger loading the next/previous page.

    Parameters

    • top: number = window.pageYOffset

    Returns void

onbeforeremove

onbeforeupdate

oncreate

oninit

onremove

onscroll

onupdate

scrollToIndex

  • Scroll down to a certain post by index.

    Returns

    Parameters

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

      Whether or not to scroll to the reply placeholder.

    Returns JQueryDeferred<any>

scrollToItem

  • Scroll down to the given post.

    Returns

    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>

scrollToNumber

  • Scroll down to a certain post by number and 'flash' it.

    Returns

    Parameters

    • number: number
    • animate: boolean

    Returns JQueryDeferred<any>

triggerScroll

updateScrubber

view

Static component

Static initAttrs

  • Initialize the component's attrs.

    This can be used to assign default values for missing, optional attrs.

    Parameters

    • attrs: unknown

    Returns void

Settings

Member Visibility

Theme

Generated using TypeDoc v0.23.24