Flarum (2.x)
    Preparing search index...

    The Component class defines a user interface 'building block'. A component generates a virtual DOM to be rendered on each redraw.

    Essentially, this is a wrapper for Mithril's components that adds several useful features:

    • In the oninit and onbeforeupdate lifecycle hooks, we store vnode attrs in `this.attrs. This allows us to use attrs across components without having to pass the vnode to every single method.
    • The static initAttrs method allows a convenient way to provide defaults (or to otherwise modify) the attrs that have been passed into a component.
    • When the component is created in the DOM, we store its DOM element under this.element; this lets us use jQuery to modify child DOM state from internal methods via the this.$() method.
    • A convenience component method, which serves as an alternative to hyperscript and JSX.

    As with other Mithril components, components extending Component can be initialized and nested using JSX, hyperscript, or a combination of both. The component method can also be used.

    return m('div', <MyComponent foo="bar"><p>Hello World</p></MyComponent>);
    
    return m('div', MyComponent.component({foo: 'bar'), m('p', 'Hello World!'));
    

    Type Parameters

    Hierarchy (View Summary)

    Index
    loading: boolean = false
    near: number | null = null

    The permalinked message, taken from the route once. The stream drops it from the address after opening on it, and the route's own copy would still say it afterwards.

    HEADER_AVATARS: number = 3

    How many of a group's groups and members the header shows before counting the rest.

    • Whether to say the other member can't reply: they can't send messages, and the viewer can't send here either. Not to viewers who can't send at all, who aren't told whether anyone else can. Never in a group, where the others still can.

      Returns boolean