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

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

    Type Parameters

    Hierarchy (View Summary)

    Index

    The attributes passed into the component.

    element: Element

    The root DOM element for the component.

    renderedHtml: string | null = null

    The HTML string last handed to Mithril, or null while editing. Mithril re-inserts the HTML whenever it changes, inert scripts included.

    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.

    • 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.

      Parameters

      • Optionalselector: string

        a jQuery-compatible selector string

      Returns JQuery

      the jQuery object for the DOM node

    • The post HTML to render, before search highlighting. Override it to transform the markup: extend can't change a string return value.

      Not called while the post is being edited. The result is rendered as trusted HTML. Posts and messages rebuild it when their own state changes, not on every redraw, so return the same HTML for the same input and cache costly work on it.

      Returns string