mirror of
https://github.com/flarum/core.git
synced 2025-08-06 08:27:42 +02:00
Fragment: Update documentation
This commit is contained in:
@@ -1,12 +1,16 @@
|
|||||||
import * as Mithril from 'mithril';
|
import * as Mithril from 'mithril';
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* The `Fragment` class provides a wrapper class for Mithril components to be used with m.render().
|
* The `Fragment` class represents a chunk of DOM that is rendered once with Mithril and then takes
|
||||||
* This is very similar to the `Component` wrapper class, but is used for more fine-grained control over
|
* over control of its own DOM and lifecycle.
|
||||||
* the rendering and display of some significant chunks of the DOM.
|
|
||||||
*
|
*
|
||||||
* The main benefit of using this wrapper class as opposed to Mithril components directly
|
* This is very similar to the `Component` wrapper class, but is used for more fine-grained control over
|
||||||
* is that it stores the vnode DOM, and provides a `$()` method allowing manipulation of said DOM.
|
* the rendering and display of some significant chunks of the DOM. In contrast to components, fragments
|
||||||
|
* do not offer Mithril's lifecycle hooks.
|
||||||
|
*
|
||||||
|
* Use this when you want to enjoy the benefits of JSX / VDOM for initial rendering, combined with
|
||||||
|
* small helper methods that then make updates to that DOM directly, instead of fully redrawing
|
||||||
|
* everything through Mithril.
|
||||||
*
|
*
|
||||||
* This should only be used when necessary, and only with `m.render`. If you are unsure whether you need
|
* This should only be used when necessary, and only with `m.render`. If you are unsure whether you need
|
||||||
* this or `Component, you probably need `Component`.
|
* this or `Component, you probably need `Component`.
|
||||||
|
Reference in New Issue
Block a user