Options
All
  • Public
  • Public/Protected
  • All
Menu

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

Index

Constructors

constructor

Properties

attrs

attrs: IPostAttrs

The attributes passed into the component.

see

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

element

element: Element

The root DOM element for the component.

loading

loading: boolean = false

May be set by subclasses.

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.

subtree

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.

    final

    Parameters

    • Optional selector: string

    Returns JQuery<HTMLElement>

    the jQuery object for the DOM node

actionItems

classes

  • classes(existing?: string): string[]

content

  • content(): any

description

  • description(data: Record<string, unknown>): Children
  • Get the description text for the event.

    Parameters

    • data: Record<string, unknown>

    Returns Children

    The description to render in the DOM

descriptionData

  • descriptionData(): Record<string, unknown>

descriptionKey

  • descriptionKey(): string

elementAttrs

  • elementAttrs(): Record<string, unknown>

footerItems

icon

  • icon(): string

onbeforeremove

onbeforeupdate

oncreate

oninit

onremove

onupdate

view

Static component

  • component<SAttrs>(attrs?: SAttrs, children?: Children): Vnode<{}, {}>

Static initAttrs

  • initAttrs<T>(attrs: T): void
  • Initialize the component's attrs.

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

    Type parameters

    • T

    Parameters

    • attrs: T

    Returns void

Generated using TypeDoc version 0.22.10