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

    Class MessagesPageHero<CustomAttrs>

    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!'));

    https://mithril.js.org/components.html

    Type Parameters

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Methods

    bodyItems className contentItems

    Constructors

    Methods

    • Defines the child elements that will be rendered within the main container of the hero. Subclasses MUST implement this method to define the specific content of the hero.

      Returns ItemList<Children>

      bodyItems(): ItemList<Mithril.Children> {
        const items = new ItemList<Mithril.Children>();
        items.add('title', <h1>Welcome!</h1>);
        return items;
      }

    Settings

    Member Visibility

    On This Page

    Constructors
    Methods