[DOC] component: add a section on semantics

closes #89
This commit is contained in:
Géry Debongnie
2019-05-08 11:59:40 +02:00
parent f7f8c34e1c
commit 2f70a7a352
+88 -3
View File
@@ -9,6 +9,7 @@
- [Properties](#properties)
- [Methods](#methods)
- [Lifecycle](#lifecycle)
- [Semantics](#semantics)
## Overview
@@ -113,10 +114,8 @@ with a class object:
```js
<t t-widget="MyWidget" t-att-class="{a: state.flagA, b: state.flagB}" />
```
## Reference
An Owl component is a small class which represent a widget or some UI element.
@@ -197,7 +196,7 @@ developers write components. Here is a complete description of the lifecycle of
a owl component:
| Method | Description |
| ------------------------------------------------ | --------------------------------------- |
| ------------------------------------------------ | ----------------------------------------------------- |
| **[constructor](#constructor)** | constructor |
| **[willStart](#willStart)** | async, before first rendering |
| **[mounted](#mounted)** | just after component is rendered and added to the DOM |
@@ -345,3 +344,89 @@ the DOM. This is a good place to remove some listeners, for example.
```
This is the opposite method of `mounted`.
### Semantics
We give here an informal description of the way components are created/updated
in an application. Here, ordered lists describe actions that are executed
sequentially, bullet lists describe actions that are executed in parallel.
**Scenario 1: Initial Mounting** Imagine we want to render the following component tree:
```
A
/ \
B C
/ \
D E
```
Here is what happen whenever we mount the root
component (with some code like `app.mount(document.body)`).
1. `willStart` is called on `A`
2. when it is done, template `A` is rendered.
- widget `B` is created
1. `willStart` is called on `B`
2. template `B` is rendered
- widget `C` is created
1. `willStart` is called on `C`
2. template `C` is rendered
- widget `D` is created
1. `willStart` is called on `D`
2. template `D` is rendered
- widget `E` is created
1. `willStart` is called on `E`
2. template `E` is rendered
3. widget `A` is patched into a detached DOM element. This will create the actual
widget `A` DOM structure. The patching process will cause recursively the
patching of the `B`, `C`, `D` and `E` DOM trees. (so the actual full DOM tree is created
in one pass)
4. the widget `A` root element is actually appended to `document.body`
5. The method `mounted` is called recursively on all widgets in the following
order: `B`, `D`, `E`, `C`, `A`.
**Scenario 2: state change, rerendering**. Now, let's assume that the user clicked on some
button in `C`, and this results in a state update, which is supposed to:
- update `D`,
- remove `E`,
- add new widget `F`.
So, the component tree should look like this:
```
A
/ \
B C
/ \
D F
```
Here is what Owl will do:
1. because of a state change, the method `render` is called on `C`
2. template `C` is rendered again
- widget `D` is updated:
1. hook `willUpdateProps` is called on `D` (async)
2. template `D` is rerendered
- widget `F` is created:
1. hook `willStart` is called on `E` (async)
2. template `F` is rerendered
3. `willPatch` hooks are called recursively on widgets `C`, `D` (not on `F`,
because it is not mounted yet)
4. widget `C` is patched, which will cause recursively:
1. patching of `D`,
2. `willUnmount` hook on `E`, then destruction of `E`,
3. (initial) patching of `F`, then hook `mounted` is called on `F`
5. `patched` hooks are called on `D`, `C`