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

DiscussionListItem

Extends:

Component → DiscussionListItem

The DiscussionListItem component shows a single discussion in the discussion list.

Props

  • discussion
  • params

Member Summary

Public Members
public
public

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

Method Summary

Public Methods
public

Determine whether or not the discussion is currently being viewed.

public

attrs(): {"className": *}

public

config(isInitialized: *)

public

Build an item list of info for a discussion listing.

public

init()

public

Mark the discussion as read.

public

Determine whether or not information about who started the discussion should be displayed instead of information about the most recent reply to the discussion.

public

Determine whether or not the number of replies should be shown instead of the number of unread posts.

public

view(): *

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.

Public Members

public highlightRegExp: * source

public subtree: SubtreeRetainer source

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

Public Methods

public active(): Boolean source

Determine whether or not the discussion is currently being viewed.

Return:

Boolean

public attrs(): {"className": *} source

Return:

{"className": *}

public config(isInitialized: *) source

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.

Override:

Component#config

Params:

NameTypeAttributeDescription
isInitialized *

public infoItems(): ItemList source

Build an item list of info for a discussion listing. By default this is just the first/last post indicator.

Return:

ItemList

public init() source

Called when the component is constructed.

Override:

Component#init

public markAsRead() source

Mark the discussion as read.

public showFirstPost(): Boolean source

Determine whether or not information about who started the discussion should be displayed instead of information about the most recent reply to the discussion.

Return:

Boolean

public showRepliesCount(): Boolean source

Determine whether or not the number of replies should be shown instead of the number of unread posts.

Return:

Boolean

public view(): * source

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

Override:

Component#view

Return:

*