wip

# v2.0.7

 - [FIX] compiler: t-key and t-ref together

.eslintrc

@@ -0,0 +1,47 @@
+{
+    "env": {
+        "browser": true,
+        "node": true,
+        "es2022": true
+    },
+    "parser": "@typescript-eslint/parser",
+    "plugins": ["@typescript-eslint"],
+    "parserOptions": {
+        "sourceType": "module"
+    },
+    "root": true,
+    "rules": {
+        "no-restricted-globals": ["error", "event", "self"],
+        "no-const-assign": ["error"],
+        "no-debugger": ["error"],
+        "no-dupe-class-members": ["error"],
+        "no-dupe-keys": ["error"],
+        "no-dupe-args": ["error"],
+        "no-dupe-else-if": ["error"],
+        "no-unsafe-negation": ["error"],
+        "no-duplicate-imports": ["error"],
+        "valid-typeof": ["error"],
+        "@typescript-eslint/no-unused-vars": ["error", { "vars": "all", "args": "none", "ignoreRestSiblings": false, "caughtErrors": "all" }],
+        "no-restricted-syntax": [
+            "error",
+            {
+                "selector": "MemberExpression[object.name='test'][property.name='only']",
+                "message": "test.only(...) is forbidden",
+            },
+            {
+                "selector": "MemberExpression[object.name='describe'][property.name='only']",
+                "message": "describe.only(...) is forbidden",
+            }
+        ],
+    },
+    "globals": {
+        "describe": true,
+        "expect": true,
+        "test": true,
+        "beforeEach": true,
+        "beforeAll": true,
+        "afterEach": true,
+        "afterAll": true,
+        "jest": true,
+    },
+}

.github/workflows/deploy.yml

@@ -5,7 +5,7 @@ name: Node.js CI
 
 on:
   pull_request:
-    branches: [ master, owl-next ]
+    branches: [ master ]
 
 jobs:
   build:
@@ -22,6 +22,8 @@ jobs:
       uses: actions/setup-node@v1
       with:
         node-version: ${{ matrix.node-version }}
-    - run: npm install
+    - run: npm ci
     - run: npm run test
     - run: npm run check-formatting
+    - run: npm run lint
+    - run: npm run build

.gitignore

@@ -14,9 +14,6 @@ npm-debug.log*
 yarn-debug.log*
 yarn-error.log*
 
-package-lock.json
-yarn.lock
-
 #ide's
 .vscode
 .idea

CHANGELOG.md

@@ -8,13 +8,16 @@ patching the `setup` method of `Component` to auto register all the lifecycle
 methods as hooks). This will be done for the transition period, but will be
 removed after.
 
-## Changes
+## From Owl 1.x to Owl 2.0
+
+All changes are documented here in no particular order.
 
 **Components**
 
 - components can now have empty content or multiple root nodes (htmlelement or text) ([details](#31-components-can-now-have-arbitrary-content))
-- new `useEffect` hook
-- new `onDestroyed`, `onWillRender` and `onRendered` hooks
+- breaking: component.el is removed ([details](#9-componentel-is-removed))
+- new `useEffect` hook ([doc](doc/reference/hooks.md#useeffect))
+- new `onWillDestroy`, `onWillRender` and `onRendered` hooks ([doc](doc/reference/component.md#lifecycle))
 - breaking: lifecycle methods are removed ([details](#1-component-lifecycle-methods-are-removed))
 - breaking: can no longer be mounted on detached DOM ([details](#2-components-can-no-longer-be-mounted-in-a-detached-dom-element))
 - breaking: standalone `mount` method API is simpler ([details](#4-mount-method-api-is-simpler))
@@ -22,47 +25,77 @@ removed after.
 - breaking: components can no longer be unmounted/remounted ([details](#6-components-can-no-longer-be-unmountedremounted))
 - breaking: template name is no longer inferred from the class name ([details](#7-template-name-is-no-longer-inferred-from-the-class-name))
 - breaking: components no longer have a `shouldUpdate` method ([details](#8-components-no-longer-have-a-shouldupdate-method))
-- breaking: component.el may be a text node, and is no longer `null` ([details](#9-componentel-may-be-a-text-node-and-is-no-longer-null))
-- breaking: style/class on components are now regular props ([details](#10-styleclass-on-components-are-now-regular-props))
 - breaking: components can no longer be mounted with position=self ([details](#11-components-can-no-longer-be-mounted-with-positionself))
-- breaking: `t-on` does not work on components any more ([details](#12-t-on-does-not-work-on-components-any-more))
+- breaking: `render` method does not return a promise anymore ([details](#35-render-method-does-not-return-a-promise-anymore))
+- breaking: `catchError` method is replaced by `onError` hook ([details](#36-catcherror-method-is-replaced-by-onerror-hook))
+- breaking: Support for inline css (`css` tag and static `style`) has been removed ([details](#37-support-for-inline-css-css-tag-and-static-style-has-been-removed))
+- new: prop validation system can now describe that additional props are allowed (with `*`) ([doc](doc/reference/props.md#props-validation))
+- breaking: prop validation system does not allow default prop on a mandatory (not optional) prop ([doc](doc/reference/props.md#props-validation))
+- breaking: rendering a component does not necessarily render child components ([details](#40-rendering-a-component-does-not-necessarily-render-child-components))
+
+
+
+**Templates**
+
+- breaking: `t-foreach` should always have a corresponding `t-key` ([details](#20-t-foreach-should-always-have-a-corresponding-t-key))
+- breaking: `t-ref` does not work on components ([details](#29-t-ref-does-not-work-on-component))
+- breaking: `t-raw` directive has been removed (replaced by `t-out`) ([details](#38-t-raw-directive-has-been-removed-replaced-by-t-out))
+- new: add support for synthetic events ([doc](doc/reference/event_handling.md#synthetic-events))
+- breaking: style/class on components are now regular props ([details](#10-styleclass-on-components-are-now-regular-props))
+- new: components can use the `.bind` suffix to bind function props ([doc](doc/reference/props.md#binding-function-props))
+- breaking: `t-on` does not accept expressions, only functions ([details](#30-t-on-does-not-accept-expressions-only-functions))
+- new: an error is thrown if an handler defined in a `t-on-` directive is not a function (failed silently previously in some cases)
 - breaking: `t-component` no longer accepts strings ([details](#17-t-component-no-longer-accepts-strings))
+- new: the `this` variable in template expressions is now bound to the component
 
-**Portal**
 
-- portals can now have arbitrary content (no longer restricted to one single child)
-- breaking: does no longer transfer dom events ([details](#13-portal-does-no-longer-transfer-dom-events))
-- breaking: does render as an empty text node instead of `<portal/>` ([details](#14-portal-does-render-as-an-empty-text-node-instead-of-portal))
+**Reactivity**
+
+- finer grained reactivity: owl 2 tracks change per key/component
+- finer grained reactivity: sub components can reobserve state ([doc](doc/reference/reactivity.md))
+- new: `reactive` function: create reactive state (without being linked to a component) ([doc](doc/reference/reactivity.md#reactive))
+- new: `markRaw` function: mark an object or array so that it is ignored by the reactivity system ([doc](doc/reference/reactivity.md#markraw))
+- new: `toRaw` function: given a reactive objet, return the raw (non reactive) underlying object ([doc](doc/reference/reactivity.md#toraw))
+
 
 **Slots**
 
 - breaking: `t-set` does not define a slot any more ([details](#3-t-set-will-no-longer-work-to-define-a-slot))
+- slots capabilities have been improved ([doc](doc/reference/slots.md))
+  - params can be give to slot content (to pass information from slot owner to slot user)
+  - slots are given as a `prop` (and can be manipulated/propagated to sub components )
+  - slots can define scopes (to pass information from slot user to slot owner)
+
+
+**Portal**
+
+- Portal are now defined with `t-portal` ([details](#33-portal-are-now-defined-with-t-portal))
+- portals can now have arbitrary content (no longer restricted to one single child)
+- breaking: does no longer transfer dom events ([details](#13-portal-does-no-longer-transfer-dom-events))
+- breaking: does render as an empty text node instead of `<portal/>` ([details](#14-portal-does-render-as-an-empty-text-node-instead-of-portal))
+
 
 **Miscellaneous**
 
 - improved performance
 - much simpler code 
-- finer grained reactivity: owl 2 tracks change per key/component
-- finer grained reactivity: sub components can reobserve state
-- new App class to encapsulate a root Owl component (with the config for that application)
-- new `Memo` component
+- new App class to encapsulate a root Owl component (with the config for that application) ([doc](doc/reference/app.md))
+- new `useEffect` hook ([doc](doc/reference/hooks.md#useeffect))
 - breaking: `Context` is removed ([details](#15-context-is-removed))
 - breaking: `env` is now totally empty ([details](#16-env-is-now-totally-empty))
+- breaking: `env` is now frozen ([details](#28-env-is-now-frozen))
+- new hook: `useChildSubEnv` (only applies to child components) ([details](#27-usechildsubenv-only-applies-to-child-components))
 - breaking: most exports are exported at top level ([details](#18-most-exports-are-exported-at-top-level))
 - breaking: properties are no longer set as attributes ([details](#19-properties-are-no-longer-set-as-attributes))
-- breaking: `t-foreach` should always have a corresponding `t-key` ([details](#20-t-foreach-should-always-have-a-corresponding-t-key))
 - breaking: `EventBus` api changed: it is now an `EventTarget` ([details](#21-eventbus-api-changed-it-is-now-an-eventtarget))
 - breaking: `Store` is removed ([details](#22-store-is-removed))
 - breaking: `Router` is removed ([details](#23-router-is-removed))
 - breaking: transition system is removed ([details](#24-transition-system-is-removed))
 - breaking: no more global components or templates ([details](#25-no-more-global-components-or-templates))
 - breaking: `AsyncRoot` utility component is removed ([details](#26-asyncroot-utility-component-is-removed))
-- breaking: `useSubEnv` only applies to child components ([details](#27-usesubenv-only-applies-to-child-components))
-- breaking: `env` is now frozen ([details](#28-env-is-now-frozen))
-- breaking: `t-ref` does not work on components ([details](#29-t-ref-does-not-work-on-component))
-- breaking: `t-on` does not accept expressions, only functions ([details](#30-t-on-does-not-accept-expressions-only-functions))
 - breaking: `renderToString` function on qweb has been removed ([details](#32-rendertostring-on-qweb-has-been-removed))
-
+- breaking: `debounce` utility function has been removed ([details](#34-debounce-utility-function-has-been-removed))
+- breaking: `browser` object has been removed ([details](#39-browser-object-has-been-removed))
 
 ## Details/Rationale/Migration
 
@@ -96,6 +129,8 @@ class MyComponent extends Component {
 }
 ```
 
+Documentation: [Component Lifecycle](doc/reference/component.md#lifecycle)
+
 ### 2. components can no longer be mounted in a detached dom element
 
 Nor document fragment.
@@ -147,6 +182,8 @@ because real applications will need to configure the templates, the translations
 and other stuff. All complex usecases need to go through the new `App` class,
 that encapsulates the root of an owl application.
 
+Documentation: [Mounting a component](doc/reference/app.md#mount-helper)
+
 ### 5. components can no longer be instantiated and mounted by hand
 
 In Owl 1, it was possible to instantiate a component by hand:
@@ -210,40 +247,21 @@ Rationale: `shouldUpdate` is a dangerous method to use, that may cause a lot of
 issues. Vue does not have such a mechanism (see https://github.com/vuejs/vue/issues/4255),
 because the reactivity system in Vue is smart enough to only rerender the minimal
 subset of components that is subscribed to a piece of state. Now, Owl 2 features
-a much more powerful reactivity system.
+a much more powerful reactivity system, so the same rationale applies: in a way,
+it's like each Owl 2 component has a `shouldUpdate` method that precisely tracks
+every value used by the component.
 
-Migration code: remove the `shouldUpdate` methods. Then, maybe the following
-ideas may help:
+Migration code: remove the `shouldUpdate` methods, and it should work as well
+as before.
 
-- try to organize the state/architecture to minimize the number of state updates
-- take advantage of the finer reactivity system. For example, if we have a list
-  of items, with a component for each item, we can write this:
+### 9. component.el is removed
 
-  ```js
-  class Item extends Component {
-      setup() {
-          this.item = useState(this.props.item); // and only use this, not props.item
-      }
-  }
-  ```
-  Doing so will make it that each `Item` component will register itself as an
-  observer of its own item, and will be the only component being rerendered when
-  its item object is updated.
-- use the `Memo` component to wrap some piece of template. `Memo` memoize its
-  content, and only update itself if its props are different (shallow comparison):
-  
-  ```xml
-    <Memo a="state.a" b="state.b"> 
-        <t t-esc="state.a"/>
-        <t t-esc="state.b"/>
-        <t t-esc="state.c"/>
-    </Memo>
-  ```
+This comes from the fact that Owl 2 supports fragments (arbitrary content).
 
-### 9. component.el may be a text node, and is no longer `null`
+Migration: if one need a reference to the root htmlelement of a template, it is
+suggested to simply add a `ref` on it, and access the reference as needed.
 
-This comes from the fact that Owl 2 supports fragments (arbitrary content). When
-it is not defined, it was `null` in Owl 1 and is `undefined` in owl 2.
+Documentation: [Refs](doc/reference/refs.md)
 
 ### 10. style/class on components are now regular props
 
@@ -286,34 +304,13 @@ compatible with the fact that a component can have a root `<div>` then later,
 change it to something else, or even a text node.
 
 Migration: no real way to do the same. Owl application needs to be appended or
-prepended in something, maybe a `div`.
+prepended in something, maybe a `div`. Remember that you the root component
+can have multiple roots
 
-### 12. `t-on` does not work on components any more
+Documentation:
+- [Fragments](doc/reference/templates.md#fragments)
+- [Mounting a component](doc/reference/app.md#mount-helper)
 
-In owl 1, it was possible to bind an event listener on a component tag in a
-template:
-
-```xml
-<SomeComponent t-on-some-event="doSomething"/>
-```
-
-This does not work any more.
-
-Rationale: with the support of fragments, there is no longer a canonical html
-element that we can refer. So, this makes it difficult to implement correctly
-and efficiently. Also, we noticed in practice that the event system was an issue
-in some cases, when components need to communicate before they are mounted. In
-those cases, the better solution is to directly use a callback.  Also, another
-conceptual issue with this is that it kind of breaks the component encapsulation.
-The child component kind of leak its own implementation to the outside world.
-
-Migration: a quick fix that may work in some cases is to simply bind the event
-handler on a parent htmlelement. A better way to do it, if possible, is to change
-the component API to accept explicitely a callback as props. 
-
-```xml
-<SomeComponent onSomeEvent="doSomething"/>
-```
 
 ### 13. Portal does no longer transfer DOM events
 
@@ -372,6 +369,8 @@ Migration: there is no proper way to get an equivalent. The closest is to get
 a reference to the root App using `this.__owl__.app`. If you need to do this,
 let us know. If this is a legitimate usecase, we may add a `useApp` hook.
 
+Documentation: [Environment](doc/reference/environment.md)
+
 ### 17. `t-component` no longer accepts strings
 
 In owl 1, we could write this:
@@ -397,6 +396,8 @@ the implementation is slightly simpler.
 Migration: simply using `constructor.components.Coucou` instead of `Coucou` will
 do the trick.
 
+Documentation: [Component](doc/reference/component.md#dynamic-sub-components)
+
 ### 18. most exports are exported at top level
 
 Most exports are flattened: for ex, `onMounted` is in owl, not in `owl.hooks`.
@@ -453,6 +454,8 @@ rewritten like this: `bus.addEventListener("event-type", (({detail: info}) => {.
 
 Do not forget to similarly replace `bus.off(...)` by `bus.removeEventListener(...)`
 
+Documentation: [EventBus](doc/reference/utils.md#eventbus)
+
 ### 22. `Store` is removed
 
 The Store system had been abandoned in owl 2.
@@ -514,14 +517,12 @@ either a fallback when the data is not ready, or the actual component with data
 as props.  If there is no escape, and `AsyncRoot` is needed, please reach out to
 us so we can study this usecase.
 
-### 27. `useSubEnv` only applies to child components
-
-In Owl 1, a call to `useSubEnv` would define a new environment for the children
-AND the component. It now only defines an environment for the children.
-
-Rationale: This was a subtle cause for bugs: some code had to be rrun
-before the call to `useSubEnv`, otherwise it could interfere with the sub environment.
+### 27. `useChildSubEnv` (only applies to child components)
 
+In Owl, a call to `useSubEnv` would define a new environment for the children
+AND the component. It is very useful, but in some cases, one only need to update
+the children component environment. This can now be done with a new hook:
+[`useChildSubEnv`](doc/reference/hooks.md#usesubenv-and-usechildsubenv)
 
 ### 28. `env` is now frozen
 
@@ -536,6 +537,8 @@ components. This use case still works with `useSubEnv`.
 Migration: use `useSubEnv` instead of writing directly to the env.  Also, note
 that the environment given to the App can initially contain anything.
 
+Documentation: [Environment](doc/reference/environment.md)
+
 ### 29. `t-ref` does not work on component
 
 Before, `t-ref` could be used to get a reference to a child component. It no
@@ -576,6 +579,8 @@ adapted like this:
 <button t-on-click="() => this.someFunction(someVar)">blabla</button>
 ```
 
+Documentation: [Event Handling](doc/reference/event_handling.md)
+
 ### 31. components can now have arbitrary content
 
 Before Owl 2, components had to limit themselves to one single htmlelement as
@@ -588,6 +593,8 @@ So, the following template works for components:
   hello
 ```
 
+Documentation: [Fragments](doc/reference/templates.md#fragments)
+
 ### 32. `renderToString` on QWeb has been removed
 
 Rationale: the `renderToString` function was a qweb method, which made sense because
@@ -601,12 +608,159 @@ Also, this can easily be done in userspace, by mounting a component in a div.  F
 export async function renderToString(template, context) {
   class C extends Component {
     static template = template;
+    setup () {
+        Object.assign(this, context);
+    }
   }
   const div = document.createElement('div');
   document.body.appendChild(div);
-  const component = await mount(C, div);
+  const app = new App(C);
+  await app.mount(div);
   const result = div.innerHTML;
   app.destroy();
   div.remove();
   return result;
-}
+}
+```
+
+The function above works for most cases, but is asynchronous.  An alternative
+function could look like this:
+
+```js
+const { App, blockDom } = owl;
+const app = new App(Component); // act as a template repository
+
+function renderToString(template, context = {}) {
+  app.addTemplate(template, template, { allowDuplicate: true });
+  const templateFn = app.getTemplate(template);
+  const bdom = templateFn(context, {});
+  const div = document.createElement('div')
+  blockDom.mount(bdom, div);
+  return div.innerHTML;
+}
+```
+
+This is a synchronous function, so it will not work with components, but it should
+be useful for most simple templates.
+
+Also note that these two examples do not translate their templates. To do that,
+they need to be modified to pass the proper translate function to the `App`
+configuration.
+
+### 33. Portal are now defined with `t-portal`
+
+Before Owl 2, one could use the `Portal` component by importing it and using it.
+Now, it is no longer available. Instead, we can simply use the `t-portal` directive:
+
+```xml
+<div>
+  some content
+  <span t-portal="'body'">
+    portalled content
+  </span>
+<div>
+```
+
+Rationale: it makes it slightly simpler to use (just need the directive, instead
+of having to import and use a sub component), it makes the implementation slightly
+simpler as well. Also, it prevents subclassing the Portal component, which could
+be dangerous, since it is really doing weird stuff under the hood, and could
+easily be broken inadvertendly.
+
+### 34. `debounce` utility function has been removed
+
+Rationale: it did not really help that much, is available as utility function
+elsewhere, so, we decided to have a smaller footprint by focusing Owl on what
+it does best.
+
+### 35. `render` method does not return a promise anymore
+
+Rationale: using the `render` method directly and waiting for it to complete
+was slightly un-declarative. Also, it can be done using the lifecycle hooks
+any way.
+
+Migration: if necessary, one can use the lifecycle hooks to execute code after
+the next mounted/patched operation.
+
+### 36. `catchError` method is replaced by `onError` hook
+
+The `catchError` method was used to provide a way to components to handle errors
+occurring during the component lifecycle. This has been replaced by a `onError`
+hook, with a similar API.
+
+Rationale: `catchError` felt a little big awkward, when most of the way we
+interact with componentss is via hooks.  Using hooks felt more natural and
+consistent.
+
+Migration: mostly replace all `catchError` methods by `onError` hooks in the
+`setup` method.
+
+Documentation: [Error Handling](doc/reference/error_handling.md)
+
+
+## 37. Support for inline css (`css` tag and static `style`) has been removed
+
+Rationale: Owl tries to focus on what it does best, and supporting inline css
+was not a priority.  It used to support some simplified scss language, but it
+was feared that it would cause more trouble than it was worth. Also, it seems
+like it can be done in userspace.
+
+Migration: it seems possible to implement an equivalent solution using hooks. A
+simple implementation could look like this:
+
+```js
+let cache = {};
+
+function useStyle(css) {
+  if (!css in cache) {
+    const sheet = document.createElement("style");
+    sheet.innerHTML = css;
+    cache[css] = sheet;
+    document.head.appendChild(sheet);
+  }
+}
+```
+
+## 38. `t-raw` directive has been removed (replaced by `t-out`)
+
+To match the Odoo qweb server implementation, Owl does no longer implement `t-raw`.
+It is replaced by the `t-out` directive, which is safer: it requires the data
+to be marked explicitely as markup if it is to be inserted without escaping.
+Otherwise, it will be escaped (just like `t-esc`).
+
+Migration: replace all `t-raw` uses by `t-out`, and uses the `markup` function
+to mark all the js values.
+
+Documentation: [Outputting data](doc/reference/templates.md#outputting-data)
+
+## 39. `browser` object has been removed
+
+Rationale: the `browser` object caused more trouble than it was worth. Also, it
+seems like this should be done in user space, not at the framework level.  
+
+Migration: code should just be adapted to either use another browser object,
+or to use native browser function (and then, just mock them directly).
+
+## 40. Rendering a component does not necessarily render child components
+
+Before, if one had the following component tree:
+
+```mermaid
+  graph TD;
+      A-->B;
+      A-->C;
+```
+
+when `A` would render, it would also render `B` and `C`. Now, in Owl 2, it will 
+(shallow) compare the before and after props, and `B` or `C` will only be rerendered
+if their props have changed.
+
+Now, the question is what happens if the props have changed, but in a deeper way?
+In that case, Owl will know, because each props are now reactive. So, if some
+inner value read by `B` was changed, then only `B` will be updated.
+
+Rationale: This was just not possible in Owl 1, but it now possible. This is
+due to the rewriteof the underlying rendering engine and the reactivity
+system. The goal is to have a big performance boost in large screen with many
+components: now Owl only rerender what is strictly useful.
+

README.md

@@ -16,8 +16,10 @@ framework, written in Typescript, taking the best ideas from React and Vue in a
 simple and consistent way. Owl's main features are:
 
 - a declarative component system,
-- a reactivity system based on hooks,
-- concurrent mode by default,
+- a fine grained reactivity system similar to Vue,
+- hooks
+- fragments
+- asynchronous rendering
 
 Owl components are defined with ES6 classes and xml templates, uses an
 underlying virtual DOM, integrates beautifully with hooks, and the rendering is
@@ -38,28 +40,26 @@ const { Component, useState, mount, xml } = owl;
 
 class Counter extends Component {
   static template = xml`
-    <button t-on-click="() => state.value++">
+    <button t-on-click="() => state.value = state.value + props.increment">
       Click Me! [<t t-esc="state.value"/>]
     </button>`;
 
   state = useState({ value: 0 });
 }
 
-class App extends Component {
+class Root extends Component {
   static template = xml`
-    <div>
-      <span>Hello Owl</span>
-      <Counter />
-    </div>`;
+    <span>Hello Owl</span>
+    <Counter increment="2"/>`;
 
   static components = { Counter };
 }
 
-mount(App, document.body);
+mount(Root, document.body);
 ```
 
 Note that the counter component is made reactive with the [`useState` hook](doc/reference/hooks.md#usestate).
-Also, all examples here uses the [`xml` helper](doc/reference/tags.md#xml-tag) to define inline templates.
+Also, all examples here uses the [`xml` helper](doc/reference/templates.md#inline-templates) to define inline templates.
 But this is not mandatory, many applications will load templates separately.
 
 More interesting examples can be found on the
@@ -74,47 +74,45 @@ Are you new to Owl? This is the place to start!
 - [Tutorial: create a TodoList application](doc/learning/tutorial_todoapp.md)
 - [How to start an Owl project](doc/learning/quick_start.md)
 - [How to test Components](doc/learning/how_to_test.md)
-- [How to write Single File Components](doc/learning/how_to_write_sfc.md)
 
 ### Reference
 
-You will find here a complete reference of every feature, class or object
-provided by Owl.
-
-- [Animations](doc/reference/animations.md)
-- [Browser](doc/reference/browser.md)
+- [Overview](doc/readme.md)
+- [App](doc/reference/app.md)
 - [Component](doc/reference/component.md)
-- [Content](doc/reference/content.md)
+- [Component Lifecycle](doc/reference/component.md#lifecycle)
 - [Concurrency Model](doc/reference/concurrency_model.md)
-- [Configuration](doc/reference/config.md)
-- [Context](doc/reference/context.md)
+- [Dev mode](doc/reference/app.md#dev-mode)
+- [Dynamic sub components](doc/reference/component.md#dynamic-sub-components)
 - [Environment](doc/reference/environment.md)
-- [Event Bus](doc/reference/event_bus.md)
-- [Event Handling](doc/reference/event_handling.md)
 - [Error Handling](doc/reference/error_handling.md)
+- [Event Handling](doc/reference/event_handling.md)
+- [Form Input Bindings](doc/reference/input_bindings.md)
+- [Fragments](doc/reference/templates.md#fragments)
 - [Hooks](doc/reference/hooks.md)
-- [Mounting a component](doc/reference/mounting.md)
-- [Miscellaneous Components](doc/reference/misc.md)
-- [Observer](doc/reference/observer.md)
+- [Loading Templates](doc/reference/app.md#loading-templates)
+- [Mounting a component](doc/reference/app.md#mount-helper)
+- [Portal](doc/reference/portal.md)
+- [Precompiling templates](doc/reference/precompiling_templates.md)
 - [Props](doc/reference/props.md)
-- [Props Validation](doc/reference/props_validation.md)
-- [QWeb Templating Language](doc/reference/qweb_templating_language.md)
-- [QWeb Engine](doc/reference/qweb_engine.md)
+- [Props Validation](doc/reference/props.md#props-validation)
+- [Reactivity](doc/reference/reactivity.md)
+- [Rendering SVG](doc/reference/templates.md#rendering-svg)
+- [Refs](doc/reference/refs.md)
 - [Slots](doc/reference/slots.md)
-- [Tags](doc/reference/tags.md)
+- [Sub components](doc/reference/component.md#sub-components)
+- [Sub templates](doc/reference/templates.md#sub-templates)
+- [Templates (Qweb)](doc/reference/templates.md)
+- [Translations](doc/reference/translations.md)
 - [Utils](doc/reference/utils.md)
 
 ### Other Topics
 
-This section provides miscellaneous document that explains some topics
-which cannot be considered either a tutorial, or reference documentation.
-
-- [Owl architecture: the Virtual DOM](doc/miscellaneous/vdom.md)
-- [Owl architecture: the rendering pipeline](doc/miscellaneous/rendering.md)
+- [Notes On Owl Architecture](doc/miscellaneous/architecture.md)
 - [Comparison with React/Vue](doc/miscellaneous/comparison.md)
-- [Why did Odoo built Owl?](doc/miscellaneous/why_owl.md)
-
-
+- [Why did Odoo build Owl?](doc/miscellaneous/why_owl.md)
+- [Changelog (from owl 1.x to 2.x)](CHANGELOG.md)
+- [Notes on compiled templates](doc/miscellaneous/compiled_template.md)
 
 ## Installing Owl
 
@@ -126,5 +124,5 @@ npm install @odoo/owl
 
 If you want to use a simple `<script>` tag, the last release can be downloaded here:
 
-- [owl-1.4.7](https://github.com/odoo/owl/releases/tag/v1.4.7)
+- [owl](https://github.com/odoo/owl/releases/latest)
 

doc/learning/how_to_write_sfc.md

@@ -1,52 +0,0 @@
-# 🦉 How to write Single File Components 🦉
-
-It is very useful to group code by feature instead of by type of file. It makes
-it easier to scale application to larger size.
-
-To do so, Owl has two small helpers that make it easy to define a
-template or a stylesheet inside a javascript (or typescript) file: the
-[`xml`](../reference/tags.md#xml-tag) and [`css`](../reference/tags.md#css-tag)
-helper.
-
-This means that the template, the style and the javascript code can be defined in
-the same file. For example:
-
-```js
-const { Component } = owl;
-const { xml, css } = owl.tags;
-
-// -----------------------------------------------------------------------------
-// TEMPLATE
-// -----------------------------------------------------------------------------
-const TEMPLATE = xml/* xml */ `
-	<div class="main">
-		<Sidebar/>
-		<Content />
-	</div>`;
-
-// -----------------------------------------------------------------------------
-// STYLE
-// -----------------------------------------------------------------------------
-const STYLE = css/* css */ `
-  .main {
-    display: grid;
-    grid-template-columns: 200px auto;
-  }
-`;
-
-// -----------------------------------------------------------------------------
-// CODE
-// -----------------------------------------------------------------------------
-class Main extends Component {
-  static template = TEMPLATE;
-  static style = STYLE;
-  static components = { Sidebar, Content };
-
-  // rest of component...
-}
-```
-
-Note that the above example has an inline xml comment, just after the `xml` call.
-This is useful for some editor plugins, such as the VS Code addon
-`Comment tagged template`, which, if installed, add syntax highlighting to the
-content of the template string.

doc/learning/tutorial_todoapp.md

@@ -116,7 +116,7 @@ class App extends Component {}
 App.template = xml`<div>todo app</div>`;
 ```
 
-Note 3: writing inline templates with the [`xml` helper](../reference/tags.md#xml-tag)
+Note 3: writing inline templates with the [`xml` helper](../reference/templates.md#inline-templates)
 is nice, but there is no syntax highlighting, and this makes it very easy to
 have malformed xml. Some editors support syntax highlighting for this situation.
 For example, VS Code has an addon `Comment tagged template`, which, if installed,
@@ -173,14 +173,14 @@ class Root extends Component {
 }
 ```
 
-The template contains a [`t-foreach`](../reference/qweb_templating_language.md#loops) loop to iterate
-through the tasks. It can find the `tasks` list from the component, since the
-component is the rendering context. Note that we use the `id` of each task as a
-`t-key`, which is very common. There are two css classes: `task-list` and `task`,
+The template contains a [`t-foreach`](../reference/templates.md#loops) loop to iterate
+through the tasks. It can find the `tasks` list from the component, since the rendering
+context contains the properties of the component. Note that we use the `id` of each task
+as a `t-key`, which is very common. There are two css classes: `task-list` and `task`,
 that we will use in the next section.
 
 Finally, notice the use of the `t-att-checked` attribute:
-prefixing an attribute by [`t-att`](../reference/qweb_templating_language.md#dynamic-attributes) makes
+prefixing an attribute by [`t-att`](../reference/templates.md#dynamic-attributes) makes
 it dynamic. Owl will evaluate the expression and set it as the value of the
 attribute.
 
@@ -240,7 +240,7 @@ class Task extends Component {
   static template = xml /* xml */`
     <div class="task" t-att-class="props.task.isCompleted ? 'done' : ''">
       <input type="checkbox" t-att-checked="props.task.isCompleted"/>
-      <span><t t-esc="props.task.title"/></span>
+      <span><t t-esc="props.task.text"/></span>
     </div>`;
   static props = ["task"];
 }
@@ -277,10 +277,10 @@ A lot of stuff happened here:
 - the `Task` component has a `props` key: this is only useful for validation
   purpose. It says that each `Task` should be given exactly one prop, named
   `task`. If this is not the case, Owl will throw an
-  [error](../reference/props_validation.md). This is extremely
+  [error](../reference/props.md#props-validation). This is extremely
   useful when refactoring components
 - finally, to activate the props validation, we need to set Owl's
-  [mode](../reference/config.md#mode) to `dev`. This is done in the last argument
+  [mode](../reference/app.md#configuration) to `dev`. This is done in the last argument
   of the `mount` function. Note that this should be removed when an app is used in a real
   production environment, since `dev` mode is slightly slower, due to extra
   checks and validations.
@@ -502,6 +502,10 @@ deleteTask(task) {
 Notice that the `onDelete` prop is defined with a `.bind` suffix: this is a special
 suffix that makes sure the function callback is bound to the component.
 
+Notice also that we have two functions named `deleteTask`. The one in the Task
+component just delegates the work to the Root component that owns the task list
+via the `onDelete` property.
+
 ## 10. Using a store
 
 Looking at the code, it is apparent that all the code handling tasks is scattered
@@ -743,7 +747,7 @@ the user experience.
 ```xml
 <input type="checkbox" t-att-checked="props.task.isCompleted"
     t-att-id="props.task.id"
-    t-on-click="dispatch('toggleTask', props.task.id)"/>
+    t-on-click="() => store.toggleTask(props.task)"/>
 <label t-att-for="props.task.id"><t t-esc="props.task.text"/></label>
 ```
 
@@ -770,10 +774,11 @@ For reference, here is the final code:
     <meta charset="UTF-8" />
     <title>OWL Todo App</title>
     <link rel="stylesheet" href="app.css" />
+  </head>
+  <body>
     <script src="owl.js"></script>
     <script src="app.js"></script>
-  </head>
-  <body></body>
+  </body>
 </html>
 ```
 

doc/miscellaneous/architecture.md

@@ -0,0 +1,68 @@
+# 🦉 Notes On Owl Architecture 🦉
+
+We explain here how Owl is designed
+
+Warning: these notes are technical by nature, and intended for people working
+on Owl (or interested in understanding its design).
+
+## Overview
+
+Roughly speaking, Owl has 5 main parts:
+
+- a virtual dom system (in `src/blockdom`)
+- a component system (in `src/component`)
+- a template compiler (located in the `src/compiler` folder)
+- a small runtime code to tie them together (in `src/app`)
+- a reactivity system (in `src/reactivity.ts`)
+
+There are some other files, but the core of Owl can be understood with these
+five main parts.
+
+The virtual dom is an optimized virtual dom based on blocks, which supports
+multi blocks (for fragments). Everything that owl renders is internally
+represented by a virtual node. The job of the virtual dom is to efficiently
+represent the current state of the application, and to build an actual DOM
+representation when needed, or update the DOM whenever it is needed.
+
+- some other helpers/smaller scale stuff
+  A rendering occurs in two phases:
+
+- virtual rendering: this generates the virtual dom in memory, asynchronously
+- patch: applies a virtual tree to the screen (synchronously)
+
+There are several classes involved in a rendering:
+
+- components
+- a scheduler
+- fibers: small objects containing some metadata, associated with a rendering of
+  a specific component
+
+Components are organized in a dynamic component tree, visible in the user
+interface. Whenever a rendering is initiated in a component `C`:
+
+- a fiber is created on `C` with the rendering props information
+- the virtual rendering phase starts on C (will asynchronously render all the
+  child components)
+- the fiber is added to the scheduler, which will poll continuously, every
+  animation frame, if the fiber is done
+- once it is done, the scheduler will call the task callback, which will apply
+  the patch (if it was not cancelled in the meantime).
+
+# 🦉 VDom 🦉
+
+Owl is a declarative component system: we declare the structure of the component
+tree, and Owl will translate that to a list of imperative operations. This
+translation is done by a virtual dom. This is the low level layer of Owl, most
+developer will not need to call directly the virtual dom functions.
+
+The main idea behind a virtual dom is to keep a in-memory representation of the
+DOM (called a virtual node), and whenever some change is needed, to regenerate
+a new representation, compute the difference between the old and the new, then
+apply the changes.
+
+`vdom` exports two functions:
+
+- `h`: create a new virtual node
+- `patch`: compare two virtual nodes, and apply the difference.
+
+Note: Owl's virtual dom is a fork of [snabbdom](https://github.com/snabbdom/snabbdom).

doc/miscellaneous/comparison.md

@@ -78,7 +78,7 @@ additional tools, we made a lot of effort to make the most of the web platform.
 
 For example, Owl uses the standard `xml` parser that comes with every browser.
 Because of that, Owl did not have to write its own template parser. Another
-example is the [`xml`](../reference/tags.md#xml-tag) tag helper function, which makes use of
+example is the [`xml`](../reference/templates.md#inline-templates) tag helper function, which makes use of
 native template literals to allow in a natural way to write `xml` templates
 directly in the javascript code. This can be easily integrated with editor
 plugins to have autocompletion inside the template.
@@ -126,7 +126,7 @@ structured than a template language. Note that the tooling is quite impressive:
 there is a syntax highlighter for jsx here on github!
 
 By comparison, here is the equivalent Owl component, written with the
-[`xml`](../reference/tags.md#xml-tag) tag helper:
+[`xml`](../reference/templates.md#inline-templates) tag helper:
 
 ```js
 class Clock extends Component {

doc/miscellaneous/compiled_template.md

@@ -0,0 +1,98 @@
+# 🦉 Notes On Owl Compiled Templates 🦉
+
+This page will explain what an Owl compiled template look like. This is a
+technical document intended for developers interested in understanding how Owl
+works internally.
+
+Broadly speaking, Owl compiles templates into a javascript function (a closure)
+that returns a function (the "render" function). The point of the closure is to
+have a place to store all values specific to the template (in particular, "blocks").
+Once a template is compiled, its closure function is called once to get the
+render function, and from then on, only the render function is used.
+
+The render function takes some context (and some additional information) and
+return a virtual dom representation of the rendered template, as a block tree.
+A block tree is a very light weight representation that only contains the dynamic
+part of the template, and its structure. It is actually independant of the
+static part of the templates (which are contained in the blocks captured by the
+closure). This means that the work performed at render time is only to collect
+dynamic data, and to describe the block structure of the result.
+
+It looks like this, in pseudo code:
+
+```js
+function closure(bdom, helpers) {
+    // here is some place to put stuff specific to the template, such as
+    // blocks
+    ...
+
+    return function render(context, node, key) {
+        // only build here all dynamic parts of the template
+        // build a block tree
+        return tree;
+    }
+}
+```
+
+Now, let us see an example. Consider the following template:
+
+```xml
+<div class="some-class">
+    <div class="blabla">
+        <span><t t-esc="state.value"/></span>
+    </div>
+    <t t-if="state.info">
+        <p class="info" t-att-class="someAttribute">
+            <t t-esc="state.info"/>
+        </p>
+    </t>
+    <SomeComponent value="value"/>
+</div>
+```
+
+If you look carefully, there are 5 dynamic things:
+
+- a text value (the first `t-esc`),
+- a sub block (the `t-if`),
+- a dynamic attribute (the `t-att-class` attribute),
+- another text value (the second `t-esc`),
+- and finally, a sub component
+
+Here is the compiled code for this template:
+
+```js
+function closure(bdom, helpers) {
+  let { text, createBlock, list, multi, html, toggler, component, comment } = bdom;
+
+  let block1 = createBlock(
+    `<div class="some-class"><div class="blabla"><span><block-text-0/></span></div><block-child-0/><block-child-1/></div>`
+  );
+  let block2 = createBlock(`<p class="info" block-attribute-0="class"><block-text-1/></p>`);
+
+  return function render(ctx, node, key = "") {
+    let b2, b3;
+    let txt1 = ctx["state"].value;
+    if (ctx["state"].info) {
+      let attr1 = ctx["someAttribute"];
+      let txt2 = ctx["state"].info;
+      b2 = block2([attr1, txt2]);
+    }
+    b3 = component(`SomeComponent`, { value: ctx["value"] }, key + `__1`, node, ctx);
+    return block1([txt1], [b2, b3]);
+  };
+}
+```
+
+The values captured in the closure capture the static part of the template: we
+define here two blocks (which contains a template node, that can be deep cloned
+whenever a block is mounted). Then the render function only describes the block
+tree structure of the result, depending on the context. This means that we
+minimize the amount of work done at render time.
+
+Then, when we want to patch the dom, Owl will uses the `patch` function from
+blockdom, which then will diff the block tree, and deep clone new blocks whenever
+a new block is inserted, keep track of dynamic parts of each block, and update
+them accordingly.
+
+With this design, the cost of rendering a template is proportional to the number
+of dynamic values, and not to the size of the template.

doc/miscellaneous/rendering.md

@@ -1,32 +0,0 @@
-# 🦉 Rendering Pipeline 🦉
-
-We explain here how Owl is designed, from the perspective of its rendering
-pipeline.
-
-Warning: these notes are technical by nature, and intended for people working
-on Owl (or interested in understanding its design).
-
-## Overview
-
-A rendering occurs in two phases:
-
-- virtual rendering: this generates the virtual dom in memory, asynchronously
-- patch: applies a virtual tree to the screen (synchronously)
-
-There are several classes involved in a rendering:
-
-- components
-- a scheduler
-- fibers: small objects containing some metadata, associated with a rendering of
-  a specific component
-
-Components are organized in a dynamic component tree, visible in the user
-interface. Whenever a rendering is initiated in a component `C`:
-
-- a fiber is created on `C` with the rendering props information
-- the virtual rendering phase starts on C (will asynchronously render all the
-  child components)
-- the fiber is added to the scheduler, which will poll continuously, every
-  animation frame, if the fiber is done
-- once it is done, the scheduler will call the task callback, which will apply
-  the patch (if it was not cancelled in the meantime).

doc/miscellaneous/vdom.md

@@ -1,18 +0,0 @@
-# 🦉 VDom 🦉
-
-Owl is a declarative component system: we declare the structure of the component
-tree, and Owl will translate that to a list of imperative operations. This
-translation is done by a virtual dom. This is the low level layer of Owl, most
-developer will not need to call directly the virtual dom functions.
-
-The main idea behind a virtual dom is to keep a in-memory representation of the
-DOM (called a virtual node), and whenever some change is needed, to regenerate
-a new representation, compute the difference between the old and the new, then
-apply the changes.
-
-`vdom` exports two functions:
-
-- `h`: create a new virtual node
-- `patch`: compare two virtual nodes, and apply the difference.
-
-Note: Owl's virtual dom is a fork of [snabbdom](https://github.com/snabbdom/snabbdom).

doc/readme.md

@@ -0,0 +1,49 @@
+# 🦉 Owl overview 🦉
+
+Here is a list of everything exported by the Owl library:
+
+Main entities:
+
+- [`App`](reference/app.md): represent an Owl application (mainly a root component,a set of templates, and a config)
+- [`Component`](reference/component.md): the main class to define a concrete Owl component
+- [`mount`](reference/app.md#mount-helper): main entry point for most application: mount a component to a target
+- [`xml`](reference/templates.md#inline-templates): helper to define an inline template
+
+Reactivity
+
+- [`useState`](reference/reactivity.md#usestate): create a reactive object (hook, linked to a specific component)
+- [`reactive`](reference/reactivity.md#reactive): create a reactive object (not linked to any component)
+- [`markRaw`](reference/reactivity.md#markraw): mark an object or array so that it is ignored by the reactivity system
+- [`toRaw`](reference/reactivity.md#toraw): given a reactive objet, return the raw (non reactive) underlying object
+
+Lifecycle hooks:
+
+- [`onWillStart`](reference/component.md#willstart): hook to define asynchronous code that should be executed before component is rendered
+- [`onMounted`](reference/component.md#mounted): hook to define code that should be executed when component is mounted
+- [`onWillPatch`](reference/component.md#willpatch): hook to define code that should be executed before component is patched
+- [`onWillUpdateProps`](reference/component.md#willupdateprops): hook to define code that should be executed before component is updated
+- [`onPatched`](reference/component.md#patched): hook to define code that should be executed when component is patched
+- [`onWillRender`](reference/component.md#willrender): hook to define code that should be executed before component is rendered
+- [`onRendered`](reference/component.md#rendered): hook to define code that should be executed after component is rendered
+- [`onWillUnmount`](reference/component.md#willunmount): hook to define code that should be executed before component is unmounted
+- [`onWillDestroy`](reference/component.md#willdestroy): hook to define code that should be executed before component is destroyed
+- [`onError`](reference/component.md#onerror): hook to define a Owl error handler
+
+Other hooks:
+
+- [`useComponent`](reference/hooks.md#usecomponent): return a reference to the current component (useful to create derived hooks)
+- [`useEffect`](reference/hooks.md#useeffect): define an effect with its dependencies
+- [`useEnv`](reference/hooks.md#useenv): return a reference to the current env
+- [`useExternalListener`](reference/hooks.md#useexternallistener): add a listener outside of a component DOM
+- [`useRef`](reference/hooks.md#useref): get an object representing a reference (`t-ref`)
+- [`useChildSubEnv`](reference/hooks.md#usesubenv-and-usechildsubenv): extend the current env with additional information (for child components)
+- [`useSubEnv`](reference/hooks.md#usesubenv-and-usechildsubenv): extend the current env with additional information (for current component and child components)
+
+Utility/helpers:
+
+- [`EventBus`](reference/utils.md#eventbus): a simple event bus
+- [`loadFile`](reference/utils.md#loadfile): an helper to load a file from the server
+- [`markup`](reference/templates.md#outputting-data): utility function to define strings that represent html (should not be escaped)
+- [`status`](reference/component.md#status-helper): utility function to get the status of a component (new, mounted or destroyed)
+- [`validate`](reference/utils.md#validate): validates if an object satisfies a specified schema
+- [`whenReady`](reference/utils.md#whenready): utility function to execute code when DOM is ready

doc/reference/animations.md

@@ -1,127 +0,0 @@
-# 🦉 Animations 🦉
-
-Animation is a complex topic. There are many different use cases, and many
-solutions and technologies. Owl only supports some basic use cases.
-
-## Simple CSS effects
-
-Sometimes, using pure CSS is enough. For these use cases, Owl is not really
-necessary: it just needs to render a DOM element with a specific class. For
-example:
-
-```xml
-<a class="btn flash" t-on-click="doSomething">Click</a>
-```
-
-with the following CSS:
-
-```css
-btn {
-  background-color: gray;
-}
-
-.flash {
-  transition: background 0.5s;
-}
-
-.flash:active {
-  background-color: #41454a;
-  transition: background 0s;
-}
-```
-
-will produce a nice flash effect whenever the user clicks (or activates with the
-keyboard) the button.
-
-## CSS Transitions
-
-A more complex situation occurs when we want to transition an element in or out
-of the page. For example, we may want a fade-in and fade-out effect.
-
-The `t-transition` directive is here to help us. It works on html elements and
-on components, by adding and removing some css classes.
-
-To perform useful transition effects, whenever an element appears or disappears,
-it is necessary to add/remove some css style or class at some precise moment in
-the lifetime of a node. Since this is not easy to do by hand, Owl `t-transition`
-directive is there to help.
-
-Whenever a node has a `t-transition` directive, with a `name` value, the following
-sequence of events will happen:
-
-At node insertion:
-
-- the css classes `name-enter` and `name-enter-active` will be added directly
-  when the node is inserted into the DOM.
-- on the next animation frame: the css class `name-enter` will be removed and the
-  class `name-enter-to` will be added (so they can be used to trigger css
-  transition effects).
-- at the end of the transition, `name-enter-to` and `name-enter-active` will be removed.
-
-At node destruction:
-
-- the css classes `name-leave` and `name-leave-active` will be added before the
-  node is removed to the DOM.
-- on the next animation frame: the css class `name-leave` will be removed and the
-  class `name-leave-to` will be added (so they can be used to trigger css
-  transition effects).
-- at the end of the transition, `name-leave-to` and `name-leave-active` will be removed.
-
-For example, a simple fade in/out effect can be done with this:
-
-```xml
-<div>
-    <div t-if="state.flag" class="square" t-transition="fade">Hello</div>
-</div>
-```
-
-```css
-.fade-enter-active,
-.fade-leave-active {
-  transition: opacity 0.5s;
-}
-.fade-enter,
-.fade-leave-to {
-  opacity: 0;
-}
-```
-
-The `t-transition` directive can be applied on a node element or on a component.
-
-Notes:
-
-Owl does not support more than one transition on a single node, so the
-`t-transition` expression must be a single value (i.e. no space allowed).
-
-## SCSS Mixins
-
-If you use SCSS, you can use mixins to make generic animations. Here is an exemple with a fade in / fade out animation:
-
-```scss
-@mixin animation-fade($time, $name) {
-  .#{$name}_fade-enter-active,
-  .#{$name}_fade-active {
-    transition: all $time;
-  }
-
-  .#{$name}_fade-enter {
-    opacity: 0;
-  }
-
-  .#{$name}_fade-leave-to {
-    opacity: 0;
-  }
-}
-```
-
-Usage:
-
-```scss
-@include animation-fade(0.5s, "o_notification");
-```
-
-You can now have in your template:
-
-```xml
-<SomeTag  t-transition="o_notification_fade"/>
-```

doc/reference/app.md

@@ -0,0 +1,123 @@
+# 🦉 App 🦉
+
+## Content
+
+- [Overview](#overview)
+- [API](#api)
+- [Configuration](#configuration)
+- [`mount` helper](#mount-helper)
+- [Loading templates](#loading-templates)
+
+## Overview
+
+Every Owl application has a root element, a set of templates, an environment and
+possibly a few other settings. The `App` class is a simple class that represents
+all of these elements. Here is an example:
+
+```js
+const {Component, App } = owl;
+
+class MyComponent extends Component { ... }
+
+const app = new App(MyComponent, { props: {...}, templates: "..."});
+app.mount(document.body);
+```
+
+The basic workflow is: create an `App` instance configured with the root
+component, the templates, and possibly other settings. Then, we mount that
+instance somewhere in the DOM.
+
+## API
+
+- **`constructor(Root[, config])`**: first argument should be a component class (not
+  an instance), and the optional second argument is a configuration object (see below).
+
+- **`mount(target, options)`**: first argument is an html element, and the optional
+  second argument is an object with mounting options (see below). Mount the app
+  to a target in the DOM. Note that this is an asynchronous operation: the `mount`
+  method returns a promise that resolves to the component instance whenever it
+  is complete.
+
+  The `option` object is an object with the following keys:
+
+  - **`position (string)`**: either `first-child` or `last-child`. This option determines
+    the position of the application in the target: either first or last child.
+
+- **`destroy()`**: destroys the application
+
+## Configuration
+
+The `config` object is an object with some of the following keys:
+
+- **`env (object)`**: if given, this will be the shared `env` given to each component
+- **`props (object)`**: the props given to the root component
+- **`dev (boolean, default=false)`**: if `true`, the application is rendered in
+  [`dev` mode](#dev-mode);
+- **`test (boolean, default=false)`**: `test` mode is the same as `dev` mode, except
+  that Owl will not log a message to warn that Owl is in `dev` mode.
+- **`translatableAttributes (string[])`**: a list of additional attributes that should
+  be translated (see [translations](translations.md))
+- **`translateFn (function)`**: a function that will be called by owl to translate
+  templates (see [translations](translations.md))
+- **`templates (string | xml document)`**: all the templates that will be used by
+  the components created by the application.
+- **`warnIfNoStaticProps (boolean, default=false)`**: if true, Owl will log a warning
+  whenever it encounters a component that does not provide a [static props description](props.md#props-validation).
+
+## `mount` helper
+
+Note that there is a `mount` helper to do that in just a line:
+
+```js
+const { mount, Component } = owl;
+
+class MyComponent extends Component {
+    ...
+}
+
+mount(MyComponent, document.body, { props: {...}, templates: "..."});
+```
+
+Here is the `mount` function signature:
+
+**`mount(Component, target, config)`** with the following arguments:
+
+- **`Component`**: a component class (Root component of the app)
+- **`target`**: an html element, where the component will be mounted as last child
+- **`config (optional)`**: a config object (the same as the App config object)
+
+Most of the time, the `mount` helper is more convenient, but whenever one needs
+a reference to the actual Owl App, then using the `App` class directly is
+possible.
+
+## Loading templates
+
+Most applications will need to load templates whenever they start. Here is
+what it could look like in practice:
+
+```js
+// in the main js file:
+const { loadFile, mount } = owl;
+
+// async, so we can use async/await
+(async function setup() {
+  const templates = await loadFile(`/some/endpoint/that/return/templates`);
+  const env = {
+    _t: someTranslateFn,
+    templates,
+    // possibly other stuff
+  };
+
+  mount(Root, document.body, { env });
+})();
+```
+
+## Dev mode
+
+Dev mode activates some additional checks and developer amenities:
+
+- [Props validation](./props.md#props-validation) is performed
+- [t-foreach](./templates.md#loops) loops check for key unicity
+- Lifecycle hooks are wrapped to report their errors in a more developer-friendly way
+- onWillStart and onWillUpdateProps will emit a warning in the console when they
+  take longer than 3 seconds in an effort to ease debugging the presence of deadlocks

doc/reference/browser.md

@@ -1,33 +0,0 @@
-# 🦉 Browser 🦉
-
-## Content
-
-- [Overview](#overview)
-- [Browser Content](#browser-content)
-
-## Overview
-
-The browser object contains some browser native APIs, such as `setTimeout`, that
-are used by Owl and its utility functions. They are exposed with the intent of
-making them mockable if necessary.
-
-```js
-owl.browser.setTimeout === window.setTimeout; // return true
-```
-
-For now, this object contains some functions that are not used by Owl. They
-will eventually be removed in Owl 2.0.
-
-## Browser Content
-
-More specifically, the `browser` object contains the following methods and objects:
-
-- `setTimeout`
-- `clearTimeout`
-- `setInterval`
-- `clearInterval`
-- `requestAnimationFrame`
-- `random`
-- `Date`
-- `fetch`
-- `localStorage`

doc/reference/concurrency_model.md

@@ -11,7 +11,7 @@
 
 Owl was designed from the very beginning with asynchronous components. This comes
 from the `willStart` and the `willUpdateProps` lifecycle hooks. With these
-methods, it is possible to build complex highly concurrent applications.
+asynchronous hooks, it is possible to build complex highly concurrent applications.
 
 Owl concurrent mode has several benefits: it makes it possible to delay the
 rendering until some asynchronous operation is complete, it makes it possible
@@ -35,7 +35,8 @@ two phases: _virtual rendering_ and _patching_.
 
 ### Virtual rendering
 
-This phase represent the process of rendering a template, in memory, which create a virtual representation of the desired component html). The output of this phase is a
+This phase represent the process of rendering a template, in memory, which creates
+a virtual representation of the desired component html). The output of this phase is a
 virtual DOM.
 
 It is asynchronous: each subcomponents needs to either be created (so, `willStart`
@@ -94,7 +95,7 @@ component (with some code like `app.mount(document.body)`).
 5. The method `mounted` is called recursively on all components in the following
    order: `E`, `D`, `C`, `B`, `A`.
 
-**Scenario 2: rerendering a component**. Now, let's assume that the user clicked on some
+**Scenario 2: updating a component**. 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`,
@@ -136,8 +137,7 @@ Here is what Owl will do:
 6. `mounted` hook is called on `F`, `patched` hooks are called on `D`, `C`
 
 Tags are very small helpers to make it easy to write inline templates. There is
-only one currently available tag: `xml`, but we plan to add other tags later,
-such as a `css` tag, which will be used to write [single file components](../learning/how_to_write_sfc.md).
+only one currently available tag: `xml`.
 
 ### Asynchronous Rendering
 
@@ -160,22 +160,4 @@ Here are a few tips on how to work with asynchronous components:
 1. Minimize the use of asynchronous components!
 2. Lazy loading external libraries is a good use case for async rendering. This
    is mostly fine, because we can assume that it will only takes a fraction of a
-   second, and only once (see [`owl.utils.loadJS`](utils.md#loadjs))
-3. For all the other cases, the [`AsyncRoot`](misc.md#asyncroot) component is there to help you. When
-   this component is met, a new rendering
-   sub tree is created, such that the rendering of that component (and its
-   children) is not tied to the rendering of the rest of the interface. It can
-   be used on an asynchronous component, to prevent it from delaying the
-   rendering of the whole interface, or on a synchronous one, such that its
-   rendering isn't delayed by other (asynchronous) components. Note that this
-   directive has no effect on the first rendering, but only on subsequent ones
-   (triggered by state or props changes).
-
-   ```xml
-   <div t-name="ParentComponent">
-     <SyncChild />
-     <AsyncRoot>
-        <AsyncChild/>
-     </AsyncRoot>
-   </div>
-   ```
+   second, and only once.

doc/reference/config.md

@@ -1,44 +0,0 @@
-# 🦉 Config 🦉
-
-The Owl framework is designed to work in many situations. However, it is
-sometimes necessary to customize some behaviour. This is done by using the
-global `config` object. It provides two settings:
-
-- [`mode`](#mode) (default value: `prod`),
-- [`enableTransitions`](#enabletransitions) (default value: `true`).
-
-## Mode
-
-By default, Owl is in _production_ mode, this means that it will try to do its
-job fast, and skip some expensive operations. However, it is sometimes necessary
-to have better information on what is going on, this is the purpose
-of the `dev` mode.
-
-Owl has a mode flag, in `owl.config.mode`. Its default value is `prod`, but
-it can be set to `dev`:
-
-```js
-owl.config.mode = "dev";
-```
-
-Note that templates compiled with the `prod` settings will not be recompiled.
-So, changing this setting is best done at startup.
-
-An important job done by the `dev` mode is to validate props for each component
-creation and update. Also, extra props will cause an error.
-
-## `enableTransitions`
-
-Transitions are usually nice, but they can cause issues in some specific cases,
-such as automated tests. It is uncomfortable having to wait for a transition
-to end before moving to the next step.
-
-To solve this issue, Owl can be configured to ignore the `t-transition` directive.
-To do that, one only needs to set the `enableTransitions` flag to false:
-
-```js
-owl.config.enableTransitions = false;
-```
-
-Note that it suffers from the same drawback as the "dev" mode: all compiled
-templates, if any, will keep their current behaviours.

doc/reference/content.md

@@ -1,36 +0,0 @@
-# 🦉 Owl Content 🦉
-
-Here is a complete visual representation of everything exported by the `owl`
-global object.
-
-For example, `Component` is available at `owl.Component` and `EventBus` is
-exported as `owl.core.EventBus`.
-
-```
-browser
-Component                               misc
-Context                                     AsyncRoot
-QWeb                                        Portal
-mount
-useState                                tags
-config                                      css
-    mode                                    xml
-core                                    utils
-    EventBus                                debounce
-    Observer                                escape
-hooks                                       loadJS
-    onWillStart                             loadFile
-    onMounted                               shallowEqual
-    onWillUpdateProps                       whenReady
-    onWillPatch
-    onPatched
-    onWillUnmount
-    useContext
-    useState
-    useRef
-    useComponent
-    useEnv
-    useSubEnv
-```
-
-Note that for convenience, the `useState` hook is also exported at the root of the `owl` object.

doc/reference/context.md

@@ -1,105 +0,0 @@
-# 🦉 Context 🦉
-
-## Content
-
-- [Overview](#overview)
-- [Example](#example)
-- [Reference](#reference)
-  - [`Context`](#context)
-  - [`useContext`](#usecontext)
-
-## Overview
-
-The `Context` object provides a way to share data between an arbitrary number
-of components. Usually, data is passed from a parent to its children component,
-but when we have to deal with some mostly global information, this can be
-annoying, since each component will need to pass the information to each children,
-even though some or most of them will not use the information.
-
-With a `Context` object, each component can subscribe (with the `useContext` hook)
-to its state, and will be updated whenever the context state is updated.
-
-## Example
-
-Assume that we have an application with various components which needs to render
-differently depending on the size of the device. Here is how we could proceed
-to make sure that the information is properly shared. First, let us create a
-context, and add it to the environment:
-
-```js
-const deviceContext = new Context({ isMobile: true });
-App.env.deviceContext = deviceContext;
-```
-
-If we want to make it completely responsive, we need to update its value whenever
-the size of the screen is updated:
-
-```js
-const isMobile = () => window.innerWidth <= 768;
-window.addEventListener(
-  "resize",
-  owl.utils.debounce(() => {
-    const state = deviceContext.state;
-    if (state.isMobile !== isMobile()) {
-      state.isMobile = !state.isMobile;
-    }
-  }, 15)
-);
-```
-
-Then, each component that want can subscribe and render differently depending on the
-fact that we are in a mobile or desktop mode.
-
-```js
-class SomeComponent extends Component {
-  static template = xml`
-    <div>
-      <t t-if=device.isMobile>
-          some simplified user interface
-      </t>
-      <t t-else="">
-          a more advanced user interface
-      </t>
-    </div>`;
-  device = useContext(this.env.deviceContext);
-}
-```
-
-## Reference
-
-### `Context`
-
-A `Context` object should be created with a state object:
-
-```js
-const someContext = new Context({ some: "key" });
-```
-
-Its state is now available in the `state` key:
-
-```js
-someContext.state.some = "other key";
-```
-
-This is the way some global code (such as the responsive code above) should
-read and update the context state. However, components should not ever read the
-context state directly from the context, they should instead use the `useContext`
-hook to properly register themselves to state changes.
-
-Note that the `Context` hook is different from the React version. For example,
-there is no concept of provider/consumer. So, the `Context` feature does not
-by itself allow the use of a different context state depending on the component
-place in the component tree. However, this functionality can be obtained, if
-necessary, with the use of sub environment.
-
-### `useContext`
-
-The `useContext` hook is the normal way for a component to register themselve
-to context state changes. The `useContext` method returns the context state:
-
-```js
-device = useContext(this.env.deviceContext);
-```
-
-It is a simple observed state (with an owl `Observer`), which contains the shared
-information.

doc/reference/environment.md

@@ -6,15 +6,15 @@
 - [Setting an Environment](#setting-an-environment)
 - [Using a sub environment](#using-a-sub-environment)
 - [Content of an Environment](#content-of-an-environment)
-- [Special keys](#special-keys)
 
 ## Overview
 
-An environment is an object which contains a [`QWeb` instance](qweb_engine.md). Whenever
-a root component is created, it is assigned an environment (see
-[below](#setting-an-environment) for more info on this). This environment is
-then automatically given to each sub component (and accessible in the `this.env`
-property).
+An environment is a shared object given to all components in a tree. It is not
+used by Owl itself, but it is useful for application developers to provide a
+simple communication channel between components (in addition to the props).
+
+The `env` given to the [`App`](app.md) is assigned to the `env` component
+property.
 
 ```
     Root
@@ -22,31 +22,14 @@ property).
    A    B
 ```
 
-This way, all components share the same `QWeb` instance. Owl internally requires
-that the environment has a `qweb` key which maps to a
-[`QWeb`](qweb_engine.md) instance. This is the QWeb instance that will be used to
-render each templates in this specific component tree. Note that if no `QWeb`
-instance is provided, Owl will simply generate it on the fly.
-
-The environment is mostly static. Each application is free to add anything to
-the environment, which is very useful, since this can be accessed by each sub
-component.
+Also, the `env` object is frozen when the application is started. This is done
+to ensure a simpler mental model of what's happening in runtime. Note that it
+is only shallowly frozen, so sub objects can be modified.
 
 ## Setting an environment
 
-An Owl application needs an [environment](environment.md) to be executed. The
-environment has an important key: the [QWeb](qweb_engine.md) instance, which will render
-all templates.
-
-Whenever a root component `App` is mounted, Owl will setup a valid environment by
-following the next steps:
-
-- take the `env` object defined on `App.env` (if no `env` was explicitly setup,
-  this will return the empty `env` object defined on `Component`)
-- if `env.qweb` is not set, then Owl will create a `QWeb` instance.
-
-The correct way to customize an environment is to simply set it up on the root
-component class, before the first component is created:
+The correct way to customize an environment is to simply give it to the `App`,
+whenever it is created.
 
 ```js
 const env = {
@@ -56,81 +39,38 @@ const env = {
         ...
     },
 };
-mount(App, { target: document.body, env });
+
+new App(Root, { env }).mount(document.body);
+
+// or alternatively
+mount(App, document.body, { env });
 ```
 
-It is also possible to simply share an environment between all root components,
-by simply doing this:
-
-```js
-Component.env = myEnv; // will be the default env for all components
-```
-
-Note that this environment is the global owl environment for an application. The
-next section explains how to extend an environment for a specific sub component
-and its children.
-
 ## Using a sub environment
 
 It is sometimes useful to add one (or more) specific keys to the environment,
 from the perspective of a specific component and its children. In that case, the
 solution presented above will not work, since it sets the global environment.
 
-There is a hook for this situation: [`useSubEnv`](hooks.md#usesubenv).
+There are two hooks for this situation: [`useSubEnv` and `useChildSubEnv`](hooks.md#usesubenv-and-usechildsubenv).
 
 ```js
-class FormComponent extends Component {
-  constructor(parent, props) {
-    super(parent, props);
-    useSubEnv({ myKey: someValue });
+class SomeComponent extends Component {
+  setup() {
+    useSubEnv({ myKey: someValue }); // myKey is now available for all child components
   }
 }
 ```
 
 ## Content of an Environment
 
-Some good use cases for additional keys in the environment are:
+The `env` object content is totally up to the application developer. However,
+some good use cases for additional keys in the environment are:
 
 - some configuration keys,
 - session information,
 - generic services (such as doing rpcs).
+- other utility functions that one want to inject, such as a translation function.
 
 Doing it this way means that components are easily testable: we can simply
 create a test environment with mock services.
-
-For example:
-
-```js
-async function myEnv() {
-  const templates = await loadTemplates();
-  const qweb = new QWeb({ templates });
-  const session = getSession();
-
-  return {
-    _t: myTranslateFunction,
-    session: session,
-    qweb: qweb,
-    services: {
-      localStorage: localStorage,
-      rpc: rpc,
-    },
-    debug: false,
-    inMobileMode: true,
-  };
-}
-
-async function start() {
-  const env = await myEnv();
-  mount(App, { target: document.body, env });
-}
-```
-
-## Special Keys
-
-There are two special key/value added by Owl if not provided in the environment:
-the `QWeb` instance and a `browser` object:
-
-- `qweb` will be set to an empty `QWeb` instance. This is absolutely necessary
-  for Owl to be able to render anything
-- `browser`: this is an object that contains some common access points to the
-  browser methods with a side effect. See [browser](browser.md) for more information. Note that the browser object will be removed from the environment in Owl 2.0.

doc/reference/error_handling.md

@@ -3,60 +3,30 @@
 ## Content
 
 - [Overview](#overview)
+- [Managing Errors](#managing-errors)
 - [Example](#example)
-- [Reference](#reference)
 
 ## Overview
 
 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.
+without any user-visible feedback.
 
-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.
+Clearly, it is usually a little bit extreme to destroy the application. This
+is why we need a mechanism to handle rendering errors (and errors coming
+from lifecycle hooks): the `onError` hook.
 
-## Example
+The main idea is that the `onError` hook register a function that will be called
+with the error. This function need to handle the situation, most of the time by
+updating some state and rerendering itself, so the application can return to a
+normal state.
 
-For example, here is how we could implement an `ErrorBoundary` component:
+## Managing Errors
 
-```xml
-<div t-name="ErrorBoundary">
-    <t t-if="state.error">
-        Error handled
-    </t>
-    <t t-else="">
-        <t t-slot="default" />
-    </t>
-</div>
-```
-
-```js
-class ErrorBoundary extends Component {
-  state = useState({ error: false });
-
-  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, see the page on
-[slots](slots.md) for more information on the `t-slot` directive).
-
-## Reference
-
-Whenever the `catchError` lifecycle hook is implemented, all errors coming from
+Whenever the `onError` lifecycle hook is used, all errors coming from
 sub components rendering and/or lifecycle method calls will be caught and given
-to the `catchError` method. This allows us to properly handle the error, and to
+to the `onError` method. This allows us to properly handle the error, and to
 not break the application.
 
 There are important things to know:
@@ -65,17 +35,41 @@ There are important things to know:
   Owl will destroy the full application. This is done on purpose, because Owl
   cannot guarantee that the state is not corrupted from this point on.
 
-- errors coming from event handlers are NOT managed by `catchError` or any other
+- errors coming from event handlers are NOT managed by `onError` or any other
   owl mechanism. This is up to the application developer to properly recover
   from an error
 
-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.
+- if an error handler is unable to properly handle an error, it can just rethrow
+  an error, and Owl will try looking for another error handler up the component
+  tree.
+
+## Example
+
+For example, here is how we could implement a generic component `ErrorBoundary`
+that render its content, and a fallback if an error happened.
 
 ```js
-env.qweb.on("error", null, function (error) {
-  // do something
-  // react to the error
-});
+class ErrorBoundary extends Component {
+  static template = xml`
+    <t t-if="error" t-slot="fallback">An error occurred</t>
+    <t t-else="" t-slot="content"`;
+
+  setup() {
+    this.state = useState({ error: false });
+    onError(() => (this.state.error = true));
+  }
+}
 ```
+
+Using the `ErrorBoundary` is then simple simple:
+
+```xml
+<ErrorBoundary>
+  <SomeOtherComponent/>
+  <t t-set-slot="fallback">Some specific error message</t>
+</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, see the page on
+[slots](slots.md) for more information on the `t-slot` directive).

doc/reference/event_bus.md

@@ -1,25 +0,0 @@
-# 🦉 Event Bus 🦉
-
-It is sometimes useful to use a `Bus` to communicate informations between various
-parts of the code. Owl has a very simple bus class, which manages subscriptions,
-triggering events, and callbacks.
-
-```js
-const bus = new owl.core.EventBus();
-
-bus.on("some-event", null, function (...args) {
-  console.log(...args);
-});
-
-bus.trigger("some-event", 1, 2, 3);
-// [1,2,3] will be logged to the console
-```
-
-Its API is:
-
-| Method                           | Description                       |
-| -------------------------------- | --------------------------------- |
-| `on(eventType, owner, callback)` | add a listener                    |
-| `off(eventType, owner)`          | remove all listeners for an owner |
-| `trigger(eventType, ...args)`    | trigger an event                  |
-| `clear`                          | remove all subscriptions          |

doc/reference/event_handling.md

@@ -3,22 +3,15 @@
 ## Content
 
 - [Event Handling](#event-handling)
-- [Business DOM Events](#business-dom-events)
-- [Inline Event Handlers](#inline-event-handlers)
 - [Modifiers](#modifiers)
+- [Synthetic Events](#synthetic-events)
+- [On Components](#on-components)
 
 ## Event Handling
 
 In a component's template, it is useful to be able to register handlers on DOM
-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`).
+elements to some specific events. This is what makes a template _alive_. This
+is done with the `t-on` directive. For example:
 
 ```xml
 <button t-on-click="someMethod">Do something</button>
@@ -31,93 +24,28 @@ button.addEventListener("click", component.someMethod.bind(component));
 ```
 
 The suffix (`click` in this example) is simply the name of the actual DOM
-event.
-
-## Business DOM Events
-
-A _business_ DOM event is triggered by a call to `trigger` on a component.
+event. The value of the `t-on` expression should be a valid javascript expression
+that evaluates to a function in the context of the current component. So, one
+can get a reference to the event, or pass some additional arguments. For example,
+all the following expressions are valid:
 
 ```xml
-<MyComponent t-on-menu-loaded="someMethod" />
+<button t-on-click="someMethod">Do something</button>
+<button t-on-click="() => this.increment(3)">Add 3</button>
+<button t-on-click="ev => this.doStuff(ev, 'value')">Do something</button>
 ```
 
-```js
- class MyComponent {
-     someWhere() {
-         const payload = ...;
-         this.trigger('menu-loaded', payload);
-     }
- }
-```
+Notice the use of the `this` keyword in the lambda function: this is the
+correct way to call a method on the component in a lambda function.
 
-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.
-
-```js
- class ParentComponent {
-     someMethod(ev) {
-         const payload = ev.detail;
-         ...
-     }
- }
-```
-
-By convention, we use KebabCase for the name of _business_ events.
-
-The `t-on` directive allows to prebind its arguments. For example,
+One could use the following expression:
 
 ```xml
-<button t-on-click="someMethod(expr)">Do something</button>
+<button t-on-click="() => increment(3)">Add 3</button>
 ```
 
-Here, `expr` is a valid Owl expression, so it could be `true` or some variable
-from the rendering context.
-
-### Type Hinting
-
-Note that if you work with Typescript, the `trigger` method is generic on the type of the payload.
-
-You can then describe the type of the event, so you will see typing errors...
-
-```typescript
-this.trigger<MyCustomPayload>("my-custom-event", payload);
-```
-
-```typescript
-myCustomEventHandler(ev: OwlEvent<MyCustomPayload>) { ... }
-```
-
-## Inline Event Handlers
-
-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:
-
-```js
-button.addEventListener("click", () => {
-  context.state.counter++;
-});
-```
-
-Warning: inline expressions are evaluated in the context of the template. This
-means that they can access the component methods and properties. But if they set
-a key, the inline statement will actually not modify the component, but a key in
-a sub scope.
-
-```xml
-<button t-on-click="value = 1">Set value to 1 (does not work!!!)</button>
-<button t-on-click="state.value = 1">Set state.value to 1 (work as expected)</button>
-```
+But then, the increment function may be unbound (unless the component binds it
+in its setup function, for example).
 
 ## Modifiers
 
@@ -125,12 +53,13 @@ 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                                                        |
-| `.capture` | bind the event handler in [capture](https://developer.mozilla.org/en-US/docs/Web/API/EventTarget/addEventListener) mode. |
+| 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                                                        |
+| `.capture`   | bind the event handler in [capture](https://developer.mozilla.org/en-US/docs/Web/API/EventTarget/addEventListener) mode. |
+| `.synthetic` | define a synthetic event handler (see below)                                                                             |
 
 ```xml
 <button t-on-click.stop="someMethod">Do something</button>
@@ -149,3 +78,42 @@ modifiers. For example,
 ```
 
 This will simply stop the propagation of the event.
+
+## Synthetic Events
+
+In some cases, attaching an event handler for each element of large lists has
+a non trivial cost. Owl provides a way to efficiently improve the performance:
+with synthetic event, it actually adds only one handler on the document body,
+and will properly call the handler, just as expected.
+
+The only difference with regular events is that the event is caught at the document
+body, so it cannot be stopped before it actually gets there. Since it may be
+surprising in some cases, it is not enabled by default.
+
+To enable it, one can just use the `.synthetic` suffix:
+
+```xml
+<div>
+    <t t-foreach="largeList" t-as="elem" t-key="elem.id">
+        <button t-on-click.synthetic="doSomething" ...>
+            <!-- some content -->
+        </button>
+    </t>
+</div>
+```
+
+## On Components
+
+The `t-on` directive also works on a child component:
+
+```xml
+<div>
+    in some template
+    <Child t-on-click="dosomething"/>
+</div>
+```
+
+This will catch all click events on any html element contained in the `Child`
+sub component. Note that if the child component is reduced to one (or more) text
+nodes, then clicking on it will not call the handler, since the event will be
+dispatched by the browser on the parent element (a `div` in this case).

doc/reference/hooks.md

@@ -3,24 +3,17 @@
 ## Content
 
 - [Overview](#overview)
-- [Example: Mouse Position](#example-mouse-position)
-- [Example: Autofocus](#example-autofocus)
-- [Reference](#reference)
-  - [One Rule](#one-rule)
+- [The Hook Rule](#the-hook-rule)
+- [Lifecycle hooks](#lifecycle-hooks)
+- [Other hooks](#other-hooks)
   - [`useState`](#usestate)
-  - [`onMounted`](#onmounted)
-  - [`onWillUnmount`](#onwillunmount)
-  - [`onWillPatch`](#onwillpatch)
-  - [`onPatched`](#onpatched)
-  - [`onWillStart`](#onwillstart)
-  - [`onWillUpdateProps`](#onwillupdateprops)
-  - [`useContext`](#usecontext)
   - [`useRef`](#useref)
-  - [`useSubEnv`](#usesubenv)
+  - [`useSubEnv` and `useChildSubEnv`](#usesubenv-and-usechildsubenv)
   - [`useExternalListener`](#useexternallistener)
   - [`useComponent`](#usecomponent)
   - [`useEnv`](#useenv)
-  - [Making customized hooks](#making-customized-hooks)
+  - [`useEffect`](#useeffect)
+- [Example: Mouse Position](#example-mouse-position)
 
 ## Overview
 
@@ -39,96 +32,9 @@ Hooks work beautifully with Owl components: they solve the problems mentioned
 above, and in particular, they are the perfect way to make your component
 reactive.
 
-## Example: mouse position
+## The Hook Rule
 
-Here is the classical example of a non trivial hook to track the mouse position.
-
-```js
-const { useState, onMounted, onWillUnmount } = owl.hooks;
-
-// We define here a custom behaviour: this hook tracks the state of the mouse
-// position
-function useMouse() {
-  const position = useState({ x: 0, y: 0 });
-
-  function update(e) {
-    position.x = e.clientX;
-    position.y = e.clientY;
-  }
-  onMounted(() => {
-    window.addEventListener("mousemove", update);
-  });
-  onWillUnmount(() => {
-    window.removeEventListener("mousemove", update);
-  });
-
-  return position;
-}
-
-// Main root component
-class App extends owl.Component {
-  static template = xml`
-    <div t-name="App">
-      <div>Mouse: <t t-esc="mouse.x"/>, <t t-esc="mouse.y"/></div>
-    </div>`;
-
-  // this hooks is bound to the 'mouse' property.
-  mouse = useMouse();
-}
-```
-
-Note that we use the prefix `use` for hooks, just like in React. This is just
-a convention.
-
-## Example: autofocus
-
-Hooks can be combined to create the desired effect. For example, the following
-hook combines the `useRef` hook with the `onPatched` and `onMounted` functions
-to create an easy way to focus an input whenever it appears in the DOM:
-
-```js
-function useAutofocus(name) {
-  let ref = useRef(name);
-  let isInDom = false;
-  function updateFocus() {
-    if (!isInDom && ref.el) {
-      isInDom = true;
-      ref.el.focus();
-    } else if (isInDom && !ref.el) {
-      isInDom = false;
-    }
-  }
-  onPatched(updateFocus);
-  onMounted(updateFocus);
-}
-```
-
-This hook takes the name of a valid `t-ref` directive, which should be present
-in the template. It then checks whenever the component is mounted or patched if
-the reference is not valid, and in this case, it will focus the node element.
-This hook can be used like this:
-
-```js
-class SomeComponent extends Component {
-  static template = xml`
-    <div>
-        <input />
-        <input t-ref="myinput"/>
-    </div>`;
-
-  constructor(...args) {
-    super(...args);
-    useAutofocus("myinput");
-  }
-}
-```
-
-## Reference
-
-### One rule
-
-There is only one rule: every hook for a component has to be called in the
-constructor, in the _setup_ method, or in class fields:
+There is only one rule: every hook for a component has to be called in the _setup_ method, or in class fields:
 
 ```js
 // ok
@@ -136,14 +42,6 @@ class SomeComponent extends Component {
   state = useState({ value: 0 });
 }
 
-// also ok
-class SomeComponent extends Component {
-  constructor(...args) {
-    super(...args);
-    this.state = useState({ value: 0 });
-  }
-}
-
 // also ok
 class SomeComponent extends Component {
   setup() {
@@ -159,15 +57,24 @@ class SomeComponent extends Component {
 }
 ```
 
-As you can see, the `useState` hook does not need to be given a reference to
-the component. This is possible because there is a way to get a reference to the
-current component: the `Component.current` static property is the reference to the
-component instance that is currently being created.
+## Lifecycle Hooks
 
-Hooks need to be called in the constructor to ensure that this reference is
-properly set. This is also a good thing for performance reasons (Owl can use
-this to optimize its implementation), and for a clean architecture (this makes
-it easier for developers to understand what is really happening in a component).
+All lifecycle hooks are documented in detail in their specific [section](component.md#lifecycle).
+
+| Hook                                                  | Description                                                            |
+| ----------------------------------------------------- | ---------------------------------------------------------------------- |
+| **[onWillStart](component.md#willstart)**             | async, before first rendering                                          |
+| **[onWillRender](component.md#willrender)**           | just before component is rendered                                      |
+| **[onRendered](component.md#rendered)**               | just after component is rendered                                       |
+| **[onMounted](component.md#mounted)**                 | just after component is rendered and added to the DOM                  |
+| **[onWillUpdateProps](component.md#willupdateprops)** | async, before props update                                             |
+| **[onWillPatch](component.md#willpatch)**             | just before the DOM is patched                                         |
+| **[onPatched](component.md#patched)**                 | just after the DOM is patched                                          |
+| **[onWillUnmount](component.md#willunmount)**         | just before removing component from DOM                                |
+| **[onWillDestroy](component.md#willdestroy)**         | just before component is destroyed                                     |
+| **[onError](component.md#onerror)**                   | catch and handle errors (see [error handling page](error_handling.md)) |
+
+## Other Hooks
 
 ### `useState`
 
@@ -178,9 +85,9 @@ The `useState` hook has to be given an object or an array, and will return
 an observed version of it (using a `Proxy`).
 
 ```javascript
-const { useState } = owl.hooks;
+const { useState, Component } = owl;
 
-class Counter extends owl.Component {
+class Counter extends Component {
   static template = xml`
     <button t-on-click="increment">
         Click Me! [<t t-esc="state.value"/>]
@@ -197,128 +104,38 @@ class Counter extends owl.Component {
 It is important to remember that `useState` only works with objects or arrays. It
 is necessary, since Owl needs to react to a change in state.
 
-### `onMounted`
-
-`onMounted` is not a user hook, but is a building block designed to help make useful
-abstractions. `onMounted` registers a callback, which will be called when the component
-is mounted (see example on top of this page).
-
-### `onWillUnmount`
-
-`onWillUnmount` is not a user hook, but is a building block designed to help make useful
-abstractions. `onWillUnmount` registers a callback, which will be called when the component
-is unmounted (see example on top of this page).
-
-### `onWillPatch`
-
-`onWillPatch` is not a user hook, but is a building block designed to help make useful
-abstractions. `onWillPatch` registers a callback, which will be called just
-before the component patched.
-
-### `onPatched`
-
-`onPatched` is not a user hook, but is a building block designed to help make useful
-abstractions. `onPatched` registers a callback, which will be called just
-after the component patched.
-
-### `onWillStart`
-
-`onWillStart` is an asynchronous hook. This means that the function registered
-in the hook will be run just before the component is first rendered and can return a
-promise, to express the fact that it is an asynchronous operation.
-
-Note that if there are more than one `onWillStart` registered callback, then they
-will all be run in parallel.
-
-It can be used to load some initial data. For example, the following hook will
-automatically load some data from the server, and return an object that will
-be ready whenever the component is rendered:
-
-```js
-function useLoader() {
-  const component = Component.current;
-  const record = useState({});
-  onWillStart(async () => {
-    const recordId = component.props.id;
-    Object.assign(record, await fetchSomeRecord(recordId));
-  });
-  return record;
-}
-```
-
-Note that this example does not update the record value whenever props are
-updated. For that situation, we need to use the `onWillUpdateProps` hook.
-
-### `onWillUpdateProps`
-
-Just like `onWillStart`, `onWillUpdateProps` is an asynchronous hook. It is
-designed to be run whenever the component props are updated. This could be
-useful to perform some asynchronous task such as fetching updated data.
-
-```js
-function useLoader() {
-  const component = Component.current;
-  const record = useState({});
-
-  async function updateRecord(id) {
-    Object.assign(record, await fetchSomeRecord(id));
-  }
-
-  onWillStart(() => updateRecord(component.props.id));
-  onWillUpdateProps((nextProps) => updateRecord(nextProps.id));
-
-  return record;
-}
-```
-
-Note that if there are more than one `onWillUpdateProps` registered callback,
-then they will all be run in parallel.
-
-### `useContext`
-
-See [`useContext`](context.md#usecontext) for reference documentation.
-
 ### `useRef`
 
 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:
+of a component, rendered by Owl. It only work on a html element tagged by the
+`t-ref` directive:
 
 ```xml
 <div>
-    <div t-ref="someDiv"/>
-    <SubComponent t-ref="someComponent"/>
+    <input t-ref="someDiv"/>
+    <span>hello</span>
 </div>
 ```
 
 In this example, the component will be able to access the `div` and the component
-`SubComponent` using the `useRef` hook:
+`SubComponent` with the `useRef` hook:
 
 ```js
 class Parent extends Component {
-  subRef = useRef("someComponent");
-  divRef = useRef("someDiv");
+  inputRef = useRef("someComponent");
 
   someMethod() {
     // here, if component is mounted, refs are active:
-    // - this.divRef.el is the div HTMLElement
-    // - this.subRef.comp is the instance of the sub component
-    // - this.subRef.el is the root HTML node of the sub component (i.e. this.subRef.comp.el)
+    // - this.inputRef.el is the input HTMLElement
   }
 }
 ```
 
-As shown by the example above, html elements are accessed by using the `el`
-key, and components references are accessed with `comp`.
-
-Notes:
-
-- if used on a component, the reference will be set in the `refs`
-  variable between `willPatch` and `patched`,
-- on a component, accessing `ref.el` will get the root node of the component.
+As shown by the example above, the actual HTMLElement instance is accessed with
+the `el` key.
 
 The `t-ref` directive also accepts dynamic values with string interpolation
-(like the [`t-attf-`](qweb_templating_language.md#dynamic-attributes) and
+(like the [`t-attf-`](templates.md#dynamic-attributes) and
 `t-component` directives). For example,
 
 ```xml
@@ -335,31 +152,41 @@ this.ref2 = useRef("component_2");
 References are only guaranteed to be active while the parent component is mounted.
 If this is not the case, accessing `el` or `comp` on it will return `null`.
 
-### `useSubEnv`
+### `useSubEnv` and `useChildSubEnv`
 
 The environment is sometimes useful to share some common information between
 all components. But sometimes, we want to _scope_ that knowledge to a subtree.
 
 For example, if we have a form view component, maybe we would like to make some
 `model` object available to all sub components, but not to the whole application.
-This is where the `useSubEnv` hook may be useful: it lets a component add some
-information to the environment in a way that only the component and its children
+This is where the `useChildSubEnv` hook may be useful: it lets a component add some
+information to the environment in a way that only its children
 can access it:
 
 ```js
 class FormComponent extends Component {
-  constructor(...args) {
-    super(...args);
+  setup() {
     const model = makeModel();
+    // model will be available on this.env for this component and all children
     useSubEnv({ model });
+    // someKey will be available on this.env for all children
+    useChildSubEnv({ someKey: "value" });
   }
 }
 ```
 
-The `useSubEnv` takes one argument: an object which contains some key/value that
-will be added to the parent environment. Note that it will extend, not replace
-the parent environment. And of course, the parent environment will not be
-affected.
+The `useSubEnv` and `useChildSubEnv` hooks take one argument: an object which
+contains some key/value that will be added to the current environment. These hooks
+will create a new env object with the new information:
+
+- `useSubEnv` will assign this new `env` to itself and to all children components
+- `useChildSubEnv` will only assign this new `env` to all children components.
+
+As usual in Owl, [environments](environment.md) created with these two hooks are
+frozen, to prevent unwanted modifications.
+
+Note that both these hooks can be called an arbitrary number of times. The `env`
+will then be updated accordingly.
 
 ### `useExternalListener`
 
@@ -377,70 +204,122 @@ useExternalListener(window, "click", this.closeMenu);
 The `useComponent` hook is useful as a building block for some customized hooks,
 that may need a reference to the component calling them.
 
+```js
+function useSomething() {
+  const component = useComponent();
+  // now, component is bound to the instance of the current component
+}
+```
+
 ### `useEnv`
 
 The `useEnv` hook is useful as a building block for some customized hooks,
 that may need a reference to the env of the component calling them.
 
-### Making customized hooks
+```js
+function useSomething() {
+  const env = useEnv();
+  // now, env is bound to the env of the current component
+}
+```
 
-Hooks are a wonderful way to organize the code of a complex component by feature
-instead of by lifecycle methods. They are like mixins, except that they can be
-easily composed together.
+### `useEffect`
 
-But, like every good things in life, hooks should be used with moderation. They are
-not the solution to every problem.
+This hook will run a callback when a component is mounted and patched, and
+will run a cleanup function before patching and before unmounting the
+the component (only if some dependencies have changed).
 
-- they may be overkill: if your component needs to perform some action specific
-  to itself (so, the specific code does not need to be shared), there is nothing
-  wrong with a simple class method:
+It has almost the same API as the React `useEffect` hook, except that the dependencies
+are defined by a function instead of just the dependencies.
 
-  ```js
-  // maybe overkill
-  class A extends Component {
-    constructor(...args) {
-      super(...args);
-      useMySpecificHook();
-    }
+The `useEffect` hook takes two function: the effect function and the dependency
+function. The effect function perform some task and return (optionally) a cleanup
+function. The dependency function returns a list of dependencies, these dependencies
+are passed as parameters in the effect function . If any of these
+dependencies changes, then the current effect will be cleaned up and reexecuted.
+
+Here is an example without any dependencies:
+
+```js
+useEffect(
+  () => {
+    window.addEventListener("mousemove", someHandler);
+    return () => window.removeEventListener("mousemove", someHandler);
+  },
+  () => []
+);
+```
+
+In the example above, the dependency list is empty, so the effect is only cleaned
+up when the component is unmounted.
+
+If the dependency function is skipped, then the effect will be cleaned up and
+rerun at every patch.
+
+Here is another example, of how one could implement a `useAutofocus` hook with
+the `useEffect` hook:
+
+```js
+function useAutofocus(name) {
+  let ref = useRef(name);
+  useEffect(
+    (el) => el && el.focus(),
+    () => [ref.el]
+  );
+}
+```
+
+This hook takes the name of a valid `t-ref` directive, which should be present
+in the template. It then checks whenever the component is mounted or patched if
+the reference is not valid, and in this case, it will focus the node element.
+This hook can be used like this:
+
+```js
+class SomeComponent extends Component {
+  static template = xml`
+    <div>
+        <input />
+        <input t-ref="myinput"/>
+    </div>`;
+
+  setup() {
+    useAutofocus("myinput");
   }
+}
+```
 
-  // ok
-  class B extends Component {
-    constructor(...args) {
-      super(...args);
-      this.performSpecificTask();
-    }
+## Example: mouse position
+
+Here is the classical example of a non trivial hook to track the mouse position.
+
+```js
+const { useState, onWillDestroy, Component } = owl;
+
+// We define here a custom behaviour: this hook tracks the state of the mouse
+// position
+function useMouse() {
+  const position = useState({ x: 0, y: 0 });
+
+  function update(e) {
+    position.x = e.clientX;
+    position.y = e.clientY;
   }
-  ```
+  window.addEventListener("mousemove", update);
+  onWillDestroy(() => {
+    window.removeEventListener("mousemove", update);
+  });
 
-  Note that the second solution is easier to extend in sub components.
+  return position;
+}
 
-- they may be harder to test: if a customized hook injects some external side
-  effect dependency, then it is harder to test without doing some non obvious
-  manipulation. For example, assume that we want to give a reference to a
-  router in a `useRouter` hook. We could do this:
+// Main root component
+class Root extends Component {
+  static template = xml`<div>Mouse: <t t-esc="mouse.x"/>, <t t-esc="mouse.y"/></div>`;
 
-  ```js
-  const router = new Router(...);
+  // this hooks is bound to the 'mouse' property.
+  mouse = useMouse();
+}
+```
 
-  function useRouter() {
-      return router;
-  }
-  ```
-
-  As you can see, this does not _hook_ into the internal of the component. It
-  simply returns a global object, which is difficult to mock.
-
-  A better way would be to do something like this: get the reference from the
-  environment.
-
-  ```js
-  function useRouter() {
-    const env = useEnv();
-    return env.router;
-  }
-  ```
-
-  This means that we give control to the application developer to create the
-  router, which is good, so they can set it up, subclass it, ... And then, to
-  test our components, we can just add a mock router in the environment.
+Note that we use the prefix `use` for hooks, just like in React. This is just
+a convention.

doc/reference/input_bindings.md

@@ -0,0 +1,92 @@
+# 🦉 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 {
+  state = useState({ text: "" });
+
+  _updateInputValue(event) {
+    this.state.text = event.target.value;
+  }
+}
+```
+
+```xml
+<div>
+  <input t-on-input="_updateInputValue" />
+  <span t-esc="state.text" />
+</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
+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:
+
+```js
+class Form extends owl.Component {
+  state = { text: "" };
+}
+```
+
+```xml
+<div>
+  <input t-model="state.text" />
+  <span t-esc="state.text" />
+</div>
+```
+
+The `t-model` directive works with `<input>`, `<input type="checkbox">`,
+`<input type="radio">`, `<textarea>` and `<select>`:
+
+```xml
+<div>
+    <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>
+    <div>Selection:
+        <select t-model="state.color">
+            <option value="">Select a color</option>
+            <option value="red">Red</option>
+            <option value="blue">Blue</option>
+        </select>
+    </div>
+    <div>
+        Selection with radio buttons:
+        <span>
+            <input type="radio" name="color" id="red" value="red" t-model="state.color"/>
+            <label for="red">Red</label>
+        </span>
+        <span>
+            <input type="radio" name="color" id="blue" value="blue" t-model="state.color" />
+            <label for="blue">Blue</label>
+        </span>
+    </div>
+</div>
+```
+
+Like event handling, the `t-model` directive accepts the following modifiers:
+
+| Modifier  | Description                                                          |
+| --------- | -------------------------------------------------------------------- |
+| `.lazy`   | update the value on the `change` event (default is on `input` event) |
+| `.number` | try to parse the value to a number (using `parseFloat`)              |
+| `.trim`   | trim the resulting value                                             |
+
+For example:
+
+```xml
+<input t-model.lazy="state.someVal" />
+```
+
+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.

doc/reference/misc.md

@@ -1,133 +0,0 @@
-# 🦉 Miscellaneous 🦉
-
-## Content
-
-- [Portal](#portal)
-- [AsyncRoot](#asyncroot)
-
-## `Portal`
-
-### Overview
-
-The component `Portal` is meant to be used as a transparent way to 'teleport' a piece
-of DOM to the node represented by its sole `target` props.
-
-This component aims at helping the implementation of the needed infrastructure
-for modals (as in `bootstrap-modal`).
-
-### Usage
-
-The content it will teleport is defined within the `<Portal>` node and
-internally uses the `default` [Slot](slots.md).
-
-This slot must contain only **one** node, which in turn can have as many children as necessary.
-
-The element under which the content will be teleported is represented as a selector
-by the `target` props which only accepts a string as value.
-
-The `target` props only supports static selector, and is not meant to be passed to `Portal`
-as a variable. Namely, `<Portal target="'body'" />` is the intended use.
-By contrast, `<Portal target="state.target" />` is not supported.
-
-The component `Portal` has no particular state, rather it is meant to be a slave to its parent,
-and ultimately just a way for the parent to teleport a piece of its own DOM elsewhere.
-
-The `Portal`'s root node is always `<portal/>` and is placed where the teleported content
-_would have_ been. It is this element that the [teleported events](#expected-behaviors) are re-directed on.
-
-### Example
-
-The canonic use-case is to implement a Dialog, where a Component may choose to break the natural
-workflow to help the user put in some data, which it could use later on.
-
-JavaScript:
-
-```js
-const { Component, mount } = owl;
-const { Portal } = owl.misc;
-
-class TeleportedComponent extends Component {}
-class App extends Component {
-  static components = { Portal, TeleportedComponent };
-}
-
-mount(App, { target: document.body });
-```
-
-XML:
-
-```xml
-<templates>
-    <div t-name="TeleportedComponent">
-        <span>I will move soon enough</span>
-    </div>
-
-    <div t-name="App">
-        <span>I am like the rest of us</span>
-        <Portal target="'body'">
-            <TeleportedComponent />
-        </Portal>
-    </div>
-</templates>
-```
-
-In this example, the `Portal` component will teleport the `TeleportedComponent`'s `div` as a child of the `body`.
-`TeleportedComponent` is acting as a Dialog here.
-
-The resulting DOM will look like:
-
-```xml
-<body>
-    <div>
-        <span>I am like the rest of us</span>
-        <portal></portal>
-    </div>
-    <div>
-        <span>I will move soon enough</span>
-    </div>
-</body>
-```
-
-### Expected Behaviors
-
-The teleported piece is updated as any other `Component`'s DOM and in the same sequence.
-Namely the teleported piece will be updated in function of its parents components, and patched as
-a normal child.
-
-The [_business_ events](event_handling.md#business-dom-events) triggered by a child component will be stopped
-to not bubble outside of the `target`. They will, on the other hand, be re-directed onto the
-`Portal`'s root node and bubble up the DOM as if it were triggered by a regular child component.
-
-Beware that those re-directed events are copies of the original event.
-They have:
-
-- The same payload.
-- The same `originalComponent` than their original counterpart,
-  that is the actual Component that triggered it.
-- A **different** `target` property than their original counterpart.
-  The `target` of a re-directed event is necessarily the `Portal`'s root node.
-
-Pure DOM events do not follow this pattern and are free to bubble their natural, unaltered way
-up to the `body`.
-
-## `AsyncRoot`
-
-When this component is used, a new rendering sub tree is created, such that the
-rendering of that component (and its children) is not tied to the rendering of
-the rest of the interface. It can be used on an asynchronous component, to
-prevent it from delaying the rendering of the whole interface, or on a
-synchronous one, such that its rendering isn't delayed by other (asynchronous)
-components. Note that this directive has no effect on the first rendering, but
-only on subsequent ones (triggered by state or props changes).
-
-```xml
-<div t-name="ParentComponent">
-  <SyncChild />
-  <AsyncRoot>
-     <AsyncChild/>
-  </AsyncRoot>
-</div>
-```
-
-The `AsyncRoot` assumes that there is exactly one root node inside it. It can
-be a dom node or a component.

doc/reference/mounting.md

@@ -1,60 +0,0 @@
-# 🦉 Mounting an application 🦉
-
-## Content
-
-- [Overview](#overview)
-- [API](#api)
-
-## Overview
-
-Mounting an Owl application is done by using the `mount` method (available in
-`owl.mount` if you are using the iife build, or it can be directly imported
-from `owl` if you are using a module system):
-
-```js
-const mount = { owl }; // if owl is available as an object
-
-const env = { ... };
-const app = await mount(MyComponent, { target: document.body, env });
-```
-
-Another example:
-
-```js
-const config = {
-  env: ...,
-  props: ...,
-  target: document.body,
-  position: "self",
-};
-const app = await mount(App, config);
-```
-
-A common way to initialize an application is to first setup an environment,
-then to call the `mount` method.
-
-## API
-
-Mount takes two parameters:
-
-- `C`, which should be a component class (NOT instance),
-- `params`, which is an object with the following keys:
-  - `target (HTMLElement | DocumentFragment)`: the target of the mount operation
-  - `env (optional, Env)` an environment
-  - `position (optional, "first-child" | "last-child" | "self")` the position
-    where it should be mounted (see below for more informations)
-  - `props (optional, any)`: some initial values that are given as props. Useful
-    when the root component is configurable, or when testing sub components
-
-Here are the various positions supported by Owl:
-
-- `first-child`: with this option, the component will be prepended inside the target,
-- `last-child` (default value): with this option, the component will be
-  appended in the target element,
-- `self`: the target will be used as the root element for the component. This
-  means that the target has to be an HTMLElement (and not a document fragment).
-  In this situation, it is possible that the component cannot be unmounted. For
-  example, if its target is `document.body`.
-
-The `mount` method returns a promise that resolves to the instance of the created
-component.

doc/reference/observer.md

@@ -1,52 +0,0 @@
-# 🦉 Observer 🦉
-
-Owl needs to be able to react to state changes. For example, whenever the state
-of a component is changed, Owl needs to rerender it. To help with that, there is
-an Observer class. Its job is to observe the state of an object (or array), and
-to react to any change. The observer is implemented with the native `Proxy`
-object. Note that this means that it will not work on older browsers.
-
-Note that the `Observer` is used by the `useState` and `useContext` hooks. This
-is the way most Owl applications will create observers. For the majority of
-use cases, there is no need to directly instantiate an observer.
-
-## Example
-
-For example, this code will display `update` in the console:
-
-```javascript
-const observer = new owl.core.Observer();
-observer.notifyCB = () => console.log("update");
-const obj = observer.observe({ a: { b: 1 } });
-
-obj.a.b = 2;
-```
-
-This example shows that an observer can observe nested properties.
-
-## Reference
-
-**observe** An observer can observe multiple values with the `observe` method.
-This method takes an object or an array as its argument and will return a proxy
-(which is mapped to the initial object/array). With this proxy, the observer
-can detect whenever any internal value is changed.
-
-**Registering a callback** Whenever an observer sees a state change, it will
-call its `notifyCB` method. No additional information is given to the callback.
-
-**deepRevNumber** Each observed value has an internal revision number, which
-is incremented every time the value is observed. Sometimes, it can be useful
-to obtain that number:
-
-```js
-const observer = new owl.core.Observer();
-const obj = observer.observe({ a: { b: 1 } });
-
-observer.revNumber(obj.a); // 1
-obj.a.b = 2;
-
-observer.revNumber(obj.a); // 2
-```
-
-The `revNumber` can also return 0, which indicates that the value is not
-observed.

doc/reference/portal.md

@@ -0,0 +1,17 @@
+# 🦉 Portal 🦉
+
+It is sometimes useful to be able to render some content outside the boundaries
+of a component. To do that, Owl provides a special directive: `t-portal`:
+
+```js
+class SomeComponent extends Component {
+  static template = xml`
+      <div>this is inside the component</div>
+      <div t-portal="'body'">and this is outside</div>
+    `;
+}
+```
+
+The `t-portal` directive takes a valid css selector as argument. The content of
+the portalled template will be mounted at the corresponding location. Note that
+Owl need to insert an empty text node at the location of the portalled content.

doc/reference/precompiling_templates.md

@@ -0,0 +1,30 @@
+# 🦉 Precompiling templates 🦉
+
+Owl is designed to be used by the Odoo javascript framework. Since Odoo handles
+its assets in its own non standard way, it was decided/assumed that Owl would
+compile templates at runtime.
+
+However, in some cases, it is not optimal, or even worse, not possible to do that.
+For example, browser extensions do not allow javascript code to create a new
+function (using the `new Function(...)` syntax).
+
+Therefore, in these cases, it is required to compile templates ahead of time. It
+is possible to do that in Owl, but the tooling is still rough. For now, the
+process is the following:
+
+1. write your templates in xml files (with a `t-name` directive to declare the name
+   of the template)
+2. Compile them in a `templates.js` file
+3. get the `owl.iife.runtime.js` file (which is a owl build without the compiler)
+4. bundle `owl.iife.runtime.js` and `template.js` with your assets (owl needs to
+   be positioned before the templates)
+
+Here is a more detailed explanation on how to compile xml files into a js file:
+
+1. clone the owl repository locally
+2. `npm install` to install all the required tooling
+3. `npm run build:runtime` to build the `owl.iife.runtime.js` file
+4. `npm run build:compiler` to build the template compiler
+5. `npm run compile_templates -- path/to/your/templates` will scan your target
+   folder, find all xml files, get all templates, compile them, and generate a
+   `templates.js` file.

doc/reference/props.md

@@ -4,8 +4,11 @@
 
 - [Overview](#overview)
 - [Definition](#definition)
-- [Good Practices](#good-practices)
+- [Binding function props](#binding-function-props)
 - [Dynamic Props](#dynamic-props)
+- [Default Props](#default-props)
+- [Props validation](#props-validation)
+- [Good Practices](#good-practices)
 
 ## Overview
 
@@ -38,8 +41,6 @@ The `props` object is made of every attributes defined on the template, with the
 following exceptions:
 
 - every attribute starting with `t-` are not props (they are QWeb directives),
-- `style` and `class` attributes are excluded as well (they are applied by Owl on
-  the root element of the component).
 
 In the following example:
 
@@ -47,7 +48,6 @@ In the following example:
 <div>
     <ComponentA a="state.a" b="'string'"/>
     <ComponentB t-if="state.flag" model="model"/>
-    <ComponentC style="color:red;" class="left-pane" />
 </div>
 ```
 
@@ -55,7 +55,197 @@ the `props` object contains the following keys:
 
 - for `ComponentA`: `a` and `b`,
 - for `ComponentB`: `model`,
-- for `ComponentC`: empty object
+
+## Binding function props
+
+It is common to have the need to pass a callback as a prop. Since Owl components
+are class based, the callback frequently needs to be bound to its owner component.
+So, one can do this:
+
+```js
+class SomeComponent extends Component {
+  static template = xml`
+    <div>
+      <Child callback="doSomething"/>
+    </div>`;
+
+  setup() {
+    this.doSomething = this.doSomething.bind(this);
+  }
+
+  doSomething() {
+    // ...
+  }
+}
+```
+
+However, this is such a common use case that Owl provides a special suffix to do
+just that: `.bind`. This looks like this:
+
+```js
+class SomeComponent extends Component {
+  static template = xml`
+    <div>
+      <Child callback.bind="doSomething"/>
+    </div>`;
+
+  doSomething() {
+    // ...
+  }
+}
+```
+
+## Dynamic Props
+
+The `t-props` directive can be used to specify totally dynamic props:
+
+```xml
+<div t-name="ParentComponent">
+    <Child t-props="some.obj"/>
+</div>
+```
+
+```js
+class ParentComponent {
+  static components = { Child };
+  some = { obj: { a: 1, b: 2 } };
+}
+```
+
+## Default Props
+
+If the static `defaultProps` property is defined, it will be used to complete
+props received by the parent, if missing.
+
+```js
+class Counter extends owl.Component {
+  static defaultProps = {
+    initialValue: 0,
+  };
+  ...
+}
+```
+
+In the example above, the `initialValue` props is now by default set to 0.
+
+## Props Validation
+
+As an application becomes complex, it may be quite unsafe to define props in an informal way. This leads to two issues:
+
+- hard to tell how a component should be used, by looking at its code.
+- unsafe, it is easy to send wrong props into a component, either by refactoring a component, or one of its parents.
+
+A props type system solves both issues, by describing the types and shapes
+of the props. Here is how it works in Owl:
+
+- `props` key is a static key (so, different from `this.props` in a component instance)
+- it is optional: it is ok for a component to not define a `props` key.
+- props are validated whenever a component is created/updated
+- props are only validated in `dev` mode (see [how to configure an app](app.md#configuration))
+- if a key does not match the description, an error is thrown
+- it validates keys defined in (static) `props`. Additional keys given by the
+  parent will cause an error (unless the special prop `*` is present).
+- it is an object or a list of strings
+- a list of strings is a simplified props definition, which only lists the name
+  of the props. Also, if the name ends with `?`, it is considered optional.
+- all props are by default required, unless they are defined with `optional: true`
+  (in that case, it is only done if there is a value)
+- valid types are: `Number, String, Boolean, Object, Array, Date, Function`, and all
+  constructor functions (so, if you have a `Person` class, it can be used as a type)
+- arrays are homogeneous (all elements have the same type/shape)
+
+For each key, a `prop` definition is either a boolean, a constructor, a list of constructors, or an object:
+
+- a boolean: indicate that the props exists, and is mandatory.
+- a constructor: this should describe the type, for example: `id: Number` describe
+  the props `id` as a number
+- an object describing a value as type. This is done by using the `value` key. For example, `{value: false}` specifies that the corresponding value should be equal to false.
+- a list of constructors. In that case, this means that we allow more than one
+  type. For example, `id: [Number, String]` means that `id` can be either a string
+  or a number.
+- an object. This makes it possible to have more expressive definition. The following sub keys are then allowed (but not mandatory):
+  - `type`: the main type of the prop being validated
+  - `element`: if the type was `Array`, then the `element` key describes the type of each element in the array. If it is not set, then we only validate the array, not its elements,
+  - `shape`: if the type was `Object`, then the `shape` key describes the interface of the object. If it is not set, then we only validate the object, not its elements,
+  - `validate`: this is a function which should return a boolean to determine if
+    the value is valid or not. Useful for custom validation logic.
+  - `optional`: if true, the prop is not mandatory
+
+There is a special `*` prop that means that additional prop are allowed. This is
+sometimes useful for generic components that will propagate some or all their
+props to their child components.
+
+Note that default values cannot be defined for a mandatory props. Doing so will
+result in a prop validation error.
+
+Examples:
+
+```js
+class ComponentA extends owl.Component {
+    static props = ['id', 'url'];
+
+    ...
+}
+
+class ComponentB extends owl.Component {
+  static props = {
+    count: {type: Number},
+    messages: {
+      type: Array,
+      element: {type: Object, shape: {id: Boolean, text: String }
+    },
+   date: Date,
+   combinedVal: [Number, Boolean],
+   optionalProp: { type: Number, optional: true }
+  };
+
+  ...
+}
+```
+
+```js
+  // only the existence of those 3 keys is documented
+  static props = ['message', 'id', 'date'];
+```
+
+```js
+  // only the existence of those 3 keys is documented. any other key is allowed.
+  static props = ['message', 'id', 'date', '*'];
+```
+
+```js
+  // size is optional
+  static props = ['message', 'size?'];
+```
+
+```js
+  static props = {
+    messageIds: {type: Array, element: Number},  // list of number
+    otherArr: {type: Array},   // just array. no validation is made on sub elements
+    otherArr2: Array,   // same as otherArr
+    someObj: {type: Object},  // just an object, no internal validation
+    someObj2: {
+      type: Object,
+      shape: {
+        id: Number,
+        name: {type: String, optional: true},
+        url: String
+      ]},    // object, with keys id (number), name (string, optional) and url (string)
+    someFlag: Boolean,     // a boolean, mandatory (even if `false`)
+    someVal: [Boolean, Date],   // either a boolean or a date
+    otherValue: true,     // indicates that it is a prop
+    kindofsmallnumber: {
+      type: Number,
+      validate: n => (0 <= n && n <= 10)
+    },
+    size: {
+      validate:  e => ["small", "medium", "large"].includes(e)
+    },
+    someId: [Number, {value: false}], // either a number or false
+  };
+```
+
+Note: the props validation code is done by using the [validate utility function](utils.md#validate).
 
 ## Good Practices
 
@@ -78,20 +268,3 @@ sent to the parent (for example, with an event).
 Any value can go in a props. Strings, objects, classes, or even callbacks could
 be given to a child component (but then, in the case of callbacks, communicating
 with events seems more appropriate).
-
-## Dynamic Props
-
-The `t-props` directive can be used to specify totally dynamic props:
-
-```xml
-<div t-name="ParentComponent">
-    <Child t-props="some.obj"/>
-</div>
-```
-
-```js
-class ParentComponent {
-  static components = { Child };
-  some = { obj: { a: 1, b: 2 } };
-}
-```

doc/reference/props_validation.md

@@ -1,103 +0,0 @@
-# 🦉 Props Validation 🦉
-
-As an application becomes complex, it may be quite unsafe to define props in an informal way. This leads to two issues:
-
-- hard to tell how a component should be used, by looking at its code.
-- unsafe, it is easy to send wrong props into a component, either by refactoring a component, or one of its parents.
-
-A props type system solves both issues, by describing the types and shapes
-of the props. Here is how it works in Owl:
-
-- `props` key is a static key (so, different from `this.props` in a component instance)
-- it is optional: it is ok for a component to not define a `props` key.
-- props are validated whenever a component is created/updated
-- props are only validated in `dev` mode (see [config page](config.md#mode))
-- if a key does not match the description, an error is thrown
-- it validates keys defined in (static) `props`. Additional keys given by the
-  parent will cause an error.
-
-For example:
-
-```js
-class ComponentA extends owl.Component {
-    static props = ['id', 'url'];
-
-    ...
-}
-
-class ComponentB extends owl.Component {
-  static props = {
-    count: {type: Number},
-    messages: {
-      type: Array,
-      element: {type: Object, shape: {id: Boolean, text: String }
-    },
-   date: Date,
-   combinedVal: [Number, Boolean]
-  };
-
-  ...
-}
-```
-
-- it is an object or a list of strings
-- a list of strings is a simplified props definition, which only lists the name
-  of the props. Also, if the name ends with `?`, it is considered optional.
-- all props are by default required, unless they are defined with `optional: true`
-  (in that case, validation is only done if there is a value)
-- valid types are: `Number, String, Boolean, Object, Array, Date, Function`, and all
-  constructor functions (so, if you have a `Person` class, it can be used as a type)
-- arrays are homogeneous (all elements have the same type/shape)
-
-For each key, a `prop` definition is either a boolean, a constructor, a list of constructors, or an object:
-
-- a boolean: indicate that the props exists, and is mandatory.
-- a constructor: this should describe the type, for example: `id: Number` describe
-  the props `id` as a number
-- a list of constructors. In that case, this means that we allow more than one
-  type. For example, `id: [Number, String]` means that `id` can be either a string
-  or a number.
-- an object. This makes it possible to have more expressive definition. The following sub keys are then allowed (but not mandatory):
-  - `type`: the main type of the prop being validated
-  - `element`: if the type was `Array`, then the `element` key describes the type of each element in the array. If it is not set, then we only validate the array, not its elements,
-  - `shape`: if the type was `Object`, then the `shape` key describes the interface of the object. If it is not set, then we only validate the object, not its elements,
-  - `validate`: this is a function which should return a boolean to determine if
-    the value is valid or not. Useful for custom validation logic.
-
-Examples:
-
-```js
-  // only the existence of those 3 keys is documented
-  static props = ['message', 'id', 'date'];
-```
-
-```js
-  // size is optional
-  static props = ['message', 'size?'];
-```
-
-```js
-  static props = {
-    messageIds: {type: Array, element: Number},  // list of number
-    otherArr: {type: Array},   // just array. no validation is made on sub elements
-    otherArr2: Array,   // same as otherArr
-    someObj: {type: Object},  // just an object, no internal validation
-    someObj2: {
-      type: Object,
-      shape: {
-        id: Number,
-        name: {type: String, optional: true},
-        url: String
-      ]},    // object, with keys id (number), name (string, optional) and url (string)
-    someFlag: Boolean,     // a boolean, mandatory (even if `false`)
-    someVal: [Boolean, Date],   // either a boolean or a date
-    otherValue: true,     // indicates that it is a prop
-    kindofsmallnumber: {
-      type: Number,
-      validate: n => (0 <= n && n <= 10)
-    },
-    size: {
-      validate:  e => ["small", "medium", "large"].includes(e)
-    },
-  };
-```

doc/reference/qweb_engine.md

@@ -1,153 +0,0 @@
-# 🦉 QWeb Engine 🦉
-
-## Content
-
-- [Overview](#overview)
-- [Reference](#reference)
-
-## Overview
-
-[QWeb](https://www.odoo.com/documentation/13.0/reference/qweb.html) is the primary
-templating engine used by Odoo. The QWeb class in the OWL project is an
-implementation of that specification with a few interesting points:
-
-- it compiles templates into functions that output a virtual DOM instead of a
-  string. This is necessary for the component system.
-- it has a few extra directives: `t-component`, `t-on`, ...
-
-We present in this section the engine, not the templating language.
-
-## Reference
-
-This section is about the javascript code that implements the `QWeb` specification.
-Owl exports a `QWeb` class in `owl.QWeb`. To use it, it just needs to be
-instantiated:
-
-```js
-const qweb = new owl.QWeb();
-```
-
-Its API is quite simple:
-
-- **`constructor(config)`**: constructor. Takes an optional configuration object
-  with an optional `templates` string to add initial
-  templates (see `addTemplates` for more information on format of the string)
-  and an optional `translateFn` translate function (see the section on
-  [translations](#translations)).
-
-  ```js
-  const qweb = new owl.QWeb({ templates: TEMPLATES, translateFn: _t });
-  ```
-
-- **`addTemplate(name, xmlStr, allowDuplicate)`**: add a specific template.
-
-  ```js
-  qweb.addTemplate("mytemplate", "<div>hello</div>");
-  ```
-
-  If the optional `allowDuplicate` is set to `true`, then `QWeb` will simply
-  ignore templates added for a second time. Otherwise, `QWeb` will crash.
-
-- **`addTemplates(xmlStr)`**: add a list of templates (identified by `t-name`
-  attribute).
-
-  ```js
-  const TEMPLATES = `
-    <templates>
-      <div t-name="App" class="main">main</div>
-      <div t-name="OtherComponent">other component</div>
-    </templates>`;
-  qweb.addTemplates(TEMPLATES);
-  ```
-
-- **`render(name, context, extra)`**: renders a template. This returns a `vnode`,
-  which is a virtual representation of the DOM (see [vdom doc](../miscellaneous/vdom.md)).
-
-  ```js
-  const vnode = qweb.render("App", component);
-  ```
-
-- **`renderToString(name, context)`**: renders a template, but returns an html
-  string.
-
-  ```js
-  const str = qweb.renderToString("someTemplate", somecontext);
-  ```
-
-- **`registerTemplate(name, template)`**: static function to register a global
-  QWeb template. This is useful for commonly used components accross the
-  application, and for making a template available to an application without
-  having a reference to the actual QWeb instance.
-
-  ```js
-  QWeb.registerTemplate("mytemplate", `<div>some template</div>`);
-  ```
-
-- **`registerComponent(name, Component)`**: static function to register an OWL Component
-  to QWeb's global registry. Globally registered Components can be used in
-  templates (see the `t-component` directive). This is useful for commonly used
-  components accross the application.
-
-  ```js
-  class Dialog extends owl.Component { ... }
-  QWeb.registerComponent("Dialog", Dialog);
-
-  ...
-
-  class ParentComponent extends owl.Component { ... }
-  qweb.addTemplate("ParentComponent", "<div><Dialog/></div>");
-  ```
-
-In some way, a `QWeb` instance is the core of an Owl application. It is the only
-mandatory element of an [environment](environment.md). As such, it
-has an extra responsibility: it can act as an event bus for internal communication
-between Owl classes. This is the reason why `QWeb` actually extends [EventBus](event_bus.md).
-
-### Translations
-
-take care of this and "cherry-pick" 8464a1b04e7469434f9dcb3d68a543f58cb61b8e
-
-If properly setup, Owl QWeb engine can translate all rendered templates. To do
-so, it needs a translate function, which takes a string and returns a string.
-
-For example:
-
-```js
-const translations = {
-  hello: "bonjour",
-  yes: "oui",
-  no: "non",
-};
-const translateFn = (str) => translations[str] || str;
-
-const qweb = new QWeb({ translateFn });
-```
-
-Once setup, all rendered templates will be translated using `translateFn`:
-
-- each text node will be replaced with its translation,
-- each of the following attribute values will be translated as well: `title`,
-  `placeholder`, `label` and `alt`,
-- translating text nodes can be disabled with the special attribute `t-translation`,
-  if its value is `off`.
-
-So, with the above `translateFn`, the following templates:
-
-```xml
-<div>hello</div>
-<div t-translation="off">hello</div>
-<div>Are you sure?</div>
-<input placeholder="hello" other="yes"/>
-```
-
-will be rendered as:
-
-```xml
-<div>bonjour</div>
-<div>hello</div>
-<div>Are you sure?</div>
-<input placeholder="bonjour" other="yes"/>
-```
-
-Note that the translation is done during the compilation of the template, not
-when it is rendered.

doc/reference/reactivity.md

@@ -0,0 +1,395 @@
+# 🦉 Reactivity 🦉
+
+## Content
+
+- [Introduction](#introduction)
+- [`useState`](#usestate)
+- [`reactive`](#reactive)
+- [`Escape hatches`](#escape-hatches)
+- [`Advanced usage`](#advanced-usage)
+
+## Introduction
+
+Reactivity is a big topic in javascript frameworks. The goal is to provide a
+simple way to manipulate state, in such a way that the interface updates automatically
+according to state changes, and to do so in a performant manner.
+
+To this end, Owl provides a proxy-based reactivity system, based on the `reactive` primitive.
+The `reactive` function takes an object as a first argument, and an optional callback as its second
+argument, it returns a proxy of the object. This proxy tracks what properties are read
+through the proxy, and calls the provided callback whenever one of these properties is changed
+through any reactive version of the same object. It does so in depth, by returning reactive versions
+of the subobjects when they are read.
+
+## `useState`
+
+While the `reactive` primitive is very powerful, its usage in components follow a very standard pattern:
+components want to be rerendered when part of the state which they depend on for rendering changes. To
+this end, owl provides a standard hook: `useState`. To put it simply, this hook simply calls reactive
+with the provided object, and the current component's render function as its callback. This will cause
+it to rerender whenever any part of the state object that has been read by this component is modified.
+
+Here is a simple example of how `useState` can be used:
+
+```js
+class Counter extends Component {
+  static template = xml`
+    <div t-on-click="() => this.state.value++">
+      <t t-esc="state.value"/>
+    </div>`;
+
+  setup() {
+    this.state = useState({ value: 0 });
+  }
+}
+```
+
+This component reads `state.value` when it renders, subscribing it to changes to that key. Whenever
+the value changes, Owl will update the component. Note that there is nothing special about the
+`state` property, you can name your state variables whatever you want, and you can have multiple of
+them on the same component if it makes sense to do so. This also allows `useState` to be used in custom
+hooks that may require state that is specific to that hook.
+
+### Reactive props
+
+Since version 2.0, Owl renders are no longer "deep" by default: a component is only rerendered by its
+parent if its props have changed (using a simple equality test). What if the contents of a props have
+changed in a deeper property? If that prop is reactive, owl will rerender the child components that
+need to be updated automatically, and only those components, it does so by reobserving reactive
+objects passed as props to components. Consider the following example:
+
+```js
+class Counter extends Component {
+  static template = xml`
+    <div t-on-click="() => props.state.value++">
+      <t t-esc="props.state.value"/>
+    </div>`;
+}
+
+class Parent extends Component {
+  static template = xml`
+    <Counter state="this.state"/>
+    <button t-on-click="() => this.state.value = 0">Reset counter</button>
+    <button t-on-click="() => this.state.test++" t-esc="this.state.test"/>`;
+
+  setup() {
+    this.state = useState({ value: 0, test: 1 });
+  }
+}
+```
+
+When clicking on the counter button, only the Counter rerenders, because the Parent has never read
+the "value" key in the state. When clicking on the "Reset Counter" button, the same thing happens:
+only the Counter component rerenders. What matters is not _where_ the state is updated, but which
+parts of the state are updated, and which components depend on them. This is achieved by Owl by
+automatically calling `useState` on reactive objects passed as props to a child component.
+
+When clicking on the last button, the parent is rerendered, but the child does not care about the
+`test` key: it has not read it. The props that we give it (`this.state`) have also not changed,
+as such, the parent updates but the child doesn't.
+
+For most day-to-day operations, `useState` should cover all of your needs. If
+you are curious about more advanced use cases and technical details, read on.
+
+### Debugging subscriptions
+
+Owl provides a way to show which reactive objects and keys a component is subscribed to: you can
+look at `component.__owl__.subscriptions`. Note that this is on the internal `__owl__` field, and
+should not be used in any type of production code as the name of this property or any of its properties
+or methods are subject to change at any point, even in stable versions of Owl, and may become available
+only in debug mode in the future.
+
+## `reactive`
+
+The `reactive` function is the basic reactivity primitive. It takes an object
+or an array as first argument, and optionally, a function as the second argument.
+The function is called whenever any tracked value is updated.
+
+```js
+const obj = reactive({ a: 1 }, () => console.log("changed"));
+
+obj.a = 2; // does not log anything: the 'a' key has not been read yet
+console.log(obj.a); // logs 2 and reads the 'a' key => it is now tracked
+obj.a = 3; // logs 'changed' because we updated a tracked value
+```
+
+An important property of reactive objects is that they can be reobserved: this
+will create an independent proxy that tracks another set of keys:
+
+```js
+const obj1 = reactive({ a: 1, b: 2 }, () => console.log("observer 1"));
+const obj2 = reactive(obj1, () => console.log("observer 2"));
+
+console.log(obj1.a); // logs 1, and reads the 'a' key => it is now tracked by observer 1
+console.log(obj2.b); // logs 2, and 'b' is now tracked by observer 2
+obj2.a = 3; // only logs 'observer1', because observer2 does not track a
+obj2.b = 3; // only logs 'observer2', because observer1 does not track b
+console.log(obj2.a, obj1.b); // logs 3 and 3, while the object is observed independently, it is still a single object
+```
+
+Because `useState` returns a normal reactive object, it is possible to call `reactive` on the result
+of a `useState` to observe changes to that object while outside the context of a component, or to
+call `useState` on reactive objects created outside of components. In those cases, one needs to be
+careful with regards to the lifetime of those reactive objects, as holding references to these
+objects may prevent garbage collection of the component and its data even if Owl has destroyed it.
+
+### Subscriptions are ephemereal
+
+Subscription to state changes are ephemereal, whenever an observer is notified that a state object
+has changed, all of its subscriptions are cleared, meaning that if it still cares about it, it
+should read the properties it cares about again. For example:
+
+```js
+const obj = reactive({ a: 1 }, () => console.log("observer called"));
+
+console.log(obj.a); // logs 1, and reads the 'a' key => it is now tracked by the observer
+obj.a = 3; // logs 'observer1' and clears the subscriptions of the observer
+obj.a = 4; // doesn't log anything, the key is no longer observed
+```
+
+This may seem counter-intuitive, but it makes perfect sense in the context of components:
+
+```js
+class DoubleCounter extends Component {
+  static template = xml`
+    <t t-esc="state.selected + ': ' + state[state.selected].value"/>
+    <button t-on-click="() => this.state.count1++">increment count 1</button>
+    <button t-on-click="() => this.state.count2++">increment count 2</button>
+    <button t-on-click="changeCounter">Switch counter</button>
+  `;
+
+  setup() {
+    this.state = useState({ selected: "count1", count1: 0, count2: 0 });
+  }
+
+  changeCounter() {
+    this.state.selected = this.state.selected === "count1" ? "count2" : "count1";
+  }
+}
+```
+
+In this component, if we increment the value of the second counter, the component will not rerender,
+which makes sense as rerendering will have no effect, as the second counter is not displayed. If we
+toggle the component to display the second counter, we now no longer want the component to rerender
+when the value of the first counter changes, and this is what happens: a component only rerenders
+when there are changes to pieces of state that have been read during or after the previous render.
+If a piece of state has not been read in the last render, we know that its value won't influence the
+rendered output, and so we can ignore it.
+
+### reactive `Map` and `Set`
+
+The reactivity system has special support built-in for the standard container types `Map` and `Set`.
+They behave like one would expect: reading a key subscribes the observer to that key, adding or
+removing an item to them notifies observers that have used any of the iterators on that reactive
+object, such as `.entries()` or `.keys()`, likewise with clearing them.
+
+## Escape hatches
+
+Sometimes, it is desirable to bypass the reactivity system. Creating proxies when interacting with
+reactive objects is expensive, and while on the whole, the performance benefit that we get by
+rerendering only the parts of the interface that need it outweighs that cost, in some cases, we want
+to be able to opt out of creating them in the first place. This is the purpose of `markRaw`:
+
+### `markRaw`
+
+Marks an object so that it is ignored by the reactivity system, meaning that if this object is ever
+part of a of a reactive object, it will be returned as is, and no keys in that object will be
+observed.
+
+```js
+const someObject = markRaw({ b: 1 });
+const state = useState({
+  a: 1,
+  obj: someObject,
+});
+console.log(state.obj.b); // attempt to subscribe to the "b" key in someObject
+state.obj.b = 2; // No rerender will occur here
+console.log(someObject === state.obj); // true
+```
+
+This is useful in some rare cases. One such example would be if you want to use an array of objects
+that is potentially large to render a list, but those objects are known to be immutable:
+
+```js
+this.items = useState([
+  { label: "some text", value: 42 },
+  // ... 1000 total objects
+]);
+```
+
+in the template:
+
+```xml
+<t t-foreach="items" t-as="item" t-key="item.label" t-esc="item.label + item.value"/>
+```
+
+Here, on every render, we go and read one thousand keys from a reactive object, which causes
+one thousand reactive objects to be created. If we know that the content of these objects
+cannot change, this is wasted work. If instead all of these objects are marked as raw, we avoid
+all of this work while keeping the ability to lean on the reactivity to track the presence and
+identity of these objects:
+
+```js
+this.items = useState([
+  markRaw({ label: "some text", value: 42 }),
+  // ... 1000 total objects
+]);
+```
+
+However, use this function with caution: this is an escape hatch from the reactivity
+system, and as such, using it may cause subtle and unintended issues! For example:
+
+```js
+// This will cause a rerender
+this.items.push(markRaw({ label: "another label", value: 1337 }));
+
+// THIS WILL NOT CAUSE A RENDER!
+this.items[17].value = 3;
+// The UI is now desynced from component's state until the next render caused by something else
+```
+
+In short: only use `markRaw` if your application is slowing down noticeably and profiling reveals
+that a lot of time is spent creating useless reactive objects.
+
+### `toRaw`
+
+While `markRaw` marks an object so that it is never made reactive, `toRaw` takes an object and
+returns the underlying non-reactive object. It can be useful in some niche cases. In particular,
+because the reactivity system returns a proxy, the returned object does not compare equal to the
+original object:
+
+```js
+const obj = {};
+const reactiveObj = reactive(obj);
+console.log(obj === reactiveObj); // false
+console.log(obj === toRaw(reactiveObj)); // true
+```
+
+It can also be useful during debugging, as unfolding proxies recursively in debuggers can be confusing.
+
+## Advanced usage
+
+The following is a collection of small snippets that leverage the reactivity system in
+"non-standard" ways to help you understand its power and where using it might make your code simpler.
+
+### Notification manager
+
+Showing notifications is a pretty common need in web applications, you may want to show a
+notification from any other component within the application, and the notifications should stack on
+top of one another regardless of which component spawned them, here is how we can leverage the
+reactivity to accomplish this:
+
+```js
+let notificationId = 1;
+const notifications = reactive({});
+class NotificationContainer extends Component {
+  static template = xml`
+    <t t-foreach="notifications" t-as="notification" t-key="notification_key" t-esc="notification"/>
+  `;
+  setup() {
+    this.notifications = useState(notifications);
+  }
+}
+
+export function addNotification(label) {
+  const id = notificationId++;
+  notifications[id] = label;
+  return () => {
+    delete notifications[id];
+  };
+}
+```
+
+Here, the `notifications` variable is a reactive object. Notice how we didn't give `reactive` a
+callback: this is because in this case, all we care about is that adding or removing notifications
+in the `addNotification` function goes through the reactivity system. The `NotificationContainer`
+component reobserves this object with `useState`, and is updated whenever notifications are
+added or removed.
+
+### Store
+
+Centralizing application state is a pretty common want/need in web applications. Because of the way
+the reactivity system works, you can treat any reactive object as a store, and if you call `useState`
+on it, components automatically observe only the part of the store that they're interested in:
+
+```js
+export const store = reactive({
+  list: [],
+  add(item) {
+    this.list.push(item);
+  },
+});
+
+export function useStore() {
+  return useState(store);
+}
+```
+
+In any component:
+
+```js
+import { useStore } from "./store";
+
+class List extends Component {
+  static template = xml`
+    <t t-foreach="store.list" t-as="item" t-key="item" t-esc="item"/>
+  `;
+  setup() {
+    this.store = useStore();
+  }
+}
+```
+
+Anywhere in the application:
+
+```js
+import { store } from "./store";
+// Will cause any instance of the List component in the app to update
+store.add("New list item!");
+```
+
+Notice how we can make objects with methods into reactive objects, and when these methods are used
+to mutate the store contents, it works as expected. And while stores are generally one-off objects,
+it is entirely possible to make class instances reactive:
+
+```js
+class Store {
+  list = [];
+  add(item) {
+    this.list.push(item);
+  }
+}
+// Essentially equivalent to the previous code
+export const store = reactive(new Store());
+```
+
+Which can be useful to unit test the class separately.
+
+### Local storage synchronization
+
+Sometimes, you want to persist some state accross reloads, you can do this by storing it in the
+`localStorage`, but what if you want to update the `localStorage` item every time the state changes,
+so that you don't have to manually synchronize the states? Well, you can use the reactivity system
+to write a custom hook that will do that for you:
+
+```js
+function useStoredState(key, initialState) {
+  const state = JSON.parse(localStorage.getItem(key)) || initialState;
+  const store = (obj) => localStorage.setItem(key, JSON.stringify(obj));
+  const reactiveState = reactive(state, () => store(reactiveState));
+  store(reactiveState);
+  return useState(state);
+}
+
+class MyComponent extends Component {
+  setup() {
+    this.state = useStoredState("MyComponent.state", { value: 1 });
+  }
+}
+```
+
+One important thing to notice is that both times we call `store`, we call it with `reactiveState`,
+not `state`: we need `store` to read the keys through a reactive object for it to correctly
+subscribe to state changes. Notice also that we call `store` the first time by hand, as otherwise it
+will not be subscribed to anything, and no amount of change in the object will cause the reactive
+callback to be invoked.

doc/reference/refs.md

@@ -0,0 +1,37 @@
+# 🦉 References 🦉
+
+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,
+targeted 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:
+
+```xml
+<div>
+    <input t-ref="input"/>
+    <button t-on-click="focusInput">Click</button>
+</div>
+```
+
+```js
+import { useRef } from "owl/hooks";
+
+class SomeComponent extends Component {
+  inputRef = useRef("input");
+
+  focusInput() {
+    this.inputRef.el.focus();
+  }
+}
+```
+
+Be aware that the `el` property will only be set when the target of the `t-ref`
+directive is mounted in the DOM. Otherwise, it will be set to `null`.
+
+The `useRef` hook cannot be used to get a reference to an instance of a sub
+component.
+
+Note that this example uses the suffix `ref` to name the reference. This
+is not mandatory, but it is a useful convention, so we do not forget that it is
+a reference object.

doc/reference/slots.md

@@ -3,71 +3,92 @@
 ## Content
 
 - [Overview](#overview)
-- [Example](#example)
-- [Reference](#reference)
+- [Named slots](#named-slots)
+- [Rendering Context](#rendering-context)
+- [Default Slot](#default-slot)
+- [Default Content](#default-content)
+- [Dynamic slots](#dynamic-slots)
+- [Slots and props](#slots-and-props)
+- [Slot params](#slot-params)
+- [Slot scopes](#slot-scopes)
 
 ## Overview
 
 Owl is a template based component system. There is therefore a need to be able
-to make generic components. For example, imagine a generic `Dialog`
-component, which is able to display some arbitrary content.
-
-Obviously, we want to use this component everywhere in our application, to
-display various different content. The `Dialog` component is technically the
-owner of its content, but is only a container. The user of the `Dialog` is
-the component that want to _inject_ something inside the `Dialog`. This is
-exactly what slots are for.
-
-## Example
-
-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
-will need to render some content, some footer, but with the parent as the
-rendering context.
-
-Slots are inserted with the `t-slot` directive:
+to make generic components. For example, imagine a generic `Navbar`
+component, which displays a navbar, but with some customizable content. Since
+the specific content is only known to the user of the `Navbar`, it would be nice
+to specify it in the template where `Navbar` is used:
 
 ```xml
-<div t-name="Dialog" class="modal">
-  <div class="modal-title"><t t-esc="props.title"/></div>
-  <div class="modal-content">
+  <div>
+    <Navbar>
+      <span>Hello Owl</span>
+    </Navbar>
+  </div>
+```
+
+This is exactly the way slots work! In the example above, the user of the `Navbar`
+component specify some content (here, in the default slot). The `Navbar`
+component can insert that content in its own template at the appropriate location.
+An important information to notice is that the content of the slot is rendered in
+the parent context, not in the navbar. As such, it can access values and methods
+from the parent component.
+
+Here is how the `Navbar` component could be defined, with the `t-slot` directive:
+
+```xml
+<div class="navbar">
+  <t t-slot="default"/>
+  <ul>
+    <!-- rest of the navbar here -->
+  </ul>
+</div>
+```
+
+## Named slots
+
+Default slots are very useful, but sometimes, we may need more than one slot.
+This is what named slots are for! For example, suppose we implement a component
+`InfoBox` that display a title and some specific content. Its template could look
+like this:
+
+```xml
+<div class="info-box">
+  <div class="info-box-title">
+    <t t-slot="title"/>
+    <span class="info-box-close-button" t-on-click="close">X</span>
+  </div>
+  <div class="info-box-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-slot` directive:
+And one could use it with the `t-set-slot` directive:
 
 ```xml
-<div t-name="SomeComponent">
-  <div>some component</div>
-  <Dialog title="'Some Dialog'">
-    <t t-set-slot="content">
-      <div>hey</div>
-    </t>
-    <t t-set-slot="footer">
-      <button t-on-click="doSomething">ok</button>
-    </t>
-  </Dialog>
-</div>
+<InfoBox>
+  <t t-set-slot="title">
+    Specific Title. It could be html also.
+  </t>
+  <t t-set-slot="content">
+    <!-- some template here, with html, events, whatever -->
+  </t>
+</InfoBox>
 ```
 
-In this example, the component `Dialog` will render the slots `content` and `footer`
-with its parent as rendering context. This means that clicking on the button
-will execute the `doSomething` method on the parent, not on the dialog.
+## Rendering context
 
-Note: Owl previously used the `t-set` directive to define the content of a slot.
-This is deprecated and should no longer be used in new code.
+The content of the slots is actually rendered with the rendering context corresponding
+to where it was defined, not where it is positioned. This allows the user to define
+event handlers that will be bound to the correct component (usually, the
+grandparent of the slot content).
 
-## Reference
+## Default Slot
 
-### Default Slot
-
-The first element inside the component which is not a named slot will
-be considered the `default` slot. For example:
+All elements inside the component which are not a named slot will be treated as
+part of the content of the `default` slot. For example:
 
 ```xml
 <div t-name="Parent">
@@ -81,7 +102,20 @@ be considered the `default` slot. For example:
 </div>
 ```
 
-### Default content
+One can mix default slot and named slots:
+
+```xml
+<div>
+  <Child>
+    default content
+    <t t-set-slot="footer">
+      content for footer slot here
+    </t>
+  </Child>
+</div>
+```
+
+## Default content
 
 Slots can define a default content, in case the parent did not define them:
 
@@ -96,12 +130,7 @@ Slots can define a default content, in case the parent did not define them:
 <!-- will be rendered as: <div><span>default content</span></div> -->
 ```
 
-Rendering context: the content of the slots is actually rendered with the
-rendering context corresponding to where it was defined, not where it is
-positioned. This allows the user to define event handlers that will be bound
-to the correct component (usually, the grandparent of the slot content).
-
-### Dynamic Slots
+## Dynamic Slots
 
 The `t-slot` directive is actually able to use any expressions, using string
 interplolation:
@@ -109,3 +138,123 @@ interplolation:
 ```xml
  <t t-slot="{{current}}" />
 ```
+
+This will evaluate the `current` expression, and insert the corresponding slot
+at the place of the `t-slot` directive.
+
+## Slots and props
+
+In a sense, slots are almost the same as a prop: they define some information
+to pass to the child component. To make it possible to use it, and to pass it
+down to sub component, Owl actually define a special prop `slots` that contains
+all slot information given to the component. It looks like this:
+
+```js
+{ slotName_1: slotInfo_1, ..., slotName_m: slotInfo_m }
+```
+
+So, a component can pass its slots to a subcomponent like this:
+
+```xml
+<Child slots="props.slots"/>
+```
+
+## Slot params
+
+For advanced usecases, it may be necessary to pass additional information to a
+slot. This can be done by providing extra key/value pairs to the `t-set-slot`
+directive. Then, the generic component can read them in its prop `slots`.
+
+For example, here is how a Notebook component could be implemented (a component
+with multiple page, and a tab bar, which only render the current active page,
+and each page has a title).
+
+```js
+class Notebook extends Component {
+  static template = xml`
+    <div class="notebook">
+      <div class="tabs">
+        <t t-foreach="tabNames" t-as="tab" t-key="tab_index">
+          <span t-att-class="{active:tab_index === activeTab}" t-on-click="() => state.activeTab=tab">
+            <t t-esc="props.slots[tab].title"/>
+          </span>
+        </t>
+      </div>
+      <div class="page">
+        <t t-slot="{{currentSlot}}"/>
+      </div>
+    </div>`;
+
+  setup() {
+    this.state = useState({ activeTab: 0 });
+    this.tabNames = Object.keys(this.props.slots);
+  }
+
+  get currentSlot() {
+    return this.tabNames[this.state.activeTab];
+  }
+}
+```
+
+Notice how one can read the `title` value for each slots. Here is how one could
+use this `Notebook` component:
+
+```xml
+<Notebook>
+  <t t-set-slot="page1" title="'Page 1'">
+    <div>this is in the page 1</div>
+  </t>
+  <t t-set-slot="page2" title="'Page 2'" hidden="somevalue">
+    <div>this is in the page 2</div>
+  </t>
+</Notebook>
+```
+
+Slot params works like normal props, so one can use the `.bind` suffix to
+bind a function if needed.
+
+## Slot scopes
+
+For other kinds of advanced use cases, the content of a slot may depends on some
+information specific to the generic component. This is the opposite of the slot
+params.
+
+To solve this kind of problems, one can use the `t-slot-scope` directive along
+with the `t-set-slot`. This defines the name of a variable that can access
+everything given by the child component:
+
+```xml
+<MyComponent>
+    <t t-set-slot="foo" t-slot-scope="scope">
+        content
+        <t t-esc="scope.bool"/>
+        <t t-esc="scope.num"/>
+    </t>
+</MyComponent>
+```
+
+And the child component that includes the slot can provide values like this:
+
+```xml
+<t t-slot="foo" bool="other_var" num="5">
+```
+
+or this:
+
+```xml
+<t t-slot="foo" t-props="someObject">
+```
+
+In the case of the default slot, you may declare the slot scope directly on the
+component itself:
+
+```xml
+<MyComponent t-slot-scope="scope">
+    content
+    <t t-esc="scope.bool"/>
+    <t t-esc="scope.num"/>
+</MyComponent>
+```
+
+Slot values works like normal props, so one can use the `.bind` suffix to
+bind a function if needed.

doc/reference/tags.md

@@ -1,184 +0,0 @@
-# 🦉 Tags 🦉
-
-## Content
-
-- [Overview](#overview)
-- [`xml` tag](#xml-tag)
-- [`css` tag](#css-tag)
-
-## Overview
-
-Tags are very small helpers intended to make it easy to write inline templates
-or styles. There are currently two tags: `css` and `xml`. With these functions,
-it is possible to write [single file components](../learning/how_to_write_sfc.md).
-
-## XML tag
-
-The `xml` tag is certainly the most useful tag. It is used to define an inline
-QWeb template for a component. Without tags, creating a standalone component
-would look like this:
-
-```js
-import { Component } from 'owl'
-
-const name = 'some-unique-name';
-const template = `
-    <div>
-        <span t-if="somecondition">text</span>
-        <button t-on-click="someMethod">Click</button>
-    </div>
-`;
-QWeb.registerTemplate(name, template);
-
-class MyComponent extends Component {
-    static template = name;
-
-    ...
-}
-```
-
-With tags, this process is slightly simplified. The name is uniquely generated,
-and the template is automatically registered:
-
-```js
-const { Component } = owl;
-const { xml } = owl.tags;
-
-class MyComponent extends Component {
-    static template = xml`
-        <div>
-            <span t-if="somecondition">text</span>
-            <button t-on-click="someMethod">Click</button>
-        </div>
-    `;
-
-    ...
-}
-```
-
-## CSS tag
-
-The CSS tag is useful to define a css stylesheet in the javascript file:
-
-```js
-class MyComponent extends Component {
-  static template = xml`
-        <div class="my-component">some template</div>
-    `;
-  static style = css`
-    .my-component {
-      color: red;
-    }
-  `;
-}
-```
-
-The `css` tag registers internally the css information. Then, whenever the first
-instance of the component is created, will add a `<style>` tag to the document
-`<head>`.
-
-Note that to make it more useful, like other css preprocessors, the `css` tag
-accepts a small extension of the css specification: css scopes can be nested,
-and the rules will then be expanded by the `css` helper:
-
-```scss
-.my-component {
-  display: block;
-  .sub-component h {
-    color: red;
-  }
-}
-```
-
-will be formatted as:
-
-```css
-.my-component {
-  display: block;
-}
-.my-component .sub-component h {
-  color: red;
-}
-```
-
-This extension brings another useful feature: the `&` selector which refers to
-the parent selector. For example, we want our component to be red when hovered.
-We would like to write something like:
-
-```scss
-.my-component {
-  display: block;
-  :hover {
-    color: red;
-  }
-}
-```
-
-but it will be formatted as:
-
-```css
-.my-component {
-  display: block;
-}
-.my-component :hover {
-  color: red;
-}
-```
-
-The `&` selector can be used to solve this problem:
-
-```scss
-.my-component {
-  display: block;
-  &:hover {
-    color: red;
-  }
-}
-```
-
-will be formatted as:
-
-```css
-.my-component {
-  display: block;
-}
-.my-component:hover {
-  color: red;
-}
-```
-
-Now, there is no additional processing done by the `css` tag. However, since it
-is done in javascript at runtime, we actually have more power. For example:
-
-1. sharing values between javascript and css:
-
-```js
-import { theme } from "./theme";
-
-class MyComponent extends Component {
-  static template = xml`<div class="my-component">...</div>`;
-  static style = css`
-    .my-component {
-      color: ${theme.MAIN_COLOR};
-      background-color: ${theme.SECONDARY_color};
-    }
-  `;
-}
-```
-
-2. scoping rules to the current component:
-
-```js
-import { generateUUID } from "./utils";
-
-const uuid = generateUUID();
-
-class MyComponent extends Component {
-  static template = xml`<div data-o-${uuid}="">...</div>`;
-  static style = css`
-    [data-o-${uuid}] {
-      color: red;
-    }
-  `;
-}
-```

doc/reference/templates.md

@@ -1,12 +1,11 @@
-# 🦉 QWeb Templating Language🦉
+# 🦉 Templates 🦉
 
 ## Content
 
 - [Overview](#overview)
 - [Directives](#directives)
-- [Reference](#reference)
+- [QWeb Template reference](#qweb-template-reference)
   - [White Spaces](#white-spaces)
-  - [Root Nodes](#root-nodes)
   - [Expression Evaluation](#expression-evaluation)
   - [Static html Nodes](#static-html-nodes)
   - [Outputting Data](#outputting-data)
@@ -16,17 +15,20 @@
   - [Dynamic Class Attribute](#dynamic-class-attribute)
   - [Dynamic Tag Names](#dynamic-tag-names)
   - [Loops](#loops)
-  - [Rendering Sub Templates](#rendering-sub-templates)
+  - [Sub Templates](#sub-templates)
   - [Dynamic Sub Templates](#dynamic-sub-templates)
-  - [Translations](#translations)
   - [Debugging](#debugging)
+- [Fragments](#fragments)
+- [Inline templates](#inline-templates)
+- [Rendering svg](#rendering-svg)
+- [Restrictions](#restrictions)
 
 ## Overview
 
-[QWeb](https://www.odoo.com/documentation/13.0/reference/qweb.html) is the primary
-templating engine used by Odoo. It is based on the XML format, and used
+Owl templates are describe using the [QWeb](https://www.odoo.com/documentation/13.0/reference/qweb.html) specification. It is based on the XML format, and used
 mostly to generate HTML. In OWL, QWeb templates are compiled into functions that
-generate a virtual dom representation of the HTML.
+generate a virtual dom representation of the HTML. Also, since Owl is a live
+component system, there are additional directives specific to Owl (such as `t-on`).
 
 ```xml
 <div>
@@ -53,34 +55,33 @@ extensions.
 
 For reference, here is a list of all standard QWeb directives:
 
-| Name                           | Description                                                    |
-| ------------------------------ | -------------------------------------------------------------- |
-| `t-esc`                        | [Outputting safely a value](#outputting-data)                  |
-| `t-raw`                        | [Outputting value, without escaping](#outputting-data)         |
-| `t-set`, `t-value`             | [Setting variables](#setting-variables)                        |
-| `t-if`, `t-elif`, `t-else`,    | [conditionally rendering](#conditionals)                       |
-| `t-foreach`, `t-as`            | [Loops](#loops)                                                |
-| `t-att`, `t-attf-*`, `t-att-*` | [Dynamic attributes](#dynamic-attributes)                      |
-| `t-call`                       | [Rendering sub templates](#rendering-sub-templates)            |
-| `t-debug`, `t-log`             | [Debugging](#debugging)                                        |
-| `t-translation`                | [Disabling the translation of a node](#translations)           |
-| `t-name`                       | [Defining a template (not really a directive)](qweb_engine.md) |
+| Name                           | Description                                                     |
+| ------------------------------ | --------------------------------------------------------------- |
+| `t-esc`                        | [Outputting safely a value](#outputting-data)                   |
+| `t-out`                        | [Outputting value, possibly without escaping](#outputting-data) |
+| `t-set`, `t-value`             | [Setting variables](#setting-variables)                         |
+| `t-if`, `t-elif`, `t-else`,    | [conditionally rendering](#conditionals)                        |
+| `t-foreach`, `t-as`            | [Loops](#loops)                                                 |
+| `t-att`, `t-attf-*`, `t-att-*` | [Dynamic attributes](#dynamic-attributes)                       |
+| `t-call`                       | [Rendering sub templates](#sub-templates)                       |
+| `t-debug`, `t-log`             | [Debugging](#debugging)                                         |
+| `t-translation`                | [Disabling the translation of a node](translations.md)          |
 
 The component system in Owl requires additional directives, to express various
 needs. Here is a list of all Owl specific directives:
 
-| Name                     | Description                                                                     |
-| ------------------------ | ------------------------------------------------------------------------------- |
-| `t-component`, `t-props` | [Defining a sub component](component.md#composition)                            |
-| `t-ref`                  | [Setting a reference to a dom node or a sub component](component.md#references) |
-| `t-key`                  | [Defining a key (to help virtual dom reconciliation)](#loops)                   |
-| `t-on-*`                 | [Event handling](event_handling.md)                                             |
-| `t-transition`           | [Defining an animation](animations.md#css-transitions)                          |
-| `t-slot`                 | [Rendering a slot](slots.md)                                                    |
-| `t-model`                | [Form input bindings](component.md#form-input-bindings)                         |
-| `t-tag`                  | [Rendering nodes with dynamic tag name](#dynamic-tag-names)                     |
+| Name                                   | Description                                                     |
+| -------------------------------------- | --------------------------------------------------------------- |
+| `t-component`, `t-props`               | [Defining a sub component](component.md#sub-components)         |
+| `t-ref`                                | [Setting a reference to a dom node or a sub component](refs.md) |
+| `t-key`                                | [Defining a key (to help virtual dom reconciliation)](#loops)   |
+| `t-on-*`                               | [Event handling](event_handling.md)                             |
+| `t-portal`                             | [Portal](portal.md)                                             |
+| `t-slot`, `t-set-slot`, `t-slot-scope` | [Rendering a slot](slots.md)                                    |
+| `t-model`                              | [Form input bindings](input_bindings.md)                        |
+| `t-tag`                                | [Rendering nodes with dynamic tag name](#dynamic-tag-names)     |
 
-## Reference
+## QWeb Template Reference
 
 ### White Spaces
 
@@ -90,32 +91,6 @@ White spaces in a template are handled in a special way:
 - if a whitespace-only text node contains a linebreak, it is ignored
 - the previous rules do not apply if we are in a `<pre>` tag
 
-### Root Nodes
-
-For many reasons, Owl QWeb templates should have a single root node. More
-precisely, the result of a template rendering should have a single root node:
-
-```xml
-<!–– not ok: two root nodes ––>
-<t>
-    <div>foo</div>
-    <div>bar</div>
-</t>
-
-<!–– ok: result has one single root node ––>
-<t>
-    <div t-if="someCondition">foo</div>
-    <span t-else="">bar</span>
-</t>
-```
-
-Extra root nodes will actually be ignored (even though they will be rendered
-in memory).
-
-Note: this does not apply to subtemplates (see the `t-call` directive). In that
-case, they will be inlined in the main template, and can actually have many
-root nodes.
-
 ### Expression Evaluation
 
 QWeb expressions are strings that will be processed at compile time. Each variable in
@@ -140,7 +115,7 @@ It is useful to explain the various rules that apply on these expressions:
    <div><p t-if="console.log(1)">NOT valid</p></div>
    ```
 
-2. it can use anything in the rendering context (typically, the component):
+2. it can use anything in the rendering context (which typically contains the properties of the component):
 
    ```xml
    <p t-if="user.birthday === today()">Happy bithday!</p>
@@ -190,24 +165,29 @@ rendered with the value `value` set to `42` in the rendering context yields:
 <p>42</p>
 ```
 
-The `t-raw` directive is almost the same as `t-esc`, but without the escaping.
-This is mostly useful to inject a raw html string somewhere. Obviously, this
-is unsafe to do in general, and should only be used for strings known to be safe.
+The `t-out` directive is almost the same as `t-esc`, but possibly without the
+escaping. The difference is that the value received by the `t-out` directive
+will only be not-escaped if it has been marked as such, using the `markup`
+utility function:
 
-```xml
-<p><t t-raw="value"/></p>
+For example, in the following component:
+
+```js
+const { markup, Component, xml } = owl;
+
+class SomeComponent extends Component {
+  static template = xml`
+    <t t-out="value1"/>
+    <t t-out="value2"/>`;
+
+  value1 = "<div>some text 1</div>";
+  value2 = markup("<div>some text 2</div>");
+}
 ```
 
-rendered with the value `value` set to `<span>foo</span>` in the rendering context yields:
-
-```html
-<p><span>foo</span></p>
-```
-
-Note that since the content of the expression is not known beforehand, the `t-raw`
-directive has to parse the html (and convert it to a virtual dom structure) for
-each rendering. So, it will be much slower than a regular template. It is
-therefore advised to limit the use of `t-raw` whenever possible.
+The first `t-out` will act as a `t-esc` directive, which means that the content
+of `value1` will be escaped. However, since `value2` has been tagged as a markup,
+this will be injected as html.
 
 ### Setting Variables
 
@@ -310,10 +290,11 @@ If an expression evaluates to a falsy value, it will not be set at all:
 
 It is sometimes convenient to format an attribute with string interpolation. In
 that case, the `t-attf-` directive can be used. It is useful when we need to mix
-literal and dynamic elements, such as css classes.
+literal and dynamic elements, such as css classes. The dynamic elements can be
+specified with either `{{...}}` or `#{...}`:
 
 ```xml
-<div t-attf-foo="a {{value1}} is {{value2}} of {{value3}} ]"/>
+<div t-attf-foo="a {{value1}} is #{value2} of {{value3}} ]"/>
 <!-- result if values are set to 1,2 and 3: <div foo="a 0 is 1 of 2 ]"></div> -->
 ```
 
@@ -368,7 +349,7 @@ collection to iterate on, and a second parameter `t-as` providing the name to us
 for the current item of the iteration:
 
 ```xml
-<t t-foreach="[1, 2, 3]" t-as="i">
+<t t-foreach="[1, 2, 3]" t-as="i" t-key="i">
     <p><t t-esc="i"/></p>
 </t>
 ```
@@ -384,13 +365,17 @@ will be rendered as:
 Like conditions, `t-foreach` applies to the element bearing the directive’s attribute, and
 
 ```xml
-<p t-foreach="[1, 2, 3]" t-as="i">
+<p t-foreach="[1, 2, 3]" t-as="i" t-key="i">
     <t t-esc="i"/>
 </p>
 ```
 
 is equivalent to the previous example.
 
+An important difference should be made with the usual `QWeb` behaviour: Owl
+requires the presence of a `t-key` directive, to be able to properly reconcile
+renderings.
+
 `t-foreach` can iterate on an array (the current item will be the current value)
 or an object (the current item will be the current key).
 
@@ -416,7 +401,7 @@ into the global context.
 <t t-set="existing_variable" t-value="false"/>
 <!-- existing_variable now False -->
 
-<p t-foreach="Array(3)" t-as="i">
+<p t-foreach="Array(3)" t-as="i" t-key="i">
     <t t-set="existing_variable" t-value="true"/>
     <t t-set="new_variable" t-value="true"/>
     <!-- existing_variable and new_variable now true -->
@@ -430,17 +415,14 @@ Even though Owl tries to be as declarative as possible, the DOM does not fully
 expose its state declaratively in the DOM tree. For example, the scrolling state,
 the current user selection, the focused element or the state of an input are not
 set as attribute in the DOM tree. This is why we use a virtual dom
-algorithm to keep the actual DOM node as much as possible.
-
-However, in some situations, this is not enough, and we need to help Owl decide
-if an element is actually the same, or is a different element with the same
-properties.
+algorithm to make sure we keep the actual DOM node instead of replacing it with
+a new one.
 
 Consider the following situation: we have a list of two items `[{text: "a"}, {text: "b"}]`
 and we render them in this template:
 
 ```xml
-<p t-foreach="items" t-as="item"><t t-esc="item.text"/></p>
+<p t-foreach="items" t-as="item" t-key="item_index"><t t-esc="item.text"/></p>
 ```
 
 The result will be two `<p>` tags with text `a` and `b`. Now, if we swap them,
@@ -501,7 +483,7 @@ using the `...` javascript operator. For example:
 The `...` operator will convert the `Set` (or any other iterables) into a list,
 which will work with Owl QWeb.
 
-### Rendering Sub Templates
+### Sub Templates
 
 QWeb templates can be used for top level rendering, but they can also be used
 from within another template (to avoid duplication or give names to parts of
@@ -558,6 +540,14 @@ This can be used to define variables scoped to a sub template:
 <!-- "var" does not exist here -->
 ```
 
+Note: by default, the rendering context for a sub template is simply the current
+rendering context. However, it may be useful to be able to specify a specific
+object as context. This can be done by using the `t-call-context` directive:
+
+```xml
+<t t-call="other-template" t-call-context="obj"/>
+```
+
 ### Dynamic sub templates
 
 The `t-call` directive can also be used to dynamically call a sub template,
@@ -574,21 +564,6 @@ using string interpolation. For example:
 Here, the name of the template is obtained from the `template` value in the
 template rendering context.
 
-### Translations
-
-By default, QWeb specify that templates should be translated. If this behaviour
-is not wanted, there is a `t-translation` directive which can turn off
-translations (if it is set to the `off` value), with the following rules:
-
-- each text node will be replaced with its translation,
-- each of the following attribute values will be translated as well: `title`,
-  `placeholder`, `label` and `alt`,
-- translating text nodes can be disabled with the special attribute `t-translation`,
-  if its value is `off`.
-
-See [here](qweb_engine.md#translations) for more information on how to setup a
-translate function in Owl QWeb.
-
 ### Debugging
 
 The javascript QWeb implementation provides two useful debugging directives:
@@ -611,3 +586,117 @@ will stop execution if the browser dev tools are open.
 ```
 
 will print 42 to the console.
+
+## Fragments
+
+Owl 2 supports templates with an arbitrary number of root elements, or even just
+a text node. So, the following templates are all valid:
+
+```xml
+hello owl. This is just a text node!
+```
+
+```xml
+<div>hello</div>
+```
+
+```xml
+<div>hello</div>
+<div>ola</div>
+```
+
+```xml
+<div t-if="someCondition"><SomeChildComponent/></div>
+```
+
+```xml
+<t t-if="someCondition"><SomeChildComponent/></t>
+```
+
+## Inline templates
+
+Most real applications will define their templates in a XML file, to benefit
+from the XML ecosystem, and to do some additional processing, such as translating
+them. However, in some cases, it is convenient to be able to define a template
+inline. To do so, one can use the `xml` helper function:
+
+```js
+const { Component, xml } = owl;
+
+class MyComponent extends Component {
+  static template = xml`
+      <div>
+          <span t-if="somecondition">text</span>
+          <button t-on-click="someMethod">Click</button>
+      </div>
+  `;
+
+    ...
+}
+
+mount(MyComponent, document.body);
+```
+
+This function simply generates an unique string id, and register the template
+under that id in the internals of Owl, then return the id.
+
+## Rendering svg
+
+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>
+    `;
+  static components = { Node };
+}
+
+class RootNode extends Component {
+  static template = xml`
+        <svg height="180">
+            <Node node="graph" x="10" y="20" height="180"/>
+        </svg>
+    `;
+  static components = { Node };
+  graph = {
+    label: "a",
+    children: [
+      { label: "b" },
+      { label: "c", children: [{ label: "d" }, { label: "e" }] },
+      { label: "f", children: [{ label: "g" }] },
+    ],
+  };
+}
+```
+
+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.
+
+**Important note:** Owl needs to properly set the namespace for each svg elements.
+Since Owl compile each template separately, it is not able to determine easily
+if a template is supposed to be included in a svg namespace or not. Therefore,
+Owl depends on a heuristic: if a tag is either `svg`, `g` or `path`, then it will
+be considered as svg. In practice, this means that each component or each sub
+templates (included with `t-call`) should have one of these tag as root tag.
+
+## Restrictions
+
+Note that Owl templates forbid the use of tag and or attributes starting with
+the `block-` string. This restriction prevents name collision with the internal
+code of Owl.
+
+```xml
+<div><block-1>this will not be accepted by Owl</block-1></div>
+```

doc/reference/translations.md

@@ -0,0 +1,70 @@
+# 🦉 Translations 🦉
+
+If properly setup, Owl can translate all rendered templates. To do
+so, it needs a translate function, which takes a string and returns a string.
+
+For example:
+
+```js
+const translations = {
+  hello: "bonjour",
+  yes: "oui",
+  no: "non",
+};
+const translateFn = (str) => translations[str] || str;
+
+const app = new App(Root, { templates, tranaslateFn });
+// ...
+```
+
+See the [app configuration page](app.md#configuration) for more info on how to
+configure an Owl application.
+
+Once setup, all rendered templates will be translated using `translateFn`:
+
+- each text node will be replaced with its translation,
+- each of the following attribute values will be translated as well: `title`,
+  `placeholder`, `label` and `alt`,
+- translating text nodes can be disabled with the special attribute `t-translation`,
+  if its value is `off`.
+
+So, with the above `translateFn`, the following templates:
+
+```xml
+<div>hello</div>
+<div t-translation="off">hello</div>
+<div>Are you sure?</div>
+<input placeholder="hello" other="yes"/>
+```
+
+will be rendered as:
+
+```xml
+<div>bonjour</div>
+<div>hello</div>
+<div>Are you sure?</div>
+<input placeholder="bonjour" other="yes"/>
+```
+
+Note that the translation is done during the compilation of the template, not
+when it is rendered.
+
+In some case, it is useful to be able to extend the list of translatable attributes.
+For example, one may want to also translate `data-title` attributes. To do that,
+we can define additional attributes with the `translatableAttributes` option:
+
+```js
+const app = new App(Root, { templates, tranaslateFn, translatableAttributes: ["data-title"] });
+// ...
+```
+
+It is also possible to remove an attribute from the default list by prefixing it with `-`:
+
+```js
+const app = new App(Root, {
+  templates,
+  tranaslateFn,
+  translatableAttributes: ["data-title", "-title"],
+});
+// data-title attribute will be translated, but not title attribute...
+```

doc/reference/utils.md

@@ -6,11 +6,9 @@ functions are all available in the `owl.utils` namespace.
 ## Content
 
 - [`whenReady`](#whenready): executing code when DOM is ready
-- [`loadJS`](#loadjs): loading script files
 - [`loadFile`](#loadfile): loading a file (useful for templates)
-- [`escape`](#escape): sanitizing strings
-- [`debounce`](#debounce): limiting rate of function calls
-- [`shallowEqual`](#shallowequal): shallow object comparison
+- [`EventBus`](#eventbus): a simple EventBus
+- [`validate`](#validate): a validation function
 
 ## `whenReady`
 
@@ -19,40 +17,20 @@ not ready yet, resolved directly otherwise). If called with a callback as
 argument, it executes it as soon as the DOM ready (or directly).
 
 ```js
-Promise.all([loadFile("templates.xml"), owl.utils.whenReady()]).then(function ([templates]) {
-  const qweb = new owl.QWeb({ templates });
-  const env = { qweb };
-  await mount(App, { env, target: document.body });
-});
+const { whenReady } = owl;
+
+await whenReady();
+// do something
 ```
 
 or alternatively:
 
 ```js
-owl.utils.whenReady(function () {
-  const qweb = new owl.QWeb();
-  const env = { qweb };
-  await mount(App, { env, target: document.body });
+whenReady(function () {
+  // do something
 });
 ```
 
-## `loadJS`
-
-`loadJS` takes a url (string) for a javascript resource, and loads it (by adding
-a script tag in the document head). It returns a promise, so the caller can
-properly reacts when it is ready. Also, it is smart: it maintains a list of urls
-previously loaded (or currently being loaded), and prevent doing twice the work.
-
-For example, it is useful for lazy loading external libraries:
-
-```js
-class MyComponent extends owl.Component {
-  willStart() {
-    return owl.utils.loadJS("/static/libs/someLib.js");
-  }
-}
-```
-
 ## `loadFile`
 
 `loadFile` is a helper function to fetch a file. It simply
@@ -60,89 +38,43 @@ performs a `GET` request and returns the resulting string in a promise. The
 initial usecase for this function is to load a template file. For example:
 
 ```js
+const { loadFile } = owl;
+
 async function makeEnv() {
-  const templates = await owl.utils.loadFile("templates.xml");
-  const qweb = new owl.QWeb({ templates });
-  return { qweb };
+  const templates = await loadFile("templates.xml");
+  // do something
 }
 ```
 
-Note that unlike `loadJS`, this function returns the content of the file as a
-string. It does not add a `script` tag or any other side effect.
+## `EventBus`
 
-## `escape`
-
-Sometimes, we need to display dynamic data (for example user-generated data) in
-the user interface. If this is done by a `QWeb` template, it is not an issue:
-
-```xml
-    <div><t t-esc="user.data"/></div>
-```
-
-The `QWeb` engine will create a `div` node and add the content of the `user.data`
-string as a text node, so the web browser will not parse it as html. However,
-it may be a problem if this is done with some javascript code like this:
+It is a simple `EventBus`, with the same API as usual DOM elements, and an
+additional `trigger` method to dispatch events:
 
 ```js
-class BadComponent extends Component {
-  // some template with a ref to a div
-  // some code ...
+const bus = new EventBus();
+bus.addEventListener("event", () => console.log("something happened"));
 
-  mounted() {
-    this.divRef.el.innerHTML = this.state.value;
+bus.trigger("event"); // 'something happened' is logged
+```
+
+## `validate`
+
+The `validate` function is a function that validates if a given object satisfies a
+specified schema. It is actually used by Owl itself to perform
+[props validation](props.md#props-validation). For example:
+
+```js
+validate(
+  { a: "hey" },
+  {
+    id: Number,
+    url: [Boolean, { type: Array, element: Number }],
   }
-}
-```
-
-In this case, the content of the `div` will be parsed as html, which may inject
-unwanted behaviour. To fix this, the `escape` function will simply transform a
-string into an escaped version of the same string, which will be properly displayed
-by the browser, but which will not be parsed as html (for example, `"<ok>"` is
-escaped to the string: `"&lt;ok&gt;"`). So, the bad example above can be fixed
-with the following change:
-
-```js
-this.divRef.el.innerHTML = owl.utils.escape(this.state.value);
-```
-
-## `debounce`
-
-The `debounce` function is useful when we want to limit the number of times some
-function/action is perfomed. For example, this may be useful to prevent issue
-with people double clicking on a button.
-
-It takes three arguments:
-
-- `func` (function): this is the function that will be rate limited
-- `wait` (number): this is the number of milliseconds that we want to use to
-  rate limit the function `func`
-- `immediate` (optional, boolean, default=false): if `immediate` is true, the
-  function will be triggered immediately (leading edge of the interval). If false,
-  the function will be triggered at the end (trailing edge).
-
-It returns a function. For example:
-
-```js
-const debounce = owl.utils.debounce;
-window.addEventListener("mousemove", debounce(doSomething, 100));
-```
-
-As this example shows, it is usualy useful for event handlers which are triggered
-very quickly, such as `scroll` or `mousemove` events.
-
-## `shallowEqual`
-
-This function checks if two objects have the same values assigned to each keys:
-
-```js
-shallowEqual({ a: 1, b: 2 }, { a: 1, b: 2 }); // true
-shallowEqual({ a: 1, b: 2 }, { a: 1, b: 3 }); // false
-```
-
-However, for performance reasons, it assumes that the two objects have the same
-keys. If we are in a situation where this is not guaranteed, the following code
-will work:
-
-```js
-const completeShallowEqual = (a, b) => shallowEqual(a, b) && shallowEqual(b, a);
+);
+
+// throws an error with the following information:
+//    - unknown key 'a',
+//    - 'id' is missing (should be a number),
+//    - 'url' is missing (should be a boolean or list of numbers),
 ```

package.json

@@ -1,11 +1,10 @@
 {
   "name": "@odoo/owl",
-  "version": "2.0.0-alpha1",
+  "version": "2.0.7",
   "description": "Odoo Web Library (OWL)",
   "main": "dist/owl.cjs.js",
-  "browser": "dist/owl.iife.js",
   "module": "dist/owl.es.js",
-  "types": "dist/types/index.d.ts",
+  "types": "dist/types/owl.d.ts",
   "files": [
     "dist"
   ],
@@ -13,10 +12,12 @@
     "node": ">=12.18.3"
   },
   "scripts": {
-    "build:bundle": "rollup -c",
+    "build:bundle": "rollup -c --failAfterWarnings",
+    "build:runtime": "rollup -c --failAfterWarnings runtime",
+    "build:compiler": "rollup -c --failAfterWarnings compiler",
     "build": "npm run build:bundle",
     "test": "jest",
-    "test:debug": "node --inspect-brk node_modules/.bin/jest --runInBand --watch",
+    "test:debug": "node --inspect-brk node_modules/.bin/jest --runInBand --watch --testTimeout=5000000",
     "test:watch": "jest --watch",
     "playground:serve": "python3 tools/server.py || python tools/server.py",
     "playground": "npm run build && npm run playground:serve",
@@ -24,8 +25,10 @@
     "playground:watch": "npm-run-all  --parallel playground:serve \"build:* -- --watch\"",
     "prettier": "prettier {src/*.ts,src/**/*.ts,tests/*.ts,tests/**/*.ts,doc/*.md,doc/**/*.md} --write",
     "check-formatting": "prettier {src/*.ts,src/**/*.ts,tests/*.ts,tests/**/*.ts,doc/*.md,doc/**/*.md} --check",
+    "lint": "eslint src/**/*.ts tests/**/*.ts",
     "publish": "npm run build && npm publish",
-    "release": "node tools/release.js"
+    "release": "node tools/release.js",
+    "compile_templates": "node tools/compile_xml.js"
   },
   "repository": {
     "type": "git",
@@ -40,25 +43,25 @@
   "devDependencies": {
     "@types/jest": "^27.0.1",
     "@types/node": "^14.11.8",
+    "@typescript-eslint/eslint-plugin": "5.48.1",
+    "@typescript-eslint/parser": "5.48.1",
     "chalk": "^3.0.0",
-    "cpx": "^1.5.0",
     "current-git-branch": "^1.1.0",
-    "git-rev-sync": "^1.12.0",
+    "eslint": "8.31.0",
+    "git-rev-sync": "^3.0.2",
     "github-api": "^3.3.0",
     "jest": "^27.1.0",
     "jest-diff": "^27.3.1",
     "jest-environment-jsdom": "^27.1.0",
-    "live-server": "^1.2.1",
     "npm-run-all": "^4.1.5",
     "prettier": "2.4.1",
     "rollup": "^2.56.3",
+    "rollup-plugin-dts": "^4.2.2",
     "rollup-plugin-terser": "^7.0.2",
     "rollup-plugin-typescript2": "^0.31.1",
-    "sass": "^1.16.1",
     "source-map-support": "^0.5.10",
     "ts-jest": "^27.0.5",
-    "typescript": "4.5.2",
-    "uglify-es": "^3.3.9"
+    "typescript": "4.5.2"
   },
   "jest": {
     "testEnvironment": "jsdom",

roadmap.md

@@ -1,28 +1,9 @@
 # 🦉 OWL Roadmap 🦉
 
-- Current version: 1.4.7
+- Current version: 2.X
 - Status: stable
 
-This roadmap is only an attempt at predicting Owl's future.  Everything may
-change!
-
-
-### 1.x
-
-- add chrome and firefox devtools,
-- fix every bugs,
-- improve documentation,
-- small backward compatible improvements.
-
-### 2.x (2020? 2021? 2022?)
-
-- stop support for `t-set` directive to define the content of a slot
-
-Maybe:
-
-- reimplement vdom to use *block* system, like Vue 3, which should make Owl
-  much faster
-- refactor `QWeb` to use an intermediate representation (some kind of AST) to
-  allow additional optimisations.
-
+Owl is currently stable. No (large) improvements is expected in the near future.
 
+Note that we intend to keep maintaining owl, and as such, improvements and/or
+breaking changes may require a version bump in the future.

rollup.config.js

@@ -2,14 +2,18 @@ import pkg from "./package.json";
 import git from "git-rev-sync";
 import typescript from 'rollup-plugin-typescript2';
 import { terser } from "rollup-plugin-terser";
+import dts from "rollup-plugin-dts";
 
-const name = "owl";
-const extend = true;
+let input, output;
+
+const IIFE_FILENAME = "dist/owl.iife.js";
+const CJS_FILENAME = "dist/owl.cjs.js";
+const ES_FILENAME = "dist/owl.es.js";
+
+if (pkg.module !== ES_FILENAME || pkg.main !== CJS_FILENAME) {
+  throw new Error("package.json has been modified. Build script should be updated accordingly");
+}  
 
-/**
- * Meta data to be added on the __info__ object.
- * Used to let external tools know the current owl version.
- */
 const outro = `
 __info__.version = '${pkg.version}';
 __info__.date = '${new Date().toISOString()}';
@@ -17,13 +21,39 @@ __info__.hash = '${git.short()}';
 __info__.url = 'https://github.com/odoo/owl';
 `;
 
+switch (process.argv[4]) {
+  case "compiler": 
+    input = "src/compiler/index.ts",
+    output = [
+      getConfigForFormat('cjs', 'dist/compiler.js', ''),
+    ]
+    break;
+  case "runtime":
+    input = "src/runtime/index.ts";
+    output = [
+      getConfigForFormat('esm', addSuffix(ES_FILENAME,  'runtime'), outro),
+      getConfigForFormat('cjs', addSuffix(CJS_FILENAME,  'runtime'), outro),
+      getConfigForFormat('iife', addSuffix(IIFE_FILENAME,  'runtime'), outro),
+      getConfigForFormat('iife', addSuffix(IIFE_FILENAME,  'runtime'), outro, true),
+    ]
+    break;
+  default:
+    input = "src/index.ts",
+    output = [
+      getConfigForFormat('esm', ES_FILENAME, outro),
+      getConfigForFormat('cjs', CJS_FILENAME, outro),
+      getConfigForFormat('iife', IIFE_FILENAME, outro),
+      getConfigForFormat('iife', IIFE_FILENAME, outro, true),
+    ]
+  }
+
 /**
  * Generate from a string depicting a path a new path for the minified version.
  * @param {string} pkgFileName file name
  */
-function generateMinifiedNameFromPkgName(pkgFileName) {
+function addSuffix(pkgFileName, suffix) {
   const parts = pkgFileName.split('.');
-  parts.splice(parts.length - 1, 0, "min");
+  parts.splice(parts.length - 1, 0, suffix);
   return parts.join('.');
 }
 
@@ -33,12 +63,12 @@ function generateMinifiedNameFromPkgName(pkgFileName) {
  * @param {string} generatedFileName generated file name
  * @param {boolean} minified should it be minified
  */
-function getConfigForFormat(format, generatedFileName, minified = false) {
+function getConfigForFormat(format, generatedFileName, outro, minified = false) {
   return {
-    file: minified ? generateMinifiedNameFromPkgName(generatedFileName) : generatedFileName,
+    file: minified ? addSuffix(generatedFileName, "min") : generatedFileName,
     format: format,
-    name: name,
-    extend: extend,
+    name: "owl",
+    extend: true,
     outro: outro,
     freeze: false,
     plugins: minified ? [terser()] : [],
@@ -46,26 +76,19 @@ function getConfigForFormat(format, generatedFileName, minified = false) {
   };
 }
 
-export default {
-  input: "src/index.ts",
-  output: [
-
-    /**
-     * Read about module formats:
-     *  https://auth0.com/blog/javascript-module-systems-showdown/
-     *  https://medium.com/@kelin2025/so-you-wanna-use-es6-modules-714f48b3a953
-     */
-
-    getConfigForFormat('esm', pkg.module),
-    getConfigForFormat('esm', pkg.module, true),
-    getConfigForFormat('cjs', pkg.main),
-    getConfigForFormat('cjs', pkg.main, true),
-    getConfigForFormat('iife', pkg.browser),
-    getConfigForFormat('iife', pkg.browser, true),
-  ],
-  plugins: [
-    typescript({
-      useTsconfigDeclarationDir: true
-    }),
-  ]
-};
+export default [
+  {
+    input,
+    output,
+    plugins: [
+      typescript({
+        useTsconfigDeclarationDir: true
+      }),
+    ]
+  },
+  {
+    input: "dist/types/index.d.ts",
+    output: [{ file: "dist/types/owl.d.ts", format: "es" }],
+    plugins: [dts()],
+  },
+];

src/app/app.ts

@@ -1,105 +0,0 @@
-import { Component } from "../component/component";
-import { ComponentNode } from "../component/component_node";
-import { MountOptions } from "../component/fibers";
-import { Scheduler } from "../component/scheduler";
-import { TemplateSet, TemplateSetConfig } from "./template_set";
-import { nodeErrorHandlers } from "../component/error_handling";
-
-// reimplement dev mode stuff see last change in 0f7a8289a6fb8387c3c1af41c6664b2a8448758f
-
-export interface Env {
-  [key: string]: any;
-}
-
-export interface AppConfig extends TemplateSetConfig {
-  env?: Env;
-  props?: any;
-}
-
-export const DEV_MSG = `Owl is running in 'dev' mode.
-
-This is not suitable for production use.
-See https://github.com/odoo/owl/blob/master/doc/reference/config.md#mode for more information.`;
-
-export class App<T extends typeof Component = any> extends TemplateSet {
-  Root: T;
-  props: any;
-  env: Env;
-  scheduler = new Scheduler(window.requestAnimationFrame.bind(window));
-  root: ComponentNode | null = null;
-
-  constructor(Root: T, config: AppConfig = {}) {
-    super(config);
-    this.Root = Root;
-    if (config.dev) {
-      console.info(DEV_MSG);
-    }
-    const descrs = Object.getOwnPropertyDescriptors(config.env || {});
-    this.env = Object.freeze(Object.defineProperties({}, descrs));
-    this.props = config.props || {};
-  }
-
-  mount(target: HTMLElement, options?: MountOptions): Promise<InstanceType<T>> {
-    this.checkTarget(target);
-    const node = this.makeNode(this.Root, this.props);
-    const prom = this.mountNode(node, target, options);
-    this.root = node;
-    return prom;
-  }
-
-  checkTarget(target: HTMLElement) {
-    if (!(target instanceof HTMLElement)) {
-      throw new Error("Cannot mount component: the target is not a valid DOM element");
-    }
-    if (!document.body.contains(target)) {
-      throw new Error("Cannot mount a component on a detached dom node");
-    }
-  }
-
-  makeNode(Component: T, props: any): ComponentNode {
-    return new ComponentNode(Component, props, this);
-  }
-
-  mountNode(node: ComponentNode, target: HTMLElement, options?: MountOptions) {
-    const promise: any = new Promise((resolve, reject) => {
-      let isResolved = false;
-      // manually set a onMounted callback.
-      // that way, we are independant from the current node.
-      node.mounted.push(() => {
-        resolve(node.component);
-        isResolved = true;
-      });
-
-      // Manually add the last resort error handler on the node
-      let handlers = nodeErrorHandlers.get(node);
-      if (!handlers) {
-        handlers = [];
-        nodeErrorHandlers.set(node, handlers);
-      }
-      handlers.unshift((e) => {
-        if (isResolved) {
-          console.error(e);
-        } else {
-          reject(e);
-        }
-        throw e;
-      });
-    });
-    node.mountComponent(target, options);
-    return promise;
-  }
-
-  destroy() {
-    if (this.root) {
-      this.root.destroy();
-    }
-  }
-}
-
-export async function mount<T extends typeof Component>(
-  C: T,
-  target: HTMLElement,
-  config: AppConfig & MountOptions = {}
-): Promise<InstanceType<T>> {
-  return new App(C, config).mount(target, config);
-}

src/app/template_helpers.ts

@@ -1,200 +0,0 @@
-import { BDom, multi, text, toggler } from "../blockdom";
-import { validateProps } from "../component/props_validation";
-import { Markup } from "../utils";
-import { html } from "../blockdom/index";
-
-/**
- * This file contains utility functions that will be injected in each template,
- * to perform various useful tasks in the compiled code.
- */
-
-function withDefault(value: any, defaultValue: any): any {
-  return value === undefined || value === null || value === false ? defaultValue : value;
-}
-
-function callSlot(
-  ctx: any,
-  parent: any,
-  key: string,
-  name: string,
-  dynamic: boolean,
-  extra: any,
-  defaultContent?: (ctx: any, node: any, key: string) => BDom
-): BDom {
-  const slots = (ctx.props && ctx.props.slots) || {};
-  const { __render, __ctx, __scope } = slots[name] || {};
-  const slotScope = Object.create(__ctx || {});
-  if (__scope) {
-    slotScope[__scope] = extra || {};
-  }
-  const slotBDom = __render ? __render.call(__ctx.__owl__.component, slotScope, parent, key) : null;
-  if (defaultContent) {
-    let child1: BDom | undefined = undefined;
-    let child2: BDom | undefined = undefined;
-    if (slotBDom) {
-      child1 = dynamic ? toggler(name, slotBDom) : slotBDom;
-    } else {
-      child2 = defaultContent.call(ctx.__owl__.component, ctx, parent, key);
-    }
-    return multi([child1, child2]);
-  }
-  return slotBDom || text("");
-}
-
-function capture(ctx: any): any {
-  const component = ctx.__owl__.component;
-  const result = Object.create(component);
-  for (let k in ctx) {
-    result[k] = ctx[k];
-  }
-  return result;
-}
-
-function withKey(elem: any, k: string) {
-  elem.key = k;
-  return elem;
-}
-
-function prepareList(collection: any): [any[], any[], number, any[]] {
-  let keys: any[];
-  let values: any[];
-
-  if (Array.isArray(collection)) {
-    keys = collection;
-    values = collection;
-  } else if (collection) {
-    values = Object.keys(collection);
-    keys = Object.values(collection);
-  } else {
-    throw new Error("Invalid loop expression");
-  }
-  const n = values.length;
-  return [keys, values, n, new Array(n)];
-}
-
-const isBoundary = Symbol("isBoundary");
-
-function setContextValue(ctx: { [key: string]: any }, key: string, value: any): void {
-  const ctx0 = ctx;
-  while (!ctx.hasOwnProperty(key) && !ctx.hasOwnProperty(isBoundary)) {
-    const newCtx = ctx.__proto__;
-    if (!newCtx) {
-      ctx = ctx0;
-      break;
-    }
-    ctx = newCtx;
-  }
-  ctx[key] = value;
-}
-
-function toNumber(val: string): number | string {
-  const n = parseFloat(val);
-  return isNaN(n) ? val : n;
-}
-
-function shallowEqual(l1: any[], l2: any[]): boolean {
-  for (let i = 0, l = l1.length; i < l; i++) {
-    if (l1[i] !== l2[i]) {
-      return false;
-    }
-  }
-  return true;
-}
-
-class LazyValue {
-  fn: any;
-  ctx: any;
-  node: any;
-  constructor(fn: any, ctx: any, node: any) {
-    this.fn = fn;
-    this.ctx = capture(ctx);
-    this.node = node;
-  }
-
-  evaluate(): any {
-    return this.fn(this.ctx, this.node);
-  }
-
-  toString() {
-    return this.evaluate().toString();
-  }
-}
-
-/*
- * Safely outputs `value` as a block depending on the nature of `value`
- */
-export function safeOutput(value: any): ReturnType<typeof toggler> {
-  if (!value) {
-    return value;
-  }
-  let safeKey;
-  let block;
-  if (value instanceof Markup) {
-    safeKey = `string_safe`;
-    block = html(value as string);
-  } else if (value instanceof LazyValue) {
-    safeKey = `lazy_value`;
-    block = value.evaluate();
-  } else if (typeof value === "string") {
-    safeKey = "string_unsafe";
-    block = text(value);
-  } else {
-    // Assuming it is a block
-    safeKey = "block_safe";
-    block = value;
-  }
-  return toggler(safeKey, block);
-}
-
-let boundFunctions = new WeakMap();
-
-function bind(ctx: any, fn: Function): Function {
-  let component = ctx.__owl__.component;
-  let boundFnMap = boundFunctions.get(component);
-  if (!boundFnMap) {
-    boundFnMap = new WeakMap();
-    boundFunctions.set(component, boundFnMap);
-  }
-  let boundFn = boundFnMap.get(fn);
-  if (!boundFn) {
-    boundFn = fn.bind(component);
-    boundFnMap.set(fn, boundFn);
-  }
-  return boundFn;
-}
-
-type RefMap = { [key: string]: HTMLElement | null };
-type RefSetter = (el: HTMLElement | null) => void;
-
-function multiRefSetter(refs: RefMap, name: string): RefSetter {
-  let count = 0;
-  return (el) => {
-    if (el) {
-      count++;
-      if (count > 1) {
-        throw new Error("Cannot have 2 elements with same ref name at the same time");
-      }
-    }
-    if (count === 0 || el) {
-      refs[name] = el;
-    }
-  };
-}
-
-export const UTILS = {
-  withDefault,
-  zero: Symbol("zero"),
-  isBoundary,
-  callSlot,
-  capture,
-  withKey,
-  prepareList,
-  setContextValue,
-  multiRefSetter,
-  shallowEqual,
-  toNumber,
-  validateProps,
-  LazyValue,
-  safeOutput,
-  bind,
-};

src/compiler/index.ts

@@ -1,15 +1,19 @@
-import type { BDom } from "../blockdom";
+import type { TemplateSet } from "../runtime/template_set";
+import type { BDom } from "../runtime/blockdom";
 import { CodeGenerator, Config } from "./code_generator";
 import { parse } from "./parser";
 
 export type Template = (context: any, vnode: any, key?: string) => BDom;
 
-export type TemplateFunction = (blocks: any, utils: any) => Template;
+export type TemplateFunction = (app: TemplateSet, bdom: any, helpers: any) => Template;
 
 interface CompileOptions extends Config {
   name?: string;
 }
-export function compile(template: string | Node, options: CompileOptions = {}): TemplateFunction {
+export function compile(
+  template: string | Element,
+  options: CompileOptions = {}
+): TemplateFunction {
   // parsing
   const ast = parse(template);
 
@@ -23,5 +27,5 @@ export function compile(template: string | Node, options: CompileOptions = {}):
   const codeGenerator = new CodeGenerator(ast, { ...options, hasSafeContext });
   const code = codeGenerator.generateCode();
   // template function
-  return new Function("bdom, helpers", code) as TemplateFunction;
+  return new Function("app, bdom, helpers", code) as TemplateFunction;
 }

src/compiler/inline_expressions.ts

@@ -1,3 +1,5 @@
+import { OwlError } from "../runtime/error_handling";
+
 /**
  * Owl QWeb Expression Parser
  *
@@ -26,7 +28,7 @@
 //------------------------------------------------------------------------------
 
 const RESERVED_WORDS =
-  "true,false,NaN,null,undefined,debugger,console,window,in,instanceof,new,function,return,this,eval,void,Math,RegExp,Array,Object,Date".split(
+  "true,false,NaN,null,undefined,debugger,console,window,in,instanceof,new,function,return,eval,void,Math,RegExp,Array,Object,Date".split(
     ","
   );
 
@@ -85,8 +87,9 @@ const STATIC_TOKEN_MAP: { [key: string]: TKind } = Object.assign(Object.create(n
 });
 
 // note that the space after typeof is relevant. It makes sure that the formatted
-// expression has a space after typeof
-const OPERATORS = "...,.,===,==,+,!==,!=,!,||,&&,>=,>,<=,<,?,-,*,/,%,typeof ,=>,=,;,in ".split(",");
+// expression has a space after typeof. Currently we don't support delete and void
+const OPERATORS =
+  "...,.,===,==,+,!==,!=,!,||,&&,>=,>,<=,<,?,-,*,/,%,typeof ,=>,=,;,in ,new ,|,&,^,~".split(",");
 
 type Tokenizer = (expr: string) => Token | false;
 
@@ -105,14 +108,14 @@ let tokenizeString: Tokenizer = function (expr) {
       i++;
       cur = expr[i];
       if (!cur) {
-        throw new Error("Invalid expression");
+        throw new OwlError("Invalid expression");
       }
       s += cur;
     }
     i++;
   }
   if (expr[i] !== start) {
-    throw new Error("Invalid expression");
+    throw new OwlError("Invalid expression");
   }
   s += start;
   if (start === "`") {
@@ -199,24 +202,30 @@ const TOKENIZERS = [
 export function tokenize(expr: string): Token[] {
   const result: Token[] = [];
   let token: boolean | Token = true;
+  let error: any;
+  let current = expr;
 
-  while (token) {
-    expr = expr.trim();
-    if (expr) {
-      for (let tokenizer of TOKENIZERS) {
-        token = tokenizer(expr);
-        if (token) {
-          result.push(token);
-          expr = expr.slice(token.size || token.value.length);
-          break;
+  try {
+    while (token) {
+      current = current.trim();
+      if (current) {
+        for (let tokenizer of TOKENIZERS) {
+          token = tokenizer(current);
+          if (token) {
+            result.push(token);
+            current = current.slice(token.size || token.value.length);
+            break;
+          }
         }
+      } else {
+        token = false;
       }
-    } else {
-      token = false;
     }
+  } catch (e) {
+    error = e; // Silence all errors and throw a generic error below
   }
-  if (expr.length) {
-    throw new Error(`Tokenizer error: could not tokenize "${expr}"`);
+  if (current.length || error) {
+    throw new OwlError(`Tokenizer error: could not tokenize \`${expr}\``);
   }
   return result;
 }
@@ -329,28 +338,38 @@ export function compileExprToArray(expr: string): Token[] {
   // Mark all variables that have been used locally.
   // This assumes the expression has only one scope (incorrect but "good enough for now")
   for (const token of tokens) {
-    if (token.type === "SYMBOL" && localVars.has(token.value)) {
+    if (token.type === "SYMBOL" && token.varName && localVars.has(token.value)) {
+      token.originalValue = token.value;
+      token.value = `_${token.value}`;
       token.isLocal = true;
     }
   }
   return tokens;
 }
 
+// Leading spaces are trimmed during tokenization, so they need to be added back for some values
+const paddedValues = new Map([["in ", " in "]]);
+
 export function compileExpr(expr: string): string {
   return compileExprToArray(expr)
-    .map((t) => t.value)
+    .map((t) => paddedValues.get(t.value) || t.value)
     .join("");
 }
 
-export const INTERP_REGEXP = /\{\{.*?\}\}/g;
-const INTERP_GROUP_REGEXP = /\{\{.*?\}\}/g;
+export const INTERP_REGEXP = /\{\{.*?\}\}|\#\{.*?\}/g;
 
-export function interpolate(s: string): string {
+export function replaceDynamicParts(s: string, replacer: (s: string) => string) {
   let matches = s.match(INTERP_REGEXP);
   if (matches && matches[0].length === s.length) {
-    return `(${compileExpr(s.slice(2, -2))})`;
+    return `(${replacer(s.slice(2, matches[0][0] === "{" ? -2 : -1))})`;
   }
 
-  let r = s.replace(INTERP_GROUP_REGEXP, (s) => "${" + compileExpr(s.slice(2, -2)) + "}");
+  let r = s.replace(
+    INTERP_REGEXP,
+    (s) => "${" + replacer(s.slice(2, s[0] === "{" ? -2 : -1)) + "}"
+  );
   return "`" + r + "`";
 }
+export function interpolate(s: string): string {
+  return replaceDynamicParts(s, compileExpr);
+}

src/compiler/parser.ts

@@ -1,7 +1,12 @@
+import { OwlError } from "../runtime/error_handling";
+
 // -----------------------------------------------------------------------------
 // AST Type definition
 // -----------------------------------------------------------------------------
 
+export type EventHandlers = { [eventName: string]: string };
+export type Attrs = { [attrs: string]: string };
+
 export const enum ASTType {
   Text,
   Comment,
@@ -18,8 +23,10 @@ export const enum ASTType {
   TDebug,
   TLog,
   TSlot,
+  TSetSlot,
   TCallBlock,
   TTranslation,
+  TPortal,
 }
 
 export interface ASTText {
@@ -32,23 +39,26 @@ export interface ASTComment {
   value: string;
 }
 
+interface TModelInfo {
+  baseExpr: string;
+  expr: string;
+  targetAttr: string;
+  eventType: "change" | "click" | "input";
+  shouldTrim: boolean;
+  shouldNumberize: boolean;
+  hasDynamicChildren: boolean;
+  specialInitTargetAttr: string | null;
+}
+
 export interface ASTDomNode {
   type: ASTType.DomNode;
   tag: string;
-  dynamicTag: string | null;
-  attrs: { [key: string]: string };
   content: AST[];
+  attrs: Attrs | null;
   ref: string | null;
-  on: { [key: string]: string };
-  model: {
-    baseExpr: string;
-    expr: string;
-    targetAttr: string;
-    specialInitTargetAttr: string | null;
-    eventType: "change" | "click" | "input";
-    shouldTrim: boolean;
-    shouldNumberize: boolean;
-  } | null;
+  on: EventHandlers | null;
+  model: TModelInfo | null;
+  dynamicTag: string | null;
   ns: string | null;
 }
 
@@ -89,15 +99,13 @@ export interface ASTTForEach {
   type: ASTType.TForEach;
   collection: string;
   elem: string;
-  key: string | null;
   body: AST;
   memo: string;
-  isOnlyChild: boolean;
-  hasNoComponent: boolean;
   hasNoFirst: boolean;
   hasNoLast: boolean;
   hasNoIndex: boolean;
   hasNoValue: boolean;
+  key: string | null;
 }
 
 export interface ASTTKey {
@@ -110,6 +118,16 @@ export interface ASTTCall {
   type: ASTType.TCall;
   name: string;
   body: AST[] | null;
+  context: string | null;
+}
+
+export interface ASTSlotDefinition {
+  type: ASTType.TSetSlot;
+  name: string;
+  content: AST | null;
+  scope: string | null;
+  on: EventHandlers | null;
+  attrs: Attrs | null;
 }
 
 export interface ASTComponent {
@@ -117,14 +135,17 @@ export interface ASTComponent {
   name: string;
   isDynamic: boolean;
   dynamicProps: string | null;
-  props: { [name: string]: string };
-  slots: { [name: string]: { content: AST; attrs?: { [key: string]: string }; scope?: string } };
+  on: EventHandlers | null;
+  props: { [name: string]: string } | null;
+  body: AST | null;
+  // slots: { [name: string]: ASTSlotDefinition } | null;
 }
 
 export interface ASTSlot {
   type: ASTType.TSlot;
   name: string;
-  attrs: { [key: string]: string };
+  attrs: Attrs | null;
+  on: EventHandlers | null;
   defaultContent: AST | null;
 }
 
@@ -149,6 +170,12 @@ export interface ASTTranslation {
   content: AST | null;
 }
 
+export interface ASTTPortal {
+  type: ASTType.TPortal;
+  target: string;
+  content: AST;
+}
+
 export type AST =
   | ASTText
   | ASTComment
@@ -163,31 +190,45 @@ export type AST =
   | ASTTKey
   | ASTComponent
   | ASTSlot
+  | ASTSlotDefinition
   | ASTTCallBlock
   | ASTLog
   | ASTDebug
-  | ASTTranslation;
+  | ASTTranslation
+  | ASTTPortal;
 
 // -----------------------------------------------------------------------------
 // Parser
 // -----------------------------------------------------------------------------
-interface ParsingContext {
-  inPreTag: boolean;
-  inSVG: boolean;
-}
+const cache: WeakMap<Element, AST> = new WeakMap();
 
-export function parse(xml: string | Node): AST {
-  const node = xml instanceof Element ? xml : (parseXML(`<t>${xml}</t>`).firstChild! as Element);
-  normalizeXML(node);
-  const ctx = { inPreTag: false, inSVG: false };
-  const ast = parseNode(node, ctx);
+export function parse(xml: string | Element): AST {
+  if (typeof xml === "string") {
+    const elem = parseXML(`<t>${xml}</t>`).firstChild as Element;
+    return _parse(elem);
+  }
+  let ast = cache.get(xml);
   if (!ast) {
-    return { type: ASTType.Text, value: "" };
+    // we clone here the xml to prevent modifying it in place
+    ast = _parse(xml.cloneNode(true) as Element);
+    cache.set(xml, ast);
   }
   return ast;
 }
 
-function parseNode(node: ChildNode, ctx: ParsingContext): AST | null {
+function _parse(xml: Element): AST {
+  normalizeXML(xml);
+  const ctx = { inPreTag: false, inSVG: false };
+  return parseNode(xml, ctx) || { type: ASTType.Text, value: "" };
+}
+
+interface ParsingContext {
+  tModelInfo?: TModelInfo | null;
+  inPreTag: boolean;
+  inSVG: boolean;
+}
+
+function parseNode(node: Node, ctx: ParsingContext): AST | null {
   if (!(node instanceof Element)) {
     return parseTextCommentNode(node, ctx);
   }
@@ -195,12 +236,14 @@ function parseNode(node: ChildNode, ctx: ParsingContext): AST | null {
     parseTDebugLog(node, ctx) ||
     parseTForEach(node, ctx) ||
     parseTIf(node, ctx) ||
+    parseTPortal(node, ctx) ||
     parseTCall(node, ctx) ||
     parseTCallBlock(node, ctx) ||
     parseTEscNode(node, ctx) ||
     parseTKey(node, ctx) ||
     parseTTranslation(node, ctx) ||
     parseTSlot(node, ctx) ||
+    parseTSetSlot(node, ctx) ||
     parseTOutNode(node, ctx) ||
     parseComponent(node, ctx) ||
     parseDOMNode(node, ctx) ||
@@ -226,7 +269,7 @@ function parseTNode(node: Element, ctx: ParsingContext): AST | null {
 const lineBreakRE = /[\r\n]/;
 const whitespaceRE = /\s+/g;
 
-function parseTextCommentNode(node: ChildNode, ctx: ParsingContext): AST | null {
+function parseTextCommentNode(node: Node, ctx: ParsingContext): AST | null {
   if (node.nodeType === Node.TEXT_NODE) {
     let value = node.textContent || "";
     if (!ctx.inPreTag) {
@@ -274,6 +317,8 @@ function parseTDebugLog(node: Element, ctx: ParsingContext): AST | null {
 const hasDotAtTheEnd = /\.[\w_]+\s*$/;
 const hasBracketsAtTheEnd = /\[[^\[]+\]\s*$/;
 
+const ROOT_SVG_TAGS = new Set(["svg", "g", "path"]);
+
 function parseDOMNode(node: Element, ctx: ParsingContext): AST | null {
   const { tagName } = node;
   const dynamicTag = node.getAttribute("t-tag");
@@ -281,33 +326,37 @@ function parseDOMNode(node: Element, ctx: ParsingContext): AST | null {
   if (tagName === "t" && !dynamicTag) {
     return null;
   }
+  if (tagName.startsWith("block-")) {
+    throw new OwlError(`Invalid tag name: '${tagName}'`);
+  }
   ctx = Object.assign({}, ctx);
   if (tagName === "pre") {
     ctx.inPreTag = true;
   }
-  const shouldAddSVGNS = tagName === "svg" || (tagName === "g" && !ctx.inSVG);
+  const shouldAddSVGNS = ROOT_SVG_TAGS.has(tagName) && !ctx.inSVG;
   ctx.inSVG = ctx.inSVG || shouldAddSVGNS;
   const ns = shouldAddSVGNS ? "http://www.w3.org/2000/svg" : null;
   const ref = node.getAttribute("t-ref");
   node.removeAttribute("t-ref");
 
-  const children = parseChildren(node, ctx);
-
   const nodeAttrsNames = node.getAttributeNames();
-  const attrs: ASTDomNode["attrs"] = {};
-  const on: ASTDomNode["on"] = {};
-  let model: ASTDomNode["model"] = null;
+  let attrs: ASTDomNode["attrs"] = null;
+  let on: EventHandlers | null = null;
+  let model: TModelInfo | null = null;
 
   for (let attr of nodeAttrsNames) {
     const value = node.getAttribute(attr)!;
     if (attr.startsWith("t-on")) {
       if (attr === "t-on") {
-        throw new Error("Missing event name with t-on directive");
+        throw new OwlError("Missing event name with t-on directive");
       }
+      on = on || {};
       on[attr.slice(5)] = value;
     } else if (attr.startsWith("t-model")) {
       if (!["input", "select", "textarea"].includes(tagName)) {
-        throw new Error("The t-model directive only works with <input>, <textarea> and <select>");
+        throw new OwlError(
+          "The t-model directive only works with <input>, <textarea> and <select>"
+        );
       }
 
       let baseExpr, expr;
@@ -320,7 +369,7 @@ function parseDOMNode(node: Element, ctx: ParsingContext): AST | null {
         baseExpr = value.slice(0, index);
         expr = value.slice(index + 1, -1);
       } else {
-        throw new Error(`Invalid t-model expression: "${value}" (it should be assignable)`);
+        throw new OwlError(`Invalid t-model expression: "${value}" (it should be assignable)`);
       }
 
       const typeAttr = node.getAttribute("type");
@@ -341,19 +390,31 @@ function parseDOMNode(node: Element, ctx: ParsingContext): AST | null {
         targetAttr: isCheckboxInput ? "checked" : "value",
         specialInitTargetAttr: isRadioInput ? "checked" : null,
         eventType,
+        hasDynamicChildren: false,
         shouldTrim: hasTrimMod && (isOtherInput || isTextarea),
         shouldNumberize: hasNumberMod && (isOtherInput || isTextarea),
       };
-    } else {
-      if (attr.startsWith("t-") && !attr.startsWith("t-att")) {
-        throw new Error(`Unknown QWeb directive: '${attr}'`);
+      if (isSelect) {
+        // don't pollute the original ctx
+        ctx = Object.assign({}, ctx);
+        ctx.tModelInfo = model;
       }
+    } else if (attr.startsWith("block-")) {
+      throw new OwlError(`Invalid attribute: '${attr}'`);
+    } else if (attr !== "t-name") {
+      if (attr.startsWith("t-") && !attr.startsWith("t-att")) {
+        throw new OwlError(`Unknown QWeb directive: '${attr}'`);
+      }
+      const tModel = ctx.tModelInfo;
+      if (tModel && ["t-att-value", "t-attf-value"].includes(attr)) {
+        tModel.hasDynamicChildren = true;
+      }
+      attrs = attrs || {};
       attrs[attr] = value;
     }
   }
-  if (children.length === 1 && children[0].type === ASTType.TForEach) {
-    children[0].isOnlyChild = true;
-  }
+
+  const children = parseChildren(node, ctx);
   return {
     type: ASTType.DomNode,
     tag: tagName,
@@ -396,7 +457,7 @@ function parseTEscNode(node: Element, ctx: ParsingContext): AST | null {
     };
   }
   if (ast.type === ASTType.TComponent) {
-    throw new Error("t-esc is not supported on Component nodes");
+    throw new OwlError("t-esc is not supported on Component nodes");
   }
   return tesc;
 }
@@ -452,7 +513,7 @@ function parseTForEach(node: Element, ctx: ParsingContext): AST | null {
   node.removeAttribute("t-as");
   const key = node.getAttribute("t-key");
   if (!key) {
-    throw new Error(
+    throw new OwlError(
       `"Directive t-foreach should always be used with a t-key!" (expression: t-foreach="${collection}" t-as="${elem}")`
     );
   }
@@ -478,8 +539,6 @@ function parseTForEach(node: Element, ctx: ParsingContext): AST | null {
     body,
     memo,
     key,
-    isOnlyChild: false,
-    hasNoComponent: hasNoComponent(body),
     hasNoFirst,
     hasNoLast,
     hasNoIndex,
@@ -487,58 +546,6 @@ function parseTForEach(node: Element, ctx: ParsingContext): AST | null {
   };
 }
 
-/**
- * @returns true if we are sure the ast does not contain any component
- */
-function hasNoComponent(ast: AST): boolean {
-  switch (ast.type) {
-    case ASTType.TComponent:
-    case ASTType.TOut:
-    case ASTType.TCall:
-    case ASTType.TCallBlock:
-    case ASTType.TSlot:
-      return false;
-    case ASTType.TSet:
-    case ASTType.Text:
-    case ASTType.Comment:
-    case ASTType.TEsc:
-      return true;
-    case ASTType.TKey:
-      return hasNoComponent(ast.content);
-    case ASTType.TDebug:
-    case ASTType.TLog:
-    case ASTType.TTranslation:
-      return ast.content ? hasNoComponent(ast.content) : true;
-    case ASTType.TForEach:
-      return ast.hasNoComponent;
-    case ASTType.Multi:
-    case ASTType.DomNode: {
-      for (let elem of ast.content) {
-        if (!hasNoComponent(elem)) {
-          return false;
-        }
-      }
-      return true;
-    }
-    case ASTType.TIf: {
-      if (!hasNoComponent(ast.content)) {
-        return false;
-      }
-      if (ast.tElif) {
-        for (let elem of ast.tElif) {
-          if (!hasNoComponent(elem.content)) {
-            return false;
-          }
-        }
-      }
-      if (ast.tElse && !hasNoComponent(ast.tElse)) {
-        return false;
-      }
-      return true;
-    }
-  }
-}
-
 function parseTKey(node: Element, ctx: ParsingContext): AST | null {
   if (!node.hasAttribute("t-key")) {
     return null;
@@ -561,21 +568,23 @@ function parseTCall(node: Element, ctx: ParsingContext): AST | null {
     return null;
   }
   const subTemplate = node.getAttribute("t-call")!;
-
+  const context = node.getAttribute("t-call-context");
   node.removeAttribute("t-call");
+  node.removeAttribute("t-call-context");
+
   if (node.tagName !== "t") {
     const ast = parseNode(node, ctx);
-    const tcall: AST = { type: ASTType.TCall, name: subTemplate, body: null };
+    const tcall: AST = { type: ASTType.TCall, name: subTemplate, body: null, context };
     if (ast && ast.type === ASTType.DomNode) {
       ast.content = [tcall];
       return ast;
     }
-    if (ast && ast.type === ASTType.TComponent) {
-      return {
-        ...ast,
-        slots: { default: { content: tcall } },
-      };
-    }
+    // if (ast && ast.type === ASTType.TComponent) {
+    //   return {
+    //     ...ast,
+    //     slots: { default: { content: tcall, scope: null, on: null, attrs: null } },
+    //   };
+    // }
   }
   const body = parseChildren(node, ctx);
 
@@ -583,6 +592,7 @@ function parseTCall(node: Element, ctx: ParsingContext): AST | null {
     type: ASTType.TCall,
     name: subTemplate,
     body: body.length ? body : null,
+    context,
   };
 }
 
@@ -669,7 +679,6 @@ function parseTSetNode(node: Element, ctx: ParsingContext): AST | null {
 
 // Error messages when trying to use an unsupported directive on a component
 const directiveErrorMap = new Map([
-  ["t-on", "t-on is no longer supported on components. Consider passing a callback in props."],
   [
     "t-ref",
     "t-ref is no longer supported on components. Consider exposing only the public part of the component's API through a callback prop.",
@@ -687,7 +696,9 @@ function parseComponent(node: Element, ctx: ParsingContext): AST | null {
   let isDynamic = node.hasAttribute("t-component");
 
   if (isDynamic && name !== "t") {
-    throw new Error(`Directive 't-component' can only be used on <t> nodes (used on a <${name}>)`);
+    throw new OwlError(
+      `Directive 't-component' can only be used on <t> nodes (used on a <${name}>)`
+    );
   }
 
   if (!(firstLetter === firstLetter.toUpperCase() || isDynamic)) {
@@ -701,74 +712,38 @@ function parseComponent(node: Element, ctx: ParsingContext): AST | null {
   const dynamicProps = node.getAttribute("t-props");
   node.removeAttribute("t-props");
 
-  const props: ASTComponent["props"] = {};
+  // const defaultSlotScope = node.getAttribute("t-slot-scope");
+  // node.removeAttribute("t-slot-scope");
+  let on: ASTComponent["on"] = null;
+
+  let props: ASTComponent["props"] = null;
   for (let name of node.getAttributeNames()) {
     const value = node.getAttribute(name)!;
     if (name.startsWith("t-")) {
-      const message = directiveErrorMap.get(name.split("-").slice(0, 2).join("-"));
-      throw new Error(message || `unsupported directive on Component: ${name}`);
+      if (name.startsWith("t-on-")) {
+        on = on || {};
+        on[name.slice(5)] = value;
+      } else {
+        const message = directiveErrorMap.get(name.split("-").slice(0, 2).join("-"));
+        throw new OwlError(message || `unsupported directive on Component: ${name}`);
+      }
     } else {
+      props = props || {};
       props[name] = value;
     }
   }
 
-  const slots: ASTComponent["slots"] = {};
+  let body: ASTComponent["body"] = null;
+
+  // let slots: ASTComponent["slots"] | null = null;
   if (node.hasChildNodes()) {
-    const clone = <Element>node.cloneNode(true);
-
-    // named slots
-    const slotNodes = Array.from(clone.querySelectorAll("[t-set-slot]"));
-    for (let slotNode of slotNodes) {
-      if (slotNode.tagName !== "t") {
-        throw new Error(
-          `Directive 't-set-slot' can only be used on <t> nodes (used on a <${slotNode.tagName}>)`
-        );
-      }
-      const name = slotNode.getAttribute("t-set-slot")!;
-
-      // check if this is defined in a sub component (in which case it should
-      // be ignored)
-      let el = slotNode.parentElement!;
-      let isInSubComponent = false;
-      while (el !== clone) {
-        if (el!.hasAttribute("t-component") || el!.tagName[0] === el!.tagName[0].toUpperCase()) {
-          isInSubComponent = true;
-          break;
-        }
-        el = el.parentElement!;
-      }
-      if (isInSubComponent) {
-        continue;
-      }
-
-      slotNode.removeAttribute("t-set-slot");
-      slotNode.remove();
-      const slotAst = parseNode(slotNode, ctx);
-      if (slotAst) {
-        const slotInfo: any = { content: slotAst };
-        const attrs: { [key: string]: string } = {};
-        for (let attributeName of slotNode.getAttributeNames()) {
-          const value = slotNode.getAttribute(attributeName)!;
-          if (attributeName === "t-slot-scope") {
-            slotInfo.scope = value;
-            continue;
-          }
-          attrs[attributeName] = value;
-        }
-        if (Object.keys(attrs).length) {
-          slotInfo.attrs = attrs;
-        }
-        slots[name] = slotInfo;
-      }
+    body = parseChildNodes(node, ctx);
+    if (!node.querySelector('[t-set-slot]')) {
+      body = {type: ASTType.TSetSlot, name: "default", content: body, on: null, attrs: null, scope: null}
     }
 
-    // default slot
-    const defaultContent = parseChildNodes(clone, ctx);
-    if (defaultContent) {
-      slots.default = { content: defaultContent };
-    }
   }
-  return { type: ASTType.TComponent, name, isDynamic, dynamicProps, props, slots };
+  return { type: ASTType.TComponent, name, isDynamic, dynamicProps, props, body, on };
 }
 
 // -----------------------------------------------------------------------------
@@ -781,19 +756,92 @@ function parseTSlot(node: Element, ctx: ParsingContext): AST | null {
   }
   const name = node.getAttribute("t-slot")!;
   node.removeAttribute("t-slot");
-  const attrs: { [key: string]: string } = {};
+  let attrs: Attrs | null = null;
+  let on: ASTComponent["on"] = null;
   for (let attributeName of node.getAttributeNames()) {
     const value = node.getAttribute(attributeName)!;
-    attrs[attributeName] = value;
+    if (attributeName.startsWith("t-on-")) {
+      on = on || {};
+      on[attributeName.slice(5)] = value;
+    } else {
+      attrs = attrs || {};
+      attrs[attributeName] = value;
+    }
   }
   return {
     type: ASTType.TSlot,
     name,
     attrs,
+    on,
     defaultContent: parseChildNodes(node, ctx),
   };
 }
 
+function parseTSetSlot(node: Element, ctx: ParsingContext): AST | null {
+  if (!node.hasAttribute("t-set-slot")) {
+    return null;
+  }
+  // const t = el.ownerDocument.createElement("t");
+
+    // const clone = <Element>node.cloneNode(true);
+
+    // // named slots
+    // const slotNodes = Array.from(clone.querySelectorAll("[t-set-slot]"));
+    // for (let slotNode of slotNodes) {
+      if (node.tagName !== "t") {
+        throw new OwlError(
+          `Directive 't-set-slot' can only be used on <t> nodes (used on a <${node.tagName}>)`
+        );
+      }
+      const name = node.getAttribute("t-set-slot")!;
+
+    //   // check if this is defined in a sub component (in which case it should
+    //   // be ignored)
+    //   let el = slotNode.parentElement!;
+    //   let isInSubComponent = false;
+    //   while (el !== clone) {
+    //     if (el!.hasAttribute("t-component") || el!.tagName[0] === el!.tagName[0].toUpperCase()) {
+    //       isInSubComponent = true;
+    //       break;
+    //     }
+    //     el = el.parentElement!;
+    //   }
+    //   if (isInSubComponent) {
+    //     continue;
+    //   }
+
+      node.removeAttribute("t-set-slot");
+      node.remove();
+      const slotAst = parseNode(node, ctx);
+      let on: ASTSlotDefinition["on"] = null;
+      let attrs: Attrs | null = null;
+      let scope: string | null = null;
+      for (let attributeName of node.getAttributeNames()) {
+        const value = node.getAttribute(attributeName)!;
+        if (attributeName === "t-slot-scope") {
+          scope = value;
+          continue;
+        } else if (attributeName.startsWith("t-on-")) {
+          on = on || {};
+          on[attributeName.slice(5)] = value;
+        } else {
+          attrs = attrs || {};
+          attrs[attributeName] = value;
+        }
+      }
+    //   slots = slots || {};
+      return { type: ASTType.TSetSlot, name, content: slotAst, on, attrs, scope };
+    // }
+
+    // // default slot
+    // const defaultContent = parseChildNodes(clone, ctx);
+    // slots = slots || {};
+    // // t-set-slot="default" has priority over content
+    // if (defaultContent && !slots.default) {
+    //   slots.default = { content: defaultContent, on, attrs: null, scope: defaultSlotScope };
+    // }
+}
+
 function parseTTranslation(node: Element, ctx: ParsingContext): AST | null {
   if (node.getAttribute("t-translation") !== "off") {
     return null;
@@ -805,6 +853,30 @@ function parseTTranslation(node: Element, ctx: ParsingContext): AST | null {
   };
 }
 
+// -----------------------------------------------------------------------------
+// Portal
+// -----------------------------------------------------------------------------
+
+function parseTPortal(node: Element, ctx: ParsingContext): AST | null {
+  if (!node.hasAttribute("t-portal")) {
+    return null;
+  }
+  const target = node.getAttribute("t-portal")!;
+  node.removeAttribute("t-portal");
+  const content = parseNode(node, ctx);
+  if (!content) {
+    return {
+      type: ASTType.Text,
+      value: "",
+    };
+  }
+  return {
+    type: ASTType.TPortal,
+    target,
+    content,
+  };
+}
+
 // -----------------------------------------------------------------------------
 // helpers
 // -----------------------------------------------------------------------------
@@ -812,7 +884,7 @@ function parseTTranslation(node: Element, ctx: ParsingContext): AST | null {
 /**
  * Parse all the child nodes of a given node and return a list of ast elements
  */
-function parseChildren(node: Node, ctx: ParsingContext): AST[] {
+function parseChildren(node: Element, ctx: ParsingContext): AST[] {
   const children: AST[] = [];
   for (let child of node.childNodes) {
     const childAst = parseNode(child, ctx);
@@ -831,7 +903,7 @@ function parseChildren(node: Node, ctx: ParsingContext): AST[] {
  * Parse all the child nodes of a given node and return an ast if possible.
  * In the case there are multiple children, they are wrapped in a astmulti.
  */
-function parseChildNodes(node: Node, ctx: ParsingContext): AST | null {
+function parseChildNodes(node: Element, ctx: ParsingContext): AST | null {
   const children = parseChildren(node, ctx);
   switch (children.length) {
     case 0:
@@ -860,7 +932,7 @@ function normalizeTIf(el: Element) {
     let nattr = (name: string) => +!!node.getAttribute(name);
     if (prevElem && (pattr("t-if") || pattr("t-elif"))) {
       if (pattr("t-foreach")) {
-        throw new Error(
+        throw new OwlError(
           "t-if cannot stay at the same level as t-foreach when using t-elif or t-else"
         );
       }
@@ -869,19 +941,19 @@ function normalizeTIf(el: Element) {
           return a + b;
         }) > 1
       ) {
-        throw new Error("Only one conditional branching directive is allowed per node");
+        throw new OwlError("Only one conditional branching directive is allowed per node");
       }
       // All text (with only spaces) and comment nodes (nodeType 8) between
       // branch nodes are removed
       let textNode;
       while ((textNode = node.previousSibling) !== prevElem) {
         if (textNode!.nodeValue!.trim().length && textNode!.nodeType !== 8) {
-          throw new Error("text is not allowed between branching directives");
+          throw new OwlError("text is not allowed between branching directives");
         }
         textNode!.remove();
       }
     } else {
-      throw new Error(
+      throw new OwlError(
         "t-elif and t-else directives must be preceded by a t-if or t-elif directive"
       );
     }
@@ -902,7 +974,7 @@ function normalizeTEsc(el: Element) {
   );
   for (const el of elements) {
     if (el.childNodes.length) {
-      throw new Error("Cannot have t-esc on a component that already has content");
+      throw new OwlError("Cannot have t-esc on a component that already has content");
     }
     const value = el.getAttribute("t-esc");
     el.removeAttribute("t-esc");
@@ -956,7 +1028,7 @@ function parseXML(xml: string): XMLDocument {
         }
       }
     }
-    throw new Error(msg);
+    throw new OwlError(msg);
   }
 
   return doc;

src/component/component.ts

@@ -1,27 +0,0 @@
-import type { Env } from "../app/app";
-import type { ComponentNode } from "./component_node";
-
-// -----------------------------------------------------------------------------
-//  Component Class
-// -----------------------------------------------------------------------------
-
-export class Component {
-  static template: string = "";
-  static props?: any;
-
-  props: any;
-  env: Env;
-  __owl__: ComponentNode;
-
-  constructor(props: any, env: Env, node: ComponentNode) {
-    this.props = props;
-    this.env = env;
-    this.__owl__ = node;
-  }
-
-  setup() {}
-
-  render() {
-    this.__owl__.render();
-  }
-}

src/component/component_node.ts

@@ -1,310 +0,0 @@
-import type { App, Env } from "../app/app";
-import { BDom, VNode } from "../blockdom";
-import { Component } from "./component";
-import {
-  Fiber,
-  makeChildFiber,
-  makeRootFiber,
-  MountFiber,
-  MountOptions,
-  RootFiber,
-} from "./fibers";
-import { handleError, fibersInError } from "./error_handling";
-import { applyDefaultProps } from "./props_validation";
-import { STATUS } from "./status";
-
-let currentNode: ComponentNode | null = null;
-
-export function getCurrent(): ComponentNode | null {
-  return currentNode;
-}
-
-export function useComponent(): Component {
-  return currentNode!.component;
-}
-
-export function component(
-  name: string | typeof Component,
-  props: any,
-  key: string,
-  tKey: null | string,
-  ctx: ComponentNode,
-  parent: any
-): ComponentNode {
-  const parentChildren = ctx.children;
-  const destroy = ComponentNode.prototype.destroy;
-
-  if (tKey) {
-    const parentMap = ctx.keyToTkey;
-    const oldTkey = parentMap[key];
-    if (oldTkey && oldTkey !== tKey) {
-      const oldKey = key + oldTkey;
-      const node = parentChildren[oldKey];
-      if (node && node.status < STATUS.MOUNTED) {
-        destroy.call(node);
-        delete parentChildren[oldKey];
-      }
-    }
-    parentMap[key] = tKey;
-    key = key + tKey;
-  }
-
-  let node: any = parentChildren[key];
-  let isDynamic = typeof name !== "string";
-
-  if (node) {
-    if (node.status < STATUS.MOUNTED) {
-      destroy.call(node);
-      node = undefined;
-    } else if (node.status === STATUS.DESTROYED) {
-      node = undefined;
-    }
-  }
-  if (isDynamic && node && node.component.constructor !== name) {
-    node = undefined;
-  }
-
-  const parentFiber = ctx.fiber!;
-  if (node) {
-    node.updateAndRender(props, parentFiber);
-  } else {
-    // new component
-    let C;
-    if (isDynamic) {
-      C = name;
-    } else {
-      C = parent.constructor.components[name as any];
-      if (!C) {
-        throw new Error(`Cannot find the definition of component "${name}"`);
-      }
-    }
-    node = new ComponentNode(C, props, ctx.app, ctx);
-    parentChildren[key] = node;
-
-    const fiber = makeChildFiber(node, parentFiber);
-    node.initiateRender(fiber);
-  }
-  return node;
-}
-
-// -----------------------------------------------------------------------------
-//  Component VNode
-// -----------------------------------------------------------------------------
-
-type LifecycleHook = Function;
-
-export class ComponentNode<T extends typeof Component = typeof Component>
-  implements VNode<ComponentNode>
-{
-  el?: HTMLElement | Text | undefined;
-  app: App;
-  fiber: Fiber | null = null;
-  component: InstanceType<T>;
-  bdom: BDom | null = null;
-  status: STATUS = STATUS.NEW;
-
-  renderFn: Function;
-  parent: ComponentNode | null;
-  level: number;
-  childEnv: Env;
-  children: { [key: string]: ComponentNode } = Object.create(null);
-  refs: any = {};
-  keyToTkey: any = {};
-
-  willStart: LifecycleHook[] = [];
-  willUpdateProps: LifecycleHook[] = [];
-  willUnmount: LifecycleHook[] = [];
-  mounted: LifecycleHook[] = [];
-  willPatch: LifecycleHook[] = [];
-  patched: LifecycleHook[] = [];
-  willDestroy: LifecycleHook[] = [];
-
-  constructor(C: T, props: any, app: App, parent?: ComponentNode) {
-    currentNode = this;
-    this.app = app;
-    this.parent = parent || null;
-    this.level = parent ? parent.level + 1 : 0;
-    applyDefaultProps(props, C);
-    const env = (parent && parent.childEnv) || app.env;
-    this.childEnv = env;
-    this.component = new C(props, env, this) as any;
-    this.renderFn = app.getTemplate(C.template).bind(this.component, this.component, this);
-    this.component.setup();
-  }
-
-  mountComponent(target: any, options?: MountOptions) {
-    const fiber = new MountFiber(this, target, options);
-    this.app.scheduler.addFiber(fiber);
-    this.initiateRender(fiber);
-  }
-
-  async initiateRender(fiber: Fiber | MountFiber) {
-    this.fiber = fiber;
-    if (this.mounted.length) {
-      fiber.root.mounted.push(fiber);
-    }
-    const component = this.component;
-    try {
-      await Promise.all(this.willStart.map((f) => f.call(component)));
-    } catch (e) {
-      handleError({ node: this, error: e });
-      return;
-    }
-    if (this.status === STATUS.NEW && this.fiber === fiber) {
-      this._render(fiber);
-    }
-  }
-
-  async render() {
-    let current = this.fiber;
-    if (current && current.root.locked) {
-      await Promise.resolve();
-      // situation may have changed after the microtask tick
-      current = this.fiber;
-    }
-    if (current && !current.bdom && !fibersInError.has(current)) {
-      return;
-    }
-    if (!this.bdom && !current) {
-      return;
-    }
-
-    const fiber = makeRootFiber(this);
-    this.fiber = fiber;
-    this.app.scheduler.addFiber(fiber);
-    await Promise.resolve();
-    if (this.status === STATUS.DESTROYED) {
-      return;
-    }
-    // We only want to actually render the component if the following two
-    // conditions are true:
-    // * this.fiber: it could be null, in which case the render has been cancelled
-    // * (current || !fiber.parent): if current is not null, this means that the
-    //   render function was called when a render was already occurring. In this
-    //   case, the pending rendering was cancelled, and the fiber needs to be
-    //   rendered to complete the work.  If current is null, we check that the
-    //   fiber has no parent.  If that is the case, the fiber was downgraded from
-    //   a root fiber to a child fiber in the previous microtick, because it was
-    //   embedded in a rendering coming from above, so the fiber will be rendered
-    //   in the next microtick anyway, so we should not render it again.
-    if (this.fiber && (current || !fiber.parent)) {
-      this._render(fiber);
-    }
-  }
-
-  _render(fiber: Fiber | RootFiber) {
-    try {
-      fiber.bdom = this.renderFn();
-      fiber.root.counter--;
-    } catch (e) {
-      handleError({ node: this, error: e });
-    }
-  }
-
-  destroy() {
-    let shouldRemove = this.status === STATUS.MOUNTED;
-    this._destroy();
-    if (shouldRemove) {
-      this.bdom!.remove();
-    }
-  }
-
-  _destroy() {
-    const component = this.component;
-    if (this.status === STATUS.MOUNTED) {
-      for (let cb of this.willUnmount) {
-        cb.call(component);
-      }
-    }
-    for (let child of Object.values(this.children)) {
-      child._destroy();
-    }
-    for (let cb of this.willDestroy) {
-      cb.call(component);
-    }
-    this.status = STATUS.DESTROYED;
-  }
-
-  async updateAndRender(props: any, parentFiber: Fiber) {
-    // update
-    const fiber = makeChildFiber(this, parentFiber);
-    this.fiber = fiber;
-    const component = this.component;
-    applyDefaultProps(props, component.constructor as any);
-    const prom = Promise.all(this.willUpdateProps.map((f) => f.call(component, props)));
-    await prom;
-    if (fiber !== this.fiber) {
-      return;
-    }
-    component.props = props;
-    this._render(fiber);
-    const parentRoot = parentFiber.root;
-    if (this.willPatch.length) {
-      parentRoot.willPatch.push(fiber);
-    }
-    if (this.patched.length) {
-      parentRoot.patched.push(fiber);
-    }
-  }
-
-  /**
-   * Finds a child that has dom that is not yet updated, and update it. This
-   * method is meant to be used only in the context of repatching the dom after
-   * a mounted hook failed and was handled.
-   */
-  updateDom() {
-    if (!this.fiber) {
-      return;
-    }
-    if (this.bdom === this.fiber!.bdom) {
-      // If the error was handled by some child component, we need to find it to
-      // apply its change
-      for (let k in this.children) {
-        const child = this.children[k];
-        child.updateDom();
-      }
-    } else {
-      // if we get here, this is the component that handled the error and rerendered
-      // itself, so we can simply patch the dom
-      this.bdom!.patch(this.fiber!.bdom, false);
-      this.fiber!.appliedToDom = true;
-      this.fiber = null;
-    }
-  }
-
-  // ---------------------------------------------------------------------------
-  // Block DOM methods
-  // ---------------------------------------------------------------------------
-
-  firstNode(): Node | undefined {
-    const bdom = this.bdom;
-    return bdom ? bdom.firstNode() : undefined;
-  }
-
-  mount(parent: HTMLElement, anchor: ChildNode) {
-    const bdom = this.fiber!.bdom!;
-    this.bdom = bdom;
-    bdom.mount(parent, anchor);
-    this.status = STATUS.MOUNTED;
-    this.fiber!.appliedToDom = true;
-    this.fiber = null;
-  }
-
-  moveBefore(other: ComponentNode | null, afterNode: Node | null) {
-    this.bdom!.moveBefore(other ? other.bdom : null, afterNode);
-  }
-
-  patch() {
-    this.bdom!.patch(this!.fiber!.bdom!, false);
-    this.fiber!.appliedToDom = true;
-    this.fiber = null;
-  }
-
-  beforeRemove() {
-    this._destroy();
-  }
-
-  remove() {
-    this.bdom!.remove();
-  }
-}

src/component/lifecycle_hooks.ts

@@ -1,71 +0,0 @@
-import { getCurrent } from "./component_node";
-import { nodeErrorHandlers } from "./error_handling";
-
-// -----------------------------------------------------------------------------
-//  hooks
-// -----------------------------------------------------------------------------
-
-export function onWillStart(fn: () => Promise<void> | void | any) {
-  const node = getCurrent()!;
-  node.willStart.push(fn);
-}
-
-export function onWillUpdateProps(fn: (nextProps: any) => Promise<void> | void | any) {
-  const node = getCurrent()!;
-  node.willUpdateProps.push(fn);
-}
-
-export function onMounted(fn: () => void | any) {
-  const node = getCurrent()!;
-  node.mounted.push(fn);
-}
-
-export function onWillPatch(fn: () => Promise<void> | any | void) {
-  const node = getCurrent()!;
-  node.willPatch.unshift(fn);
-}
-
-export function onPatched(fn: () => void | any) {
-  const node = getCurrent()!;
-  node.patched.push(fn);
-}
-
-export function onWillUnmount(fn: () => Promise<void> | void | any) {
-  const node = getCurrent()!;
-  node.willUnmount.unshift(fn);
-}
-
-export function onWillDestroy(fn: () => Promise<void> | void | any) {
-  const node = getCurrent()!;
-  node.willDestroy.push(fn);
-}
-
-export function onWillRender(fn: () => void | any) {
-  const node = getCurrent()!;
-  const renderFn = node.renderFn;
-  node.renderFn = () => {
-    fn();
-    return renderFn();
-  };
-}
-
-export function onRendered(fn: () => void | any) {
-  const node = getCurrent()!;
-  const renderFn = node.renderFn;
-  node.renderFn = () => {
-    const result = renderFn();
-    fn();
-    return result;
-  };
-}
-
-type OnErrorCallback = (error: any) => void | any;
-export function onError(callback: OnErrorCallback) {
-  const node = getCurrent()!;
-  let handlers = nodeErrorHandlers.get(node);
-  if (!handlers) {
-    handlers = [];
-    nodeErrorHandlers.set(node, handlers);
-  }
-  handlers.push(callback);
-}

src/component/props_validation.ts

@@ -1,133 +0,0 @@
-import { Component } from "./component";
-
-/**
- * Apply default props (only top level).
- *
- * Note that this method does modify in place the props
- */
-export function applyDefaultProps(props: { [key: string]: any }, ComponentClass: typeof Component) {
-  const defaultProps = (ComponentClass as any).defaultProps;
-  if (defaultProps) {
-    for (let propName in defaultProps) {
-      if (props![propName] === undefined) {
-        props![propName] = defaultProps[propName];
-      }
-    }
-  }
-}
-
-//------------------------------------------------------------------------------
-// Prop validation helper
-//------------------------------------------------------------------------------
-function getPropDescription(staticProps: any) {
-  if (staticProps instanceof Array) {
-    return Object.fromEntries(
-      staticProps.map((p) => (p.endsWith("?") ? [p.slice(0, -1), false] : [p, true]))
-    );
-  }
-  return staticProps || { "*": true };
-}
-
-/**
- * Validate the component props (or next props) against the (static) props
- * description.  This is potentially an expensive operation: it may needs to
- * visit recursively the props and all the children to check if they are valid.
- * This is why it is only done in 'dev' mode.
- */
-export const validateProps = function (name: string | typeof Component, props: any, parent?: any) {
-  const ComponentClass = (
-    typeof name !== "string" ? name : parent.constructor.components[name]
-  ) as typeof Component;
-
-  applyDefaultProps(props, ComponentClass);
-
-  let propsDef = getPropDescription(ComponentClass.props);
-  const allowAdditionalProps = "*" in propsDef;
-
-  for (let propName in propsDef) {
-    if (propName === "*") {
-      continue;
-    }
-    if (props[propName] === undefined) {
-      if (propsDef[propName] && !propsDef[propName].optional) {
-        throw new Error(`Missing props '${propName}' (component '${ComponentClass.name}')`);
-      } else {
-        continue;
-      }
-    }
-    let isValid;
-    try {
-      isValid = isValidProp(props[propName], propsDef[propName]);
-    } catch (e) {
-      (e as Error).message = `Invalid prop '${propName}' in component ${ComponentClass.name} (${
-        (e as Error).message
-      })`;
-      throw e;
-    }
-    if (!isValid) {
-      throw new Error(`Invalid Prop '${propName}' in component '${ComponentClass.name}'`);
-    }
-  }
-  if (!allowAdditionalProps) {
-    for (let propName in props) {
-      if (!(propName in propsDef)) {
-        throw new Error(`Unknown prop '${propName}' given to component '${ComponentClass.name}'`);
-      }
-    }
-  }
-};
-
-/**
- * Check if an invidual prop value matches its (static) prop definition
- */
-function isValidProp(prop: any, propDef: any): boolean {
-  if (propDef === true) {
-    return true;
-  }
-  if (typeof propDef === "function") {
-    // Check if a value is constructed by some Constructor.  Note that there is a
-    // slight abuse of language: we want to consider primitive values as well.
-    //
-    // So, even though 1 is not an instance of Number, we want to consider that
-    // it is valid.
-    if (typeof prop === "object") {
-      return prop instanceof propDef;
-    }
-    return typeof prop === propDef.name.toLowerCase();
-  } else if (propDef instanceof Array) {
-    // If this code is executed, this means that we want to check if a prop
-    // matches at least one of its descriptor.
-    let result = false;
-    for (let i = 0, iLen = propDef.length; i < iLen; i++) {
-      result = result || isValidProp(prop, propDef[i]);
-    }
-    return result;
-  }
-  // propsDef is an object
-  if (propDef.optional && prop === undefined) {
-    return true;
-  }
-  let result = propDef.type ? isValidProp(prop, propDef.type) : true;
-  if (propDef.validate) {
-    result = result && propDef.validate(prop);
-  }
-  if (propDef.type === Array && propDef.element) {
-    for (let i = 0, iLen = prop.length; i < iLen; i++) {
-      result = result && isValidProp(prop[i], propDef.element);
-    }
-  }
-  if (propDef.type === Object && propDef.shape) {
-    const shape = propDef.shape;
-    for (let key in shape) {
-      result = result && isValidProp(prop[key], shape[key]);
-    }
-    if (result) {
-      for (let propName in prop) {
-        if (!(propName in shape)) {
-          throw new Error(`unknown prop '${propName}'`);
-        }
-      }
-    }
-  }
-  return result;
-}

src/component/scheduler.ts

@@ -1,74 +0,0 @@
-import { fibersInError } from "./error_handling";
-import { Fiber, RootFiber } from "./fibers";
-import { STATUS } from "./status";
-
-// -----------------------------------------------------------------------------
-//  Scheduler
-// -----------------------------------------------------------------------------
-
-export class Scheduler {
-  tasks: Set<RootFiber> = new Set();
-  isRunning: boolean = false;
-  requestAnimationFrame: Window["requestAnimationFrame"];
-
-  constructor(requestAnimationFrame: Window["requestAnimationFrame"]) {
-    this.requestAnimationFrame = requestAnimationFrame;
-  }
-
-  start() {
-    this.isRunning = true;
-    this.scheduleTasks();
-  }
-
-  stop() {
-    this.isRunning = false;
-  }
-
-  addFiber(fiber: Fiber) {
-    this.tasks.add(fiber.root);
-    if (!this.isRunning) {
-      this.start();
-    }
-  }
-
-  /**
-   * Process all current tasks. This only applies to the fibers that are ready.
-   * Other tasks are left unchanged.
-   */
-  flush() {
-    this.tasks.forEach((fiber) => {
-      if (fiber.root !== fiber) {
-        this.tasks.delete(fiber);
-        return;
-      }
-      const hasError = fibersInError.has(fiber);
-      if (hasError && fiber.counter !== 0) {
-        this.tasks.delete(fiber);
-        return;
-      }
-      if (fiber.node.status === STATUS.DESTROYED) {
-        this.tasks.delete(fiber);
-        return;
-      }
-
-      if (fiber.counter === 0) {
-        if (!hasError) {
-          fiber.complete();
-        }
-        this.tasks.delete(fiber);
-      }
-    });
-    if (this.tasks.size === 0) {
-      this.stop();
-    }
-  }
-
-  scheduleTasks() {
-    this.requestAnimationFrame(() => {
-      this.flush();
-      if (this.isRunning) {
-        this.scheduleTasks();
-      }
-    });
-  }
-}

src/index.ts

@@ -1,58 +1,16 @@
-import {
-  config,
-  createBlock,
-  html,
-  list,
-  mount as blockMount,
-  multi,
-  patch,
-  remove,
-  text,
-  toggler,
-  comment,
-} from "./blockdom";
-import { mainEventHandler } from "./component/handler";
+import { TemplateSet } from "./runtime/template_set";
+import { compile } from "./compiler";
 
-config.shouldNormalizeDom = false;
-config.mainEventHandler = mainEventHandler;
+export * from "./runtime";
 
-export const blockDom = {
-  config,
-  // bdom entry points
-  mount: blockMount,
-  patch,
-  remove,
-  // bdom block types
-  list,
-  multi,
-  text,
-  toggler,
-  createBlock,
-  html,
-  comment,
+TemplateSet.prototype._compileTemplate = function _compileTemplate(
+  name: string,
+  template: string | Element
+) {
+  return compile(template, {
+    name,
+    dev: this.dev,
+    translateFn: this.translateFn,
+    translatableAttributes: this.translatableAttributes,
+  });
 };
-
-export { App, mount } from "./app/app";
-export { Component } from "./component/component";
-export { useComponent } from "./component/component_node";
-export { status } from "./component/status";
-export { Portal } from "./portal";
-export { Memo } from "./memo";
-export { xml } from "./app/template_set";
-export { useState, reactive } from "./reactivity";
-export { useEffect, useEnv, useExternalListener, useRef, useSubEnv } from "./hooks";
-export { EventBus, whenReady, loadFile, markup } from "./utils";
-export {
-  onWillStart,
-  onMounted,
-  onWillUnmount,
-  onWillUpdateProps,
-  onWillPatch,
-  onPatched,
-  onWillRender,
-  onRendered,
-  onWillDestroy,
-  onError,
-} from "./component/lifecycle_hooks";
-
-export const __info__ = {};

src/memo.ts

@@ -1,47 +0,0 @@
-import { Component } from "./component/component";
-import type { ComponentNode } from "./component/component_node";
-import { xml } from "./app/template_set";
-import { Fiber } from "./component/fibers";
-
-export class Memo extends Component {
-  static template = xml`<t t-slot="default"/>`;
-
-  constructor(props: any, env: any, node: ComponentNode) {
-    super(props, env, node);
-
-    // prevent patching process conditionally
-    let applyPatch = false;
-    const patchFn = node.patch;
-    node.patch = () => {
-      if (applyPatch) {
-        patchFn.call(node);
-        applyPatch = false;
-      }
-    };
-
-    // check props change, and render/apply patch if it changed
-    let prevProps = props;
-    const updateAndRender = node.updateAndRender;
-    node.updateAndRender = function (props: any, parentFiber: Fiber) {
-      const shouldUpdate = !shallowEqual(prevProps, props);
-      if (shouldUpdate) {
-        prevProps = props;
-        updateAndRender.call(node, props, parentFiber);
-        applyPatch = true;
-      }
-      return Promise.resolve();
-    };
-  }
-}
-
-/**
- * we assume that each object have the same set of keys
- */
-function shallowEqual(p1: any, p2: any): boolean {
-  for (let k in p1) {
-    if (k !== "slots" && p1[k] !== p2[k]) {
-      return false;
-    }
-  }
-  return true;
-}

src/portal.ts

@@ -1,71 +0,0 @@
-import type { ComponentNode } from "./component/component_node";
-import { Component } from "./component/component";
-import { xml } from "./app/template_set";
-import { BDom, text, VNode } from "./blockdom";
-
-const VText: any = text("").constructor;
-
-class VPortal extends VText implements Partial<VNode<VPortal>> {
-  //   selector: string;
-  realBDom: BDom | null;
-  target: HTMLElement | null = null;
-
-  constructor(selector: string, realBDom: BDom) {
-    super("");
-    this.selector = selector;
-    this.realBDom = realBDom;
-  }
-  mount(parent: HTMLElement, anchor: ChildNode) {
-    super.mount(parent, anchor);
-    this.target = document.querySelector(this.selector) as any;
-    if (!this.target) {
-      let el: any = this.el;
-      while (el && el.parentElement instanceof HTMLElement) {
-        el = el.parentElement;
-      }
-      this.target = el && el.querySelector(this.selector);
-      if (!this.target) {
-        throw new Error("invalid portal target");
-      }
-    }
-    this.realBDom!.mount(this.target!, null);
-  }
-
-  beforeRemove() {
-    this.realBDom!.beforeRemove();
-  }
-  remove() {
-    super.remove();
-    this.realBDom!.remove();
-    this.realBDom = null;
-  }
-
-  patch(other: VPortal) {
-    super.patch(other);
-    if (this.realBDom) {
-      this.realBDom.patch(other.realBDom!, true);
-    } else {
-      this.realBDom = other.realBDom;
-      this.realBDom!.mount(this.target!, null);
-    }
-  }
-}
-
-export class Portal extends Component {
-  static template = xml`<t t-slot="default"/>`;
-  static props = {
-    target: {
-      type: String,
-    },
-    slots: true,
-  };
-
-  constructor(props: any, env: any, node: ComponentNode) {
-    super(props, env, node);
-    node._render = function (fiber: any) {
-      const bdom = new VPortal(props.target, this.renderFn());
-      fiber.bdom = bdom;
-      fiber.root.counter--;
-    };
-  }
-}

src/reactivity.ts

@@ -1,241 +0,0 @@
-import { onWillUnmount } from "./component/lifecycle_hooks";
-import { ComponentNode, getCurrent } from "./component/component_node";
-
-// Allows to get the target of a Reactive (used for making a new Reactive from the underlying object)
-const TARGET = Symbol("Target");
-// Special key to subscribe to, to be notified of key creation/deletion
-const KEYCHANGES = Symbol("Key changes");
-
-type ObjectKey = string | number | symbol;
-type Target = object;
-type Callback = () => void;
-type Reactive<T extends Target = Target> = T & {
-  [TARGET]: any;
-};
-
-/**
- * Checks whether a given value can be made into a reactive object.
- *
- * @param value the value to check
- * @returns whether the value can be made reactive
- */
-function canBeMadeReactive(value: any): boolean {
-  return (
-    typeof value === "object" &&
-    value !== null &&
-    !(value instanceof Date) &&
-    !(value instanceof Promise) &&
-    !(value instanceof String) &&
-    !(value instanceof Number)
-  );
-}
-
-const targetToKeysToCallbacks = new WeakMap<Target, Map<ObjectKey, Set<Callback>>>();
-/**
- * Observes a given key on a target with an callback. The callback will be
- * called when the given key changes on the target.
- *
- * @param target the target whose key should be observed
- * @param key the key to observe (or Symbol(KEYCHANGES) for key creation
- *  or deletion)
- * @param callback the function to call when the key changes
- */
-function observeTargetKey(target: Target, key: ObjectKey, callback: Callback): void {
-  if (!targetToKeysToCallbacks.get(target)) {
-    targetToKeysToCallbacks.set(target, new Map());
-  }
-  const keyToCallbacks = targetToKeysToCallbacks.get(target)!;
-  if (!keyToCallbacks.get(key)) {
-    keyToCallbacks.set(key, new Set());
-  }
-  keyToCallbacks.get(key)!.add(callback);
-  if (!callbacksToTargets.has(callback)) {
-    callbacksToTargets.set(callback, new Set());
-  }
-  callbacksToTargets.get(callback)!.add(target);
-}
-/**
- * Notify Reactives that are observing a given target that a key has changed on
- * the target.
- *
- * @param target target whose Reactives should be notified that the target was
- *  changed.
- * @param key the key that changed (or Symbol `KEYCHANGES` if a key was created
- *   or deleted)
- */
-function notifyReactives(target: Target, key: ObjectKey): void {
-  const keyToCallbacks = targetToKeysToCallbacks.get(target);
-  if (!keyToCallbacks) {
-    return;
-  }
-  const callbacks = keyToCallbacks.get(key);
-  if (!callbacks) {
-    return;
-  }
-  // Loop on copy because clearReactivesForCallback will modify the set in place
-  for (const callback of [...callbacks]) {
-    clearReactivesForCallback(callback);
-    callback();
-  }
-}
-
-const callbacksToTargets = new WeakMap<Callback, Set<Target>>();
-/**
- * Clears all subscriptions of the Reactives associated with a given callback.
- *
- * @param callback the callback for which the reactives need to be cleared
- */
-function clearReactivesForCallback(callback: Callback): void {
-  const targetsToClear = callbacksToTargets.get(callback);
-  if (!targetsToClear) {
-    return;
-  }
-  for (const target of targetsToClear) {
-    const observedKeys = targetToKeysToCallbacks.get(target);
-    if (!observedKeys) {
-      continue;
-    }
-    for (const callbacks of observedKeys.values()) {
-      callbacks.delete(callback);
-    }
-  }
-  targetsToClear.clear();
-}
-
-const reactiveCache = new WeakMap<Target, WeakMap<Callback, Reactive>>();
-/**
- * Creates a reactive proxy for an object. Reading data on the reactive object
- * subscribes to changes to the data. Writing data on the object will cause the
- * notify callback to be called if there are suscriptions to that data. Nested
- * objects and arrays are automatically made reactive as well.
- *
- * Whenever you are notified of a change, all subscriptions are cleared, and if
- * you would like to be notified of any further changes, you should go read
- * the underlying data again. We assume that if you don't go read it again after
- * being notified, it means that you are no longer interested in that data.
- *
- * Subscriptions:
- * + Reading a property on an object will subscribe you to changes in the value
- *    of that property.
- * + Accessing an object keys (eg with Object.keys or with `for..in`) will
- *    subscribe you to the creation/deletion of keys. Checking the presence of a
- *    key on the object with 'in' has the same effect.
- * - getOwnPropertyDescriptor does not currently subscribe you to the property.
- *    This is a choice that was made because changing a key's value will trigger
- *    this trap and we do not want to subscribe by writes. This also means that
- *    Object.hasOwnProperty doesn't subscribe as it goes through this trap.
- *
- * @param target the object for which to create a reactive proxy
- * @param callback the function to call when an observed property of the
- *  reactive has changed
- * @returns a proxy that tracks changes to it
- */
-export function reactive<T extends Target>(target: T, callback: Callback = () => {}): Reactive<T> {
-  if (!canBeMadeReactive(target)) {
-    throw new Error(`Cannot make the given value reactive`);
-  }
-  const originalTarget = (target as Reactive)[TARGET];
-  if (originalTarget) {
-    return reactive(originalTarget, callback);
-  }
-  if (!reactiveCache.has(target)) {
-    reactiveCache.set(target, new Map());
-  }
-  const reactivesForTarget = reactiveCache.get(target)!;
-  if (!reactivesForTarget.has(callback)) {
-    const proxy = new Proxy(target, {
-      get(target: any, key: ObjectKey, proxy: Reactive<T>) {
-        if (key === TARGET) {
-          return target;
-        }
-        observeTargetKey(target, key, callback);
-        const value = Reflect.get(target, key, proxy);
-        if (!canBeMadeReactive(value)) {
-          return value;
-        }
-        return reactive(value, callback);
-      },
-      set(target, key, value, proxy) {
-        const isNewKey = !Object.hasOwnProperty.call(target, key);
-        const originalValue = Reflect.get(target, key, proxy);
-        const ret = Reflect.set(target, key, value, proxy);
-        if (isNewKey) {
-          notifyReactives(target, KEYCHANGES);
-        }
-        // While Array length may trigger the set trap, it's not actually set by this
-        // method but is updated behind the scenes, and the trap is not called with the
-        // new value. We disable the "same-value-optimization" for it because of that.
-        if (originalValue !== value || (Array.isArray(target) && key === "length")) {
-          notifyReactives(target, key);
-        }
-        return ret;
-      },
-      deleteProperty(target, key) {
-        const ret = Reflect.deleteProperty(target, key);
-        notifyReactives(target, KEYCHANGES);
-        notifyReactives(target, key);
-        return ret;
-      },
-      ownKeys(target) {
-        observeTargetKey(target, KEYCHANGES, callback);
-        return Reflect.ownKeys(target);
-      },
-      has(target, key) {
-        // TODO: this observes all key changes instead of only the presence of the argument key
-        observeTargetKey(target, KEYCHANGES, callback);
-        return Reflect.has(target, key);
-      },
-    });
-    reactivesForTarget.set(callback, proxy);
-  }
-  return reactivesForTarget.get(callback) as Reactive<T>;
-}
-
-/**
- * Creates a batched version of a callback so that all calls to it in the same
- * microtick will only call the original callback once.
- *
- * @param callback the callback to batch
- * @returns a batched version of the original callback
- */
-export function batched(callback: Callback): Callback {
-  let called = false;
-  return async () => {
-    // This await blocks all calls to the callback here, then releases them sequentially
-    // in the next microtick. This line decides the granularity of the batch.
-    await Promise.resolve();
-    if (!called) {
-      called = true;
-      callback();
-      // wait for all calls in this microtick to fall through before resetting "called"
-      // so that only the first call to the batched function calls the original callback
-      await Promise.resolve();
-      called = false;
-    }
-  };
-}
-
-const batchedRenderFunctions = new WeakMap<ComponentNode, Callback>();
-/**
- * Creates a reactive object that will be observed by the current component.
- * Reading data from the returned object (eg during rendering) will cause the
- * component to subscribe to that data and be rerendered when it changes.
- *
- * @param state the state to observe
- * @returns a reactive object that will cause the component to re-render on
- *  relevant changes
- * @see reactive
- */
-export function useState<T extends object>(state: T): Reactive<T> {
-  const node = getCurrent()!;
-  if (!batchedRenderFunctions.has(node)) {
-    batchedRenderFunctions.set(
-      node,
-      batched(() => node.render())
-    );
-    onWillUnmount(() => clearReactivesForCallback(render));
-  }
-  const render = batchedRenderFunctions.get(node)!;
-  const reactiveState = reactive(state, render);
-  return reactiveState;
-}

src/runtime/app.ts

@@ -0,0 +1,210 @@
+import { Component, ComponentConstructor, Props } from "./component";
+import { ComponentNode } from "./component_node";
+import { nodeErrorHandlers, OwlError, handleError } from "./error_handling";
+import { Fiber, RootFiber, MountOptions } from "./fibers";
+import { Scheduler } from "./scheduler";
+import { validateProps } from "./template_helpers";
+import { TemplateSet, TemplateSetConfig } from "./template_set";
+import { validateTarget } from "./utils";
+
+// reimplement dev mode stuff see last change in 0f7a8289a6fb8387c3c1af41c6664b2a8448758f
+
+export interface Env {
+  [key: string]: any;
+}
+
+export interface AppConfig<P, E> extends TemplateSetConfig {
+  props?: P;
+  env?: E;
+  test?: boolean;
+  warnIfNoStaticProps?: boolean;
+}
+
+let hasBeenLogged = false;
+
+export const DEV_MSG = () => {
+  const hash = (window as any).owl ? (window as any).owl.__info__.hash : "master";
+
+  return `Owl is running in 'dev' mode.
+
+This is not suitable for production use.
+See https://github.com/odoo/owl/blob/${hash}/doc/reference/app.md#configuration for more information.`;
+};
+
+declare global {
+  interface Window {
+    __OWL_DEVTOOLS__: {
+      apps: Set<App>;
+      Fiber: typeof Fiber;
+      RootFiber: typeof RootFiber;
+    };
+  }
+}
+
+window.__OWL_DEVTOOLS__ ||= {
+  apps: new Set<App>(),
+  Fiber: Fiber,
+  RootFiber: RootFiber,
+};
+
+export class App<
+  T extends abstract new (...args: any) => any = any,
+  P extends object = any,
+  E = any
+> extends TemplateSet {
+  static validateTarget = validateTarget;
+
+  Root: ComponentConstructor<P, E>;
+  props: P;
+  env: E;
+  scheduler = new Scheduler();
+  root: ComponentNode<P, E> | null = null;
+  warnIfNoStaticProps: boolean;
+
+  constructor(Root: ComponentConstructor<P, E>, config: AppConfig<P, E> = {}) {
+    super(config);
+    this.Root = Root;
+    window.__OWL_DEVTOOLS__.apps.add(this);
+    if (config.test) {
+      this.dev = true;
+    }
+    this.warnIfNoStaticProps = config.warnIfNoStaticProps || false;
+    if (this.dev && !config.test && !hasBeenLogged) {
+      console.info(DEV_MSG());
+      hasBeenLogged = true;
+    }
+    const env = config.env || {};
+    const descrs = Object.getOwnPropertyDescriptors(env);
+    this.env = Object.freeze(Object.create(Object.getPrototypeOf(env), descrs));
+    this.props = config.props || ({} as P);
+  }
+
+  mount(target: HTMLElement, options?: MountOptions): Promise<Component<P, E> & InstanceType<T>> {
+    App.validateTarget(target);
+    if (this.dev) {
+      validateProps(this.Root, this.props, { __owl__: { app: this } });
+    }
+    const node = this.makeNode(this.Root, this.props);
+    const prom = this.mountNode(node, target, options);
+    this.root = node;
+    return prom;
+  }
+
+  makeNode(Component: ComponentConstructor, props: any): ComponentNode {
+    return new ComponentNode(Component, props, this, null, null);
+  }
+
+  mountNode(node: ComponentNode, target: HTMLElement, options?: MountOptions) {
+    const promise: any = new Promise((resolve, reject) => {
+      let isResolved = false;
+      // manually set a onMounted callback.
+      // that way, we are independant from the current node.
+      node.mounted.push(() => {
+        resolve(node.component);
+        isResolved = true;
+      });
+
+      // Manually add the last resort error handler on the node
+      let handlers = nodeErrorHandlers.get(node);
+      if (!handlers) {
+        handlers = [];
+        nodeErrorHandlers.set(node, handlers);
+      }
+      handlers.unshift((e) => {
+        if (!isResolved) {
+          reject(e);
+        }
+        throw e;
+      });
+    });
+    node.mountComponent(target, options);
+    return promise;
+  }
+
+  destroy() {
+    if (this.root) {
+      this.scheduler.flush();
+      this.root.destroy();
+    }
+    window.__OWL_DEVTOOLS__.apps.delete(this);
+  }
+
+  createComponent<P extends Props>(
+    name: string | null,
+    isStatic: boolean,
+    hasSlotsProp: boolean,
+    hasDynamicPropList: boolean,
+    hasNoProp: boolean
+  ) {
+    const isDynamic = !isStatic;
+    function _arePropsDifferent(props1: Props, props2: Props): boolean {
+      for (let k in props1) {
+        if (props1[k] !== props2[k]) {
+          return true;
+        }
+      }
+      return hasDynamicPropList && Object.keys(props1).length !== Object.keys(props2).length;
+    }
+    const arePropsDifferent = hasSlotsProp
+      ? (_1: any, _2: any) => true
+      : hasNoProp
+      ? (_1: any, _2: any) => false
+      : _arePropsDifferent;
+    const updateAndRender = ComponentNode.prototype.updateAndRender;
+    const initiateRender = ComponentNode.prototype.initiateRender;
+
+    return (props: P, key: string, ctx: ComponentNode, parent: any, C: any) => {
+      let children = ctx.children;
+      let node: any = children[key];
+      if (isDynamic && node && node.component.constructor !== C) {
+        node = undefined;
+      }
+      const parentFiber = ctx.fiber!;
+      if (node) {
+        if (arePropsDifferent(node.props, props) || parentFiber.deep || node.forceNextRender) {
+          node.forceNextRender = false;
+          updateAndRender.call(node, props, parentFiber);
+        }
+      } else {
+        // new component
+        if (isStatic) {
+          const components = parent.constructor.components;
+          if (!components) {
+            throw new OwlError(
+              `Cannot find the definition of component "${name}", missing static components key in parent`
+            );
+          }
+          C = components[name as any];
+          if (!C) {
+            throw new OwlError(`Cannot find the definition of component "${name}"`);
+          } else if (!(C.prototype instanceof Component)) {
+            throw new OwlError(
+              `"${name}" is not a Component. It must inherit from the Component class`
+            );
+          }
+        }
+        node = new ComponentNode(C, props, this, ctx, key);
+        children[key] = node;
+        initiateRender.call(node, new Fiber(node, parentFiber));
+      }
+      parentFiber.childrenMap[key] = node;
+      return node;
+    };
+  }
+
+  handleError(...args: Parameters<typeof handleError>) {
+    return handleError(...args);
+  }
+}
+
+export async function mount<
+  T extends abstract new (...args: any) => any = any,
+  P extends object = any,
+  E = any
+>(
+  C: T & ComponentConstructor<P, E>,
+  target: HTMLElement,
+  config: AppConfig<P, E> & MountOptions = {}
+): Promise<Component<P, E> & InstanceType<T>> {
+  return new App(C, config).mount(target, config);
+}

src/runtime/blockdom/attributes.ts

@@ -93,6 +93,10 @@ function toClassObj(expr: string | number | { [c: string]: any }) {
       for (let key in expr as any) {
         const value = (expr as any)[key];
         if (value) {
+          key = trim.call(key);
+          if (!key) {
+            continue;
+          }
           const words = split.call(key, wordRegexp);
           for (let word of words) {
             result[word] = value;
@@ -139,7 +143,8 @@ export function updateClass(this: HTMLElement, val: any, oldVal: any) {
 
 export function makePropSetter(name: string): Setter<HTMLElement> {
   return function setProp(this: HTMLElement, value: any) {
-    (this as any)[name] = value;
+    // support 0, fallback to empty string for other falsy values
+    (this as any)[name] = value === 0 ? 0 : value ? value.valueOf() : "";
   };
 }
 

src/runtime/blockdom/block_compiler.ts

@@ -1,3 +1,4 @@
+import { OwlError } from "../error_handling";
 import {
   attrsSetter,
   attrsUpdater,
@@ -156,6 +157,15 @@ function buildTree(
           : document.createElement(tagName);
       }
       if (el instanceof Element) {
+        if (!domParentTree) {
+          // some html elements may have side effects when setting their attributes.
+          // For example, setting the src attribute of an <img/> will trigger a
+          // request to get the corresponding image. This is something that we
+          // don't want at compile time. We avoid that by putting the content of
+          // the block in a <template/> element
+          const fragment = document.createElement("template").content;
+          fragment.appendChild(el);
+        }
         for (let i = 0; i < attrs.length; i++) {
           const attrName = attrs[i].name;
           const attrValue = attrs[i].value;
@@ -245,7 +255,7 @@ function buildTree(
       };
     }
   }
-  throw new Error("boom");
+  throw new OwlError("boom");
 }
 
 function addRef(tree: IntermediateTree) {
@@ -299,12 +309,13 @@ interface BlockCtx {
   locations: IndexedLocation[];
   children: Child[];
   cbRefs: number[];
+  refList: (() => void)[][];
 }
 
 function buildContext(tree: IntermediateTree, ctx?: BlockCtx, fromIdx?: number): BlockCtx {
   if (!ctx) {
     const children = new Array(tree.info.filter((v) => v.type === "child").length);
-    ctx = { collectors: [], locations: [], children, cbRefs: [], refN: tree.refN };
+    ctx = { collectors: [], locations: [], children, cbRefs: [], refN: tree.refN, refList: [] };
     fromIdx = 0;
   }
   if (tree.refN) {
@@ -408,11 +419,11 @@ function updateCtx(ctx: BlockCtx, tree: IntermediateTree) {
         break;
       }
       case "ref":
-        ctx.cbRefs.push(info.idx);
+        const index = ctx.cbRefs.push(info.idx) - 1;
         ctx.locations.push({
           idx: info.idx,
           refIdx: info.refIdx!,
-          setData: setRef,
+          setData: makeRefSetter(index, ctx.refList),
           updateData: NO_OP,
         });
     }
@@ -426,12 +437,21 @@ function buildBlock(template: HTMLElement, ctx: BlockCtx): BlockType {
   let B = createBlockClass(template, ctx);
 
   if (ctx.cbRefs.length) {
-    const refs = ctx.cbRefs;
+    const cbRefs = ctx.cbRefs;
+    const refList = ctx.refList;
+    let cbRefsNumber = cbRefs.length;
     B = class extends B {
+      mount(parent: HTMLElement, afterNode: Node | null) {
+        refList.push(new Array(cbRefsNumber));
+        super.mount(parent, afterNode);
+        for (let cbRef of refList.pop()!) {
+          cbRef();
+        }
+      }
       remove() {
         super.remove();
-        for (let ref of refs) {
-          let fn = (this as any).data[ref];
+        for (let cbRef of cbRefs) {
+          let fn = (this as any).data[cbRef];
           fn(null);
         }
       }
@@ -476,12 +496,12 @@ function createBlockClass(template: HTMLElement, ctx: BlockCtx): BlockClass {
   const nodeInsertBefore = nodeProto.insertBefore;
   const elementRemove = elementProto.remove;
 
-  return class Block {
+  class Block {
     el: HTMLElement | undefined;
-    refs: Node[] | undefined;
-    data: any[] | undefined;
     parentEl?: HTMLElement | undefined;
+    data: any[] | undefined;
     children?: (VNode | undefined)[];
+    refs: Node[] | undefined;
 
     constructor(data?: any[]) {
       this.data = data;
@@ -497,51 +517,71 @@ function createBlockClass(template: HTMLElement, ctx: BlockCtx): BlockClass {
       return this.el!;
     }
 
-    moveBefore(other: Block | null, afterNode: Node | null) {
-      const target = other ? other.el! : afterNode;
-      nodeInsertBefore.call(this.parentEl, this.el!, target);
+    moveBeforeDOMNode(node: Node | null, parent = this.parentEl) {
+      this.parentEl = parent;
+      nodeInsertBefore.call(parent, this.el!, node);
+    }
+
+    moveBeforeVNode(other: Block | null, afterNode: Node | null) {
+      nodeInsertBefore.call(this.parentEl, this.el!, other ? other.el! : afterNode);
+    }
+
+    toString() {
+      const div = document.createElement("div");
+      this.mount(div, null);
+      return div.innerHTML;
     }
 
     mount(parent: HTMLElement, afterNode: Node | null) {
-      const el = nodeCloneNode.call(template, true);
+      const el = nodeCloneNode.call(template, true) as HTMLElement;
       nodeInsertBefore.call(parent, el, afterNode);
-      if (isDynamic) {
-        // collecting references
-        const refs: Node[] = new Array(refN);
-        this.refs = refs;
-        refs[0] = el;
-        for (let i = 0; i < colN; i++) {
-          const w = collectors[i];
-          refs[w.idx] = w.getVal.call(refs[w.prevIdx]);
-        }
+      this.el = el;
+      this.parentEl = parent;
+    }
+    patch(other: Block, withBeforeRemove: boolean) {}
+  }
 
-        // applying data to all update points
-        if (locN) {
-          const data = this.data!;
-          for (let i = 0; i < locN; i++) {
-            const loc = locations[i];
-            loc.setData.call(refs[loc.refIdx], data[i]);
-          }
-        }
+  if (isDynamic) {
+    Block.prototype.mount = function mount(parent: HTMLElement, afterNode: Node | null) {
+      const el = nodeCloneNode.call(template, true);
+      // collecting references
+      const refs: Node[] = new Array(refN);
+      this.refs = refs;
+      refs[0] = el;
+      for (let i = 0; i < colN; i++) {
+        const w = collectors[i];
+        refs[w.idx] = w.getVal.call(refs[w.prevIdx]);
+      }
 
-        // preparing all children
-        if (childN) {
-          const children = this.children;
-          for (let i = 0; i < childN; i++) {
-            const child = children![i];
-            if (child) {
-              const loc = childrenLocs[i];
-              const afterNode = loc.afterRefIdx ? refs[loc.afterRefIdx] : null;
-              child.isOnlyChild = loc.isOnlyChild;
-              child.mount(refs[loc.parentRefIdx] as any, afterNode);
-            }
+      // applying data to all update points
+      if (locN) {
+        const data = this.data!;
+        for (let i = 0; i < locN; i++) {
+          const loc = locations[i];
+          loc.setData.call(refs[loc.refIdx], data[i]);
+        }
+      }
+
+      nodeInsertBefore.call(parent, el, afterNode);
+
+      // preparing all children
+      if (childN) {
+        const children = this.children;
+        for (let i = 0; i < childN; i++) {
+          const child = children![i];
+          if (child) {
+            const loc = childrenLocs[i];
+            const afterNode = loc.afterRefIdx ? refs[loc.afterRefIdx] : null;
+            child.isOnlyChild = loc.isOnlyChild;
+            child.mount(refs[loc.parentRefIdx] as any, afterNode);
           }
         }
       }
       this.el = el as HTMLElement;
       this.parentEl = parent;
-    }
-    patch(other: Block, withBeforeRemove: boolean) {
+    };
+
+    Block.prototype.patch = function patch(other: Block, withBeforeRemove: boolean) {
       if (this === other) {
         return;
       }
@@ -586,19 +626,17 @@ function createBlockClass(template: HTMLElement, ctx: BlockCtx): BlockClass {
           }
         }
       }
-    }
-    toString() {
-      const div = document.createElement("div");
-      this.mount(div, null);
-      return div.innerHTML;
-    }
-  };
+    };
+  }
+  return Block;
 }
 
 function setText(this: Text, value: any) {
   characterDataSetData.call(this, toText(value));
 }
 
-function setRef(this: HTMLElement, fn: any) {
-  fn(this);
+function makeRefSetter(index: number, refs: (() => void)[][]): Setter<HTMLElement> {
+  return function setRef(this: HTMLElement, fn: any) {
+    refs[refs.length - 1][index] = () => fn(this);
+  };
 }

src/runtime/blockdom/event_catcher.ts

@@ -0,0 +1,111 @@
+import { createEventHandler } from "./events";
+import type { VNode } from "./index";
+
+type EventsSpec = { [name: string]: number };
+
+type Catcher = (child: VNode, handlers: any[]) => VNode;
+
+export function createCatcher(eventsSpec: EventsSpec): Catcher {
+  const n = Object.keys(eventsSpec).length;
+
+  class VCatcher {
+    child: VNode;
+    handlerData: any[];
+    handlerFns: any[] = [];
+
+    parentEl?: HTMLElement | undefined;
+    afterNode: Text | null = null;
+
+    constructor(child: VNode, handlers: any[]) {
+      this.child = child;
+      this.handlerData = handlers;
+    }
+
+    mount(parent: HTMLElement, afterNode: Node | null) {
+      this.parentEl = parent;
+      this.child.mount(parent, afterNode);
+      this.afterNode = document.createTextNode("");
+      parent.insertBefore(this.afterNode, afterNode);
+      this.wrapHandlerData();
+      for (let name in eventsSpec) {
+        const index = eventsSpec[name];
+        const handler = createEventHandler(name);
+        this.handlerFns[index] = handler;
+        handler.setup.call(parent, this.handlerData[index]);
+      }
+    }
+
+    wrapHandlerData() {
+      for (let i = 0; i < n; i++) {
+        let handler = this.handlerData[i];
+        // handler = [...mods, fn, comp], so we need to replace second to last elem
+        let idx = handler.length - 2;
+        let origFn = handler[idx];
+        const self = this;
+        handler[idx] = function (ev: any) {
+          const target = ev.target;
+          let currentNode: any = self.child.firstNode();
+          const afterNode = self.afterNode;
+          while (currentNode && currentNode !== afterNode) {
+            if (currentNode.contains(target)) {
+              return origFn.call(this, ev);
+            }
+            currentNode = currentNode.nextSibling;
+          }
+        };
+      }
+    }
+
+    moveBeforeDOMNode(node: Node | null, parent = this.parentEl) {
+      this.parentEl = parent;
+      this.child.moveBeforeDOMNode(node, parent);
+      parent!.insertBefore(this.afterNode!, node);
+    }
+
+    moveBeforeVNode(other: VCatcher | null, afterNode: Node | null) {
+      if (other) {
+        // check this with @ged-odoo for use in foreach
+        afterNode = other.firstNode() || afterNode;
+      }
+      this.child.moveBeforeVNode(other ? other.child : null, afterNode);
+      this.parentEl!.insertBefore(this.afterNode!, afterNode);
+    }
+
+    patch(other: VCatcher, withBeforeRemove: boolean) {
+      if (this === other) {
+        return;
+      }
+      this.handlerData = other.handlerData;
+      this.wrapHandlerData();
+      for (let i = 0; i < n; i++) {
+        this.handlerFns[i].update.call(this.parentEl!, this.handlerData[i]);
+      }
+
+      this.child.patch(other.child, withBeforeRemove);
+    }
+
+    beforeRemove() {
+      this.child.beforeRemove();
+    }
+
+    remove() {
+      for (let i = 0; i < n; i++) {
+        this.handlerFns[i].remove.call(this.parentEl!);
+      }
+      this.child.remove();
+      this.afterNode!.remove();
+    }
+
+    firstNode(): Node | undefined {
+      return this.child.firstNode();
+    }
+
+    toString(): string {
+      return this.child.toString();
+    }
+  }
+
+  return function (child: VNode, handlers: any[]): VNode<VCatcher> {
+    return new VCatcher(child, handlers);
+  };
+}

src/runtime/blockdom/events.ts

@@ -5,6 +5,7 @@ type EventHandlerSetter = (this: HTMLElement, data: any) => void;
 interface EventHandlerCreator {
   setup: EventHandlerSetter;
   update: EventHandlerSetter;
+  remove: (this: HTMLElement) => void;
 }
 
 export function createEventHandler(rawEvent: string): EventHandlerCreator {
@@ -26,8 +27,8 @@ function createElementHandler(evName: string, capture: boolean = false): EventHa
   }
 
   function listener(ev: Event) {
-    const currentTarget = ev.currentTarget;
-    if (!currentTarget || !document.contains(currentTarget as HTMLElement)) return;
+    const currentTarget = ev.currentTarget as HTMLElement;
+    if (!currentTarget || !currentTarget.ownerDocument.contains(currentTarget)) return;
     const data = (currentTarget as any)[eventKey];
     if (!data) return;
     config.mainEventHandler(data, ev, currentTarget);
@@ -38,11 +39,15 @@ function createElementHandler(evName: string, capture: boolean = false): EventHa
     this.addEventListener(evName, listener, { capture });
   }
 
+  function remove(this: HTMLElement) {
+    delete (this as any)[eventKey];
+    this.removeEventListener(evName, listener, { capture });
+  }
   function update(this: HTMLElement, data: any) {
     (this as any)[eventKey] = data;
   }
 
-  return { setup, update };
+  return { setup, update, remove };
 }
 
 // Synthetic handler: a form of event delegation that allows placing only one
@@ -60,7 +65,12 @@ function createSyntheticHandler(evName: string, capture: boolean = false): Event
     _data[currentId] = data;
     (this as any)[eventKey] = _data;
   }
-  return { setup, update: setup };
+
+  function remove(this: HTMLElement) {
+    delete (this as any)[eventKey];
+  }
+
+  return { setup, update: setup, remove };
 }
 
 function nativeToSyntheticEvent(eventKey: string, event: Event) {

src/runtime/blockdom/html.ts

@@ -29,14 +29,18 @@ class VHtml {
     }
   }
 
-  moveBefore(other: VHtml | null, afterNode: Node | null) {
-    const target = other ? other.content[0] : afterNode;
-    const parent = this.parentEl;
+  moveBeforeDOMNode(node: Node | null, parent = this.parentEl) {
+    this.parentEl = parent;
     for (let elem of this.content) {
-      nodeInsertBefore.call(parent, elem, target);
+      nodeInsertBefore.call(parent, elem, node);
     }
   }
 
+  moveBeforeVNode(other: VHtml | null, afterNode: Node | null) {
+    const target = other ? other.content[0] : afterNode;
+    this.moveBeforeDOMNode(target);
+  }
+
   patch(other: VHtml) {
     if (this === other) {
       return;
@@ -61,6 +65,7 @@ class VHtml {
       // remove current content
       this.remove();
       this.content = content;
+      this.html = other.html;
     }
   }
 

src/runtime/blockdom/index.ts

@@ -6,10 +6,12 @@ export { list } from "./list";
 export { multi } from "./multi";
 export { text, comment } from "./text";
 export { html } from "./html";
+export { createCatcher } from "./event_catcher";
 
 export interface VNode<T = any> {
   mount(parent: HTMLElement, afterNode: Node | null): void;
-  moveBefore(other: T | null, afterNode: Node | null): void;
+  moveBeforeDOMNode(node: Node | null, parent?: HTMLElement): void;
+  moveBeforeVNode(other: T | null, afterNode: Node | null): void;
   patch(other: T, withBeforeRemove: boolean): void;
   beforeRemove(): void;
   remove(): void;

src/runtime/blockdom/list.ts

@@ -38,14 +38,23 @@ class VList {
     this.parentEl = parent;
   }
 
-  moveBefore(other: VList | null, afterNode: Node | null) {
+  moveBeforeDOMNode(node: Node | null, parent = this.parentEl) {
+    this.parentEl = parent;
+    const children = this.children;
+    for (let i = 0, l = children.length; i < l; i++) {
+      children[i].moveBeforeDOMNode(node, parent);
+    }
+    parent!.insertBefore(this.anchor!, node);
+  }
+
+  moveBeforeVNode(other: VList | null, afterNode: Node | null) {
     if (other) {
       const next = other!.children[0];
       afterNode = (next ? next.firstNode() : other!.anchor) || null;
     }
     const children = this.children;
     for (let i = 0, l = children.length; i < l; i++) {
-      children[i].moveBefore(null, afterNode);
+      children[i].moveBeforeVNode(null, afterNode);
     }
     this.parentEl!.insertBefore(this.anchor!, afterNode);
   }
@@ -66,7 +75,7 @@ class VList {
       patch: cPatch,
       remove: cRemove,
       beforeRemove,
-      moveBefore: cMoveBefore,
+      moveBeforeVNode: cMoveBefore,
       firstNode: cFirstNode,
     } = proto;
 
@@ -98,7 +107,6 @@ class VList {
     let endVn2 = ch2[endIdx2];
 
     let mapping: any = undefined;
-    // let noFullRemove = this.hasNoComponent;
 
     while (startIdx1 <= endIdx1 && startIdx2 <= endIdx2) {
       // -------------------------------------------------------------------

src/runtime/blockdom/multi.ts

@@ -38,7 +38,22 @@ export class VMulti {
     this.parentEl = parent;
   }
 
-  moveBefore(other: VMulti | null, afterNode: Node | null) {
+  moveBeforeDOMNode(node: Node | null, parent = this.parentEl) {
+    this.parentEl = parent;
+    const children = this.children;
+    const anchors = this.anchors;
+    for (let i = 0, l = children.length; i < l; i++) {
+      let child = children[i];
+      if (child) {
+        child.moveBeforeDOMNode(node, parent);
+      } else {
+        const anchor = anchors![i];
+        nodeInsertBefore.call(parent, anchor, node);
+      }
+    }
+  }
+
+  moveBeforeVNode(other: VMulti | null, afterNode: Node | null) {
     if (other) {
       const next = other!.children[0];
       afterNode = (next ? next.firstNode() : other!.anchors![0]) || null;
@@ -49,7 +64,7 @@ export class VMulti {
     for (let i = 0, l = children.length; i < l; i++) {
       let child = children[i];
       if (child) {
-        child.moveBefore(null, afterNode);
+        child.moveBeforeVNode(null, afterNode);
       } else {
         const anchor = anchors![i];
         nodeInsertBefore.call(parent, anchor, afterNode);
@@ -125,7 +140,7 @@ export class VMulti {
   }
 
   toString(): string {
-    return this.children.map((c) => c!.toString()).join("");
+    return this.children.map((c) => (c ? c!.toString() : "")).join("");
   }
 }
 

src/runtime/blockdom/text.ts

@@ -9,11 +9,11 @@ const characterDataSetData = getDescriptor(characterDataProto, "data").set!;
 const nodeRemoveChild = nodeProto.removeChild;
 
 abstract class VSimpleNode {
-  text: string;
+  text: string | String;
   parentEl?: HTMLElement | undefined;
   el?: any;
 
-  constructor(text: string) {
+  constructor(text: string | String) {
     this.text = text;
   }
 
@@ -23,9 +23,13 @@ abstract class VSimpleNode {
     this.el = node;
   }
 
-  moveBefore(other: VText | null, afterNode: Node | null) {
-    const target = other ? other.el! : afterNode;
-    nodeInsertBefore.call(this.parentEl, this.el!, target);
+  moveBeforeDOMNode(node: Node | null, parent = this.parentEl) {
+    this.parentEl = parent;
+    nodeInsertBefore.call(parent, this.el!, node);
+  }
+
+  moveBeforeVNode(other: VText | null, afterNode: Node | null) {
+    nodeInsertBefore.call(this.parentEl, this.el!, other ? other.el! : afterNode);
   }
 
   beforeRemove() {}
@@ -65,7 +69,7 @@ class VComment extends VSimpleNode {
   patch() {}
 }
 
-export function text(str: string): VNode<VText> {
+export function text(str: string | String): VNode<VText> {
   return new VText(str);
 }
 

src/runtime/blockdom/toggler.ts

@@ -20,8 +20,12 @@ class VToggler {
     this.child.mount(parent, afterNode);
   }
 
-  moveBefore(other: VToggler | null, afterNode: Node | null) {
-    this.child.moveBefore(other ? other.child : null, afterNode);
+  moveBeforeDOMNode(node: Node | null, parent?: HTMLElement) {
+    this.child.moveBeforeDOMNode(node, parent);
+  }
+
+  moveBeforeVNode(other: VToggler | null, afterNode: Node | null) {
+    this.moveBeforeDOMNode((other && other.firstNode()) || afterNode);
   }
 
   patch(other: VToggler, withBeforeRemove: boolean) {

src/runtime/component.ts

@@ -0,0 +1,44 @@
+import { Schema } from "./validation";
+import type { ComponentNode } from "./component_node";
+
+// -----------------------------------------------------------------------------
+//  Component Class
+// -----------------------------------------------------------------------------
+
+export type Props = { [key: string]: any };
+
+interface StaticComponentProperties {
+  template: string;
+  defaultProps?: any;
+  props?: Schema;
+  components?: { [componentName: string]: ComponentConstructor };
+}
+
+export type ComponentConstructor<P extends Props = any, E = any> = (new (
+  props: P,
+  env: E,
+  node: ComponentNode
+) => Component<P, E>) &
+  StaticComponentProperties;
+
+export class Component<Props = any, Env = any> {
+  static template: string = "";
+  static props?: any;
+  static defaultProps?: any;
+
+  props: Props;
+  env: Env;
+  __owl__: ComponentNode;
+
+  constructor(props: Props, env: Env, node: ComponentNode) {
+    this.props = props;
+    this.env = env;
+    this.__owl__ = node;
+  }
+
+  setup() {}
+
+  render(deep: boolean = false) {
+    this.__owl__.render(deep === true);
+  }
+}

src/runtime/component_node.ts

@@ -0,0 +1,352 @@
+import type { App, Env } from "./app";
+import { BDom, VNode } from "./blockdom";
+import { Component, ComponentConstructor, Props } from "./component";
+import { fibersInError, OwlError } from "./error_handling";
+import { Fiber, makeChildFiber, makeRootFiber, MountFiber, MountOptions } from "./fibers";
+import { clearReactivesForCallback, getSubscriptions, reactive, targets } from "./reactivity";
+import { STATUS } from "./status";
+import { batched, Callback } from "./utils";
+
+let currentNode: ComponentNode | null = null;
+
+export function getCurrent(): ComponentNode {
+  if (!currentNode) {
+    throw new OwlError("No active component (a hook function should only be called in 'setup')");
+  }
+  return currentNode;
+}
+
+export function useComponent(): Component {
+  return currentNode!.component;
+}
+
+/**
+ * Apply default props (only top level).
+ */
+function applyDefaultProps<P extends object>(props: P, defaultProps: Partial<P>) {
+  for (let propName in defaultProps) {
+    if (props[propName] === undefined) {
+      (props as any)[propName] = defaultProps[propName];
+    }
+  }
+}
+// -----------------------------------------------------------------------------
+// Integration with reactivity system (useState)
+// -----------------------------------------------------------------------------
+
+const batchedRenderFunctions = new WeakMap<ComponentNode, Callback>();
+/**
+ * Creates a reactive object that will be observed by the current component.
+ * Reading data from the returned object (eg during rendering) will cause the
+ * component to subscribe to that data and be rerendered when it changes.
+ *
+ * @param state the state to observe
+ * @returns a reactive object that will cause the component to re-render on
+ *  relevant changes
+ * @see reactive
+ */
+export function useState<T extends object>(state: T): T {
+  const node = getCurrent();
+  let render = batchedRenderFunctions.get(node)!;
+  if (!render) {
+    render = batched(node.render.bind(node, false));
+    batchedRenderFunctions.set(node, render);
+    // manual implementation of onWillDestroy to break cyclic dependency
+    node.willDestroy.push(clearReactivesForCallback.bind(null, render));
+  }
+  return reactive(state, render);
+}
+
+// -----------------------------------------------------------------------------
+//  Component VNode class
+// -----------------------------------------------------------------------------
+
+type LifecycleHook = Function;
+
+export class ComponentNode<P extends Props = any, E = any> implements VNode<ComponentNode<P, E>> {
+  el?: HTMLElement | Text | undefined;
+  app: App;
+  fiber: Fiber | null = null;
+  component: Component<P, E>;
+  bdom: BDom | null = null;
+  status: STATUS = STATUS.NEW;
+  forceNextRender: boolean = false;
+  parentKey: string | null;
+  props: P;
+
+  renderFn: Function;
+  parent: ComponentNode | null;
+  childEnv: Env;
+  children: { [key: string]: ComponentNode } = Object.create(null);
+  refs: any = {};
+
+  willStart: LifecycleHook[] = [];
+  willUpdateProps: LifecycleHook[] = [];
+  willUnmount: LifecycleHook[] = [];
+  mounted: LifecycleHook[] = [];
+  willPatch: LifecycleHook[] = [];
+  patched: LifecycleHook[] = [];
+  willDestroy: LifecycleHook[] = [];
+
+  constructor(
+    C: ComponentConstructor<P, E>,
+    props: P,
+    app: App,
+    parent: ComponentNode | null,
+    parentKey: string | null
+  ) {
+    currentNode = this;
+    this.app = app;
+    this.parent = parent;
+    this.props = props;
+    this.parentKey = parentKey;
+    const defaultProps = C.defaultProps;
+    props = Object.assign({}, props);
+    if (defaultProps) {
+      applyDefaultProps(props, defaultProps);
+    }
+    const env = (parent && parent.childEnv) || app.env;
+    this.childEnv = env;
+    for (const key in props) {
+      const prop = props[key];
+      if (prop && typeof prop === "object" && targets.has(prop)) {
+        props[key] = useState(prop);
+      }
+    }
+    this.component = new C(props, env, this);
+    const ctx = Object.assign(Object.create(this.component), { this: this.component });
+    this.renderFn = app.getTemplate(C.template).bind(this.component, ctx, this);
+    this.component.setup();
+    currentNode = null;
+  }
+
+  mountComponent(target: any, options?: MountOptions) {
+    const fiber = new MountFiber(this, target, options);
+    this.app.scheduler.addFiber(fiber);
+    this.initiateRender(fiber);
+  }
+
+  async initiateRender(fiber: Fiber | MountFiber) {
+    this.fiber = fiber;
+    if (this.mounted.length) {
+      fiber.root!.mounted.push(fiber);
+    }
+    const component = this.component;
+    try {
+      await Promise.all(this.willStart.map((f) => f.call(component)));
+    } catch (e) {
+      this.app.handleError({ node: this, error: e });
+      return;
+    }
+    if (this.status === STATUS.NEW && this.fiber === fiber) {
+      fiber.render();
+    }
+  }
+
+  async render(deep: boolean) {
+    let current = this.fiber;
+    if (current && (current.root!.locked || (current as any).bdom === true)) {
+      await Promise.resolve();
+      // situation may have changed after the microtask tick
+      current = this.fiber;
+    }
+    if (current) {
+      if (!current.bdom && !fibersInError.has(current)) {
+        if (deep) {
+          // we want the render from this point on to be with deep=true
+          current.deep = deep;
+        }
+        return;
+      }
+      // if current rendering was with deep=true, we want this one to be the same
+      deep = deep || current.deep;
+    } else if (!this.bdom) {
+      return;
+    }
+
+    const fiber = makeRootFiber(this);
+    fiber.deep = deep;
+    this.fiber = fiber;
+
+    this.app.scheduler.addFiber(fiber);
+    await Promise.resolve();
+    if (this.status === STATUS.DESTROYED) {
+      return;
+    }
+    // We only want to actually render the component if the following two
+    // conditions are true:
+    // * this.fiber: it could be null, in which case the render has been cancelled
+    // * (current || !fiber.parent): if current is not null, this means that the
+    //   render function was called when a render was already occurring. In this
+    //   case, the pending rendering was cancelled, and the fiber needs to be
+    //   rendered to complete the work.  If current is null, we check that the
+    //   fiber has no parent.  If that is the case, the fiber was downgraded from
+    //   a root fiber to a child fiber in the previous microtick, because it was
+    //   embedded in a rendering coming from above, so the fiber will be rendered
+    //   in the next microtick anyway, so we should not render it again.
+    if (this.fiber === fiber && (current || !fiber.parent)) {
+      fiber.render();
+    }
+  }
+
+  destroy() {
+    let shouldRemove = this.status === STATUS.MOUNTED;
+    this._destroy();
+    if (shouldRemove) {
+      this.bdom!.remove();
+    }
+  }
+
+  _destroy() {
+    const component = this.component;
+    if (this.status === STATUS.MOUNTED) {
+      for (let cb of this.willUnmount) {
+        cb.call(component);
+      }
+    }
+    for (let child of Object.values(this.children)) {
+      child._destroy();
+    }
+    if (this.willDestroy.length) {
+      try {
+        for (let cb of this.willDestroy) {
+          cb.call(component);
+        }
+      } catch (e) {
+        this.app.handleError({ error: e, node: this });
+      }
+    }
+    this.status = STATUS.DESTROYED;
+  }
+
+  async updateAndRender(props: P, parentFiber: Fiber) {
+    const rawProps = props;
+    props = Object.assign({}, props);
+    // update
+    const fiber = makeChildFiber(this, parentFiber);
+    this.fiber = fiber;
+    const component = this.component;
+    const defaultProps = (component.constructor as any).defaultProps;
+    if (defaultProps) {
+      applyDefaultProps(props, defaultProps);
+    }
+
+    currentNode = this;
+    for (const key in props) {
+      const prop = props[key];
+      if (prop && typeof prop === "object" && targets.has(prop)) {
+        props[key] = useState(prop);
+      }
+    }
+    currentNode = null;
+    const prom = Promise.all(this.willUpdateProps.map((f) => f.call(component, props)));
+    await prom;
+    if (fiber !== this.fiber) {
+      return;
+    }
+    component.props = props;
+    this.props = rawProps;
+    fiber.render();
+    const parentRoot = parentFiber.root!;
+    if (this.willPatch.length) {
+      parentRoot.willPatch.push(fiber);
+    }
+    if (this.patched.length) {
+      parentRoot.patched.push(fiber);
+    }
+  }
+
+  /**
+   * Finds a child that has dom that is not yet updated, and update it. This
+   * method is meant to be used only in the context of repatching the dom after
+   * a mounted hook failed and was handled.
+   */
+  updateDom() {
+    if (!this.fiber) {
+      return;
+    }
+    if (this.bdom === this.fiber!.bdom) {
+      // If the error was handled by some child component, we need to find it to
+      // apply its change
+      for (let k in this.children) {
+        const child = this.children[k];
+        child.updateDom();
+      }
+    } else {
+      // if we get here, this is the component that handled the error and rerendered
+      // itself, so we can simply patch the dom
+      this.bdom!.patch(this.fiber!.bdom, false);
+      this.fiber!.appliedToDom = true;
+      this.fiber = null;
+    }
+  }
+
+  // ---------------------------------------------------------------------------
+  // Block DOM methods
+  // ---------------------------------------------------------------------------
+
+  firstNode(): Node | undefined {
+    const bdom = this.bdom;
+    return bdom ? bdom.firstNode() : undefined;
+  }
+
+  mount(parent: HTMLElement, anchor: ChildNode) {
+    const bdom = this.fiber!.bdom!;
+    this.bdom = bdom;
+    bdom.mount(parent, anchor);
+    this.status = STATUS.MOUNTED;
+    this.fiber!.appliedToDom = true;
+    this.children = this.fiber!.childrenMap;
+    this.fiber = null;
+  }
+
+  moveBeforeDOMNode(node: Node | null, parent?: HTMLElement): void {
+    this.bdom!.moveBeforeDOMNode(node, parent);
+  }
+
+  moveBeforeVNode(other: ComponentNode<P, E> | null, afterNode: Node | null) {
+    this.bdom!.moveBeforeVNode(other ? other.bdom : null, afterNode);
+  }
+
+  patch() {
+    if (this.fiber && this.fiber.parent) {
+      // we only patch here renderings coming from above. renderings initiated
+      // by the component will be patched independently in the appropriate
+      // fiber.complete
+      this._patch();
+    }
+  }
+  _patch() {
+    let hasChildren = false;
+    // eslint-disable-next-line @typescript-eslint/no-unused-vars
+    for (let _k in this.children) {
+      hasChildren = true;
+      break;
+    }
+    const fiber = this.fiber!;
+    this.children = fiber.childrenMap;
+    this.bdom!.patch(fiber.bdom!, hasChildren);
+    fiber.appliedToDom = true;
+    this.fiber = null;
+  }
+
+  beforeRemove() {
+    this._destroy();
+  }
+
+  remove() {
+    this.bdom!.remove();
+  }
+
+  // ---------------------------------------------------------------------------
+  // Some debug helpers
+  // ---------------------------------------------------------------------------
+  get name(): string {
+    return this.component.constructor.name;
+  }
+
+  get subscriptions(): ReturnType<typeof getSubscriptions> {
+    const render = batchedRenderFunctions.get(this);
+    return render ? getSubscriptions(render) : [];
+  }
+}

src/runtime/error_handling.ts

@@ -1,11 +1,16 @@
 import type { ComponentNode } from "./component_node";
 import type { Fiber } from "./fibers";
 
+// Custom error class that wraps error that happen in the owl lifecycle
+export class OwlError extends Error {
+  cause?: any;
+}
+
 // Maps fibers to thrown errors
 export const fibersInError: WeakMap<Fiber, any> = new WeakMap();
 export const nodeErrorHandlers: WeakMap<ComponentNode, ((error: any) => void)[]> = new WeakMap();
 
-function _handleError(node: ComponentNode | null, error: any, isFirstRound = false): boolean {
+function _handleError(node: ComponentNode | null, error: any): boolean {
   if (!node) {
     return false;
   }
@@ -16,22 +21,19 @@ function _handleError(node: ComponentNode | null, error: any, isFirstRound = fal
 
   const errorHandlers = nodeErrorHandlers.get(node);
   if (errorHandlers) {
-    let stopped = false;
+    let handled = false;
     // execute in the opposite order
     for (let i = errorHandlers.length - 1; i >= 0; i--) {
       try {
         errorHandlers[i](error);
-        stopped = true;
+        handled = true;
         break;
       } catch (e) {
         error = e;
       }
     }
 
-    if (stopped) {
-      if (isFirstRound && fiber) {
-        fiber.root.counter--;
-      }
+    if (handled) {
       return true;
     }
   }
@@ -40,7 +42,14 @@ function _handleError(node: ComponentNode | null, error: any, isFirstRound = fal
 
 type ErrorParams = { error: any } & ({ node: ComponentNode } | { fiber: Fiber });
 export function handleError(params: ErrorParams) {
-  const error = params.error;
+  let { error } = params;
+  // Wrap error if it wasn't wrapped by wrapError (ie when not in dev mode)
+  if (!(error instanceof OwlError)) {
+    error = Object.assign(
+      new OwlError(`An error occured in the owl lifecycle (see this Error's "cause" property)`),
+      { cause: error }
+    );
+  }
   const node = "node" in params ? params.node : params.fiber.node;
   const fiber = "fiber" in params ? params.fiber : node.fiber!;
 
@@ -52,9 +61,9 @@ export function handleError(params: ErrorParams) {
     current = current.parent;
   } while (current);
 
-  fibersInError.set(fiber.root, error);
+  fibersInError.set(fiber.root!, error);
 
-  const handled = _handleError(node, error, true);
+  const handled = _handleError(node, error);
   if (!handled) {
     console.warn(`[Owl] Unhandled error. Destroying the root component`);
     try {
@@ -62,5 +71,6 @@ export function handleError(params: ErrorParams) {
     } catch (e) {
       console.error(e);
     }
+    throw error;
   }
 }

src/runtime/event_handling.ts

@@ -1,4 +1,6 @@
-import { filterOutModifiersFromData } from "../blockdom/config";
+import { filterOutModifiersFromData } from "./blockdom/config";
+import { STATUS } from "./status";
+import { OwlError } from "./error_handling";
 
 export const mainEventHandler = (data: any, ev: Event, currentTarget?: EventTarget | null) => {
   const { data: _data, modifiers } = filterOutModifiersFromData(data);
@@ -30,7 +32,14 @@ export const mainEventHandler = (data: any, ev: Event, currentTarget?: EventTarg
   // We check this rather than data[0] being truthy (or typeof function) so that it crashes
   // as expected when there is a handler expression that evaluates to a falsy value
   if (Object.hasOwnProperty.call(data, 0)) {
-    data[0].call(data[1] ? data[1].__owl__.component : null, ev);
+    const handler = data[0];
+    if (typeof handler !== "function") {
+      throw new OwlError(`Invalid handler (expected a function, received: '${handler}')`);
+    }
+    let node = data[1] ? data[1].__owl__ : null;
+    if (node ? node.status === STATUS.MOUNTED : true) {
+      handler.call(node ? node.component : null, ev);
+    }
   }
   return stopped;
 };

src/runtime/fibers.ts

@@ -1,48 +1,13 @@
-import { BDom, mount } from "../blockdom";
+import { BDom, mount } from "./blockdom";
 import type { ComponentNode } from "./component_node";
-import { fibersInError, handleError } from "./error_handling";
+import { fibersInError, OwlError } from "./error_handling";
 import { STATUS } from "./status";
 
-/**
- * Cleans on the root fiber the patch and willPatch fiber lists
- * It is typically needed when the same root fiber needs to recycle on
- * of its children or grandchildren's fiber.
- */
-function cleanPatchableFiber(child: Fiber, root: RootFiber) {
-  const { willPatch, patched } = root;
-  let i = willPatch.indexOf(child);
-  if (i > -1) {
-    willPatch.splice(i, 1);
-  }
-  i = patched.indexOf(child);
-  if (i > -1) {
-    patched.splice(i, 1);
-  }
-}
-
 export function makeChildFiber(node: ComponentNode, parent: Fiber): Fiber {
   let current = node.fiber;
   if (current) {
-    // current is necessarily a rootfiber here
-    let root = parent.root;
-    const isSameRoot = current.root === root;
-    cancelFibers(root, current.children);
-    current.children = [];
-    current.parent = parent;
-    // only increment our rendering if we were not
-    // already accounted for, or that we have been rendered
-    // already (in which case our fiber was removed from the root rendering)
-    if (!isSameRoot || current.bdom) {
-      root.counter++;
-    }
-
-    if (isSameRoot) {
-      cleanPatchableFiber(current, root);
-    }
-
-    current.bdom = null;
-    current.root = root;
-    return current;
+    cancelFibers(current.children);
+    current.root = null;
   }
   return new Fiber(node, parent);
 }
@@ -50,10 +15,15 @@ export function makeChildFiber(node: ComponentNode, parent: Fiber): Fiber {
 export function makeRootFiber(node: ComponentNode): Fiber {
   let current = node.fiber;
   if (current) {
-    let root = current.root;
-    root.counter -= cancelFibers(root, current.children);
+    let root = current.root!;
+    // lock root fiber because canceling children fibers may destroy components,
+    // which means any arbitrary code can be run in onWillDestroy, which may
+    // trigger new renderings
+    root.locked = true;
+    root.setCounter(root.counter + 1 - cancelFibers(current.children));
+    root.locked = false;
     current.children = [];
-    root.counter++;
+    current.childrenMap = {};
     current.bdom = null;
     if (fibersInError.has(current)) {
       fibersInError.delete(current);
@@ -69,22 +39,38 @@ export function makeRootFiber(node: ComponentNode): Fiber {
   if (node.patched.length) {
     fiber.patched.push(fiber);
   }
-
   return fiber;
 }
 
+function throwOnRender() {
+  throw new OwlError("Attempted to render cancelled fiber");
+}
+
 /**
  * @returns number of not-yet rendered fibers cancelled
  */
-function cancelFibers(root: any, fibers: Fiber[]): number {
+function cancelFibers(fibers: Fiber[]): number {
   let result = 0;
   for (let fiber of fibers) {
-    fiber.node.fiber = null;
-    fiber.root = root;
-    if (!fiber.bdom) {
+    let node = fiber.node;
+    fiber.render = throwOnRender;
+    if (node.status === STATUS.NEW) {
+      node.destroy();
+      delete node.parent!.children[node.parentKey!];
+    }
+    node.fiber = null;
+    if (fiber.bdom) {
+      // if fiber has been rendered, this means that the component props have
+      // been updated. however, this fiber will not be patched to the dom, so
+      // it could happen that the next render compare the current props with
+      // the same props, and skip the render completely. With the next line,
+      // we kindly request the component code to force a render, so it works as
+      // expected.
+      node.forceNextRender = true;
+    } else {
       result++;
     }
-    result += cancelFibers(root, fiber.children);
+    result += cancelFibers(fiber.children);
   }
   return result;
 }
@@ -92,23 +78,63 @@ function cancelFibers(root: any, fibers: Fiber[]): number {
 export class Fiber {
   node: ComponentNode;
   bdom: BDom | null = null;
-  root: RootFiber;
+  root: RootFiber | null; // A Fiber that has been replaced by another has no root
   parent: Fiber | null;
   children: Fiber[] = [];
   appliedToDom = false;
+  deep: boolean = false;
+  childrenMap: ComponentNode["children"] = {};
 
   constructor(node: ComponentNode, parent: Fiber | null) {
     this.node = node;
     this.parent = parent;
     if (parent) {
-      const root = parent.root;
-      root.counter++;
+      this.deep = parent.deep;
+      const root = parent.root!;
+      root.setCounter(root.counter + 1);
       this.root = root;
       parent.children.push(this);
     } else {
       this.root = this as any;
     }
   }
+
+  render() {
+    // if some parent has a fiber => register in followup
+    let prev = this.root!.node;
+    let scheduler = prev.app.scheduler;
+    let current = prev.parent;
+    while (current) {
+      if (current.fiber) {
+        let root = current.fiber.root!;
+        if (root.counter === 0 && prev.parentKey! in current.fiber.childrenMap) {
+          current = root.node;
+        } else {
+          scheduler.delayedRenders.push(this);
+          return;
+        }
+      }
+      prev = current;
+      current = current.parent;
+    }
+
+    // there are no current rendering from above => we can render
+    this._render();
+  }
+
+  _render() {
+    const node = this.node;
+    const root = this.root;
+    if (root) {
+      try {
+        (this.bdom as any) = true;
+        this.bdom = node.renderFn();
+      } catch (e) {
+        node.app.handleError({ node, error: e });
+      }
+      root.setCounter(root.counter - 1);
+    }
+  }
 }
 
 export class RootFiber extends Fiber {
@@ -143,13 +169,8 @@ export class RootFiber extends Fiber {
       current = undefined;
 
       // Step 2: patching the dom
-      node.bdom!.patch(this.bdom!, Object.keys(node.children).length > 0);
-      this.appliedToDom = true;
-
+      node._patch();
       this.locked = false;
-      // unregistering the fiber before mounted since it can do another render
-      // and that the current rendering is obviously completed
-      node.fiber = null;
 
       // Step 4: calling all mounted lifecycle hooks
       let mountedFibers = this.mounted;
@@ -174,7 +195,14 @@ export class RootFiber extends Fiber {
       }
     } catch (e) {
       this.locked = false;
-      handleError({ fiber: current || this, error: e });
+      node.app.handleError({ fiber: current || this, error: e });
+    }
+  }
+
+  setCounter(newValue: number) {
+    this.counter = newValue;
+    if (newValue === 0) {
+      this.node.app.scheduler.flush();
     }
   }
 }
@@ -198,6 +226,8 @@ export class MountFiber extends RootFiber {
     let current: Fiber | undefined = this;
     try {
       const node = this.node;
+      node.children = this.childrenMap;
+      (node.app.constructor as any).validateTarget(this.target);
       if (node.bdom) {
         // this is a complicated situation: if we mount a fiber with an existing
         // bdom, this means that this same fiber was already completed, mounted,
@@ -229,7 +259,7 @@ export class MountFiber extends RootFiber {
         }
       }
     } catch (e) {
-      handleError({ fiber: current as Fiber, error: e });
+      this.node.app.handleError({ fiber: current as Fiber, error: e });
     }
   }
 }

src/runtime/hooks.ts

@@ -1,6 +1,6 @@
-import type { Env } from "./app/app";
-import { getCurrent } from "./component/component_node";
-import { onMounted, onPatched, onWillUnmount } from "./component/lifecycle_hooks";
+import type { Env } from "./app";
+import { getCurrent } from "./component_node";
+import { onMounted, onPatched, onWillUnmount } from "./lifecycle_hooks";
 
 // -----------------------------------------------------------------------------
 // useRef
@@ -11,7 +11,7 @@ import { onMounted, onPatched, onWillUnmount } from "./component/lifecycle_hooks
  * html node or component.
  */
 export function useRef<T extends HTMLElement = HTMLElement>(name: string): { el: T | null } {
-  const node = getCurrent()!;
+  const node = getCurrent();
   const refs = node.refs;
   return {
     get el(): T | null {
@@ -29,7 +29,13 @@ export function useRef<T extends HTMLElement = HTMLElement>(name: string): { el:
  * need a reference to the env of the component calling them.
  */
 export function useEnv<E extends Env>(): E {
-  return getCurrent()!.component.env as any;
+  return getCurrent().component.env as any;
+}
+
+function extendEnv(currentEnv: Object, extension: Object): Object {
+  const env = Object.create(currentEnv);
+  const descrs = Object.getOwnPropertyDescriptors(extension);
+  return Object.freeze(Object.defineProperties(env, descrs));
 }
 
 /**
@@ -38,17 +44,19 @@ export function useEnv<E extends Env>(): E {
  * constructor method.
  */
 export function useSubEnv(envExtension: Env) {
-  const node = getCurrent()!;
-  const env = Object.create(node.childEnv);
-  const descrs = Object.getOwnPropertyDescriptors(envExtension);
-  node.childEnv = Object.freeze(Object.defineProperties(env, descrs));
+  const node = getCurrent();
+  node.component.env = extendEnv(node.component.env as any, envExtension);
+  useChildSubEnv(envExtension);
 }
 
+export function useChildSubEnv(envExtension: Env) {
+  const node = getCurrent();
+  node.childEnv = extendEnv(node.childEnv, envExtension);
+}
 // -----------------------------------------------------------------------------
 // useEffect
 // -----------------------------------------------------------------------------
 
-const NO_OP = () => {};
 /**
  * @param {...any} dependencies the dependencies computed by computeDependencies
  * @returns {void|(()=>void)} a cleanup function that reverses the side
@@ -69,11 +77,11 @@ type Effect = (...dependencies: any[]) => void | (() => void);
  *      NaN !== NaN, which will cause the effect to rerun on every patch.
  */
 export function useEffect(effect: Effect, computeDependencies: () => any[] = () => [NaN]) {
-  let cleanup: () => void;
+  let cleanup: (() => void) | void;
   let dependencies: any[];
   onMounted(() => {
     dependencies = computeDependencies();
-    cleanup = effect(...dependencies) || NO_OP;
+    cleanup = effect(...dependencies);
   });
 
   onPatched(() => {
@@ -81,12 +89,14 @@ export function useEffect(effect: Effect, computeDependencies: () => any[] = ()
     const shouldReapply = newDeps.some((val, i) => val !== dependencies[i]);
     if (shouldReapply) {
       dependencies = newDeps;
-      cleanup();
-      cleanup = effect(...dependencies) || NO_OP;
+      if (cleanup) {
+        cleanup();
+      }
+      cleanup = effect(...dependencies);
     }
   });
 
-  onWillUnmount(() => cleanup());
+  onWillUnmount(() => cleanup && cleanup());
 }
 
 // -----------------------------------------------------------------------------
@@ -107,12 +117,12 @@ export function useEffect(effect: Effect, computeDependencies: () => any[] = ()
  *  `useExternalListener(window, 'click', this._doSomething);`
  * */
 export function useExternalListener(
-  target: HTMLElement | typeof window,
+  target: EventTarget,
   eventName: string,
   handler: EventListener,
   eventParams?: AddEventListenerOptions
 ) {
-  const node = getCurrent()!;
+  const node = getCurrent();
   const boundHandler = handler.bind(node.component);
   onMounted(() => target.addEventListener(eventName, boundHandler, eventParams));
   onWillUnmount(() => target.removeEventListener(eventName, boundHandler, eventParams));

src/runtime/index.ts

@@ -0,0 +1,59 @@
+import {
+  config,
+  createBlock,
+  html,
+  list,
+  mount as blockMount,
+  multi,
+  patch,
+  remove,
+  text,
+  toggler,
+  comment,
+} from "./blockdom";
+import { mainEventHandler } from "./event_handling";
+
+config.shouldNormalizeDom = false;
+config.mainEventHandler = mainEventHandler;
+
+export const blockDom = {
+  config,
+  // bdom entry points
+  mount: blockMount,
+  patch,
+  remove,
+  // bdom block types
+  list,
+  multi,
+  text,
+  toggler,
+  createBlock,
+  html,
+  comment,
+};
+
+export { App, mount } from "./app";
+export { xml } from "./template_set";
+export { Component } from "./component";
+export type { ComponentConstructor } from "./component";
+export { useComponent, useState } from "./component_node";
+export { status } from "./status";
+export { reactive, markRaw, toRaw } from "./reactivity";
+export { useEffect, useEnv, useExternalListener, useRef, useChildSubEnv, useSubEnv } from "./hooks";
+export { EventBus, whenReady, loadFile, markup } from "./utils";
+export {
+  onWillStart,
+  onMounted,
+  onWillUnmount,
+  onWillUpdateProps,
+  onWillPatch,
+  onPatched,
+  onWillRender,
+  onRendered,
+  onWillDestroy,
+  onError,
+} from "./lifecycle_hooks";
+export { validate } from "./validation";
+export { OwlError } from "./error_handling";
+
+export const __info__ = {};

src/runtime/lifecycle_hooks.ts

@@ -0,0 +1,122 @@
+import { getCurrent } from "./component_node";
+import { nodeErrorHandlers, OwlError } from "./error_handling";
+
+const TIMEOUT = Symbol("timeout");
+function wrapError(fn: (...args: any[]) => any, hookName: string) {
+  const error = new OwlError(`The following error occurred in ${hookName}: `) as Error & {
+    cause: any;
+  };
+  const timeoutError = new OwlError(`${hookName}'s promise hasn't resolved after 3 seconds`);
+  const node = getCurrent();
+  return (...args: any[]) => {
+    const onError = (cause: any) => {
+      error.cause = cause;
+      if (cause instanceof Error) {
+        error.message += `"${cause.message}"`;
+      } else {
+        error.message = `Something that is not an Error was thrown in ${hookName} (see this Error's "cause" property)`;
+      }
+      throw error;
+    };
+    try {
+      const result = fn(...args);
+      if (result instanceof Promise) {
+        if (hookName === "onWillStart" || hookName === "onWillUpdateProps") {
+          const fiber = node.fiber;
+          Promise.race([
+            result.catch(() => {}),
+            new Promise((resolve) => setTimeout(() => resolve(TIMEOUT), 3000)),
+          ]).then((res) => {
+            if (res === TIMEOUT && node.fiber === fiber) {
+              console.warn(timeoutError);
+            }
+          });
+        }
+        return result.catch(onError);
+      }
+      return result;
+    } catch (cause) {
+      onError(cause);
+    }
+  };
+}
+
+// -----------------------------------------------------------------------------
+//  hooks
+// -----------------------------------------------------------------------------
+
+export function onWillStart(fn: () => Promise<void> | void | any) {
+  const node = getCurrent();
+  const decorate = node.app.dev ? wrapError : (fn: any) => fn;
+  node.willStart.push(decorate(fn.bind(node.component), "onWillStart"));
+}
+
+export function onWillUpdateProps(fn: (nextProps: any) => Promise<void> | void | any) {
+  const node = getCurrent();
+  const decorate = node.app.dev ? wrapError : (fn: any) => fn;
+  node.willUpdateProps.push(decorate(fn.bind(node.component), "onWillUpdateProps"));
+}
+
+export function onMounted(fn: () => void | any) {
+  const node = getCurrent();
+  const decorate = node.app.dev ? wrapError : (fn: any) => fn;
+  node.mounted.push(decorate(fn.bind(node.component), "onMounted"));
+}
+
+export function onWillPatch(fn: () => Promise<void> | any | void) {
+  const node = getCurrent();
+  const decorate = node.app.dev ? wrapError : (fn: any) => fn;
+  node.willPatch.unshift(decorate(fn.bind(node.component), "onWillPatch"));
+}
+
+export function onPatched(fn: () => void | any) {
+  const node = getCurrent();
+  const decorate = node.app.dev ? wrapError : (fn: any) => fn;
+  node.patched.push(decorate(fn.bind(node.component), "onPatched"));
+}
+
+export function onWillUnmount(fn: () => Promise<void> | void | any) {
+  const node = getCurrent();
+  const decorate = node.app.dev ? wrapError : (fn: any) => fn;
+  node.willUnmount.unshift(decorate(fn.bind(node.component), "onWillUnmount"));
+}
+
+export function onWillDestroy(fn: () => Promise<void> | void | any) {
+  const node = getCurrent();
+  const decorate = node.app.dev ? wrapError : (fn: any) => fn;
+  node.willDestroy.push(decorate(fn.bind(node.component), "onWillDestroy"));
+}
+
+export function onWillRender(fn: () => void | any) {
+  const node = getCurrent();
+  const renderFn = node.renderFn;
+  const decorate = node.app.dev ? wrapError : (fn: any) => fn;
+  fn = decorate(fn.bind(node.component), "onWillRender");
+  node.renderFn = () => {
+    fn();
+    return renderFn();
+  };
+}
+
+export function onRendered(fn: () => void | any) {
+  const node = getCurrent();
+  const renderFn = node.renderFn;
+  const decorate = node.app.dev ? wrapError : (fn: any) => fn;
+  fn = decorate(fn.bind(node.component), "onRendered");
+  node.renderFn = () => {
+    const result = renderFn();
+    fn();
+    return result;
+  };
+}
+
+type OnErrorCallback = (error: any) => void | any;
+export function onError(callback: OnErrorCallback) {
+  const node = getCurrent();
+  let handlers = nodeErrorHandlers.get(node);
+  if (!handlers) {
+    handlers = [];
+    nodeErrorHandlers.set(node, handlers);
+  }
+  handlers.push(callback.bind(node.component));
+}

src/runtime/portal.ts

@@ -0,0 +1,90 @@
+import { onMounted, onWillUnmount } from "./lifecycle_hooks";
+import { BDom, text, VNode } from "./blockdom";
+import { Component } from "./component";
+import { OwlError } from "./error_handling";
+
+const VText: any = text("").constructor;
+
+class VPortal extends VText implements Partial<VNode<VPortal>> {
+  content: BDom | null;
+  selector: string;
+  target: HTMLElement | null = null;
+
+  constructor(selector: string, content: BDom) {
+    super("");
+    this.selector = selector;
+    this.content = content;
+  }
+
+  mount(parent: HTMLElement, anchor: ChildNode) {
+    super.mount(parent, anchor);
+    this.target = document.querySelector(this.selector) as any;
+    if (this.target) {
+      this.content!.mount(this.target!, null);
+    } else {
+      this.content!.mount(parent, anchor);
+    }
+  }
+
+  beforeRemove() {
+    this.content!.beforeRemove();
+  }
+  remove() {
+    if (this.content) {
+      super.remove();
+      this.content!.remove();
+      this.content = null;
+    }
+  }
+
+  patch(other: VPortal) {
+    super.patch(other);
+    if (this.content) {
+      this.content.patch(other.content!, true);
+    } else {
+      this.content = other.content;
+      this.content!.mount(this.target!, null);
+    }
+  }
+}
+
+/**
+ * kind of similar to <t t-slot="default"/>, but it wraps it around a VPortal
+ */
+export function portalTemplate(app: any, bdom: any, helpers: any) {
+  let { callSlot } = helpers;
+  return function template(ctx: any, node: any, key = ""): any {
+    return new VPortal(ctx.props.target, callSlot(ctx, node, key, "default", false, null));
+  };
+}
+
+export class Portal extends Component {
+  static template = "__portal__";
+  static props = {
+    target: {
+      type: String,
+    },
+    slots: true,
+  };
+
+  setup() {
+    const node: any = this.__owl__;
+
+    onMounted(() => {
+      const portal: VPortal = node.bdom;
+      if (!portal.target) {
+        const target: HTMLElement = document.querySelector(this.props.target);
+        if (target) {
+          portal.content!.moveBeforeDOMNode(target.firstChild, target);
+        } else {
+          throw new OwlError("invalid portal target");
+        }
+      }
+    });
+
+    onWillUnmount(() => {
+      const portal: VPortal = node.bdom;
+      portal.remove();
+    });
+  }
+}

src/runtime/reactivity.ts

@@ -0,0 +1,464 @@
+import type { Callback } from "./utils";
+import { OwlError } from "./error_handling";
+
+// Special key to subscribe to, to be notified of key creation/deletion
+const KEYCHANGES = Symbol("Key changes");
+// Used to specify the absence of a callback, can be used as WeakMap key but
+// should only be used as a sentinel value and never called.
+const NO_CALLBACK = () => {
+  throw new Error("Called NO_CALLBACK. Owl is broken, please report this to the maintainers.");
+};
+
+// The following types only exist to signify places where objects are expected
+// to be reactive or not, they provide no type checking benefit over "object"
+type Target = object;
+type Reactive<T extends Target> = T;
+
+type Collection = Set<any> | Map<any, any> | WeakMap<any, any>;
+type CollectionRawType = "Set" | "Map" | "WeakMap";
+
+const objectToString = Object.prototype.toString;
+const objectHasOwnProperty = Object.prototype.hasOwnProperty;
+
+const SUPPORTED_RAW_TYPES = new Set(["Object", "Array", "Set", "Map", "WeakMap"]);
+const COLLECTION_RAWTYPES = new Set(["Set", "Map", "WeakMap"]);
+
+/**
+ * extract "RawType" from strings like "[object RawType]" => this lets us ignore
+ * many native objects such as Promise (whose toString is [object Promise])
+ * or Date ([object Date]), while also supporting collections without using
+ * instanceof in a loop
+ *
+ * @param obj the object to check
+ * @returns the raw type of the object
+ */
+function rawType(obj: any) {
+  return objectToString.call(toRaw(obj)).slice(8, -1);
+}
+/**
+ * Checks whether a given value can be made into a reactive object.
+ *
+ * @param value the value to check
+ * @returns whether the value can be made reactive
+ */
+function canBeMadeReactive(value: any): boolean {
+  if (typeof value !== "object") {
+    return false;
+  }
+  return SUPPORTED_RAW_TYPES.has(rawType(value));
+}
+/**
+ * Creates a reactive from the given object/callback if possible and returns it,
+ * returns the original object otherwise.
+ *
+ * @param value the value make reactive
+ * @returns a reactive for the given object when possible, the original otherwise
+ */
+function possiblyReactive(val: any, cb: Callback) {
+  return canBeMadeReactive(val) ? reactive(val, cb) : val;
+}
+
+const skipped = new WeakSet<Target>();
+/**
+ * Mark an object or array so that it is ignored by the reactivity system
+ *
+ * @param value the value to mark
+ * @returns the object itself
+ */
+export function markRaw<T extends Target>(value: T): T {
+  skipped.add(value);
+  return value;
+}
+
+/**
+ * Given a reactive objet, return the raw (non reactive) underlying object
+ *
+ * @param value a reactive value
+ * @returns the underlying value
+ */
+export function toRaw<T extends Target, U extends Reactive<T>>(value: U | T): T {
+  return targets.has(value) ? (targets.get(value) as T) : value;
+}
+
+const targetToKeysToCallbacks = new WeakMap<Target, Map<PropertyKey, Set<Callback>>>();
+/**
+ * Observes a given key on a target with an callback. The callback will be
+ * called when the given key changes on the target.
+ *
+ * @param target the target whose key should be observed
+ * @param key the key to observe (or Symbol(KEYCHANGES) for key creation
+ *  or deletion)
+ * @param callback the function to call when the key changes
+ */
+function observeTargetKey(target: Target, key: PropertyKey, callback: Callback): void {
+  if (callback === NO_CALLBACK) {
+    return;
+  }
+  if (!targetToKeysToCallbacks.get(target)) {
+    targetToKeysToCallbacks.set(target, new Map());
+  }
+  const keyToCallbacks = targetToKeysToCallbacks.get(target)!;
+  if (!keyToCallbacks.get(key)) {
+    keyToCallbacks.set(key, new Set());
+  }
+  keyToCallbacks.get(key)!.add(callback);
+  if (!callbacksToTargets.has(callback)) {
+    callbacksToTargets.set(callback, new Set());
+  }
+  callbacksToTargets.get(callback)!.add(target);
+}
+/**
+ * Notify Reactives that are observing a given target that a key has changed on
+ * the target.
+ *
+ * @param target target whose Reactives should be notified that the target was
+ *  changed.
+ * @param key the key that changed (or Symbol `KEYCHANGES` if a key was created
+ *   or deleted)
+ */
+function notifyReactives(target: Target, key: PropertyKey): void {
+  const keyToCallbacks = targetToKeysToCallbacks.get(target);
+  if (!keyToCallbacks) {
+    return;
+  }
+  const callbacks = keyToCallbacks.get(key);
+  if (!callbacks) {
+    return;
+  }
+  // Loop on copy because clearReactivesForCallback will modify the set in place
+  for (const callback of [...callbacks]) {
+    clearReactivesForCallback(callback);
+    callback();
+  }
+}
+
+const callbacksToTargets = new WeakMap<Callback, Set<Target>>();
+/**
+ * Clears all subscriptions of the Reactives associated with a given callback.
+ *
+ * @param callback the callback for which the reactives need to be cleared
+ */
+export function clearReactivesForCallback(callback: Callback): void {
+  const targetsToClear = callbacksToTargets.get(callback);
+  if (!targetsToClear) {
+    return;
+  }
+  for (const target of targetsToClear) {
+    const observedKeys = targetToKeysToCallbacks.get(target);
+    if (!observedKeys) {
+      continue;
+    }
+    for (const [key, callbacks] of observedKeys.entries()) {
+      callbacks.delete(callback);
+      if (!callbacks.size) {
+        observedKeys.delete(key);
+      }
+    }
+  }
+  targetsToClear.clear();
+}
+
+export function getSubscriptions(callback: Callback) {
+  const targets = callbacksToTargets.get(callback) || [];
+  return [...targets].map((target) => {
+    const keysToCallbacks = targetToKeysToCallbacks.get(target);
+    let keys = [];
+    if (keysToCallbacks) {
+      for (const [key, cbs] of keysToCallbacks) {
+        if (cbs.has(callback)) {
+          keys.push(key);
+        }
+      }
+    }
+    return { target, keys };
+  });
+}
+// Maps reactive objects to the underlying target
+export const targets = new WeakMap<Reactive<Target>, Target>();
+const reactiveCache = new WeakMap<Target, WeakMap<Callback, Reactive<Target>>>();
+/**
+ * Creates a reactive proxy for an object. Reading data on the reactive object
+ * subscribes to changes to the data. Writing data on the object will cause the
+ * notify callback to be called if there are suscriptions to that data. Nested
+ * objects and arrays are automatically made reactive as well.
+ *
+ * Whenever you are notified of a change, all subscriptions are cleared, and if
+ * you would like to be notified of any further changes, you should go read
+ * the underlying data again. We assume that if you don't go read it again after
+ * being notified, it means that you are no longer interested in that data.
+ *
+ * Subscriptions:
+ * + Reading a property on an object will subscribe you to changes in the value
+ *    of that property.
+ * + Accessing an object's keys (eg with Object.keys or with `for..in`) will
+ *    subscribe you to the creation/deletion of keys. Checking the presence of a
+ *    key on the object with 'in' has the same effect.
+ * - getOwnPropertyDescriptor does not currently subscribe you to the property.
+ *    This is a choice that was made because changing a key's value will trigger
+ *    this trap and we do not want to subscribe by writes. This also means that
+ *    Object.hasOwnProperty doesn't subscribe as it goes through this trap.
+ *
+ * @param target the object for which to create a reactive proxy
+ * @param callback the function to call when an observed property of the
+ *  reactive has changed
+ * @returns a proxy that tracks changes to it
+ */
+export function reactive<T extends Target>(target: T, callback: Callback = NO_CALLBACK): T {
+  if (!canBeMadeReactive(target)) {
+    throw new OwlError(`Cannot make the given value reactive`);
+  }
+  if (skipped.has(target)) {
+    return target;
+  }
+  if (targets.has(target)) {
+    // target is reactive, create a reactive on the underlying object instead
+    return reactive(targets.get(target) as T, callback);
+  }
+  if (!reactiveCache.has(target)) {
+    reactiveCache.set(target, new WeakMap());
+  }
+  const reactivesForTarget = reactiveCache.get(target)!;
+  if (!reactivesForTarget.has(callback)) {
+    const targetRawType = rawType(target);
+    const handler = COLLECTION_RAWTYPES.has(targetRawType)
+      ? collectionsProxyHandler(target as Collection, callback, targetRawType as CollectionRawType)
+      : basicProxyHandler<T>(callback);
+    const proxy = new Proxy(target, handler as ProxyHandler<T>) as Reactive<T>;
+    reactivesForTarget.set(callback, proxy);
+    targets.set(proxy, target);
+  }
+  return reactivesForTarget.get(callback) as Reactive<T>;
+}
+/**
+ * Creates a basic proxy handler for regular objects and arrays.
+ *
+ * @param callback @see reactive
+ * @returns a proxy handler object
+ */
+function basicProxyHandler<T extends Target>(callback: Callback): ProxyHandler<T> {
+  return {
+    get(target, key, receiver) {
+      // non-writable non-configurable properties cannot be made reactive
+      const desc = Object.getOwnPropertyDescriptor(target, key);
+      if (desc && !desc.writable && !desc.configurable) {
+        return Reflect.get(target, key, receiver);
+      }
+      observeTargetKey(target, key, callback);
+      return possiblyReactive(Reflect.get(target, key, receiver), callback);
+    },
+    set(target, key, value, receiver) {
+      const hadKey = objectHasOwnProperty.call(target, key);
+      const originalValue = Reflect.get(target, key, receiver);
+      const ret = Reflect.set(target, key, value, receiver);
+      if (!hadKey && objectHasOwnProperty.call(target, key)) {
+        notifyReactives(target, KEYCHANGES);
+      }
+      // While Array length may trigger the set trap, it's not actually set by this
+      // method but is updated behind the scenes, and the trap is not called with the
+      // new value. We disable the "same-value-optimization" for it because of that.
+      if (
+        originalValue !== Reflect.get(target, key, receiver) ||
+        (key === "length" && Array.isArray(target))
+      ) {
+        notifyReactives(target, key);
+      }
+      return ret;
+    },
+    deleteProperty(target, key) {
+      const ret = Reflect.deleteProperty(target, key);
+      // TODO: only notify when something was actually deleted
+      notifyReactives(target, KEYCHANGES);
+      notifyReactives(target, key);
+      return ret;
+    },
+    ownKeys(target) {
+      observeTargetKey(target, KEYCHANGES, callback);
+      return Reflect.ownKeys(target);
+    },
+    has(target, key) {
+      // TODO: this observes all key changes instead of only the presence of the argument key
+      // observing the key itself would observe value changes instead of presence changes
+      // so we may need a finer grained system to distinguish observing value vs presence.
+      observeTargetKey(target, KEYCHANGES, callback);
+      return Reflect.has(target, key);
+    },
+  } as ProxyHandler<T>;
+}
+/**
+ * Creates a function that will observe the key that is passed to it when called
+ * and delegates to the underlying method.
+ *
+ * @param methodName name of the method to delegate to
+ * @param target @see reactive
+ * @param callback @see reactive
+ */
+function makeKeyObserver(methodName: "has" | "get", target: any, callback: Callback) {
+  return (key: any) => {
+    key = toRaw(key);
+    observeTargetKey(target, key, callback);
+    return possiblyReactive(target[methodName](key), callback);
+  };
+}
+/**
+ * Creates an iterable that will delegate to the underlying iteration method and
+ * observe keys as necessary.
+ *
+ * @param methodName name of the method to delegate to
+ * @param target @see reactive
+ * @param callback @see reactive
+ */
+function makeIteratorObserver(
+  methodName: "keys" | "values" | "entries" | typeof Symbol.iterator,
+  target: any,
+  callback: Callback
+) {
+  return function* () {
+    observeTargetKey(target, KEYCHANGES, callback);
+    const keys = target.keys();
+    for (const item of target[methodName]()) {
+      const key = keys.next().value;
+      observeTargetKey(target, key, callback);
+      yield possiblyReactive(item, callback);
+    }
+  };
+}
+/**
+ * Creates a forEach function that will delegate to forEach on the underlying
+ * collection while observing key changes, and keys as they're iterated over,
+ * and making the passed keys/values reactive.
+ *
+ * @param target @see reactive
+ * @param callback @see reactive
+ */
+function makeForEachObserver(target: any, callback: Callback) {
+  return function forEach(forEachCb: (val: any, key: any, target: any) => void, thisArg: any) {
+    observeTargetKey(target, KEYCHANGES, callback);
+    target.forEach(function (val: any, key: any, targetObj: any) {
+      observeTargetKey(target, key, callback);
+      forEachCb.call(
+        thisArg,
+        possiblyReactive(val, callback),
+        possiblyReactive(key, callback),
+        possiblyReactive(targetObj, callback)
+      );
+    }, thisArg);
+  };
+}
+/**
+ * Creates a function that will delegate to an underlying method, and check if
+ * that method has modified the presence or value of a key, and notify the
+ * reactives appropriately.
+ *
+ * @param setterName name of the method to delegate to
+ * @param getterName name of the method which should be used to retrieve the
+ *  value before calling the delegate method for comparison purposes
+ * @param target @see reactive
+ */
+function delegateAndNotify(
+  setterName: "set" | "add" | "delete",
+  getterName: "has" | "get",
+  target: any
+) {
+  return (key: any, value: any) => {
+    key = toRaw(key);
+    const hadKey = target.has(key);
+    const originalValue = target[getterName](key);
+    const ret = target[setterName](key, value);
+    const hasKey = target.has(key);
+    if (hadKey !== hasKey) {
+      notifyReactives(target, KEYCHANGES);
+    }
+    if (originalValue !== value) {
+      notifyReactives(target, key);
+    }
+    return ret;
+  };
+}
+/**
+ * Creates a function that will clear the underlying collection and notify that
+ * the keys of the collection have changed.
+ *
+ * @param target @see reactive
+ */
+function makeClearNotifier(target: Map<any, any> | Set<any>) {
+  return () => {
+    const allKeys = [...target.keys()];
+    target.clear();
+    notifyReactives(target, KEYCHANGES);
+    for (const key of allKeys) {
+      notifyReactives(target, key);
+    }
+  };
+}
+/**
+ * Maps raw type of an object to an object containing functions that can be used
+ * to build an appropritate proxy handler for that raw type. Eg: when making a
+ * reactive set, calling the has method should mark the key that is being
+ * retrieved as observed, and calling the add or delete method should notify the
+ * reactives that the key which is being added or deleted has been modified.
+ */
+const rawTypeToFuncHandlers = {
+  Set: (target: any, callback: Callback) => ({
+    has: makeKeyObserver("has", target, callback),
+    add: delegateAndNotify("add", "has", target),
+    delete: delegateAndNotify("delete", "has", target),
+    keys: makeIteratorObserver("keys", target, callback),
+    values: makeIteratorObserver("values", target, callback),
+    entries: makeIteratorObserver("entries", target, callback),
+    [Symbol.iterator]: makeIteratorObserver(Symbol.iterator, target, callback),
+    forEach: makeForEachObserver(target, callback),
+    clear: makeClearNotifier(target),
+    get size() {
+      observeTargetKey(target, KEYCHANGES, callback);
+      return target.size;
+    },
+  }),
+  Map: (target: any, callback: Callback) => ({
+    has: makeKeyObserver("has", target, callback),
+    get: makeKeyObserver("get", target, callback),
+    set: delegateAndNotify("set", "get", target),
+    delete: delegateAndNotify("delete", "has", target),
+    keys: makeIteratorObserver("keys", target, callback),
+    values: makeIteratorObserver("values", target, callback),
+    entries: makeIteratorObserver("entries", target, callback),
+    [Symbol.iterator]: makeIteratorObserver(Symbol.iterator, target, callback),
+    forEach: makeForEachObserver(target, callback),
+    clear: makeClearNotifier(target),
+    get size() {
+      observeTargetKey(target, KEYCHANGES, callback);
+      return target.size;
+    },
+  }),
+  WeakMap: (target: any, callback: Callback) => ({
+    has: makeKeyObserver("has", target, callback),
+    get: makeKeyObserver("get", target, callback),
+    set: delegateAndNotify("set", "get", target),
+    delete: delegateAndNotify("delete", "has", target),
+  }),
+};
+/**
+ * Creates a proxy handler for collections (Set/Map/WeakMap)
+ *
+ * @param callback @see reactive
+ * @param target @see reactive
+ * @returns a proxy handler object
+ */
+function collectionsProxyHandler<T extends Collection>(
+  target: T,
+  callback: Callback,
+  targetRawType: CollectionRawType
+): ProxyHandler<T> {
+  // TODO: if performance is an issue we can create the special handlers lazily when each
+  // property is read.
+  const specialHandlers = rawTypeToFuncHandlers[targetRawType](target, callback);
+  return Object.assign(basicProxyHandler(callback), {
+    // FIXME: probably broken when part of prototype chain since we ignore the receiver
+    get(target: any, key: PropertyKey) {
+      if (objectHasOwnProperty.call(specialHandlers, key)) {
+        return (specialHandlers as any)[key];
+      }
+      observeTargetKey(target, key, callback);
+      return possiblyReactive(target[key], callback);
+    },
+  }) as ProxyHandler<T>;
+}

src/runtime/scheduler.ts

@@ -0,0 +1,76 @@
+import { fibersInError } from "./error_handling";
+import { Fiber, RootFiber } from "./fibers";
+import { STATUS } from "./status";
+
+// -----------------------------------------------------------------------------
+//  Scheduler
+// -----------------------------------------------------------------------------
+
+export class Scheduler {
+  // capture the value of requestAnimationFrame as soon as possible, to avoid
+  // interactions with other code, such as test frameworks that override them
+  static requestAnimationFrame = window.requestAnimationFrame.bind(window);
+  tasks: Set<RootFiber> = new Set();
+  requestAnimationFrame: Window["requestAnimationFrame"];
+  frame: number = 0;
+  delayedRenders: Fiber[] = [];
+
+  constructor() {
+    this.requestAnimationFrame = Scheduler.requestAnimationFrame;
+  }
+
+  addFiber(fiber: Fiber) {
+    this.tasks.add(fiber.root!);
+  }
+
+  /**
+   * Process all current tasks. This only applies to the fibers that are ready.
+   * Other tasks are left unchanged.
+   */
+  flush() {
+    if (this.delayedRenders.length) {
+      let renders = this.delayedRenders;
+      this.delayedRenders = [];
+      for (let f of renders) {
+        if (f.root && f.node.status !== STATUS.DESTROYED && f.node.fiber === f) {
+          f.render();
+        }
+      }
+    }
+
+    if (this.frame === 0) {
+      this.frame = this.requestAnimationFrame(() => {
+        this.frame = 0;
+        this.tasks.forEach((fiber) => this.processFiber(fiber));
+        for (let task of this.tasks) {
+          if (task.node.status === STATUS.DESTROYED) {
+            this.tasks.delete(task);
+          }
+        }
+      });
+    }
+  }
+
+  processFiber(fiber: RootFiber) {
+    if (fiber.root !== fiber) {
+      this.tasks.delete(fiber);
+      return;
+    }
+    const hasError = fibersInError.has(fiber);
+    if (hasError && fiber.counter !== 0) {
+      this.tasks.delete(fiber);
+      return;
+    }
+    if (fiber.node.status === STATUS.DESTROYED) {
+      this.tasks.delete(fiber);
+      return;
+    }
+
+    if (fiber.counter === 0) {
+      if (!hasError) {
+        fiber.complete();
+      }
+      this.tasks.delete(fiber);
+    }
+  }
+}

src/runtime/template_helpers.ts

@@ -0,0 +1,283 @@
+import { BDom, multi, text, toggler, createCatcher } from "./blockdom";
+import { Markup } from "./utils";
+import { html } from "./blockdom/index";
+import { isOptional, validateSchema } from "./validation";
+import type { ComponentConstructor } from "./component";
+import { markRaw } from "./reactivity";
+import { OwlError } from "./error_handling";
+
+const ObjectCreate = Object.create;
+/**
+ * This file contains utility functions that will be injected in each template,
+ * to perform various useful tasks in the compiled code.
+ */
+
+function withDefault(value: any, defaultValue: any): any {
+  return value === undefined || value === null || value === false ? defaultValue : value;
+}
+
+function callSlot(
+  ctx: any,
+  parent: any,
+  key: string,
+  name: string,
+  dynamic: boolean,
+  extra: any,
+  defaultContent?: (ctx: any, node: any, key: string) => BDom
+): BDom {
+  key = key + "__slot_" + name;
+  const slots = ctx.props.slots || {};
+  const { __render, __ctx, __scope } = slots[name] || {};
+  const slotScope = ObjectCreate(__ctx || {});
+  if (__scope) {
+    slotScope[__scope] = extra;
+  }
+  const slotBDom = __render ? __render(slotScope, parent, key) : null;
+  if (defaultContent) {
+    let child1: BDom | undefined = undefined;
+    let child2: BDom | undefined = undefined;
+    if (slotBDom) {
+      child1 = dynamic ? toggler(name, slotBDom) : slotBDom;
+    } else {
+      child2 = defaultContent(ctx, parent, key);
+    }
+    return multi([child1, child2]);
+  }
+  return slotBDom || text("");
+}
+
+function capture(ctx: any): any {
+  const result = ObjectCreate(ctx);
+  for (let k in ctx) {
+    result[k] = ctx[k];
+  }
+  return result;
+}
+
+function withKey(elem: any, k: string) {
+  elem.key = k;
+  return elem;
+}
+
+function prepareList(collection: any): [any[], any[], number, any[]] {
+  let keys: any[];
+  let values: any[];
+
+  if (Array.isArray(collection)) {
+    keys = collection;
+    values = collection;
+  } else if (collection) {
+    values = Object.keys(collection);
+    keys = Object.values(collection);
+  } else {
+    throw new OwlError("Invalid loop expression");
+  }
+  const n = values.length;
+  return [keys, values, n, new Array(n)];
+}
+
+const isBoundary = Symbol("isBoundary");
+
+function setContextValue(ctx: { [key: string]: any }, key: string, value: any): void {
+  const ctx0 = ctx;
+  while (!ctx.hasOwnProperty(key) && !ctx.hasOwnProperty(isBoundary)) {
+    const newCtx = ctx.__proto__;
+    if (!newCtx) {
+      ctx = ctx0;
+      break;
+    }
+    ctx = newCtx;
+  }
+  ctx[key] = value;
+}
+
+function toNumber(val: string): number | string {
+  const n = parseFloat(val);
+  return isNaN(n) ? val : n;
+}
+
+function shallowEqual(l1: any[], l2: any[]): boolean {
+  for (let i = 0, l = l1.length; i < l; i++) {
+    if (l1[i] !== l2[i]) {
+      return false;
+    }
+  }
+  return true;
+}
+
+class LazyValue {
+  fn: any;
+  ctx: any;
+  component: any;
+  node: any;
+  key: any;
+
+  constructor(fn: any, ctx: any, component: any, node: any, key: any) {
+    this.fn = fn;
+    this.ctx = capture(ctx);
+    this.component = component;
+    this.node = node;
+    this.key = key;
+  }
+
+  evaluate(): any {
+    return this.fn.call(this.component, this.ctx, this.node, this.key);
+  }
+
+  toString() {
+    return this.evaluate().toString();
+  }
+}
+
+/*
+ * Safely outputs `value` as a block depending on the nature of `value`
+ */
+export function safeOutput(value: any, defaultValue?: any): ReturnType<typeof toggler> {
+  if (value === undefined) {
+    return defaultValue ? toggler("default", defaultValue) : toggler("undefined", text(""));
+  }
+  let safeKey;
+  let block;
+  switch (typeof value) {
+    case "object":
+      if (value instanceof Markup) {
+        safeKey = `string_safe`;
+        block = html(value as string);
+      } else if (value instanceof LazyValue) {
+        safeKey = `lazy_value`;
+        block = value.evaluate();
+      } else if (value instanceof String) {
+        safeKey = "string_unsafe";
+        block = text(value);
+      } else {
+        // Assuming it is a block
+        safeKey = "block_safe";
+        block = value;
+      }
+      break;
+    case "string":
+      safeKey = "string_unsafe";
+      block = text(value);
+      break;
+    default:
+      safeKey = "string_unsafe";
+      block = text(String(value));
+  }
+  return toggler(safeKey, block);
+}
+
+let boundFunctions = new WeakMap();
+const WeakMapGet = WeakMap.prototype.get;
+const WeakMapSet = WeakMap.prototype.set;
+
+function bind(component: any, fn: Function): Function {
+  let boundFnMap = WeakMapGet.call(boundFunctions, component);
+  if (!boundFnMap) {
+    boundFnMap = new WeakMap();
+    WeakMapSet.call(boundFunctions, component, boundFnMap);
+  }
+  let boundFn = WeakMapGet.call(boundFnMap, fn);
+  if (!boundFn) {
+    boundFn = fn.bind(component);
+    WeakMapSet.call(boundFnMap, fn, boundFn);
+  }
+  return boundFn;
+}
+
+type RefMap = { [key: string]: HTMLElement | null };
+type RefSetter = (el: HTMLElement | null) => void;
+
+function multiRefSetter(refs: RefMap, name: string): RefSetter {
+  let count = 0;
+  return (el) => {
+    if (el) {
+      count++;
+      if (count > 1) {
+        throw new OwlError("Cannot have 2 elements with same ref name at the same time");
+      }
+    }
+    if (count === 0 || el) {
+      refs[name] = el;
+    }
+  };
+}
+
+function singleRefSetter(refs: RefMap, name: string): RefSetter {
+  let _el: HTMLElement | null = null;
+  return (el) => {
+    if (el || refs[name] === _el) {
+      refs[name] = el;
+      _el = el;
+    }
+  };
+}
+
+/**
+ * Validate the component props (or next props) against the (static) props
+ * description.  This is potentially an expensive operation: it may needs to
+ * visit recursively the props and all the children to check if they are valid.
+ * This is why it is only done in 'dev' mode.
+ */
+export function validateProps<P>(name: string | ComponentConstructor<P>, props: P, comp?: any) {
+  const ComponentClass =
+    typeof name !== "string"
+      ? name
+      : (comp.constructor.components[name] as ComponentConstructor<P> | undefined);
+
+  if (!ComponentClass) {
+    // this is an error, wrong component. We silently return here instead so the
+    // error is triggered by the usual path ('component' function)
+    return;
+  }
+
+  const schema = ComponentClass.props;
+  if (!schema) {
+    if (comp.__owl__.app.warnIfNoStaticProps) {
+      console.warn(`Component '${ComponentClass.name}' does not have a static props description`);
+    }
+    return;
+  }
+  const defaultProps = ComponentClass.defaultProps;
+  if (defaultProps) {
+    let isMandatory = (name: string) =>
+      Array.isArray(schema)
+        ? schema.includes(name)
+        : name in schema && !("*" in schema) && !isOptional(schema[name]);
+    for (let p in defaultProps) {
+      if (isMandatory(p)) {
+        throw new OwlError(
+          `A default value cannot be defined for a mandatory prop (name: '${p}', component: ${ComponentClass.name})`
+        );
+      }
+    }
+  }
+
+  const errors = validateSchema(props, schema);
+  if (errors.length) {
+    throw new OwlError(
+      `Invalid props for component '${ComponentClass.name}': ` + errors.join(", ")
+    );
+  }
+}
+
+export const helpers = {
+  withDefault,
+  zero: Symbol("zero"),
+  isBoundary,
+  callSlot,
+  capture,
+  withKey,
+  prepareList,
+  setContextValue,
+  multiRefSetter,
+  singleRefSetter,
+  shallowEqual,
+  toNumber,
+  validateProps,
+  LazyValue,
+  safeOutput,
+  bind,
+  createCatcher,
+  markRaw,
+  OwlError,
+};

src/runtime/template_set.ts

@@ -1,11 +1,11 @@
-import { createBlock, html, list, multi, text, toggler, comment } from "../blockdom";
-import { compile, Template } from "../compiler";
-import { component } from "../component/component_node";
-import { UTILS } from "./template_helpers";
+import { compile, Template, TemplateFunction } from "../compiler";
+import { comment, createBlock, html, list, multi, text, toggler } from "./blockdom";
+import { getCurrent } from "./component_node";
+import { Portal, portalTemplate } from "./portal";
+import { helpers } from "./template_helpers";
+import { OwlError } from "./error_handling";
 
-const bdom = { text, createBlock, list, multi, html, toggler, component, comment };
-
-export const globalTemplates: { [key: string]: string | Node } = {};
+const bdom = { text, createBlock, list, multi, html, toggler, comment };
 
 function parseXML(xml: string): Document {
   const parser = new DOMParser();
@@ -32,7 +32,7 @@ function parseXML(xml: string): Document {
         }
       }
     }
-    throw new Error(msg);
+    throw new OwlError(msg);
   }
   return doc;
 }
@@ -45,18 +45,15 @@ export interface TemplateSetConfig {
 }
 
 export class TemplateSet {
+  static registerTemplate(name: string, fn: TemplateFunction) {
+    globalTemplates[name] = fn;
+  }
   dev: boolean;
   rawTemplates: typeof globalTemplates = Object.create(globalTemplates);
   templates: { [name: string]: Template } = {};
   translateFn?: (s: string) => string;
   translatableAttributes?: string[];
-  utils: typeof UTILS = Object.assign({}, UTILS, {
-    call: (owner: any, subTemplate: string, ctx: any, parent: any, key: any) => {
-      const template = this.getTemplate(subTemplate);
-      return toggler(subTemplate, template.call(owner, ctx, parent, key));
-    },
-    getTemplate: (name: string) => this.getTemplate(name),
-  });
+  Portal = Portal;
 
   constructor(config: TemplateSetConfig = {}) {
     this.dev = config.dev || false;
@@ -67,14 +64,25 @@ export class TemplateSet {
     }
   }
 
-  addTemplate(name: string, template: string | Node, options: { allowDuplicate?: boolean } = {}) {
-    if (name in this.rawTemplates && !options.allowDuplicate) {
-      throw new Error(`Template ${name} already defined`);
+  addTemplate(name: string, template: string | Element) {
+    if (name in this.rawTemplates) {
+      const rawTemplate = this.rawTemplates[name];
+      const currentAsString =
+        typeof rawTemplate === "string"
+          ? rawTemplate
+          : rawTemplate instanceof Element
+          ? rawTemplate.outerHTML
+          : rawTemplate.toString();
+      const newAsString = typeof template === "string" ? template : template.outerHTML;
+      if (currentAsString === newAsString) {
+        return;
+      }
+      throw new OwlError(`Template ${name} already defined with different content`);
     }
     this.rawTemplates[name] = template;
   }
 
-  addTemplates(xml: string | Document, options: { allowDuplicate?: boolean } = {}) {
+  addTemplates(xml: string | Document) {
     if (!xml) {
       // empty string
       return;
@@ -82,8 +90,7 @@ export class TemplateSet {
     xml = xml instanceof Document ? xml : parseXML(xml);
     for (const template of xml.querySelectorAll("[t-name]")) {
       const name = template.getAttribute("t-name")!;
-      template.removeAttribute("t-name");
-      this.addTemplate(name, template, options);
+      this.addTemplate(name, template);
     }
   }
 
@@ -91,31 +98,42 @@ export class TemplateSet {
     if (!(name in this.templates)) {
       const rawTemplate = this.rawTemplates[name];
       if (rawTemplate === undefined) {
-        throw new Error(`Missing template: "${name}"`);
+        let extraInfo = "";
+        try {
+          const componentName = getCurrent().component.constructor.name;
+          extraInfo = ` (for component "${componentName}")`;
+        } catch {}
+        throw new OwlError(`Missing template: "${name}"${extraInfo}`);
       }
-      const templateFn = this._compileTemplate(name, rawTemplate);
+      const isFn = typeof rawTemplate === "function" && !(rawTemplate instanceof Element);
+      const templateFn = isFn ? rawTemplate : this._compileTemplate(name, rawTemplate);
       // first add a function to lazily get the template, in case there is a
       // recursive call to the template name
-      this.templates[name] = (context, parent) => this.templates[name](context, parent);
-      const template = templateFn(bdom, this.utils);
+      const templates = this.templates;
+      this.templates[name] = function (context, parent) {
+        return templates[name].call(this, context, parent);
+      };
+      const template = templateFn(this, bdom, helpers);
       this.templates[name] = template;
     }
     return this.templates[name];
   }
 
-  _compileTemplate(name: string, template: string | Node) {
-    return compile(template, {
-      name,
-      dev: this.dev,
-      translateFn: this.translateFn,
-      translatableAttributes: this.translatableAttributes,
-    });
+  _compileTemplate(name: string, template: string | Element): ReturnType<typeof compile> {
+    throw new OwlError(`Unable to compile a template. Please use owl full build instead`);
+  }
+
+  callTemplate(owner: any, subTemplate: string, ctx: any, parent: any, key: any): any {
+    const template = this.getTemplate(subTemplate);
+    return toggler(subTemplate, template.call(owner, ctx, parent, key));
   }
 }
 
 // -----------------------------------------------------------------------------
 //  xml tag helper
 // -----------------------------------------------------------------------------
+export const globalTemplates: { [key: string]: string | Element | TemplateFunction } = {};
+
 export function xml(...args: Parameters<typeof String.raw>) {
   const name = `__template__${xml.nextId++}`;
   const value = String.raw(...args);
@@ -124,3 +142,5 @@ export function xml(...args: Parameters<typeof String.raw>) {
 }
 
 xml.nextId = 1;
+
+TemplateSet.registerTemplate("__portal__", portalTemplate);

src/runtime/utils.ts

@@ -0,0 +1,82 @@
+import { OwlError } from "./error_handling";
+export type Callback = () => void;
+
+/**
+ * Creates a batched version of a callback so that all calls to it in the same
+ * microtick will only call the original callback once.
+ *
+ * @param callback the callback to batch
+ * @returns a batched version of the original callback
+ */
+export function batched(callback: Callback): Callback {
+  let called = false;
+  return async () => {
+    // This await blocks all calls to the callback here, then releases them sequentially
+    // in the next microtick. This line decides the granularity of the batch.
+    await Promise.resolve();
+    if (!called) {
+      called = true;
+      // wait for all calls in this microtick to fall through before resetting "called"
+      // so that only the first call to the batched function calls the original callback.
+      // Schedule this before calling the callback so that calls to the batched function
+      // within the callback will proceed only after resetting called to false, and have
+      // a chance to execute the callback again
+      Promise.resolve().then(() => (called = false));
+      callback();
+    }
+  };
+}
+
+export function validateTarget(target: HTMLElement) {
+  // Get the document and HTMLElement corresponding to the target to allow mounting in iframes
+  const document = target && target.ownerDocument;
+  if (document) {
+    const HTMLElement = document.defaultView!.HTMLElement;
+    if (target instanceof HTMLElement) {
+      if (!document.body.contains(target)) {
+        throw new OwlError("Cannot mount a component on a detached dom node");
+      }
+      return;
+    }
+  }
+  throw new OwlError("Cannot mount component: the target is not a valid DOM element");
+}
+
+export class EventBus extends EventTarget {
+  trigger(name: string, payload?: any) {
+    this.dispatchEvent(new CustomEvent(name, { detail: payload }));
+  }
+}
+
+export function whenReady(fn?: any): Promise<void> {
+  return new Promise(function (resolve) {
+    if (document.readyState !== "loading") {
+      resolve(true);
+    } else {
+      document.addEventListener("DOMContentLoaded", resolve, false);
+    }
+  }).then(fn || function () {});
+}
+
+export async function loadFile(url: string): Promise<string> {
+  const result = await fetch(url);
+  if (!result.ok) {
+    throw new OwlError("Error while fetching xml templates");
+  }
+  return await result.text();
+}
+
+/*
+ * This class just transports the fact that a string is safe
+ * to be injected as HTML. Overriding a JS primitive is quite painful though
+ * so we need to redfine toString and valueOf.
+ */
+export class Markup extends String {}
+
+/*
+ * Marks a value as safe, that is, a value that can be injected as HTML directly.
+ * It should be used to wrap the value passed to a t-out directive to allow a raw rendering.
+ */
+export function markup(value: any) {
+  return new Markup(value);
+}

src/runtime/validation.ts

@@ -0,0 +1,171 @@
+import { OwlError } from "./error_handling";
+import { toRaw } from "./reactivity";
+
+type BaseType =
+  | typeof String
+  | typeof Boolean
+  | typeof Number
+  | typeof Date
+  | typeof Object
+  | typeof Array
+  | true
+  | "*";
+
+interface TypeInfo {
+  type?: TypeDescription;
+  optional?: boolean;
+  validate?: Function;
+  shape?: Schema;
+  element?: TypeDescription;
+}
+
+type ValueType = { value: any };
+
+type TypeDescription = BaseType | TypeInfo | ValueType | TypeDescription[];
+type SimplifiedSchema = string[];
+type NormalizedSchema = { [key: string]: TypeDescription };
+export type Schema = SimplifiedSchema | NormalizedSchema;
+
+// -----------------------------------------------------------------------------
+// helpers
+// -----------------------------------------------------------------------------
+const isUnionType = (t: TypeDescription): t is TypeDescription[] => Array.isArray(t);
+const isBaseType = (t: TypeDescription): t is BaseType => typeof t !== "object";
+const isValueType = (t: TypeDescription): t is ValueType =>
+  typeof t === "object" && t && "value" in t;
+
+export function isOptional(t: TypeDescription): Boolean {
+  return typeof t === "object" && "optional" in t ? t.optional || false : false;
+}
+
+function describeType(type: BaseType): string {
+  return type === "*" || type === true ? "value" : type.name.toLowerCase();
+}
+
+function describe(info: TypeDescription): string {
+  if (isBaseType(info)) {
+    return describeType(info);
+  } else if (isUnionType(info)) {
+    return info.map(describe).join(" or ");
+  } else if (isValueType(info)) {
+    return String(info.value);
+  }
+  if ("element" in info) {
+    return `list of ${describe({ type: info.element, optional: false })}s`;
+  }
+  if ("shape" in (info as TypeInfo)) {
+    return `object`;
+  }
+  return describe(info.type || "*");
+}
+
+function toSchema(spec: SimplifiedSchema): NormalizedSchema {
+  return Object.fromEntries(
+    spec.map((e) =>
+      e.endsWith("?") ? [e.slice(0, -1), { optional: true }] : [e, { type: "*", optional: false }]
+    )
+  );
+}
+
+/**
+ * Main validate function
+ */
+export function validate(obj: { [key: string]: any }, spec: Schema) {
+  let errors = validateSchema(obj, spec);
+  if (errors.length) {
+    throw new OwlError("Invalid object: " + errors.join(", "));
+  }
+}
+
+/**
+ * Helper validate function, to get the list of errors. useful if one want to
+ * manipulate the errors without parsing an error object
+ */
+export function validateSchema(obj: { [key: string]: any }, schema: Schema): string[] {
+  if (Array.isArray(schema)) {
+    schema = toSchema(schema);
+  }
+  obj = toRaw(obj);
+  let errors = [];
+  // check if each value in obj has correct shape
+  for (let key in obj) {
+    if (key in schema) {
+      let result = validateType(key, obj[key], schema[key]);
+      if (result) {
+        errors.push(result);
+      }
+    } else if (!("*" in schema)) {
+      errors.push(`unknown key '${key}'`);
+    }
+  }
+  // check that all specified keys are defined in obj
+  for (let key in schema) {
+    const spec = schema[key];
+    if (key !== "*" && !isOptional(spec) && !(key in obj)) {
+      const isObj = typeof spec === "object" && !Array.isArray(spec);
+      const isAny = spec === "*" || (isObj && "type" in spec ? spec.type === "*" : isObj);
+      let detail = isAny ? "" : ` (should be a ${describe(spec)})`;
+      errors.push(`'${key}' is missing${detail}`);
+    }
+  }
+  return errors;
+}
+
+function validateBaseType(key: string, value: any, type: BaseType): string | null {
+  if (typeof type === "function") {
+    if (typeof value === "object") {
+      if (!(value instanceof type)) {
+        return `'${key}' is not a ${describeType(type)}`;
+      }
+    } else if (typeof value !== type.name.toLowerCase()) {
+      return `'${key}' is not a ${describeType(type)}`;
+    }
+  }
+  return null;
+}
+
+function validateArrayType(key: string, value: any, descr: TypeDescription): string | null {
+  if (!Array.isArray(value)) {
+    return `'${key}' is not a list of ${describe(descr)}s`;
+  }
+  for (let i = 0; i < value.length; i++) {
+    const error = validateType(`${key}[${i}]`, value[i], descr);
+    if (error) {
+      return error;
+    }
+  }
+  return null;
+}
+
+function validateType(key: string, value: any, descr: TypeDescription): string | null {
+  if (value === undefined) {
+    return isOptional(descr) ? null : `'${key}' is undefined (should be a ${describe(descr)})`;
+  } else if (isBaseType(descr)) {
+    return validateBaseType(key, value, descr);
+  } else if (isValueType(descr)) {
+    return value === descr.value ? null : `'${key}' is not equal to '${descr.value}'`;
+  } else if (isUnionType(descr)) {
+    let validDescr = descr.find((p) => !validateType(key, value, p));
+    return validDescr ? null : `'${key}' is not a ${describe(descr)}`;
+  }
+  let result: string | null = null;
+  if ("element" in descr) {
+    result = validateArrayType(key, value, descr.element!);
+  } else if ("shape" in descr && !result) {
+    if (typeof value !== "object" || Array.isArray(value)) {
+      result = `'${key}' is not an object`;
+    } else {
+      const errors = validateSchema(value, descr.shape!);
+      if (errors.length) {
+        result = `'${key}' has not the correct shape (${errors.join(", ")})`;
+      }
+    }
+  }
+  if ("type" in descr && !result) {
+    result = validateType(key, value, descr.type!);
+  }
+  if ("validate" in descr && !result) {
+    result = !descr.validate!(value) ? `'${key}' is not valid` : null;
+  }
+  return result;
+}

src/utils.ts

@@ -1,38 +0,0 @@
-export class EventBus extends EventTarget {
-  trigger(name: string, payload?: any) {
-    this.dispatchEvent(new CustomEvent(name, { detail: payload }));
-  }
-}
-
-export function whenReady(fn?: any): Promise<void> {
-  return new Promise(function (resolve) {
-    if (document.readyState !== "loading") {
-      resolve(true);
-    } else {
-      document.addEventListener("DOMContentLoaded", resolve, false);
-    }
-  }).then(fn || function () {});
-}
-
-export async function loadFile(url: string): Promise<string> {
-  const result = await fetch(url);
-  if (!result.ok) {
-    throw new Error("Error while fetching xml templates");
-  }
-  return await result.text();
-}
-
-/*
- * This class just transports the fact that a string is safe
- * to be injected as HTML. Overriding a JS primitive is quite painful though
- * so we need to redfine toString and valueOf.
- */
-export class Markup extends String {}
-
-/*
- * Marks a value as safe, that is, a value that can be injected as HTML directly.
- * It should be used to wrap the value passed to a t-out directive to allow a raw rendering.
- */
-export function markup(value: any) {
-  return new Markup(value);
-}

tests/__snapshots__/reactivity.test.ts.snap

@@ -47,16 +47,17 @@ exports[`Reactivity: useState concurrent renderings 3`] = `
 `;
 
 exports[`Reactivity: useState destroyed component before being mounted is inactive 1`] = `
-"function anonymous(bdom, helpers
+"function anonymous(app, bdom, helpers
 ) {
-  let { text, createBlock, list, multi, html, toggler, component, comment } = bdom;
+  let { text, createBlock, list, multi, html, toggler, comment } = bdom;
+  const comp1 = app.createComponent(\`Child\`, true, false, false, true);
   
   let block1 = createBlock(\`<div><block-child-0/></div>\`);
   
   return function template(ctx, node, key = \\"\\") {
     let b2;
     if (ctx['state'].flag) {
-      b2 = component(\`Child\`, {}, key+\`__1\`,null, node, ctx);
+      b2 = comp1({}, key + \`__1\`, node, this, null);
     }
     return block1([], [b2]);
   }
@@ -64,9 +65,9 @@ exports[`Reactivity: useState destroyed component before being mounted is inacti
 `;
 
 exports[`Reactivity: useState destroyed component before being mounted is inactive 2`] = `
-"function anonymous(bdom, helpers
+"function anonymous(app, bdom, helpers
 ) {
-  let { text, createBlock, list, multi, html, toggler, component, comment } = bdom;
+  let { text, createBlock, list, multi, html, toggler, comment } = bdom;
   
   let block1 = createBlock(\`<span><block-text-0/></span>\`);
   
@@ -78,16 +79,17 @@ exports[`Reactivity: useState destroyed component before being mounted is inacti
 `;
 
 exports[`Reactivity: useState destroyed component is inactive 1`] = `
-"function anonymous(bdom, helpers
+"function anonymous(app, bdom, helpers
 ) {
-  let { text, createBlock, list, multi, html, toggler, component, comment } = bdom;
+  let { text, createBlock, list, multi, html, toggler, comment } = bdom;
+  const comp1 = app.createComponent(\`Child\`, true, false, false, true);
   
   let block1 = createBlock(\`<div><block-child-0/></div>\`);
   
   return function template(ctx, node, key = \\"\\") {
     let b2;
     if (ctx['state'].flag) {
-      b2 = component(\`Child\`, {}, key+\`__1\`,null, node, ctx);
+      b2 = comp1({}, key + \`__1\`, node, this, null);
     }
     return block1([], [b2]);
   }
@@ -95,9 +97,9 @@ exports[`Reactivity: useState destroyed component is inactive 1`] = `
 `;
 
 exports[`Reactivity: useState destroyed component is inactive 2`] = `
-"function anonymous(bdom, helpers
+"function anonymous(app, bdom, helpers
 ) {
-  let { text, createBlock, list, multi, html, toggler, component, comment } = bdom;
+  let { text, createBlock, list, multi, html, toggler, comment } = bdom;
   
   let block1 = createBlock(\`<span><block-text-0/></span>\`);
   
@@ -109,9 +111,9 @@ exports[`Reactivity: useState destroyed component is inactive 2`] = `
 `;
 
 exports[`Reactivity: useState one components can subscribe twice to same context 1`] = `
-"function anonymous(bdom, helpers
+"function anonymous(app, bdom, helpers
 ) {
-  let { text, createBlock, list, multi, html, toggler, component, comment } = bdom;
+  let { text, createBlock, list, multi, html, toggler, comment } = bdom;
   
   let block1 = createBlock(\`<div><block-text-0/><block-text-1/></div>\`);
   
@@ -124,14 +126,15 @@ exports[`Reactivity: useState one components can subscribe twice to same context
 `;
 
 exports[`Reactivity: useState parent and children subscribed to same context 1`] = `
-"function anonymous(bdom, helpers
+"function anonymous(app, bdom, helpers
 ) {
-  let { text, createBlock, list, multi, html, toggler, component, comment } = bdom;
+  let { text, createBlock, list, multi, html, toggler, comment } = bdom;
+  const comp1 = app.createComponent(\`Child\`, true, false, false, true);
   
   let block1 = createBlock(\`<div><block-child-0/><block-text-0/></div>\`);
   
   return function template(ctx, node, key = \\"\\") {
-    let b2 = component(\`Child\`, {}, key+\`__1\`,null, node, ctx);
+    const b2 = comp1({}, key + \`__1\`, node, this, null);
     let txt1 = ctx['contextObj'].b;
     return block1([txt1], [b2]);
   }
@@ -139,9 +142,9 @@ exports[`Reactivity: useState parent and children subscribed to same context 1`]
 `;
 
 exports[`Reactivity: useState parent and children subscribed to same context 2`] = `
-"function anonymous(bdom, helpers
+"function anonymous(app, bdom, helpers
 ) {
-  let { text, createBlock, list, multi, html, toggler, component, comment } = bdom;
+  let { text, createBlock, list, multi, html, toggler, comment } = bdom;
   
   let block1 = createBlock(\`<span><block-text-0/></span>\`);
   
@@ -216,24 +219,26 @@ exports[`Reactivity: useState several nodes on different level use same context
 `;
 
 exports[`Reactivity: useState two components are updated in parallel 1`] = `
-"function anonymous(bdom, helpers
+"function anonymous(app, bdom, helpers
 ) {
-  let { text, createBlock, list, multi, html, toggler, component, comment } = bdom;
+  let { text, createBlock, list, multi, html, toggler, comment } = bdom;
+  const comp1 = app.createComponent(\`Child\`, true, false, false, true);
+  const comp2 = app.createComponent(\`Child\`, true, false, false, true);
   
   let block1 = createBlock(\`<div><block-child-0/><block-child-1/></div>\`);
   
   return function template(ctx, node, key = \\"\\") {
-    let b2 = component(\`Child\`, {}, key+\`__1\`,null, node, ctx);
-    let b3 = component(\`Child\`, {}, key+\`__2\`,null, node, ctx);
+    const b2 = comp1({}, key + \`__1\`, node, this, null);
+    const b3 = comp2({}, key + \`__2\`, node, this, null);
     return block1([], [b2, b3]);
   }
 }"
 `;
 
 exports[`Reactivity: useState two components are updated in parallel 2`] = `
-"function anonymous(bdom, helpers
+"function anonymous(app, bdom, helpers
 ) {
-  let { text, createBlock, list, multi, html, toggler, component, comment } = bdom;
+  let { text, createBlock, list, multi, html, toggler, comment } = bdom;
   
   let block1 = createBlock(\`<span><block-text-0/></span>\`);
   
@@ -245,24 +250,26 @@ exports[`Reactivity: useState two components are updated in parallel 2`] = `
 `;
 
 exports[`Reactivity: useState two components can subscribe to same context 1`] = `
-"function anonymous(bdom, helpers
+"function anonymous(app, bdom, helpers
 ) {
-  let { text, createBlock, list, multi, html, toggler, component, comment } = bdom;
+  let { text, createBlock, list, multi, html, toggler, comment } = bdom;
+  const comp1 = app.createComponent(\`Child\`, true, false, false, true);
+  const comp2 = app.createComponent(\`Child\`, true, false, false, true);
   
   let block1 = createBlock(\`<div><block-child-0/><block-child-1/></div>\`);
   
   return function template(ctx, node, key = \\"\\") {
-    let b2 = component(\`Child\`, {}, key+\`__1\`,null, node, ctx);
-    let b3 = component(\`Child\`, {}, key+\`__2\`,null, node, ctx);
+    const b2 = comp1({}, key + \`__1\`, node, this, null);
+    const b3 = comp2({}, key + \`__2\`, node, this, null);
     return block1([], [b2, b3]);
   }
 }"
 `;
 
 exports[`Reactivity: useState two components can subscribe to same context 2`] = `
-"function anonymous(bdom, helpers
+"function anonymous(app, bdom, helpers
 ) {
-  let { text, createBlock, list, multi, html, toggler, component, comment } = bdom;
+  let { text, createBlock, list, multi, html, toggler, comment } = bdom;
   
   let block1 = createBlock(\`<span><block-text-0/></span>\`);
   
@@ -274,24 +281,26 @@ exports[`Reactivity: useState two components can subscribe to same context 2`] =
 `;
 
 exports[`Reactivity: useState two independent components on different levels are updated in parallel 1`] = `
-"function anonymous(bdom, helpers
+"function anonymous(app, bdom, helpers
 ) {
-  let { text, createBlock, list, multi, html, toggler, component, comment } = bdom;
+  let { text, createBlock, list, multi, html, toggler, comment } = bdom;
+  const comp1 = app.createComponent(\`Child\`, true, false, false, true);
+  const comp2 = app.createComponent(\`Parent\`, true, false, false, true);
   
   let block1 = createBlock(\`<div><block-child-0/><block-child-1/></div>\`);
   
   return function template(ctx, node, key = \\"\\") {
-    let b2 = component(\`Child\`, {}, key+\`__1\`,null, node, ctx);
-    let b3 = component(\`Parent\`, {}, key+\`__2\`,null, node, ctx);
+    const b2 = comp1({}, key + \`__1\`, node, this, null);
+    const b3 = comp2({}, key + \`__2\`, node, this, null);
     return block1([], [b2, b3]);
   }
 }"
 `;
 
 exports[`Reactivity: useState two independent components on different levels are updated in parallel 2`] = `
-"function anonymous(bdom, helpers
+"function anonymous(app, bdom, helpers
 ) {
-  let { text, createBlock, list, multi, html, toggler, component, comment } = bdom;
+  let { text, createBlock, list, multi, html, toggler, comment } = bdom;
   
   let block1 = createBlock(\`<span><block-text-0/></span>\`);
   
@@ -303,23 +312,24 @@ exports[`Reactivity: useState two independent components on different levels are
 `;
 
 exports[`Reactivity: useState two independent components on different levels are updated in parallel 3`] = `
-"function anonymous(bdom, helpers
+"function anonymous(app, bdom, helpers
 ) {
-  let { text, createBlock, list, multi, html, toggler, component, comment } = bdom;
+  let { text, createBlock, list, multi, html, toggler, comment } = bdom;
+  const comp1 = app.createComponent(\`Child\`, true, false, false, true);
   
   let block1 = createBlock(\`<div><block-child-0/></div>\`);
   
   return function template(ctx, node, key = \\"\\") {
-    let b2 = component(\`Child\`, {}, key+\`__1\`,null, node, ctx);
+    const b2 = comp1({}, key + \`__1\`, node, this, null);
     return block1([], [b2]);
   }
 }"
 `;
 
 exports[`Reactivity: useState useContext=useState hook is reactive, for one component 1`] = `
-"function anonymous(bdom, helpers
+"function anonymous(app, bdom, helpers
 ) {
-  let { text, createBlock, list, multi, html, toggler, component, comment } = bdom;
+  let { text, createBlock, list, multi, html, toggler, comment } = bdom;
   
   let block1 = createBlock(\`<div><block-text-0/></div>\`);
   
@@ -331,23 +341,24 @@ exports[`Reactivity: useState useContext=useState hook is reactive, for one comp
 `;
 
 exports[`Reactivity: useState useless atoms should be deleted 1`] = `
-"function anonymous(bdom, helpers
+"function anonymous(app, bdom, helpers
 ) {
-  let { text, createBlock, list, multi, html, toggler, component, comment } = bdom;
+  let { text, createBlock, list, multi, html, toggler, comment } = bdom;
   let { prepareList, withKey } = helpers;
+  const comp1 = app.createComponent(\`Quantity\`, true, false, false, false);
   
   let block1 = createBlock(\`<div><block-child-0/> Total: <block-text-0/> Count: <block-text-1/></div>\`);
   
   return function template(ctx, node, key = \\"\\") {
     ctx = Object.create(ctx);
-    const [k_block2, v_block2, l_block2, c_block2] = prepareList(Object.keys(ctx['state']));
+    const [k_block2, v_block2, l_block2, c_block2] = prepareList(Object.keys(ctx['state']));;
     for (let i1 = 0; i1 < l_block2; i1++) {
       ctx[\`id\`] = v_block2[i1];
-      let key1 = ctx['id'];
-      c_block2[i1] = withKey(component(\`Quantity\`, {id: ctx['id']}, key+\`__1__\${key1}\`,null, node, ctx), key1);
+      const key1 = ctx['id'];
+      c_block2[i1] = withKey(comp1({id: ctx['id']}, key + \`__1__\${key1}\`, node, this, null), key1);
     }
     ctx = ctx.__proto__;
-    let b2 = list(c_block2);
+    const b2 = list(c_block2);
     let txt1 = ctx['total'];
     let txt2 = Object.keys(ctx['state']).length;
     return block1([txt1, txt2], [b2]);
@@ -356,9 +367,9 @@ exports[`Reactivity: useState useless atoms should be deleted 1`] = `
 `;
 
 exports[`Reactivity: useState useless atoms should be deleted 2`] = `
-"function anonymous(bdom, helpers
+"function anonymous(app, bdom, helpers
 ) {
-  let { text, createBlock, list, multi, html, toggler, component, comment } = bdom;
+  let { text, createBlock, list, multi, html, toggler, comment } = bdom;
   
   let block1 = createBlock(\`<div><block-text-0/></div>\`);
   
@@ -370,9 +381,9 @@ exports[`Reactivity: useState useless atoms should be deleted 2`] = `
 `;
 
 exports[`Reactivity: useState very simple use, with initial value 1`] = `
-"function anonymous(bdom, helpers
+"function anonymous(app, bdom, helpers
 ) {
-  let { text, createBlock, list, multi, html, toggler, component, comment } = bdom;
+  let { text, createBlock, list, multi, html, toggler, comment } = bdom;
   
   let block1 = createBlock(\`<div><block-text-0/></div>\`);
   

tests/app/__snapshots__/app.test.ts.snap

@@ -1,9 +1,9 @@
 // Jest Snapshot v1, https://goo.gl/fbAQLP
 
 exports[`app App supports env with getters/setters 1`] = `
-"function anonymous(bdom, helpers
+"function anonymous(app, bdom, helpers
 ) {
-  let { text, createBlock, list, multi, html, toggler, component, comment } = bdom;
+  let { text, createBlock, list, multi, html, toggler, comment } = bdom;
   
   let block1 = createBlock(\`<div><block-text-0/> <block-text-1/></div>\`);
   
@@ -16,9 +16,9 @@ exports[`app App supports env with getters/setters 1`] = `
 `;
 
 exports[`app can configure an app with props 1`] = `
-"function anonymous(bdom, helpers
+"function anonymous(app, bdom, helpers
 ) {
-  let { text, createBlock, list, multi, html, toggler, component, comment } = bdom;
+  let { text, createBlock, list, multi, html, toggler, comment } = bdom;
   
   let block1 = createBlock(\`<div><block-text-0/></div>\`);
   
@@ -29,10 +29,23 @@ exports[`app can configure an app with props 1`] = `
 }"
 `;
 
-exports[`app destroy remove the widget from the DOM 1`] = `
-"function anonymous(bdom, helpers
+exports[`app can mount app in an iframe 1`] = `
+"function anonymous(app, bdom, helpers
 ) {
-  let { text, createBlock, list, multi, html, toggler, component, comment } = bdom;
+  let { text, createBlock, list, multi, html, toggler, comment } = bdom;
+  
+  let block1 = createBlock(\`<div class=\\"my-div\\"/>\`);
+  
+  return function template(ctx, node, key = \\"\\") {
+    return block1();
+  }
+}"
+`;
+
+exports[`app destroy remove the widget from the DOM 1`] = `
+"function anonymous(app, bdom, helpers
+) {
+  let { text, createBlock, list, multi, html, toggler, comment } = bdom;
   
   let block1 = createBlock(\`<div/>\`);
   
@@ -41,3 +54,17 @@ exports[`app destroy remove the widget from the DOM 1`] = `
   }
 }"
 `;
+
+exports[`app warnIfNoStaticProps works as expected 1`] = `
+"function anonymous(app, bdom, helpers
+) {
+  let { text, createBlock, list, multi, html, toggler, comment } = bdom;
+  
+  let block1 = createBlock(\`<div><block-text-0/></div>\`);
+  
+  return function template(ctx, node, key = \\"\\") {
+    let txt1 = ctx['message'];
+    return block1([txt1]);
+  }
+}"
+`;

tests/app/app.test.ts

@@ -1,5 +1,5 @@
-import { App, Component, xml } from "../../src";
-import { status } from "../../src/component/status";
+import { App, Component, mount, xml } from "../../src";
+import { status } from "../../src/runtime/status";
 import { makeTestFixture, snapshotEverything, nextTick, elem } from "../helpers";
 
 let fixture: HTMLElement;
@@ -59,4 +59,39 @@ describe("app", () => {
     await app.mount(fixture);
     expect(fixture.innerHTML).toBe("<div>333</div>");
   });
+
+  test("warnIfNoStaticProps works as expected", async () => {
+    let originalconsoleWarn = console.warn;
+    let mockConsoleWarn = jest.fn(() => {});
+    console.warn = mockConsoleWarn;
+
+    class Root extends Component {
+      static template = xml`<div t-esc="message"/>`;
+    }
+
+    await mount(Root, fixture, { dev: true, props: { messge: "hey" }, warnIfNoStaticProps: true });
+
+    console.warn = originalconsoleWarn;
+    expect(mockConsoleWarn).toBeCalledWith(
+      "Component 'Root' does not have a static props description"
+    );
+  });
+
+  test("can mount app in an iframe", async () => {
+    class SomeComponent extends Component {
+      static template = xml`<div class="my-div"/>`;
+    }
+
+    const iframe = document.createElement("iframe");
+    fixture.appendChild(iframe);
+    const app = new App(SomeComponent);
+    const iframeDoc = iframe.contentDocument!;
+    const comp = await app.mount(iframeDoc.body);
+    const div = iframeDoc.querySelector(".my-div");
+    expect(div).not.toBe(null);
+    expect(iframeDoc.contains(div)).toBe(true);
+    app.destroy();
+    expect(iframeDoc.contains(div)).toBe(false);
+    expect(status(comp)).toBe("destroyed");
+  });
 });

tests/blockdom/block.test.ts

@@ -1,4 +1,4 @@
-import { createBlock, mount, patch, remove, text } from "../../src/blockdom";
+import { createBlock, mount, patch, remove, text } from "../../src/runtime/blockdom";
 import { makeTestFixture } from "./helpers";
 
 //------------------------------------------------------------------------------

tests/blockdom/block_attributes.test.ts

@@ -1,4 +1,4 @@
-import { mount, patch, createBlock } from "../../src/blockdom";
+import { mount, patch, createBlock } from "../../src/runtime/blockdom";
 import { makeTestFixture } from "./helpers";
 
 //------------------------------------------------------------------------------
@@ -169,6 +169,27 @@ describe("properties", () => {
     expect(input.value).toBe("potato");
   });
 
+  test("input with value attribute, and falsy value given", () => {
+    const block = createBlock(`<input block-attribute-0="value"/>`);
+
+    const tree = block([undefined]);
+    mount(tree, fixture);
+    const input = fixture.querySelector("input")!;
+    expect(input.value).toBe("");
+
+    patch(tree, block([null]));
+    expect(input.value).toBe("");
+
+    patch(tree, block([0]));
+    expect(input.value).toBe("0");
+
+    patch(tree, block([""]));
+    expect(input.value).toBe("");
+
+    patch(tree, block([false]));
+    expect(input.value).toBe("");
+  });
+
   test("input type=checkbox with checked attribute", () => {
     // render input with initial value
     const block = createBlock(`<input type="checkbox" block-attribute-0="checked"/>`);

tests/blockdom/block_event_handling.test.ts

@@ -1,4 +1,4 @@
-import { mount, createBlock, multi, config, patch } from "../../src/blockdom";
+import { mount, createBlock, multi, config, patch } from "../../src/runtime/blockdom";
 // import { defaultHandler, setupMainHandler } from "../../src/bdom/block";
 import { makeTestFixture } from "./helpers";
 

tests/blockdom/block_refs.test.ts

@@ -1,4 +1,5 @@
-import { createBlock, mount, patch, remove } from "../../src/blockdom";
+import { createBlock, mount, patch, remove } from "../../src/runtime/blockdom";
+import { logStep } from "../helpers";
 import { makeTestFixture } from "./helpers";
 
 //------------------------------------------------------------------------------
@@ -55,3 +56,15 @@ test("is in dom when callback is called", async () => {
 
   mount(tree, fixture);
 });
+
+test("callback ref in callback ref with same block", async () => {
+  const block = createBlock('<p block-ref="0"><block-text-1/><block-child-0/></p>');
+  let refFn = (el: HTMLParagraphElement) => logStep(el.outerHTML);
+
+  const child = block([refFn, "child"], []);
+  const parent = block([refFn, "parent"], [child]);
+  mount(parent, fixture);
+
+  expect(fixture.innerHTML).toBe("<p>parent<p>child</p></p>");
+  expect(["<p>child</p>", "<p>parent<p>child</p></p>"]).toBeLogged();
+});

tests/blockdom/comment.test.ts

@@ -1,4 +1,4 @@
-import { comment, mount } from "../../src/blockdom";
+import { comment, mount } from "../../src/runtime/blockdom";
 import { makeTestFixture } from "./helpers";
 
 //------------------------------------------------------------------------------

tests/blockdom/event_catcher.test.ts

@@ -0,0 +1,54 @@
+import { config, createBlock, createCatcher, mount } from "../../src/runtime/blockdom";
+import { makeTestFixture } from "./helpers";
+import { mainEventHandler } from "../../src/runtime/event_handling";
+
+//------------------------------------------------------------------------------
+// Setup and helpers
+//------------------------------------------------------------------------------
+
+let fixture: HTMLElement;
+config.mainEventHandler = mainEventHandler;
+
+beforeEach(() => {
+  fixture = makeTestFixture();
+});
+
+afterEach(() => {
+  fixture.remove();
+});
+
+test("simple event catcher", async () => {
+  const catcher = createCatcher({ click: 0 });
+  const block = createBlock("<div></div>");
+  let n = 0;
+  let ctx = {};
+  let handler = [() => n++, ctx];
+  const tree = catcher(block(), [handler]);
+
+  mount(tree, fixture);
+  expect(fixture.innerHTML).toBe("<div></div>");
+
+  expect(fixture.firstChild).toBeInstanceOf(HTMLDivElement);
+  expect(n).toBe(0);
+  (fixture.firstChild as HTMLDivElement).click();
+  expect(n).toBe(1);
+});
+
+test("do not catch events outside of itself", async () => {
+  const catcher = createCatcher({ click: 0 });
+  const childBlock = createBlock("<div></div>");
+  const parentBlock = createBlock("<button><block-child-0/></button>");
+  let n = 0;
+  let ctx = {};
+  let handler = [() => n++, ctx];
+  const tree = parentBlock([], [catcher(childBlock(), [handler])]);
+
+  mount(tree, fixture);
+  expect(fixture.innerHTML).toBe("<button><div></div></button>");
+
+  expect(n).toBe(0);
+  fixture.querySelector("div")!.click();
+  expect(n).toBe(1);
+  fixture.querySelector("button")!.click();
+  expect(n).toBe(1);
+});

tests/blockdom/html.test.ts

@@ -1,4 +1,4 @@
-import { html, mount, patch, text } from "../../src/blockdom";
+import { html, mount, patch, text } from "../../src/runtime/blockdom";
 import { makeTestFixture } from "./helpers";
 
 //------------------------------------------------------------------------------