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

Attrs

  • stream
  • className

Hierarchy

Constructors

Properties

adjustingHeight: undefined | boolean

The attributes passed into the component.

See

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

dragging: undefined | boolean
element: Element

The root DOM element for the component.

handlers: undefined | {}
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

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.

    Returns

    the jQuery object for the DOM node

    Final

    Parameters

    • Optional selector: string

      a jQuery-compatible selector string

    Returns JQuery<HTMLElement>

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

    Returns

    Property

    The percent per post for posts on either side of the visible part of the scrubber.

    Property

    The percent per post for the visible part of the scrubber.

    Returns {
        index: number;
        visible: number;
    }

    • index: number
    • visible: number
  • 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

  • Initialize the component's attrs.

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

    Parameters

    • attrs: unknown

    Returns void

Generated using TypeDoc v0.23.24