Reference Source
import EventPost from 'flarum/components/EventPost'
public class | source

EventPost

Extends:

ComponentPost → EventPost

Direct Subclass:

DiscussionRenamedPost

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.

Props

  • All of the props for Post

Method Summary

Public Methods
public

attrs(): *

public

content(): *

public

Get the description text for the event.

public

Get the translation data for the description of the event.

public

Get the translation key for the description of the event.

public

Get the name of the event icon.

Inherited Summary

From class Component
public static

component(props: Object, children: *): Object

Get a Mithril component object for this component, preloaded with props.

public static

initProps(props: Object)

Initialize the component's props.

public

element: *

The root DOM element for the component.

public

The properties passed into the component.

public

Whether or not to retain the component's subtree on redraw.

public

$(selector: String): jQuery

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.

public

config(isInitialized: Boolean, context: Object, vdom: Object)

Called after the component's root element is redrawn. This hook can be used to perform any actions on the DOM, both on the initial draw and any subsequent redraws. See Mithril's documentation for more information.

public

Called when the component is destroyed, i.e.

public

Get the renderable virtual DOM that represents the component's view.

This should NOT be overridden by subclasses. Subclasses wishing to define their virtual DOM should override Component#view instead.

protected

init()

Called when the component is constructed.

protected

Get the virtual DOM that represents the component's view.

From class Post
public
public

Set up a subtree retainer so that the post will not be redrawn unless new data comes in.

public

Build an item list for the post's actions.

public

Get attributes for the post element.

public

config(isInitialized: *)

public

Get the post's content.

public

Build an item list for the post's footer.

public

init()

public

view(): *

Public Methods

public attrs(): * source

Get attributes for the post element.

Override:

Post#attrs

Return:

*

public content(): * source

Get the post's content.

Override:

Post#content

Return:

*

public description(data: Object): String | Object source

Get the description text for the event.

Params:

NameTypeAttributeDescription
data Object

Return:

String | Object

The description to render in the DOM

public descriptionData(): Object source

Get the translation data for the description of the event.

Return:

Object

public descriptionKey(): String source

Get the translation key for the description of the event.

Return:

String

public icon(): String source

Get the name of the event icon.

Return:

String