The EventPost component displays a post which indicating a discussion event, like a discussion being renamed or stickied. Subclasses must implement the icon and description methods.

Attrs

  • All of the attrs for Post

Abstract

Hierarchy

Constructors

Properties

attrs: IPostAttrs

The attributes passed into the component.

See

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

element: Element

The root DOM element for the component.

loading: boolean = false

May be set by subclasses.

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.

Ensures that the post will not be redrawn unless new data comes in.

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 description text for the event.

    Returns

    The description to render in the DOM

    Parameters

    • data: Record<string, unknown>

    Returns Children

  • Get the translation data for the description of the event.

    Returns

    Returns Record<string, unknown>

  • 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