2019-04-24 11:54:26 +02:00
# 🦉 OWL Component 🦉
2019-03-14 12:51:19 +01:00
2019-04-24 11:54:26 +02:00
## Content
- [Overview ](#overview )
- [Example ](#example )
- [Reference ](#reference )
2019-09-26 17:04:42 +02:00
- [Reactive System ](#reactive-system )
2019-04-24 11:54:26 +02:00
- [Properties ](#properties )
2019-05-28 09:54:25 +02:00
- [Static Properties ](#static-properties )
2019-04-24 11:54:26 +02:00
- [Methods ](#methods )
- [Lifecycle ](#lifecycle )
2019-06-22 14:44:09 +02:00
- [Root Component ](#root-component )
2019-06-04 13:16:50 +02:00
- [Composition ](#composition )
- [Event Handling ](#event-handling )
2019-06-14 15:45:16 +02:00
- [Form Input Bindings ](#form-input-bindings )
2019-06-14 15:24:04 +02:00
- [References ](#references )
2019-06-11 15:02:10 +02:00
- [Slots ](#slots )
2019-11-11 17:31:34 +01:00
- [Dynamic sub components ](#dynamic-sub-components )
2019-07-09 14:33:56 +02:00
- [Error Handling ](#error-handling )
2019-09-26 17:04:42 +02:00
- [Functional Components ](#functional-components )
2019-10-02 16:40:13 +02:00
- [SVG components ](#svg-components )
2019-04-24 11:54:26 +02:00
## Overview
OWL components are the building blocks for user interface. They are designed to be:
2019-04-23 15:26:00 +02:00
2019-10-17 09:50:03 +02:00
1. **declarative: ** the user interface should be described in terms of the state
2019-04-23 15:26:00 +02:00
of the application, not as a sequence of imperative steps.
2019-06-20 09:42:33 +02:00
2. **composable: ** each component can seamlessly be created in a parent component by
a simple tag or directive in its template.
2019-04-23 15:26:00 +02:00
3. **asynchronous rendering: ** the framework will transparently wait for each
2019-06-20 09:42:33 +02:00
sub components to be ready before applying the rendering. It uses native promises
2019-04-23 15:26:00 +02:00
under the hood.
4. **uses QWeb as a template system: ** the templates are described in XML
and follow the QWeb specification. This is a requirement for Odoo.
2019-04-24 11:54:26 +02:00
OWL components are defined as a subclass of Component. The rendering is
2019-11-11 17:31:34 +01:00
exclusively done by a [QWeb ](qweb_templating_language.md ) template (which needs to be preloaded in QWeb).
2019-05-11 12:11:00 +02:00
Rendering a component generates a virtual dom representation
2019-06-20 09:42:33 +02:00
of the component, which is then patched to the DOM, in order to apply the changes in an efficient way.
2019-04-25 15:28:20 +02:00
2019-04-24 11:54:26 +02:00
## Example
2019-03-14 14:23:27 +01:00
2019-04-24 11:54:26 +02:00
Let us have a look at a simple component:
2019-03-14 14:23:27 +01:00
2019-04-24 11:54:26 +02:00
``` javascript
2019-09-24 14:06:53 +02:00
const { useState } = owl . hooks ;
2019-04-24 11:54:26 +02:00
class ClickCounter extends owl . Component {
2019-09-24 14:06:53 +02:00
state = useState ( { value : 0 } ) ;
2019-03-14 14:23:27 +01:00
2019-04-24 11:54:26 +02:00
increment ( ) {
this . state . value ++ ;
2019-03-14 14:23:27 +01:00
}
}
```
2019-04-05 23:44:07 +02:00
``` xml
2019-05-14 23:34:28 +02:00
<button t-name= "ClickCounter" t-on-click= "increment" >
2019-04-24 11:54:26 +02:00
Click Me! [<t t-esc= "state.value" /> ]
</button>
2019-04-05 23:44:07 +02:00
```
2019-04-24 11:54:26 +02:00
Note that this code is written in ESNext style, so it will only run on the
latest browsers without a transpilation step.
2019-04-05 23:44:07 +02:00
2019-10-17 09:50:03 +02:00
This example shows how a component should be defined: it simply subclasses the
2019-09-12 09:45:32 +02:00
Component class. If no static `template` key is defined, then
2019-05-14 23:34:28 +02:00
Owl will use the component's name as template name. Here,
2019-09-24 14:06:53 +02:00
a state object is defined, by using the `useState` hook. It is not mandatory to use the state object, but it is certainly encouraged. The result of the `useState` call is
[observed ](observer.md ), and any change to it will cause a rerendering.
2019-09-26 17:04:42 +02:00
## Reference
2019-10-17 09:50:03 +02:00
An Owl component is a small class which represents a component or some UI element.
2019-10-30 10:22:59 +01:00
It exists in the context of an [environment ](environment.md ) (`env` ), which is propagated from a
2019-11-11 17:31:34 +01:00
parent to its children. The environment needs to have a [QWeb ](qweb_templating_language.md ) instance, which
2019-09-26 17:04:42 +02:00
will be used to render the component template.
Be aware that the name of the component may be significant: if a component does
not define a `template` key, then Owl will lookup in QWeb to
2019-10-17 09:50:03 +02:00
find a template with the component name (or one of its ancestors).
2019-09-26 17:04:42 +02:00
### Reactive system
2019-09-24 14:06:53 +02:00
2019-10-20 09:01:38 +02:00
OWL components are normal javascript classes. So, changing a component internal
2019-10-17 09:50:03 +02:00
state does nothing more:
2019-09-24 14:06:53 +02:00
2019-10-17 09:50:03 +02:00
``` js
class Counter extends Component {
2019-10-20 09:01:38 +02:00
static template = xml ` <div t-on-click="increment"><t t-esc="state.value"/></div> ` ;
state = { value : 0 } ;
2019-10-17 09:50:03 +02:00
2019-10-20 09:01:38 +02:00
increment ( ) {
this . state . value ++ ;
}
2019-10-17 09:50:03 +02:00
}
```
Clicking on the `Counter` component defined above will call the `increment`
2019-10-20 09:01:38 +02:00
method, but it will not rerender the component. To fix that, one could add an
2019-10-17 09:50:03 +02:00
explicit call to `render` in `increment` :
``` js
increment ( ) {
this . state . value ++ ;
this . render ( ) ;
}
```
However, it may be simple in this case, but it quickly become cumbersome, as a
component get more complex, and its internal state is modified by more than one
method.
A better way is to use the reactive system: by using the `useState` hook (see the
[hooks ](hooks.md ) section for more details), one can make Owl react to state
2019-10-20 09:01:38 +02:00
changes. The `useState` hook generates a proxy version of an object
2019-09-24 14:06:53 +02:00
(this is done by an [observer ](observer.md )), which allows the component to
2019-10-17 09:50:03 +02:00
react to any change. So, the `Counter` example above can be improved like this:
2019-09-24 14:06:53 +02:00
2019-10-17 09:50:03 +02:00
``` js
2019-09-24 14:06:53 +02:00
const { useState } = owl . hooks ;
2019-10-17 09:50:03 +02:00
class Counter extends Component {
2019-10-20 09:01:38 +02:00
static template = xml ` <div t-on-click="increment"><t t-esc="state.value"/></div> ` ;
state = useState ( { value : 0 } ) ;
2019-10-17 09:50:03 +02:00
2019-10-20 09:01:38 +02:00
increment ( ) {
this . state . value ++ ;
}
2019-09-24 14:06:53 +02:00
}
```
2019-10-17 09:50:03 +02:00
Obviously, we can call the `useState` hook more than once:
2019-10-20 09:01:38 +02:00
2019-10-17 09:50:03 +02:00
``` js
const { useState } = owl . hooks ;
class Counter extends Component {
2019-10-20 09:01:38 +02:00
static template = xml `
2019-10-17 09:50:03 +02:00
<div>
<span t-on-click="increment(counter1)"><t t-esc="counter1.value"/></span>
<span t-on-click="increment(counter2)"><t t-esc="counter2.value"/></span>
</div> ` ;
2019-10-20 09:01:38 +02:00
counter1 = useState ( { value : 0 } ) ;
counter2 = useState ( { value : 0 } ) ;
2019-10-17 09:50:03 +02:00
2019-10-20 09:01:38 +02:00
increment ( counter ) {
counter . value ++ ;
}
2019-10-17 09:50:03 +02:00
}
```
Note that hooks are subject to one important [rule ](hooks.md#one-rule ): they need
to be called in the constructor.
2019-04-24 11:54:26 +02:00
### Properties
- **`el` ** (HTMLElement | null): reference to the DOM root node of the element. It is `null` when the
component is not mounted.
2019-11-11 17:31:34 +01:00
- **`env` ** (Object): the component [environment ](environment.md ), which contains a QWeb instance.
2019-04-24 11:54:26 +02:00
2019-10-17 09:50:03 +02:00
- **`props` ** (Object): this is an object containing all the properties given by
2019-10-20 09:01:38 +02:00
the parent to a child component. For example, in the following situation,
2019-10-17 09:50:03 +02:00
the parent component gives a `user` and a `color` value to the `ChildComponent` .
```xml
<div>
<ChildComponent user="state.user" color="color">
</div>
` ``
Note that ` props` are owned by the parent, not by the component.
As such, it should not ever be modified by the component (otherwise you risk
unintended effects, since the parent may not be aware of the change)!!
2019-10-20 09:01:38 +02:00
The ` props` can be modified dynamically by the parent. In that case, the
2019-10-17 09:50:03 +02:00
component will go through the following lifecycle methods: ` willUpdateProps`,
` willPatch` and ` patched`.
2019-04-24 11:54:26 +02:00
2019-05-28 09:54:25 +02:00
### Static Properties
2019-09-12 09:45:32 +02:00
- **` template`** (string, optional): if given, this is the name of the QWeb template that will render the component. Note that there is a helper ` xml` to
make it easy to define an inline template.
* **` components`** (Object, optional): if given, this is an object that contains
2019-09-10 22:37:08 +02:00
the classes of any sub components needed by the template. This is the main way
used by Owl to be able to create sub components.
` ``js
class ParentComponent extends owl.Component {
2019-09-11 14:01:49 +02:00
static components = { SubComponent };
2019-09-10 22:37:08 +02:00
}
` ``
2019-09-12 09:45:32 +02:00
* **` props`** (Object, optional): if given, this is an object that describes the
2019-05-28 09:54:25 +02:00
type and shape of the (actual) props given to the component. If Owl mode is
` dev`, this will be used to validate the props each time the component is
2019-11-30 21:36:41 +01:00
created/updated. See [Props Validation](props_validation.md) for more information.
2019-06-28 12:59:27 +02:00
` ``js
class Counter extends owl.Component {
2019-06-28 15:48:33 +02:00
static props = {
initialValue: Number,
optional: true
};
2019-06-28 12:59:27 +02:00
}
` ``
2019-09-12 09:45:32 +02:00
- **` defaultProps`** (Object, optional): if given, this object define default
2019-05-28 09:54:25 +02:00
values for (top-level) props. Whenever ` props` are given to the object, they
will be altered to add default value (if missing). Note that it does not
change the initial object, a new object will be created instead.
2019-06-28 12:59:27 +02:00
` ``js
class Counter extends owl.Component {
2019-06-28 15:48:33 +02:00
static defaultProps = {
initialValue: 0
};
2019-06-28 12:59:27 +02:00
}
` ``
2019-10-13 08:33:51 +02:00
There is another static property defined on the ` Component` class: ` current`.
This property is set to the currently being defined component (in the constructor).
This is the way [hooks](hooks.md) are able to get a reference to the target
component.
2019-04-24 11:54:26 +02:00
### Methods
2019-06-24 13:02:12 +02:00
We explain here all the public methods of the ` Component` class.
2019-11-05 09:05:05 +01:00
- **` mount(target)`** (async): this is the main way a
2019-08-28 10:02:38 +02:00
component is added to the DOM: the root component is mounted to a target
2019-11-22 14:49:37 +01:00
HTMLElement (or document fragment). Obviously, this is asynchronous, since each children need to be
2019-08-28 10:02:38 +02:00
created as well. Most applications will need to call ` mount` exactly once, on
the root component.
2019-04-24 11:54:26 +02:00
2019-11-05 09:05:05 +01:00
Note that if a component is mounted, unmounted and remounted, it will be
automatically re-rendered to ensure that changes in its state (or something
in the environment, or in the store, or ...) will be taken into account.
2019-08-22 13:32:53 +02:00
2019-11-22 14:49:37 +01:00
If a component is mounted inside an element or a fragment which is not in the
DOM, then it will be rendered fully, but not active: the ` mounted` hooks will
not be called. This is sometimes useful if we want to load an application in
memory. In that case, we need to mount the root component again in an element
which is in the DOM:
` ``js
const app = new App();
await app.mount(document.createDocumentFragment());
// app is rendered in memory, but not active
await app.mount(document.body);
// app is now visible
` ``
2019-10-17 09:50:03 +02:00
- **` unmount()`**: in case a component needs to be detached/removed from the DOM, this
2019-04-24 11:54:26 +02:00
method can be used. Most applications should not call ` unmount`, this is more
useful to the underlying component system.
- **` render()`** (async): calling this method directly will cause a rerender. Note
that this should be very rare to have to do it manually, the Owl framework is
most of the time responsible for doing that at an appropriate moment.
2019-04-25 15:28:20 +02:00
Note that the render method is asynchronous, so one cannot observe the updated
DOM in the same stack frame.
2019-04-24 11:54:26 +02:00
- **` shouldUpdate(nextProps)`**: this method is called each time a component's props
2019-06-20 09:42:33 +02:00
are updated. It returns a boolean, which indicates if the component should
2019-04-24 11:54:26 +02:00
ignore a props update. If it returns false, then ` willUpdateProps` will not
be called, and no rendering will occur. Its default implementation is to
always return true. This is an optimization, similar to React's ` shouldComponentUpdate`. Most of the time, this should not be used, but it
can be useful if we are handling large number of components.
- **` destroy()`**. As its name suggests, this method will remove the component,
and perform all necessary cleanup, such as unmounting the component, its children,
removing the parent/children relationship. This method should almost never be
called directly (except maybe on the root component), but should be done by the
framework instead.
2019-06-24 13:02:12 +02:00
Obviously, these methods are reserved for Owl, and should not be used by Owl
2019-06-28 15:48:33 +02:00
users, unless they want to override them. Also, Owl reserves all method names
2019-06-24 13:02:12 +02:00
starting with ` __`, in order to prevent possible future conflicts with user code
whenever Owl needs to change.
2019-04-24 11:54:26 +02:00
### Lifecycle
A solid and robust component system needs useful hooks/methods to help
developers write components. Here is a complete description of the lifecycle of
a owl component:
2019-07-09 14:33:56 +02:00
| Method | Description |
| ------------------------------------------------ | ------------------------------------------------------------ |
| **[constructor](#constructorparent-props)** | constructor |
| **[willStart](#willstart)** | async, before first rendering |
| **[mounted](#mounted)** | just after component is rendered and added to the DOM |
| **[willUpdateProps](#willupdatepropsnextprops)** | async, before props update |
| **[willPatch](#willpatch)** | just before the DOM is patched |
| **[patched](#patchedsnapshot)** | just after the DOM is patched |
| **[willUnmount](#willunmount)** | just before removing component from DOM |
| **[catchError](#catcherrorerror)** | catch errors (see [error handling section](#error-handling)) |
2019-04-05 23:44:07 +02:00
2019-04-29 12:07:20 +02:00
Notes:
- hooks call order is precisely defined: ` [willX]` hooks are called first on parent,
then on children, and ` [Xed]` are called in the reverse order: first children,
then parent.
- no hook method should ever be called manually. They are supposed to be
2019-05-08 11:59:40 +02:00
called by the owl framework whenever it is required.
2019-04-05 23:44:07 +02:00
2019-04-24 11:54:26 +02:00
#### ` constructor(parent, props)`
2019-04-05 23:44:07 +02:00
2019-04-24 11:54:26 +02:00
The constructor is not exactly a hook, it is the regular,
normal, constructor of the component. Since it is not a hook, you need to make
sure that ` super` is called.
2019-04-05 23:44:07 +02:00
2019-04-24 11:54:26 +02:00
This is usually where you would set the initial state and the template of the
component.
2019-04-05 23:44:07 +02:00
2019-04-24 11:54:26 +02:00
` ``javascript
constructor(parent, props) {
super(parent, props);
2019-09-24 14:06:53 +02:00
this.state = useState({someValue: true});
2019-04-24 11:54:26 +02:00
this.template = 'mytemplate';
}
` ``
Note that with ESNext class fields, the constructor method does not need to be
implemented in most cases:
` ``javascript
class ClickCounter extends owl.Component {
2019-09-24 14:06:53 +02:00
state = useState({ value: 0 });
2019-04-24 11:54:26 +02:00
...
}
` ``
#### ` willStart()`
willStart is an asynchronous hook that can be implemented to
perform some action before the initial rendering of a component.
2019-04-05 23:44:07 +02:00
It will be called exactly once before the initial rendering. It is useful
in some cases, for example, to load external assets (such as a JS library)
2019-06-20 09:42:33 +02:00
before the component is rendered. Another use case is to load data from a server.
2019-04-05 23:44:07 +02:00
2019-04-24 11:54:26 +02:00
` ``javascript
2019-04-29 11:21:02 +02:00
async willStart() {
await owl.utils.loadJS("my-awesome-lib.js");
2019-04-24 11:54:26 +02:00
}
` ``
At this point, the component is not yet rendered. Note that a slow ` willStart` method will slow down the rendering of the user
interface. Therefore, some care should be made to make this method as
2019-04-05 23:44:07 +02:00
fast as possible.
2019-04-24 11:54:26 +02:00
#### ` mounted()`
` mounted` is called each time a component is attached to the
DOM, after the initial rendering and possibly later if the component was unmounted
and remounted. At this point, the component is considered _active_. This is a good place to add some listeners, or to interact with the
2019-04-05 23:44:07 +02:00
DOM, if the component needs to perform some measure for example.
2019-04-24 11:54:26 +02:00
It is the opposite of ` willUnmount`. If a component has been mounted, it will
always be unmounted at some point in the future.
The mounted method will be called recursively on each of its children. First,
the parent, then all its children.
2019-04-05 23:44:07 +02:00
2019-09-24 14:06:53 +02:00
It is allowed (but not encouraged) to modify the state in the ` mounted` hook.
Doing so will cause a rerender, which will not be perceptible by the user, but
will slightly slow down the component.
2019-04-24 11:54:26 +02:00
#### ` willUpdateProps(nextProps)`
2019-04-09 13:51:04 +02:00
The willUpdateProps is an asynchronous hook, called just before new props
2019-10-27 20:23:02 +01:00
are set. This is useful if the component needs to perform an asynchronous task,
depending on the props (for example, assuming that the props are
2019-04-09 13:51:04 +02:00
some record Id, fetching the record data).
2019-04-24 11:54:26 +02:00
` ``javascript
willUpdateProps(nextProps) {
return this.loadData({id: nextProps.id});
}
` ``
2019-04-09 13:51:04 +02:00
This hook is not called during the first render (but willStart is called
and performs a similar job).
2019-04-24 11:54:26 +02:00
#### ` willPatch()`
2019-04-05 23:44:07 +02:00
The willPatch hook is called just before the DOM patching process starts.
2019-10-27 20:23:02 +01:00
It is not called on the initial render. This is useful to read
2019-04-24 11:54:26 +02:00
information from the DOM. For example, the current position of the
scrollbar.
2019-09-24 14:06:53 +02:00
Note that modifying the state is not allowed here. This method is called just
2019-04-24 11:54:26 +02:00
before an actual DOM patch, and is only intended to be used to save some local
2019-10-30 15:15:32 +01:00
DOM state. Also, it will not be called if the component is not in the DOM.
2019-04-05 23:44:07 +02:00
2019-04-25 14:46:04 +02:00
#### ` patched(snapshot)`
2019-04-05 23:44:07 +02:00
2019-04-24 11:54:26 +02:00
This hook is called whenever a component did actually update its DOM (most
likely via a change in its state/props or environment).
2019-04-05 23:44:07 +02:00
This method is not called on the initial render. It is useful to interact
with the DOM (for example, through an external library) whenever the
2019-06-20 09:42:33 +02:00
component was patched. Note that this hook will not be called if the compoent is
2019-10-30 15:15:32 +01:00
not in the DOM.
2019-04-05 23:44:07 +02:00
2019-10-17 09:50:03 +02:00
Updating the component state in this hook is possible, but not encouraged.
2019-10-20 09:01:38 +02:00
One needs to be careful, because updates here will create an additional rendering, which in
turn will cause other calls to the ` patched` method. So, we need to be particularly
2019-04-05 23:44:07 +02:00
careful at avoiding endless cycles.
2019-04-24 11:54:26 +02:00
#### ` willUnmount()`
2019-04-05 23:44:07 +02:00
2019-04-09 12:57:34 +02:00
willUnmount is a hook that is called each time just before a component is unmounted from
2019-10-27 20:23:02 +01:00
the DOM. This is a good place to remove listeners, for example.
2019-04-05 23:44:07 +02:00
2019-04-24 11:54:26 +02:00
` ``javascript
mounted() {
this.env.bus.on('someevent', this, this.doSomething);
}
willUnmount() {
this.env.bus.off('someevent', this, this.doSomething);
}
` ``
2019-05-04 13:50:43 +02:00
This is the opposite method of ` mounted`.
2019-05-08 11:59:40 +02:00
2019-07-09 14:33:56 +02:00
#### ` catchError(error)`
The ` catchError` method is useful when we need to intercept and properly react
to (rendering) errors that occur in some sub components. See the section on
2019-10-20 09:01:38 +02:00
[error handling](#error-handling).
2019-07-09 14:33:56 +02:00
2019-06-22 14:44:09 +02:00
### Root Component
Most of the time, an Owl component will be created automatically by a tag (or the ` t-component`
directive) in a template. There is however an obvious exception: the root component
of an Owl application has to be created manually:
` ``js
class App extends owl.Component { ... }
2019-10-30 10:22:59 +01:00
const app = new App();
2019-06-22 14:44:09 +02:00
app.mount(document.body);
` ``
2019-11-01 07:58:25 +01:00
The root component does not have a parent nor ` props` (see note below). It will be setup with an
2019-10-31 22:45:22 +01:00
[environment](environment.md) (either the ` env` defined on its class, or a
default empty environment).
2019-06-22 14:44:09 +02:00
2019-11-01 07:58:25 +01:00
Note: a root component can however be given a ` props` object in its constructor,
2019-11-02 19:45:28 +01:00
like this: ` new App(null, {some: 'object'});`. It will not be a true ` props`
2019-11-01 07:58:25 +01:00
object, managed by Owl (so, for example, it will never be updated).
2019-06-14 10:17:13 +02:00
### Composition
2019-06-04 13:16:50 +02:00
2019-06-18 09:24:52 +02:00
The example above shows a QWeb template with a sub component. In a template,
components are declared with a tagname corresponding to the class name. It has
to be capitalized.
2019-06-04 13:16:50 +02:00
` ``xml
2019-06-20 09:42:33 +02:00
<div t-name="ParentComponent">
2019-06-04 13:16:50 +02:00
<span>some text</span>
2019-06-20 09:42:33 +02:00
<MyComponent info="13" />
2019-06-04 13:16:50 +02:00
</div>
` ``
` ``js
2019-06-20 09:42:33 +02:00
class ParentComponent extends owl.Component {
2019-09-10 22:37:08 +02:00
static components = { MyComponent: MyComponent};
2019-06-04 13:16:50 +02:00
...
}
` ``
2019-06-20 09:42:33 +02:00
In this example, the ` ParentComponent`'s template creates a component ` MyComponent` just
after the span. The ` info` key will be added to the subcomponent's ` props`. Each
2019-06-18 09:24:52 +02:00
` props` is a string which represents a javascript (QWeb) expression, so it is
2019-06-04 13:16:50 +02:00
dynamic. If it is necessary to give a string, this can be done by quoting it:
2019-06-22 14:44:09 +02:00
` someString="'somevalue'"`.
2019-06-04 13:16:50 +02:00
2019-06-20 09:42:33 +02:00
Note that the rendering context for the template is the component itself. This means
2019-09-24 14:06:53 +02:00
that the template can access ` state` (if it exists), ` props`, ` env`, or any
methods defined in the component.
2019-06-04 13:16:50 +02:00
` ``xml
2019-06-20 09:42:33 +02:00
<div t-name="ParentComponent">
<ChildComponent count="state.val" />
2019-06-04 13:16:50 +02:00
</div>
` ``
` ``js
2019-06-20 09:42:33 +02:00
class ParentComponent {
2019-09-10 22:37:08 +02:00
static components = { ChildComponent };
2019-09-24 14:06:53 +02:00
state = useState({ val: 4 });
2019-06-04 13:16:50 +02:00
}
` ``
2019-06-20 09:42:33 +02:00
Whenever the template is rendered, it will automatically create the subcomponent
` ChildComponent` at the correct place. It needs to find the reference to the
2019-09-10 22:37:08 +02:00
actual component class in the special static ` components` key, or the class registered in
2019-06-04 13:16:50 +02:00
QWeb's global registry (see ` register` function of QWeb). It first looks inside
2019-09-10 22:37:08 +02:00
the static ` components` key, then fallbacks on the global registry.
2019-06-04 13:16:50 +02:00
2019-06-20 09:42:33 +02:00
_Props_: In this example, the child component will receive the object ` {count: 4}` in its
2019-06-04 13:16:50 +02:00
constructor. This will be assigned to the ` props` variable, which can be accessed
2019-06-20 09:42:33 +02:00
on the component (and also, in the template). Whenever the state is updated, then
2019-11-11 17:31:34 +01:00
the sub component will also be updated automatically. See the [props section](props.md)
for more information.
2019-09-21 09:28:56 +02:00
2019-10-27 20:23:02 +01:00
**CSS and style:** Owl allows the parent to declare
2019-06-20 09:42:33 +02:00
additional css classes or style for the sub component: css declared in ` class`, ` style`, ` t-att-class` or ` t-att-style` will be added to the
root component element.
2019-06-04 13:16:50 +02:00
` ``xml
2019-06-20 09:42:33 +02:00
<div t-name="ParentComponent">
<MyComponent class="someClass" style="font-weight:bold;" info="13" />
2019-06-04 13:16:50 +02:00
</div>
` ``
Warning: there is a small caveat with dynamic class attributes: since Owl needs
to be able to add/remove proper classes whenever necessary, it needs to be aware
of the possible classes. Otherwise, it will not be able to make the difference
2019-10-27 20:23:02 +01:00
between a valid css class added by the component, or other custom code, and a
2019-06-04 13:16:50 +02:00
class that need to be removed. This is why we only support the explicit syntax
with a class object:
` ``xml
2019-06-20 09:42:33 +02:00
<MyComponent t-att-class="{a: state.flagA, b: state.flagB}" />
2019-06-04 13:16:50 +02:00
` ``
2019-06-14 15:24:04 +02:00
### Event Handling
2019-06-04 13:16:50 +02:00
2019-10-27 20:23:02 +01:00
In a component's template, it is useful to be able to register handlers on DOM
2019-06-04 13:16:50 +02:00
elements to some specific events. This is what makes a template _alive_. There
are four different use cases.
1. Register an event handler on a DOM node (_pure_ DOM event)
2. Register an event handler on a component (_pure_ DOM event)
3. Register an event handler on a DOM node (_business_ DOM event)
4. Register an event handler on a component (_business_ DOM event)
A _pure_ DOM event is directly triggered by a user interaction (e.g. a ` click`).
` ``xml
<button t-on-click="someMethod">Do something</button>
` ``
This will be roughly translated in javascript like this:
` ``js
2019-06-20 09:42:33 +02:00
button.addEventListener("click", component.someMethod.bind(component));
2019-06-04 13:16:50 +02:00
` ``
The suffix (` click` in this example) is simply the name of the actual DOM
event.
A _business_ DOM event is triggered by a call to ` trigger` on a component.
` ``xml
2019-06-20 09:42:33 +02:00
<MyComponent t-on-menu-loaded="someMethod" />
2019-06-04 13:16:50 +02:00
` ``
` ``js
2019-06-20 09:42:33 +02:00
class MyComponent {
2019-06-04 13:16:50 +02:00
someWhere() {
const payload = ...;
this.trigger('menu-loaded', payload);
}
}
` ``
2019-11-21 11:27:06 +01:00
The call to ` trigger` generates an ` OwlEvent`, a subclass of [_CustomEvent_](https://developer.mozilla.org/docs/Web/Guide/Events/Creating_and_triggering_events)
with an additional attribute ` originalComponent` (the component that triggered
the event). The generated event is of type ` menu-loaded` and dispatches it on
the component's DOM element (` this.el`). The event bubbles and is cancelable.
The parent component listening to event ` menu-loaded` will receive the payload
in its ` someMethod` handler (in the ` detail` property of the event), whenever
the event is triggered.
2019-06-04 13:16:50 +02:00
` ``js
2019-06-20 09:42:33 +02:00
class ParentComponent {
2019-06-04 13:16:50 +02:00
someMethod(ev) {
const payload = ev.detail;
...
}
}
` ``
By convention, we use KebabCase for the name of _business_ events.
2019-10-27 20:23:02 +01:00
The ` t-on` directive allows to prebind its arguments. For example,
2019-10-25 10:57:08 +02:00
` ``xml
<button t-on-click="someMethod(expr)">Do something</button>
` ``
Here, ` expr` is a valid Owl expression, so it could be ` true` or some variable
from the rendering context.
One can also directly specify inline statements. For example,
` ``xml
<button t-on-click="state.counter++">Increment counter</button>
` ``
Here, ` state` must be defined in the rendering context (typically the component)
as it will be translated to:
2019-10-26 08:55:38 +02:00
2019-10-25 10:57:08 +02:00
` ``js
2019-10-26 08:55:38 +02:00
button.addEventListener("click", () => {
component.state.counter++;
});
2019-10-25 10:57:08 +02:00
` ``
2019-06-04 13:16:50 +02:00
In order to remove the DOM event details from the event handlers (like calls to
` event.preventDefault`) and let them focus on data logic, _modifiers_ can be
specified as additional suffixes of the ` t-on` directive.
| Modifier | Description |
| ---------- | ----------------------------------------------------------------- |
| ` .stop` | calls ` event.stopPropagation()` before calling the method |
| ` .prevent` | calls ` event.preventDefault()` before calling the method |
| ` .self` | calls the method only if the ` event.target` is the element itself |
` ``xml
<button t-on-click.stop="someMethod">Do something</button>
` ``
Note that modifiers can be combined (ex: ` t-on-click.stop.prevent`), and that
the order may matter. For instance ` t-on-click.prevent.self` will prevent all
clicks while ` t-on-click.self.prevent` will only prevent clicks on the element
itself.
2019-10-25 10:58:18 +02:00
Finally, empty handlers are tolerated as they could be defined only to apply
modifiers. For example,
` ``xml
<button t-on-click.stop="">Do something</button>
` ``
This will simply stop the propagation of the event.
2019-06-14 15:45:16 +02:00
### Form Input Bindings
It is very common to need to be able to read the value out of an html ` input` (or
` textarea`, or ` select`) in order to use it (note: it does not need to be in a
form!). A possible way to do this is to do it by hand:
` ``js
class Form extends owl.Component {
2019-09-24 14:06:53 +02:00
state = useState({ text: "" });
2019-06-14 15:45:16 +02:00
_updateInputValue(event) {
this.state.text = event.target.value;
}
}
` ``
` ``xml
<div>
2019-06-18 09:24:52 +02:00
<input t-on-input="_updateInputValue" />
<span t-esc="state.text" />
2019-06-14 15:45:16 +02:00
</div>
` ``
This works. However, this requires a little bit of _plumbing_ code. Also, the
plumbing code is slightly different if you need to interact with a checkbox,
or with radio buttons, or with select tags.
To help with this situation, Owl has a builtin directive ` t-model`: its value
2019-09-24 14:06:53 +02:00
should be an observed value in the component (usually ` state.someValue`). With
the ` t-model` directive, we can write a shorter code, equivalent to the previous
example:
2019-06-14 15:45:16 +02:00
` ``js
class Form extends owl.Component {
state = { text: "" };
}
` ``
` ``xml
<div>
2019-09-24 14:06:53 +02:00
<input t-model="state.text" />
2019-06-18 09:24:52 +02:00
<span t-esc="state.text" />
2019-06-14 15:45:16 +02:00
</div>
` ``
The ` t-model` directive works with ` <input>`, ` <input type="checkbox">`,
` <input type="radio">`, ` <textarea>` and ` <select>`:
` ``xml
<div>
2019-09-24 14:06:53 +02:00
<div>Text in an input: <input t-model="state.someVal"/></div>
<div>Textarea: <textarea t-model="state.otherVal"/></div>
<div>Boolean value: <input type="checkbox" t-model="state.someFlag"/></div>
2019-06-14 15:45:16 +02:00
<div>Selection:
2019-09-24 14:06:53 +02:00
<select t-model="state.color">
2019-06-14 15:45:16 +02:00
<option value="">Select a color</option>
<option value="red">Red</option>
<option value="blue">Blue</option>
</select>
</div>
<div>
Selection with radio buttons:
<span>
2019-09-24 14:06:53 +02:00
<input type="radio" name="color" id="red" value="red" t-model="state.color"/>
2019-06-14 15:45:16 +02:00
<label for="red">Red</label>
</span>
<span>
2019-09-24 14:06:53 +02:00
<input type="radio" name="color" id="blue" value="blue" t-model="state.color" />
2019-06-14 15:45:16 +02:00
<label for="blue">Blue</label>
</span>
</div>
</div>
` ``
2019-10-27 20:23:02 +01:00
Like event handling, the ` t-model` directive accepts the following modifiers:
2019-06-14 15:45:16 +02:00
| Modifier | Description |
| --------- | -------------------------------------------------------------------- |
| ` .lazy` | update the value on the ` change` event (default is on ` input` event) |
2019-10-20 09:01:38 +02:00
| ` .number` | try to parse the value to a number (using ` parseFloat`) |
2019-06-14 15:45:16 +02:00
| ` .trim` | trim the resulting value |
For example:
` ``xml
2019-09-24 14:06:53 +02:00
<input t-model.lazy="state.someVal" />
2019-06-14 15:45:16 +02:00
` ``
These modifiers can be combined. For instance, ` t-model.lazy.number` will only
update a number whenever the change is done.
Note: the online playground has an example to show how it works.
2019-06-14 15:24:04 +02:00
### References
2019-06-04 13:16:50 +02:00
2019-09-26 21:56:01 +02:00
The ` useRef` hook is useful when we need a way to interact with some inside part
of a component, rendered by Owl. It can work either on a DOM node, or on a component,
tagged by the ` t-ref` directive. See the [hooks section](hooks.md#useref) for
more detail.
As a short example, here is how we could set the focus on a given input:
2019-06-04 13:16:50 +02:00
` ``xml
<div>
2019-09-26 21:56:01 +02:00
<input t-ref="input"/>
<button t-on-click="focusInput">Click</button>
2019-06-04 13:16:50 +02:00
</div>
` ``
` ``js
2019-09-26 21:56:01 +02:00
import { useRef } from "owl/hooks";
2019-06-04 13:16:50 +02:00
2019-09-26 21:56:01 +02:00
class SomeComponent extends Component {
inputRef = useRef("input");
2019-06-04 13:16:50 +02:00
2019-09-26 21:56:01 +02:00
focusInput() {
this.inputRef.el.focus();
}
}
` ``
2019-06-04 13:16:50 +02:00
2019-09-26 21:56:01 +02:00
The ` useRef` hook can also be used to get a reference to an instance of a sub
component rendered by Owl. In that case, we need to access it with the ` comp`
property instead of ` el`:
2019-06-04 13:16:50 +02:00
` ``xml
2019-09-26 21:56:01 +02:00
<div>
<SubComponent t-ref="sub"/>
<button t-on-click="doSomething">Click</button>
</div>
2019-06-04 13:16:50 +02:00
` ``
` ``js
2019-09-26 21:56:01 +02:00
import { useRef } from "owl/hooks";
class SomeComponent extends Component {
static components = { SubComponent };
subRef = useRef("sub");
doSomething() {
this.subRef.comp.doSomeThingElse();
}
}
2019-06-04 13:16:50 +02:00
` ``
2019-09-26 21:56:01 +02:00
Note that these two examples uses the suffix ` ref` to name the reference. This
is not mandatory, but it is a useful convention, so we do not forget to access
it with the ` el` or ` comp` suffix.
2019-06-11 15:02:10 +02:00
### Slots
2019-06-20 09:42:33 +02:00
To make generic components, it is useful to be able for a parent component to _inject_
some sub template, but still be the owner. For example, a generic dialog component
2019-06-11 15:02:10 +02:00
will need to render some content, some footer, but with the parent as the
rendering context.
2019-06-13 16:27:12 +02:00
This is what _slots_ are for.
2019-06-11 15:02:10 +02:00
` ``xml
<div t-name="Dialog" class="modal">
<div class="modal-title"><t t-esc="props.title"/></div>
<div class="modal-content">
<t t-slot="content"/>
</div>
<div class="modal-footer">
<t t-slot="footer"/>
</div>
</div>
` ``
Slots are defined by the caller, with the ` t-set` directive:
` ``xml
2019-06-20 09:42:33 +02:00
<div t-name="SomeComponent">
<div>some component</div>
2019-06-18 09:24:52 +02:00
<Dialog title="Some Dialog">
2019-06-11 15:02:10 +02:00
<t t-set="content">
<div>hey</div>
</t>
<t t-set="footer">
<button t-on-click="doSomething">ok</button>
</t>
2019-06-18 09:24:52 +02:00
</Dialog>
2019-06-11 15:02:10 +02:00
</div>
` ``
2019-06-20 09:42:33 +02:00
In this example, the component ` Dialog` will render the slots ` content` and ` footer`
2019-06-13 16:27:12 +02:00
with its parent as rendering context. This means that clicking on the button
2019-06-11 15:02:10 +02:00
will execute the ` doSomething` method on the parent, not on the dialog.
2019-06-20 09:42:33 +02:00
Default slot: the first element inside the component which is not a named slot will
2019-06-15 14:47:05 +02:00
be considered the ` default` slot. For example:
` ``xml
<div t-name="Parent">
2019-06-18 09:24:52 +02:00
<Child>
2019-06-15 14:47:05 +02:00
<span>some content</span>
2019-06-18 09:24:52 +02:00
</Child>
2019-06-15 14:47:05 +02:00
</div>
<div t-name="Child">
<t t-slot="default"/>
</div>
` ``
2019-11-11 17:31:34 +01:00
### Dynamic sub components
It is not common, but sometimes we need a dynamic component name. In this case,
the ` t-component` directive can also be used to accept dynamic values with string interpolation (like the [` t-attf-`](qweb_templating_language.md#dynamic-attributes) directive):
` ``xml
<div t-name="ParentComponent">
<t t-component="ChildComponent{{id}}" />
</div>
` ``
` ``js
class ParentComponent {
static components = { ChildComponent1, ChildComponent2 };
state = { id: 1 };
}
` ``
There is an even more dynamic way to use ` t-component`: its value can be an
expression evaluating to an actual component class. In that case, this is the
class that will be used to create the component:
` ``js
class A extends Component<any, any, any> {
static template = xml` <span>child a</span>`;
}
class B extends Component<any, any, any> {
static template = xml` <span>child b</span>`;
}
class App extends Component<any, any, any> {
static template = xml` <t t-component="myComponent" t-key="state.child"/>`;
state = { child: "a" };
get myComponent() {
return this.state.child === "a" ? A : B;
}
}
` ``
In this example, the component ` App` selects dynamically the concrete sub
component class.
2019-11-21 15:17:25 +01:00
Note that the ` t-component` directive can only be used on ` <t>` nodes.
2019-07-09 14:33:56 +02:00
### Error Handling
By default, whenever an error occurs in the rendering of an Owl application, we
destroy the whole application. Otherwise, we cannot offer any guarantee on the
state of the resulting component tree. It might be hopelessly corrupted, but
without any user-visible state.
Clearly, it sometimes is a little bit extreme to destroy the application. This
is why we have a builtin mechanism to handle rendering errors (and errors coming
from lifecycle hooks): the ` catchError` hook.
Whenever the ` catchError` lifecycle hook is implemented, all errors coming from
sub components rendering and/or lifecycle method calls will be caught and given
2019-10-20 09:01:38 +02:00
to the ` catchError` method. This allows us to properly handle the error, and to
2019-07-09 14:33:56 +02:00
not break the application.
For example, here is how we could implement an ` ErrorBoundary` component:
` ``xml
<div t-name="ErrorBoundary">
<t t-if="state.error">
Error handled
</t>
<t t-else="1">
<t t-slot="default" />
</t>
</div>
` ``
` ``js
2019-09-24 14:06:53 +02:00
class ErrorBoundary extends Component {
state = useState({ error: false });
2019-07-09 14:33:56 +02:00
catchError() {
this.state.error = true;
}
}
` ``
Using the ` ErrorBoundary` is then extremely simple:
` ``xml
<ErrorBoundary><SomeOtherComponent/></ErrorBoundary>
` ``
Note that we need to be careful here: the fallback UI should not throw any
error, otherwise we risk going into an infinite loop.
Also, it may be useful to know that whenever an error is caught, it is then
broadcasted to the application by an event on the ` qweb` instance. It may be
useful, for example, to log the error somewhere.
` ``js
env.qweb.on("error", null, function(error) {
// do something
// react to the error
});
` ``
2019-09-26 17:04:42 +02:00
### Functional Components
2019-09-26 21:56:01 +02:00
Owl does not exactly have functional components. However, there is an extremely
2019-09-26 17:04:42 +02:00
close alternative: calling sub templates.
A stateless functional component in react is usually some kind of function that
maps props to a virtual dom (often with ` jsx`). So, basically, almost like a
2019-09-26 21:56:01 +02:00
template rendered with ` props`. In Owl, this can be done by
2019-09-26 17:04:42 +02:00
simply defining a template, that will access the ` props` object:
` ``js
const Welcome = xml` <h1>Hello, {props.name}</h1>`;
class MyComponent extends Component {
2019-09-26 21:56:01 +02:00
static template = xml`
2019-09-26 17:04:42 +02:00
<div>
<t t-call=${Welcome}/>
<div>something</div>
</div>
`;
}
` ``
The way this works is that sub templates are inlined, and have access to the
ambient context. They can therefore access ` props`, and any other part of the
2019-09-26 21:56:01 +02:00
caller component.
2019-10-02 16:40:13 +02:00
### SVG Components
Owl components can be used to generate dynamic SVG graphs:
` ``js
class Node extends Component {
static template = xml`
<g>
<circle t-att-cx="props.x" t-att-cy="props.y" r="4" fill="black"/>
<text t-att-x="props.x - 5" t-att-y="props.y + 18"><t t-esc="props.node.label"/></text>
<t t-set="childx" t-value="props.x + 100"/>
<t t-set="height" t-value="props.height/(props.node.children || []).length"/>
<t t-foreach="props.node.children || []" t-as="child">
<t t-set="childy" t-value="props.y + child_index*height"/>
<line t-att-x1="props.x" t-att-y1="props.y" t-att-x2="childx" t-att-y2="childy" stroke="black" />
<Node x="childx" y="childy" node="child" height="height"/>
</t>
</g>
`;
2019-09-29 16:47:06 +02:00
static components = { Node };
2019-10-02 16:40:13 +02:00
}
class RootNode extends Component {
static template = xml`
<svg height="180">
<Node node="graph" x="10" y="20" height="180"/>
</svg>
`;
static components = { Node };
graph = {
2019-09-29 16:47:06 +02:00
label: "a",
children: [
{ label: "b" },
{ label: "c", children: [{ label: "d" }, { label: "e" }] },
{ label: "f", children: [{ label: "g" }] }
]
2019-10-02 16:40:13 +02:00
};
}
` ``
This ` RootNode` component will then display a live SVG representation of the
graph described by the ` graph` property. Note that there is a recursive structure
here: the ` Node` component uses itself as a subcomponent.
Note that since SVG needs to be handled in a specific way (its namespace needs
to be properly set), there is a small constraint for Owl components: if an owl
component is supposed to be a part of an svg graph, then its root node needs to
2019-09-29 16:47:06 +02:00
be a ` g` tag, so Owl can properly set the namespace.