mirror of
https://github.com/odoo/owl.git
synced 2025-10-06 19:59:41 +07:00
Compare commits
3 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
| 71a9b21472 | |||
| 5cbf43110f | |||
| e00be61b8e |
@@ -5,7 +5,7 @@ name: Node.js CI
|
|||||||
|
|
||||||
on:
|
on:
|
||||||
pull_request:
|
pull_request:
|
||||||
branches: [ master ]
|
branches: [ master, owl-next ]
|
||||||
|
|
||||||
jobs:
|
jobs:
|
||||||
build:
|
build:
|
||||||
@@ -24,5 +24,4 @@ jobs:
|
|||||||
node-version: ${{ matrix.node-version }}
|
node-version: ${{ matrix.node-version }}
|
||||||
- run: npm install
|
- run: npm install
|
||||||
- run: npm run test
|
- run: npm run test
|
||||||
- run: npm run check-formatting
|
- run: npm run prettier
|
||||||
- run: npm run build
|
|
||||||
|
|||||||
@@ -30,5 +30,4 @@ release-notes.md
|
|||||||
|
|
||||||
.rpt2_cache
|
.rpt2_cache
|
||||||
|
|
||||||
# useful in some cases
|
|
||||||
/temp
|
/temp
|
||||||
-766
@@ -1,766 +0,0 @@
|
|||||||
# Changelog
|
|
||||||
|
|
||||||
This document contains an overview of all changes between Owl 1.x and
|
|
||||||
Owl 2.x, with some pointers on how to update the code.
|
|
||||||
|
|
||||||
Note that some of these changes can be magically implemented (for example, by
|
|
||||||
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.
|
|
||||||
|
|
||||||
## 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))
|
|
||||||
- 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))
|
|
||||||
- breaking: components can no longer be instantiated and mounted by hand ([details](#5-components-can-no-longer-be-instantiated-and-mounted-by-hand))
|
|
||||||
- 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: components can no longer be mounted with position=self ([details](#11-components-can-no-longer-be-mounted-with-positionself))
|
|
||||||
- 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
|
|
||||||
|
|
||||||
|
|
||||||
**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
|
|
||||||
- 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: `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: `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
|
|
||||||
|
|
||||||
All changes are listed in no particular order.
|
|
||||||
|
|
||||||
### 1. component lifecycle methods are removed
|
|
||||||
|
|
||||||
There was two ways to define hooks: the component methods (`willStart`, `mounted`, ...) and the hooks (`onWillStart`, `onMounted`, ...). In Owl 2, the component methods have been removed.
|
|
||||||
|
|
||||||
Rationale: it makes the implementation simpler and slightly faster. Hooks are more composable
|
|
||||||
than component methods. It enforces a single entry point to check all the useful lifecycle
|
|
||||||
calls (instead of it being scattered in the component definition). It feels more "modern".
|
|
||||||
|
|
||||||
Migration: lifecycle methods should be defined in the `setup`:
|
|
||||||
|
|
||||||
```js
|
|
||||||
class MyComponent extends Component {
|
|
||||||
mounted() {
|
|
||||||
// do something
|
|
||||||
}
|
|
||||||
}
|
|
||||||
```
|
|
||||||
should become:
|
|
||||||
```js
|
|
||||||
class MyComponent extends Component {
|
|
||||||
setup() {
|
|
||||||
onMounted(() => {
|
|
||||||
// do something
|
|
||||||
});
|
|
||||||
}
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
Documentation: [Component Lifecycle](doc/reference/component.md#lifecycle)
|
|
||||||
|
|
||||||
### 2. components can no longer be mounted in a detached dom element
|
|
||||||
|
|
||||||
Nor document fragment.
|
|
||||||
|
|
||||||
Rationale: it is actually very difficult to do it: this implies that a component
|
|
||||||
can be mounted more than once, that we need to check every time different status,
|
|
||||||
that some elements is in the dom, and was a cause for bugs. Also, we don't use it
|
|
||||||
in practice. Removing this means that we have a much simpler mental model of what
|
|
||||||
happens.
|
|
||||||
|
|
||||||
Migration: well, not really easy. The code needs to be refactored in a different way.
|
|
||||||
|
|
||||||
|
|
||||||
### 3. **`t-set` will no longer work to define a slot**
|
|
||||||
|
|
||||||
The `t-set` directive cannot define a slot anymore. Only the `t-set-slot` directive
|
|
||||||
can do it.
|
|
||||||
|
|
||||||
Rationale: it was left for compatibility reason, but was deprecated anyway.
|
|
||||||
|
|
||||||
Migration: `t-set` should be changed to `t-set-slot` (when defining a slot)
|
|
||||||
|
|
||||||
Example:
|
|
||||||
|
|
||||||
```xml
|
|
||||||
<SideBar><t t-set="content">content</t></SideBar>
|
|
||||||
```
|
|
||||||
should become:
|
|
||||||
```xml
|
|
||||||
<SideBar><t t-set-slot="content">content</t></SideBar>
|
|
||||||
```
|
|
||||||
|
|
||||||
### 4. `mount` method API is simpler
|
|
||||||
|
|
||||||
Before, the `mount` method was used like this:
|
|
||||||
|
|
||||||
```js
|
|
||||||
await mount(Root, { target: document.body });
|
|
||||||
```
|
|
||||||
|
|
||||||
It is now simpler and takes the root component and a target argument:
|
|
||||||
|
|
||||||
```js
|
|
||||||
await mount(Root, document.body);
|
|
||||||
```
|
|
||||||
|
|
||||||
Rationale: the `mount` method is only useful anyway for small toy examples,
|
|
||||||
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:
|
|
||||||
|
|
||||||
```js
|
|
||||||
const root = new Root();
|
|
||||||
await root.mount(document.body);
|
|
||||||
```
|
|
||||||
|
|
||||||
Now, it is no longer possible. All component instantiations should be done by
|
|
||||||
the owl framework itself.
|
|
||||||
|
|
||||||
Rationale: the `mount` method does not make sense for all non root components.
|
|
||||||
Also, the fact that it was possible for a component to be sometimes root,
|
|
||||||
sometimes a child made for a weird constructor signature. This changes makes it
|
|
||||||
simpler.
|
|
||||||
|
|
||||||
Migration: all code doing that should use either the `mount` method (if the use
|
|
||||||
case is simple enough, or the `App` class):
|
|
||||||
|
|
||||||
```js
|
|
||||||
const app = new App(Root);
|
|
||||||
app.configure({ templates: ..., ...});
|
|
||||||
await app.mount(document.body);
|
|
||||||
```
|
|
||||||
|
|
||||||
### 6. components can no longer be unmounted/remounted
|
|
||||||
|
|
||||||
Rationale: this is a very difficult feature to implement (it adds a lot of possible
|
|
||||||
state transitions), compared to its benefit.
|
|
||||||
|
|
||||||
Migration: all code using it should find a way to export and reimport the state
|
|
||||||
|
|
||||||
### 7. template name is no longer inferred from the class name
|
|
||||||
|
|
||||||
Before, it was possible to define a component without specifying its template:
|
|
||||||
|
|
||||||
```js
|
|
||||||
class Blabla extends Component {
|
|
||||||
// no static template here!
|
|
||||||
}
|
|
||||||
```
|
|
||||||
with the `Blabla` template. It also worked with subclasses. But then, this means
|
|
||||||
that the code had to look up all the super classes names to find the correct
|
|
||||||
template.
|
|
||||||
|
|
||||||
Rationale: in practice, it is not really useful, since all templates are usually
|
|
||||||
namespaced: `web.SomeComponent` anyway. All the trouble to do that was just not
|
|
||||||
worth it.
|
|
||||||
|
|
||||||
Migration: simply explicitely defines the template key everytime:
|
|
||||||
|
|
||||||
```js
|
|
||||||
class Blabla extends Component {}
|
|
||||||
Blabla.template = "Blabla";
|
|
||||||
```
|
|
||||||
|
|
||||||
### 8. components no longer have a `shouldUpdate` method
|
|
||||||
|
|
||||||
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, 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, and it should work as well
|
|
||||||
as before.
|
|
||||||
|
|
||||||
### 9. component.el is removed
|
|
||||||
|
|
||||||
This comes from the fact that Owl 2 supports fragments (arbitrary content).
|
|
||||||
|
|
||||||
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.
|
|
||||||
|
|
||||||
Documentation: [Refs](doc/reference/refs.md)
|
|
||||||
|
|
||||||
### 10. style/class on components are now regular props
|
|
||||||
|
|
||||||
Before, it was possible to do this in a template:
|
|
||||||
|
|
||||||
```xml
|
|
||||||
<Child style="..." class="..."/>
|
|
||||||
```
|
|
||||||
(or with `t-att-style` and `t-att-class`). This does no longer work, as they are
|
|
||||||
now considered normal props.
|
|
||||||
|
|
||||||
Rationale: with the move to fragments, the semantics of where the style/class
|
|
||||||
attribute should be set is unclear. Also, it is actually very hard to implement
|
|
||||||
properly, in particular with higher order components. And another issue is that
|
|
||||||
it (slightly) breaks the encapsulation of behaviour from the `Child` component
|
|
||||||
perspective.
|
|
||||||
|
|
||||||
Migration: each component that wishes to be customized should explicitely add
|
|
||||||
the `class` and `style` attributes in its template. Also, the parent component
|
|
||||||
should be aware that since we are talking about props, it should be a javascript expression:
|
|
||||||
|
|
||||||
In parent:
|
|
||||||
|
|
||||||
```xml
|
|
||||||
<Child class="'o_my_god'"/>
|
|
||||||
```
|
|
||||||
and in child:
|
|
||||||
|
|
||||||
```xml
|
|
||||||
<div t-att-class="props.class">
|
|
||||||
...
|
|
||||||
</div>
|
|
||||||
```
|
|
||||||
|
|
||||||
### 11. components can no longer be mounted with position=self
|
|
||||||
|
|
||||||
Rationale: this is due to the implementation of owl 2 virtual dom. The hack
|
|
||||||
necessary to support position=self does not work. This position also is not
|
|
||||||
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`. Remember that you the root component
|
|
||||||
can have multiple roots
|
|
||||||
|
|
||||||
Documentation:
|
|
||||||
- [Fragments](doc/reference/templates.md#fragments)
|
|
||||||
- [Mounting a component](doc/reference/app.md#mount-helper)
|
|
||||||
|
|
||||||
|
|
||||||
### 13. Portal does no longer transfer DOM events
|
|
||||||
|
|
||||||
In Owl 1, a Portal component would listen to events emitted on its portalled
|
|
||||||
child, and redispatch them on itself. It no longer works.
|
|
||||||
|
|
||||||
Rationale: Portal now supports an arbitrary content (so, more than one child,
|
|
||||||
and potentially no html element), so it is already unclear what it should listen
|
|
||||||
to. Also, redispatching events was an hack. And this changes allows the portal
|
|
||||||
to render itself as a text node, which is nice. This is also in line with the
|
|
||||||
fact that modern Owl moves toward using callback instead of `t-on` for communication.
|
|
||||||
|
|
||||||
Migration: use callback if possible to communicate. Otherwise, use a sub env.
|
|
||||||
|
|
||||||
### 14. Portal does render as an empty text node instead of `<portal/>`
|
|
||||||
|
|
||||||
That is pretty nice. No real migration needed.
|
|
||||||
|
|
||||||
### 15. Context is removed
|
|
||||||
|
|
||||||
Context was an abstraction in Owl that was used to define some reactive state
|
|
||||||
and to let some components subscribe to it, then only them would be rerendered
|
|
||||||
if the context was updated. This has been removed.
|
|
||||||
|
|
||||||
Rationale: first, the Context api and code was kind of awkward, which is a sign
|
|
||||||
that the abstraction is not well thought. But the good news is that it is actually
|
|
||||||
completely replaced by the new reactivity system, which is even more powerful,
|
|
||||||
since it can tracks changes key by key.
|
|
||||||
|
|
||||||
Migration: replace all uses of Context with the new reactivity system.
|
|
||||||
|
|
||||||
```js
|
|
||||||
// somewhere, maybe in a service, or in the global env
|
|
||||||
const context = observe({some: "state"})
|
|
||||||
|
|
||||||
// in a component that would previously get a reference to the context:
|
|
||||||
|
|
||||||
setup() {
|
|
||||||
this.context = useState(context);
|
|
||||||
// now the component is subscribed to the context and will react to any
|
|
||||||
// change for any key read by the component, and only those changes
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
### 16. `env` is now totally empty
|
|
||||||
|
|
||||||
In Owl 1, the `env` object had to contain a QWeb instance. This was the way
|
|
||||||
components would get a reference to their template function. It no longer works
|
|
||||||
that way: the `env` object is now totally empty (from the perspective of Owl).
|
|
||||||
It is now a user space concept, useful for the application.
|
|
||||||
|
|
||||||
Rationale: first, there is no longer a QWeb class. Also, this changes simplifies
|
|
||||||
the way components works internally.
|
|
||||||
|
|
||||||
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:
|
|
||||||
|
|
||||||
```xml
|
|
||||||
<t t-component="Coucou"/>
|
|
||||||
```
|
|
||||||
|
|
||||||
This meant that Owl would look for the component class like this: `components["Coucou"]`,
|
|
||||||
so, essentially equivalent to `<Coucou/>`. In Owl 2, the `t-component` directive
|
|
||||||
is assumed to be an expression evaluating to a component class:
|
|
||||||
|
|
||||||
```js
|
|
||||||
class Parent extends Component {
|
|
||||||
static template = xml`<t t-component="Child"/>`;
|
|
||||||
Child = Child;
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
Rationale: it simply seems more consistent with the way directive works. Also,
|
|
||||||
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`.
|
|
||||||
|
|
||||||
Rationale: this makes it easier to work with, instead of importing stuff from
|
|
||||||
`owl`, then `owl.hooks` and `owl.tags` for example.
|
|
||||||
|
|
||||||
Migration: all import code simply need to be slightly adapted.
|
|
||||||
|
|
||||||
### 19. Properties are no longer set as attributes
|
|
||||||
|
|
||||||
Formerly, html properties `<input type="checkbox" t-att-checked="blah"/>` were
|
|
||||||
set as property and as attribute, so, they would be visible in the DOM:
|
|
||||||
`<input type="checkbox" checked="blah"/>`. Now, they are treated as property only:
|
|
||||||
`<input type="checkbox"/>`.
|
|
||||||
|
|
||||||
Rationale: this is actually simple to do, is faster, and makes more sense to me.
|
|
||||||
|
|
||||||
### 20. `t-foreach` should always have a corresponding `t-key`
|
|
||||||
|
|
||||||
It was possible in Owl 1 to write a `t-foreach` without a `t-key`. In that case,
|
|
||||||
the index was used as key. Since it was clearly a possible bug, Owl 1 had a
|
|
||||||
warning in some cases, when it could detect that there was definitely not a `t-key`.
|
|
||||||
However, this was imperfect, and in some cases no warning was displayed. In Owl 2,
|
|
||||||
the tag with a `t-foreach` has to have a corresponding `t-key`.
|
|
||||||
|
|
||||||
Rationale: this makes it easier to avoid bugs.
|
|
||||||
|
|
||||||
Migration: simply move the `t-key` to the tag with the `t-foreach`. If this is
|
|
||||||
a situation where there is really not a need for a `t-key`, you can still add
|
|
||||||
it with the `_index` suffix:
|
|
||||||
|
|
||||||
```xml
|
|
||||||
<div t-foreach="items" t-as="item" t-key="item_index">
|
|
||||||
...
|
|
||||||
</div>
|
|
||||||
```
|
|
||||||
|
|
||||||
### 21. `EventBus` api changed: it is now an `EventTarget`
|
|
||||||
|
|
||||||
In Owl 1, the `EventBus` class was done manually, with a custom API. In Owl 2,
|
|
||||||
it simply extends `EventTarget` (the native Dom class), so its implementation
|
|
||||||
is basically only 5 lines long. This means that it has now the usual DOM interface:
|
|
||||||
|
|
||||||
```js
|
|
||||||
bus.addEventListener('event-name', callback);
|
|
||||||
```
|
|
||||||
|
|
||||||
Rationale: it makes it easier to have just one interface to remember, it makes
|
|
||||||
the code simpler
|
|
||||||
|
|
||||||
Migration: most bus methods need to be adapted. So, `bus.on("event-type", owner, (info) => {...})` has to be
|
|
||||||
rewritten like this: `bus.addEventListener("event-type", (({detail: info}) => {...}).bind(owner))`.
|
|
||||||
|
|
||||||
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.
|
|
||||||
|
|
||||||
Rationale: first, it was complicated to maintain. Second, it was not really
|
|
||||||
used in Odoo. Finally, the new reactivity system seems to be a pretty good basis
|
|
||||||
to write a store, and it should not take much work. Also, this can be done in
|
|
||||||
user space (so, not necessarily at the framework level). Another point is that
|
|
||||||
the store API was invented before the hooks, then was still a little awkward.
|
|
||||||
|
|
||||||
Migration:
|
|
||||||
- rewrite the code not to use a store
|
|
||||||
- probably use the reactivity system instead and build a store class and a few
|
|
||||||
hooks on top of it.
|
|
||||||
|
|
||||||
### 23. `Router` is removed
|
|
||||||
|
|
||||||
Rationale: Router was not used that much, and it felt like it did not fit in Owl 2.
|
|
||||||
Its API needs to be reworked, and we are not confident that it is a good
|
|
||||||
experience to use it. Also, it can be done in userspace (it does not need specific
|
|
||||||
integration at the framework level)
|
|
||||||
|
|
||||||
Migration: reimport all missing piece from the code in Owl 1.
|
|
||||||
|
|
||||||
### 24. transition system is removed
|
|
||||||
|
|
||||||
Rationale: this was a high ratio cost/value, with a lot of potential for bugs.
|
|
||||||
We feel like there should be a way to reimplement in userspace the simple cases.
|
|
||||||
|
|
||||||
Maybe something like: add a `t-ref` in the template, and define a hook `useFadeOut`
|
|
||||||
that takes the ref, and add a fadeout class at initial render, then in mounted,
|
|
||||||
wait for a micro tick and remove it.
|
|
||||||
|
|
||||||
Migration: try to reimplement it manually.
|
|
||||||
|
|
||||||
### 25. no more global components or templates
|
|
||||||
|
|
||||||
It was possible in Owl 1 to register globally a component or a template. This is
|
|
||||||
no longer the case in Owl 2.
|
|
||||||
|
|
||||||
Rationale: first, this was a tradeoff: ease of use was gained, but at the cost
|
|
||||||
of a higher complexity. Users had to know that there was a magic mechanism. Also,
|
|
||||||
it was not used much in practice, and the cost of having to import manually components
|
|
||||||
is low. Finally, this can be mostly done in user space (for example, by subclassing
|
|
||||||
`Component`).
|
|
||||||
|
|
||||||
Migration: import manually all required global components, or find a way to organize
|
|
||||||
the code to do it.
|
|
||||||
|
|
||||||
### 26. `AsyncRoot` utility component is removed
|
|
||||||
|
|
||||||
Rationale: it was difficult to understand, never used, and not really useful.
|
|
||||||
It seems better to control the asynchrony of an application by simply controlling
|
|
||||||
how/when the state is updated, and how each component is loading/updating itself.
|
|
||||||
|
|
||||||
Migration: remove the `AsyncRoot` component, then possibly, reorganize the code
|
|
||||||
to fetch data in a higher order component, and using a `t-if/t-else` to display
|
|
||||||
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. `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
|
|
||||||
|
|
||||||
In Owl 2, the `env` object is frozen. It can no longer be modified (structurally)
|
|
||||||
arbitrarily.
|
|
||||||
|
|
||||||
Rationale: it seems like the `env` object purpose is to have a global channel of
|
|
||||||
communication between components. It is however scary if anyone can add something
|
|
||||||
to it. The usual use case is to add something to the environment for some child
|
|
||||||
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
|
|
||||||
longer works.
|
|
||||||
|
|
||||||
Rationale: the possibility of having a ref to a child component breaks the
|
|
||||||
encapsulation provided by Owl components: a child component now has a private
|
|
||||||
and a public interface. Another issue is that it may be unclear when the ref
|
|
||||||
should be set: is the component active on setup, or on mounted? Also, it is
|
|
||||||
kind of awkward to implement.
|
|
||||||
|
|
||||||
Migration: the `env` and `props` should provide a communication channel wide enough:
|
|
||||||
the sub component can expose its public API by calling a callback at the proper
|
|
||||||
timing, or by triggering an event.
|
|
||||||
|
|
||||||
### 30. `t-on` does not accept expressions, only functions
|
|
||||||
|
|
||||||
In Owl 1, it was possible to define simple expressions inline, in a template:
|
|
||||||
|
|
||||||
```xml
|
|
||||||
<button t-on-click="state.value = state.value + 1">blabla</button>
|
|
||||||
<button t-on-click="someFunction(someVar)">blabla</button>
|
|
||||||
```
|
|
||||||
|
|
||||||
This does not work anymore. Now, the `t-on` directive assumes that what it get is
|
|
||||||
a function.
|
|
||||||
|
|
||||||
Rationale: the fact that owl 1 had to support expressions meant that it was not
|
|
||||||
possible to properly inject the event in general. With this restriction, Owl 2
|
|
||||||
can support more general use cases. Also, the examples above can simply be
|
|
||||||
wrapped in a lambda function.
|
|
||||||
|
|
||||||
Migration: use lambda functions. For example, the two examples above can be
|
|
||||||
adapted like this:
|
|
||||||
|
|
||||||
```xml
|
|
||||||
<button t-on-click="() => state.value = state.value + 1">blabla</button>
|
|
||||||
<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
|
|
||||||
root. Now, the content is arbitrary: it can be empty, or multiple html elements.
|
|
||||||
So, the following template works for components:
|
|
||||||
|
|
||||||
```xml
|
|
||||||
<div>1</div>
|
|
||||||
<div>2</div>
|
|
||||||
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
|
|
||||||
the qweb instance knew all templates. But now, the closest analogy is the `App`
|
|
||||||
class, but it is not as convenient, since the `app` instance is no longer visible
|
|
||||||
to components (while before, `qweb` was in the environment).
|
|
||||||
|
|
||||||
Also, this can easily be done in userspace, by mounting a component in a div. For example:
|
|
||||||
|
|
||||||
```js
|
|
||||||
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 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.
|
|
||||||
|
|
||||||
@@ -1,4 +1,4 @@
|
|||||||
<h1 align="center">🦉 <a href="https://odoo.github.io/owl/">Owl Framework</a> 🦉</h1>
|
<h1 align="center">🦉 <a href="https://odoo.github.io/owl/">OWL Framework</a> 🦉</h1>
|
||||||
|
|
||||||
[](https://www.gnu.org/licenses/lgpl-3.0)
|
[](https://www.gnu.org/licenses/lgpl-3.0)
|
||||||
[](https://badge.fury.io/js/@odoo%2Fowl)
|
[](https://badge.fury.io/js/@odoo%2Fowl)
|
||||||
@@ -6,113 +6,114 @@
|
|||||||
|
|
||||||
_Class based components with hooks, reactive state and concurrent mode_
|
_Class based components with hooks, reactive state and concurrent mode_
|
||||||
|
|
||||||
**Try it online!** you can experiment with the Owl framework in an online [playground](https://odoo.github.io/owl/playground).
|
|
||||||
|
|
||||||
## Project Overview
|
## Project Overview
|
||||||
|
|
||||||
The Odoo Web Library (Owl) is a smallish (~<20kb gzipped) UI framework built by
|
The Odoo Web Library (OWL) is a smallish (~<20kb gzipped) UI framework intended to
|
||||||
[Odoo](https://www.odoo.com/) for its products. Owl is a modern
|
be the basis for the [Odoo](https://www.odoo.com/) Web Client. Owl is a modern
|
||||||
framework, written in Typescript, taking the best ideas from React and Vue in a
|
framework, written in Typescript, taking the best ideas from React and Vue in a
|
||||||
simple and consistent way. Owl's main features are:
|
simple and consistent way. Owl's main features are:
|
||||||
|
|
||||||
- a declarative component system,
|
- a declarative component system,
|
||||||
- a fine grained reactivity system similar to Vue,
|
- a reactivity system based on hooks,
|
||||||
- hooks
|
- concurrent mode by default,
|
||||||
- fragments
|
- a store and a frontend router
|
||||||
- asynchronous rendering
|
|
||||||
|
|
||||||
Owl components are defined with ES6 classes and xml templates, uses an
|
Owl components are defined with ES6 classes, they use QWeb templates, an
|
||||||
underlying virtual DOM, integrates beautifully with hooks, and the rendering is
|
underlying virtual DOM, integrates beautifully with hooks, and the rendering is
|
||||||
asynchronous.
|
asynchronous.
|
||||||
|
|
||||||
Quick links:
|
**Try it online!** An online playground is available at
|
||||||
|
[https://odoo.github.io/owl/playground](https://odoo.github.io/owl/playground)
|
||||||
|
to let you experiment with the Owl framework. There are some code examples to
|
||||||
|
showcase some interesting features.
|
||||||
|
|
||||||
- [documentation](#documentation),
|
Owl is currently stable. Possible future changes are explained in the
|
||||||
- [changelog](CHANGELOG.md) (from Owl 1.x to 2.x),
|
[roadmap](roadmap.md).
|
||||||
- [playground](https://odoo.github.io/owl/playground)
|
|
||||||
|
## Why Owl?
|
||||||
|
|
||||||
|
Why did Odoo decide to make Yet Another Framework? This is really a question
|
||||||
|
that deserves [a long answer](doc/miscellaneous/why_owl.md). But in short, we believe that
|
||||||
|
while the current state of the art frameworks are excellent, they are not
|
||||||
|
optimized for our use case, and there is still room for something else.
|
||||||
|
|
||||||
|
If you are interested in a comparison with React or Vue, you will
|
||||||
|
find some more additional information [here](doc/miscellaneous/comparison.md).
|
||||||
|
|
||||||
## Example
|
## Example
|
||||||
|
|
||||||
Here is a short example to illustrate interactive components:
|
Here is a short example to illustrate interactive components:
|
||||||
|
|
||||||
```javascript
|
```javascript
|
||||||
const { Component, useState, mount, xml } = owl;
|
const { Component, useState } = owl;
|
||||||
|
const { xml } = owl.tags;
|
||||||
|
|
||||||
class Counter extends Component {
|
class Counter extends Component {
|
||||||
static template = xml`
|
static template = xml`
|
||||||
<button t-on-click="() => state.value = state.value + props.increment">
|
<button t-on-click="state.value++">
|
||||||
Click Me! [<t t-esc="state.value"/>]
|
Click Me! [<t t-esc="state.value"/>]
|
||||||
</button>`;
|
</button>`;
|
||||||
|
|
||||||
state = useState({ value: 0 });
|
state = useState({ value: 0 });
|
||||||
}
|
}
|
||||||
|
|
||||||
class Root extends Component {
|
class App extends Component {
|
||||||
static template = xml`
|
static template = xml`
|
||||||
<span>Hello Owl</span>
|
<div>
|
||||||
<Counter increment="2"/>`;
|
<span>Hello Owl</span>
|
||||||
|
<Counter />
|
||||||
|
</div>`;
|
||||||
|
|
||||||
static components = { Counter };
|
static components = { Counter };
|
||||||
}
|
}
|
||||||
|
|
||||||
mount(Root, document.body);
|
const app = new App();
|
||||||
|
app.mount(document.body);
|
||||||
```
|
```
|
||||||
|
|
||||||
Note that the counter component is made reactive with the [`useState` hook](doc/reference/hooks.md#usestate).
|
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/templates.md#inline-templates) to define inline templates.
|
Also, all examples here uses the [`xml` helper](doc/reference/tags.md#xml-tag) to define inline templates.
|
||||||
But this is not mandatory, many applications will load templates separately.
|
But this is not mandatory, many applications will load templates separately.
|
||||||
|
|
||||||
More interesting examples can be found on the
|
More interesting examples can be found on the
|
||||||
[playground](https://odoo.github.io/owl/playground) application.
|
[playground](https://odoo.github.io/owl/playground) application.
|
||||||
|
|
||||||
|
## Design Principles
|
||||||
|
|
||||||
|
OWL is designed to be used in highly dynamic applications where changing
|
||||||
|
requirements are common and code needs to be maintained by large teams.
|
||||||
|
|
||||||
|
- **XML based**: templates are based on the XML format, which allows interesting
|
||||||
|
applications. For example, they could be stored in a database and modified
|
||||||
|
dynamically with `xpaths`.
|
||||||
|
- **templates compilation in the browser**: this may not be a good fit for all
|
||||||
|
applications, but if you need to generate dynamically user interfaces in the
|
||||||
|
browser, this is very powerful. For example, a generic form view component
|
||||||
|
could generate a specific form user interface for each various models, from a XML view.
|
||||||
|
- **no toolchain required**: this is extremely useful for some applications, if,
|
||||||
|
for various reasons (security/deployment/dynamic modules/specific assets tools),
|
||||||
|
it is not ok to use standard web tools based on `npm`.
|
||||||
|
|
||||||
|
Owl is not designed to be fast nor small (even though it is quite good on those
|
||||||
|
two topics). It is a no nonsense framework to build applications. There is only
|
||||||
|
one way to define components (with classes). There is no black magic. It just
|
||||||
|
works.
|
||||||
|
|
||||||
|
|
||||||
## Documentation
|
## Documentation
|
||||||
|
|
||||||
### Learning Owl
|
A complete documentation for Owl can be found here:
|
||||||
|
|
||||||
Are you new to Owl? This is the place to start!
|
- [Main documentation page](doc/readme.md).
|
||||||
|
|
||||||
- [Tutorial: create a TodoList application](doc/learning/tutorial_todoapp.md)
|
Some of the most important pages are:
|
||||||
|
|
||||||
|
- [Tutorial: TodoList application](doc/learning/tutorial_todoapp.md)
|
||||||
- [How to start an Owl project](doc/learning/quick_start.md)
|
- [How to start an Owl project](doc/learning/quick_start.md)
|
||||||
- [How to test Components](doc/learning/how_to_test.md)
|
- [QWeb templating language](doc/reference/qweb_templating_language.md)
|
||||||
|
|
||||||
### Reference
|
|
||||||
|
|
||||||
- [Overview](doc/readme.md)
|
|
||||||
- [App](doc/reference/app.md)
|
|
||||||
- [Component](doc/reference/component.md)
|
- [Component](doc/reference/component.md)
|
||||||
- [Component Lifecycle](doc/reference/component.md#lifecycle)
|
|
||||||
- [Concurrency Model](doc/reference/concurrency_model.md)
|
|
||||||
- [Dev mode](doc/reference/app.md#dev-mode)
|
|
||||||
- [Dynamic sub components](doc/reference/component.md#dynamic-sub-components)
|
|
||||||
- [Environment](doc/reference/environment.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)
|
- [Hooks](doc/reference/hooks.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.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)
|
|
||||||
- [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
|
|
||||||
|
|
||||||
- [Notes On Owl Architecture](doc/miscellaneous/architecture.md)
|
|
||||||
- [Comparison with React/Vue](doc/miscellaneous/comparison.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
|
## Installing Owl
|
||||||
|
|
||||||
@@ -124,5 +125,8 @@ npm install @odoo/owl
|
|||||||
|
|
||||||
If you want to use a simple `<script>` tag, the last release can be downloaded here:
|
If you want to use a simple `<script>` tag, the last release can be downloaded here:
|
||||||
|
|
||||||
- [owl-1.4.10](https://github.com/odoo/owl/releases/tag/v1.4.10)
|
- [owl-1.0.13](https://github.com/odoo/owl/releases/tag/v1.0.13)
|
||||||
|
|
||||||
|
## License
|
||||||
|
|
||||||
|
OWL is [LGPL licensed](./LICENSE).
|
||||||
|
|||||||
@@ -0,0 +1,43 @@
|
|||||||
|
# 🦉 How to debug Owl applications 🦉
|
||||||
|
|
||||||
|
Non trivial applications become quickly more difficult to understand. It is then
|
||||||
|
useful to have a solid understanding of what is going on. To help with that,
|
||||||
|
logging useful information is extremely valuable. There is a [javascript file](../../tools/debug.js) which can be evaluated in an application.
|
||||||
|
|
||||||
|
Once it is executed, it will log a lot of information on each component main hooks. The following code is a minified version to make it easier to copy/paste:
|
||||||
|
|
||||||
|
```
|
||||||
|
function debugOwl(t,e){let n,o="[OWL_DEBUG]";function r(t){let e;try{e=JSON.stringify(t||{})}catch(t){e="<JSON error>"}return e.length>200&&(e=e.slice(0,200)+"..."),e}if(Object.defineProperty(t.Component,"current",{get:()=>n,set(s){n=s;const i=s.constructor.name;if(e.componentBlackList&&e.componentBlackList.test(i))return;if(e.componentWhiteList&&!e.componentWhiteList.test(i))return;let l;Object.defineProperty(n,"__owl__",{get:()=>l,set(n){!function(n,s,i){let l=`${s}<id=${i}>`,c=t=>console.log(`${o} ${l} ${t}`),u=t=>(!e.methodBlackList||!e.methodBlackList.includes(t))&&!(e.methodWhiteList&&!e.methodWhiteList.includes(t));u("constructor")&&c(`constructor, props=${r(n.props)}`);u("willStart")&&t.hooks.onWillStart(()=>{c("willStart")});u("mounted")&&t.hooks.onMounted(()=>{c("mounted")});u("willUpdateProps")&&t.hooks.onWillUpdateProps(t=>{c(`willUpdateProps, nextprops=${r(t)}`)});u("willPatch")&&t.hooks.onWillPatch(()=>{c("willPatch")});u("patched")&&t.hooks.onPatched(()=>{c("patched")});u("willUnmount")&&t.hooks.onWillUnmount(()=>{c("willUnmount")});const d=n.__render.bind(n);n.__render=function(...t){c("rendering template"),d(...t)};const h=n.render.bind(n);n.render=function(...t){const e=n.__owl__;let o="render";return e.isMounted||e.currentFiber||(o+=" (warning: component is not mounted, this render has no effect)"),c(o),h(...t)};const p=n.mount.bind(n);n.mount=function(...t){return c("mount"),p(...t)}}(s,i,(l=n).id)}})}}),e.logScheduler){let e=t.Component.scheduler.start,n=t.Component.scheduler.stop;t.Component.scheduler.start=function(){this.isRunning||console.log(`${o} scheduler: start running tasks queue`),e.call(this)},t.Component.scheduler.stop=function(){this.isRunning&&console.log(`${o} scheduler: stop running tasks queue`),n.call(this)}}if(e.logStore){let e=t.Store.prototype.dispatch;t.Store.prototype.dispatch=function(t,...n){return console.log(`${o} store: action '${t}' dispatched. Payload: '${r(n)}'`),e.call(this,t,...n)}}}
|
||||||
|
debugOwl(owl, {
|
||||||
|
// componentBlackList: /App/, // regexp
|
||||||
|
// componentWhiteList: /SomeComponent/, // regexp
|
||||||
|
// methodBlackList: ["mounted"], // list of method names
|
||||||
|
// methodWhiteList: ["willStart"], // list of method names
|
||||||
|
logScheduler: false, // display/mute scheduler logs
|
||||||
|
logStore: true, // display/mute store logs
|
||||||
|
});
|
||||||
|
```
|
||||||
|
|
||||||
|
The above code, once pasted somewhere in the main javascript file of an owl
|
||||||
|
application, will log information looking like this:
|
||||||
|
|
||||||
|
```
|
||||||
|
[OWL_DEBUG] TodoApp<id=1> constructor, props={}
|
||||||
|
[OWL_DEBUG] TodoApp<id=1> mount
|
||||||
|
[OWL_DEBUG] TodoApp<id=1> willStart
|
||||||
|
[OWL_DEBUG] TodoApp<id=1> rendering template
|
||||||
|
[OWL_DEBUG] TodoItem<id=2> constructor, props={"id":2,"completed":false,"title":"hey"}
|
||||||
|
[OWL_DEBUG] TodoItem<id=2> willStart
|
||||||
|
[OWL_DEBUG] TodoItem<id=3> constructor, props={"id":4,"completed":false,"title":"aaa"}
|
||||||
|
[OWL_DEBUG] TodoItem<id=3> willStart
|
||||||
|
[OWL_DEBUG] TodoItem<id=2> rendering template
|
||||||
|
[OWL_DEBUG] TodoItem<id=3> rendering template
|
||||||
|
[OWL_DEBUG] TodoItem<id=3> mounted
|
||||||
|
[OWL_DEBUG] TodoItem<id=2> mounted
|
||||||
|
[OWL_DEBUG] TodoApp<id=1> mounted
|
||||||
|
```
|
||||||
|
|
||||||
|
Each component has an internal `id`, which is very useful when debugging.
|
||||||
|
|
||||||
|
Note that it is certainly useful to run this code at some point in an application,
|
||||||
|
just to get a feel of what each user action implies, for the framework.
|
||||||
+47
-11
@@ -30,21 +30,27 @@ To help with this, it is useful to have a `helper.js` file that contains some
|
|||||||
common utility functions:
|
common utility functions:
|
||||||
|
|
||||||
```js
|
```js
|
||||||
let lastFixture = null;
|
|
||||||
|
|
||||||
export function makeTestFixture() {
|
export function makeTestFixture() {
|
||||||
let fixture = document.createElement("div");
|
let fixture = document.createElement("div");
|
||||||
document.body.appendChild(fixture);
|
document.body.appendChild(fixture);
|
||||||
if (lastFixture) {
|
|
||||||
lastFixture.remove();
|
|
||||||
}
|
|
||||||
lastFixture = fixture;
|
|
||||||
return fixture;
|
return fixture;
|
||||||
}
|
}
|
||||||
|
|
||||||
export async function nextTick() {
|
export function nextTick() {
|
||||||
await new Promise((resolve) => setTimeout(resolve));
|
let requestAnimationFrame = owl.Component.scheduler.requestAnimationFrame;
|
||||||
await new Promise((resolve) => requestAnimationFrame(resolve));
|
return new Promise(function(resolve) {
|
||||||
|
setTimeout(() => requestAnimationFrame(() => resolve()));
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
export function makeTestEnv() {
|
||||||
|
// application specific. It needs a way to load actual templates
|
||||||
|
const templates = ...;
|
||||||
|
|
||||||
|
return {
|
||||||
|
qweb: new QWeb(templates),
|
||||||
|
..., // each service can be mocked here
|
||||||
|
};
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
@@ -53,7 +59,7 @@ With such a file, a typical test suite for Jest will look like this:
|
|||||||
```js
|
```js
|
||||||
// in SomeComponent.test.js
|
// in SomeComponent.test.js
|
||||||
import { SomeComponent } from "../../src/ui/SomeComponent";
|
import { SomeComponent } from "../../src/ui/SomeComponent";
|
||||||
import { nextTick, makeTestFixture } from '../helpers';
|
import { nextTick, makeTestFixture, makeTestEnv} from '../helpers';
|
||||||
|
|
||||||
|
|
||||||
//------------------------------------------------------------------------------
|
//------------------------------------------------------------------------------
|
||||||
@@ -64,6 +70,9 @@ let env: Env;
|
|||||||
|
|
||||||
beforeEach(() => {
|
beforeEach(() => {
|
||||||
fixture = makeTestFixture();
|
fixture = makeTestFixture();
|
||||||
|
env = makeTestEnv();
|
||||||
|
// we set here the default environment for each component created in the test
|
||||||
|
Component.env = env;
|
||||||
});
|
});
|
||||||
|
|
||||||
afterEach(() => {
|
afterEach(() => {
|
||||||
@@ -76,7 +85,8 @@ afterEach(() => {
|
|||||||
describe("SomeComponent", () => {
|
describe("SomeComponent", () => {
|
||||||
test("component behaves as expected", async () => {
|
test("component behaves as expected", async () => {
|
||||||
const props = {...}; // depends on the component
|
const props = {...}; // depends on the component
|
||||||
const comp = await mount(SomeComponent, fixture, { props });
|
const comp = new SomeComponent(null, props);
|
||||||
|
await comp.mount(fixture);
|
||||||
|
|
||||||
// do some assertions
|
// do some assertions
|
||||||
expect(...).toBe(...);
|
expect(...).toBe(...);
|
||||||
@@ -93,3 +103,29 @@ describe("SomeComponent", () => {
|
|||||||
Note that Owl does wait for the next animation frame to actually update the DOM.
|
Note that Owl does wait for the next animation frame to actually update the DOM.
|
||||||
This is why it is necessary to wait with the `nextTick` (or other methods) to
|
This is why it is necessary to wait with the `nextTick` (or other methods) to
|
||||||
make sure that the DOM is up-to-date.
|
make sure that the DOM is up-to-date.
|
||||||
|
|
||||||
|
It is sometimes useful to wait until Owl is completely done updating components
|
||||||
|
(in particular, if we have a highly concurrent user interface). This next
|
||||||
|
helper simply polls every 20ms the internal Owl task queue and returns a promise
|
||||||
|
which resolves when it is empty:
|
||||||
|
|
||||||
|
```js
|
||||||
|
function afterUpdates() {
|
||||||
|
return new Promise((resolve, reject) => {
|
||||||
|
let timer = setTimeout(poll, 20);
|
||||||
|
let counter = 0;
|
||||||
|
function poll() {
|
||||||
|
counter++;
|
||||||
|
if (owl.Component.scheduler.tasks.length) {
|
||||||
|
if (counter > 10) {
|
||||||
|
reject(new Error("timeout"));
|
||||||
|
} else {
|
||||||
|
timer = setTimeout(poll);
|
||||||
|
}
|
||||||
|
} else {
|
||||||
|
resolve();
|
||||||
|
}
|
||||||
|
}
|
||||||
|
});
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|||||||
@@ -0,0 +1,52 @@
|
|||||||
|
# 🦉 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.
|
||||||
@@ -0,0 +1,133 @@
|
|||||||
|
# 🦉 Quick Overview 🦉
|
||||||
|
|
||||||
|
Owl components in an application are used to define a (dynamic) tree of components.
|
||||||
|
|
||||||
|
```
|
||||||
|
Root
|
||||||
|
/ \
|
||||||
|
A B
|
||||||
|
/ \
|
||||||
|
C D
|
||||||
|
```
|
||||||
|
|
||||||
|
**State:** each component can manage its own local state. It is a simple ES6
|
||||||
|
class, there are no special rules:
|
||||||
|
|
||||||
|
```js
|
||||||
|
class Counter extends Component {
|
||||||
|
static template = xml`
|
||||||
|
<button t-on-click="increment">
|
||||||
|
Click Me! [<t t-esc="state.value"/>]
|
||||||
|
</button>`;
|
||||||
|
|
||||||
|
state = { value: 0 };
|
||||||
|
|
||||||
|
increment() {
|
||||||
|
this.state.value++;
|
||||||
|
this.render();
|
||||||
|
}
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
The example above shows a component with a local state. Note that since there
|
||||||
|
is nothing magical to the `state` object, we need to manually call the `render`
|
||||||
|
function whenever we update it. This can quickly become annoying (and not
|
||||||
|
efficient if we do it too much). There is a better way: using the `useState`
|
||||||
|
hook, which transforms an object into a reactive version of itself:
|
||||||
|
|
||||||
|
```js
|
||||||
|
const { useState } = owl.hooks;
|
||||||
|
|
||||||
|
class Counter extends Component {
|
||||||
|
static template = xml`
|
||||||
|
<button t-on-click="increment">
|
||||||
|
Click Me! [<t t-esc="state.value"/>]
|
||||||
|
</button>`;
|
||||||
|
|
||||||
|
state = useState({ value: 0 });
|
||||||
|
|
||||||
|
increment() {
|
||||||
|
this.state.value++;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
Note that the `t-on-click` handler can even be replaced by an inline statement:
|
||||||
|
|
||||||
|
```xml
|
||||||
|
<button t-on-click="state.value++">
|
||||||
|
```
|
||||||
|
|
||||||
|
**Props:** sub components often needs some information from their parents. This
|
||||||
|
is done by adding the required information to the template. This will then be
|
||||||
|
accessible by the sub component in the `props` object. Note that there is an
|
||||||
|
important rule here: the information contained in the `props` object is not
|
||||||
|
owned by the sub component, and should never be modified.
|
||||||
|
|
||||||
|
```js
|
||||||
|
class Child extends Component {
|
||||||
|
static template = xml`<div>Hello <t t-esc="props.name"/></div>`;
|
||||||
|
}
|
||||||
|
|
||||||
|
class Parent extends Component {
|
||||||
|
static template = xml`
|
||||||
|
<div>
|
||||||
|
<Child name="'Owl'" />
|
||||||
|
<Child name="'Framework'" />
|
||||||
|
</div>`;
|
||||||
|
static components = { Child };
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
**Communication:** there are multiple ways to communicate information between
|
||||||
|
components. However, the two most important ways are the following:
|
||||||
|
|
||||||
|
- from parent to children: by using `props`,
|
||||||
|
- from a children to one of its parent: by triggering events.
|
||||||
|
|
||||||
|
The following example illustrate both mechanisms:
|
||||||
|
|
||||||
|
```js
|
||||||
|
class OrderLine extends Component {
|
||||||
|
static template = xml`
|
||||||
|
<div t-on-click="add">
|
||||||
|
<div><t t-esc="props.line.name"/></div>
|
||||||
|
<div>Quantity: <t t-esc="props.line.quantity"/></div>
|
||||||
|
</div>`;
|
||||||
|
|
||||||
|
add() {
|
||||||
|
this.trigger("add-to-order", { line: props.line });
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
class Parent extends Component {
|
||||||
|
static template = xml`
|
||||||
|
<div t-on-add-to-order="addToOrder">
|
||||||
|
<OrderLine
|
||||||
|
t-foreach="orders"
|
||||||
|
t-as="line"
|
||||||
|
line="line" />
|
||||||
|
</div>`;
|
||||||
|
static components = { OrderLine };
|
||||||
|
orders = useState([
|
||||||
|
{ id: 1, name: "Coffee", quantity: 0 },
|
||||||
|
{ id: 2, name: "Tea", quantity: 0 },
|
||||||
|
]);
|
||||||
|
|
||||||
|
addToOrder(event) {
|
||||||
|
const line = event.detail.line;
|
||||||
|
line.quantity++;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
In this example, the `OrderLine` component trigger a `add-to-order` event. This
|
||||||
|
will generate a DOM event which will bubble along the DOM tree. It will then be
|
||||||
|
intercepted by the parent component, which will then get the line (from the
|
||||||
|
`detail` key) and then increment its quantity. See the page on [event handling](../reference/event_handling.md)
|
||||||
|
for more details on how events work.
|
||||||
|
|
||||||
|
Note that this example would have also worked if the `OrderLine` component
|
||||||
|
directly modifies the `line` object. However, this is not a good practice: this
|
||||||
|
only works because the `props` object received by the child component is reactive,
|
||||||
|
so the child component is then coupled to the parents implementation.
|
||||||
+52
-40
@@ -36,8 +36,6 @@ hello_owl/
|
|||||||
The file `owl.js` can be downloaded from the last release published at
|
The file `owl.js` can be downloaded from the last release published at
|
||||||
[https://github.com/odoo/owl/releases](https://github.com/odoo/owl/releases). It
|
[https://github.com/odoo/owl/releases](https://github.com/odoo/owl/releases). It
|
||||||
is a single javascript file which export all Owl into the global `owl` object.
|
is a single javascript file which export all Owl into the global `owl` object.
|
||||||
Note that there are multiple files, and in this case, we need one of the two
|
|
||||||
files suffixed with `.iife`: they are built to be directly used in a browser.
|
|
||||||
|
|
||||||
Now, `index.html` should contain the following:
|
Now, `index.html` should contain the following:
|
||||||
|
|
||||||
@@ -47,24 +45,31 @@ Now, `index.html` should contain the following:
|
|||||||
<head>
|
<head>
|
||||||
<title>Hello Owl</title>
|
<title>Hello Owl</title>
|
||||||
<script src="owl.js"></script>
|
<script src="owl.js"></script>
|
||||||
</head>
|
|
||||||
<body>
|
|
||||||
<script src="app.js"></script>
|
<script src="app.js"></script>
|
||||||
</body>
|
</head>
|
||||||
|
<body></body>
|
||||||
</html>
|
</html>
|
||||||
```
|
```
|
||||||
|
|
||||||
And `app.js` should look like this:
|
And `app.js` should look like this:
|
||||||
|
|
||||||
```js
|
```js
|
||||||
const { Component, mount, xml } = owl;
|
const { Component } = owl;
|
||||||
|
const { xml } = owl.tags;
|
||||||
|
const { whenReady } = owl.utils;
|
||||||
|
|
||||||
// Owl Components
|
// Owl Components
|
||||||
class Root extends Component {
|
class App extends Component {
|
||||||
static template = xml`<div>Hello Owl</div>`;
|
static template = xml`<div>Hello Owl</div>`;
|
||||||
}
|
}
|
||||||
|
|
||||||
mount(Root, document.body);
|
// Setup code
|
||||||
|
function setup() {
|
||||||
|
const app = new App();
|
||||||
|
app.mount(document.body);
|
||||||
|
}
|
||||||
|
|
||||||
|
whenReady(setup);
|
||||||
```
|
```
|
||||||
|
|
||||||
Now, simply loading this html file in a browser should display a welcome message.
|
Now, simply loading this html file in a browser should display a welcome message.
|
||||||
@@ -89,16 +94,14 @@ Let us start a new project with the following file structure:
|
|||||||
```
|
```
|
||||||
hello_owl/
|
hello_owl/
|
||||||
src/
|
src/
|
||||||
|
app.js
|
||||||
index.html
|
index.html
|
||||||
main.js
|
main.js
|
||||||
owl.js
|
owl.js
|
||||||
root.js
|
|
||||||
```
|
```
|
||||||
|
|
||||||
As previously, the file `owl.js` can be downloaded from the last release published at
|
As previously, the file `owl.js` can be downloaded from the last release published at
|
||||||
[https://github.com/odoo/owl/releases](https://github.com/odoo/owl/releases).
|
[https://github.com/odoo/owl/releases](https://github.com/odoo/owl/releases).
|
||||||
Note that there are multiple files, and in this case, we need one of the two
|
|
||||||
files suffixed with `.iife`: they are built to be directly used in a browser.
|
|
||||||
|
|
||||||
Now, `index.html` should contain the following:
|
Now, `index.html` should contain the following:
|
||||||
|
|
||||||
@@ -108,33 +111,38 @@ Now, `index.html` should contain the following:
|
|||||||
<head>
|
<head>
|
||||||
<title>Hello Owl</title>
|
<title>Hello Owl</title>
|
||||||
<script src="owl.js"></script>
|
<script src="owl.js"></script>
|
||||||
</head>
|
|
||||||
<body>
|
|
||||||
<script src="main.js" type="module"></script>
|
<script src="main.js" type="module"></script>
|
||||||
</body>
|
</head>
|
||||||
|
<body></body>
|
||||||
</html>
|
</html>
|
||||||
```
|
```
|
||||||
|
|
||||||
Not that the `main.js` script tag has the `type="module"` attribute. This means
|
Not that the `main.js` script tag has the `type="module"` attribute. This means
|
||||||
that the browser will parse the script as a module, and load all its dependencies.
|
that the browser will parse the script as a module, and load all its dependencies.
|
||||||
|
|
||||||
Here is the content of `root.js` and `main.js`:
|
Here is the content of `app.js` and `main.js`:
|
||||||
|
|
||||||
```js
|
```js
|
||||||
// root.js ----------------------------------------------------------------------
|
// app.js ----------------------------------------------------------------------
|
||||||
const { Component, mount, xml } = owl;
|
const { Component } = owl;
|
||||||
|
const { xml } = owl.tags;
|
||||||
|
|
||||||
export class Root extends Component {
|
export class App extends Component {
|
||||||
static template = xml`<div>Hello Owl</div>`;
|
static template = xml`<div>Hello Owl</div>`;
|
||||||
}
|
}
|
||||||
|
|
||||||
// main.js ---------------------------------------------------------------------
|
// main.js ---------------------------------------------------------------------
|
||||||
import { Root } from "./root.js";
|
import { App } from "./app.js";
|
||||||
|
|
||||||
mount(Root, document.body);
|
function setup() {
|
||||||
|
const app = new App();
|
||||||
|
app.mount(document.body);
|
||||||
|
}
|
||||||
|
|
||||||
|
owl.utils.whenReady(setup);
|
||||||
```
|
```
|
||||||
|
|
||||||
The `main.js` file imports the `root.js` file. Note that the import statement has
|
The `main.js` file import the `app.js` file. Note that the import statement has
|
||||||
a `.js` suffix, which is important. Most text editor can understand this syntax
|
a `.js` suffix, which is important. Most text editor can understand this syntax
|
||||||
and will provide autocompletion.
|
and will provide autocompletion.
|
||||||
|
|
||||||
@@ -187,11 +195,11 @@ hello_owl/
|
|||||||
index.html
|
index.html
|
||||||
src/
|
src/
|
||||||
components/
|
components/
|
||||||
Root.js
|
App.js
|
||||||
main.js
|
main.js
|
||||||
tests/
|
tests/
|
||||||
components/
|
components/
|
||||||
Root.test.js
|
App.test.js
|
||||||
helpers.js
|
helpers.js
|
||||||
.gitignore
|
.gitignore
|
||||||
package.json
|
package.json
|
||||||
@@ -218,15 +226,13 @@ Note that there are no `<script>` tag here. They will be injected by webpack.
|
|||||||
Now, let's have a look at the javascript files:
|
Now, let's have a look at the javascript files:
|
||||||
|
|
||||||
```js
|
```js
|
||||||
// src/components/Root.js -------------------------------------------------------
|
// src/components/App.js -------------------------------------------------------
|
||||||
import { Component, xml, useState } from "@odoo/owl";
|
import { Component, tags, useState } from "@odoo/owl";
|
||||||
|
|
||||||
export class Root extends Component {
|
const { xml } = tags;
|
||||||
static template = xml`
|
|
||||||
<div t-on-click="update">
|
|
||||||
Hello <t t-esc="state.text"/>
|
|
||||||
</div>`;
|
|
||||||
|
|
||||||
|
export class App extends Component {
|
||||||
|
static template = xml`<div t-on-click="update">Hello <t t-esc="state.text"/></div>`;
|
||||||
state = useState({ text: "Owl" });
|
state = useState({ text: "Owl" });
|
||||||
update() {
|
update() {
|
||||||
this.state.text = this.state.text === "Owl" ? "World" : "Owl";
|
this.state.text = this.state.text === "Owl" ? "World" : "Owl";
|
||||||
@@ -234,15 +240,19 @@ export class Root extends Component {
|
|||||||
}
|
}
|
||||||
|
|
||||||
// src/main.js -----------------------------------------------------------------
|
// src/main.js -----------------------------------------------------------------
|
||||||
import { utils, mount } from "@odoo/owl";
|
import { utils } from "@odoo/owl";
|
||||||
import { Root } from "./components/Root";
|
import { App } from "./components/App";
|
||||||
|
|
||||||
mount(Root, document.body);
|
function setup() {
|
||||||
|
const app = new App();
|
||||||
|
app.mount(document.body);
|
||||||
|
}
|
||||||
|
|
||||||
// tests/components/Root.test.js ------------------------------------------------
|
utils.whenReady(setup);
|
||||||
import { Root } from "../../src/components/Root";
|
|
||||||
|
// tests/components/App.test.js ------------------------------------------------
|
||||||
|
import { App } from "../../src/components/App";
|
||||||
import { makeTestFixture, nextTick, click } from "../helpers";
|
import { makeTestFixture, nextTick, click } from "../helpers";
|
||||||
import { mount } from "@odoo/owl";
|
|
||||||
|
|
||||||
let fixture;
|
let fixture;
|
||||||
|
|
||||||
@@ -254,9 +264,10 @@ afterEach(() => {
|
|||||||
fixture.remove();
|
fixture.remove();
|
||||||
});
|
});
|
||||||
|
|
||||||
describe("Root", () => {
|
describe("App", () => {
|
||||||
test("Works as expected...", async () => {
|
test("Works as expected...", async () => {
|
||||||
await mount(Root, fixture);
|
const app = new App();
|
||||||
|
await app.mount(fixture);
|
||||||
expect(fixture.innerHTML).toBe("<div>Hello Owl</div>");
|
expect(fixture.innerHTML).toBe("<div>Hello Owl</div>");
|
||||||
|
|
||||||
click(fixture, "div");
|
click(fixture, "div");
|
||||||
@@ -270,8 +281,9 @@ import { Component } from "@odoo/owl";
|
|||||||
import "regenerator-runtime/runtime";
|
import "regenerator-runtime/runtime";
|
||||||
|
|
||||||
export async function nextTick() {
|
export async function nextTick() {
|
||||||
await new Promise((resolve) => setTimeout(resolve));
|
return new Promise(function (resolve) {
|
||||||
await new Promise((resolve) => requestAnimationFrame(resolve));
|
setTimeout(() => Component.scheduler.requestAnimationFrame(() => resolve()));
|
||||||
|
});
|
||||||
}
|
}
|
||||||
|
|
||||||
export function makeTestFixture() {
|
export function makeTestFixture() {
|
||||||
|
|||||||
+329
-296
@@ -50,11 +50,10 @@ the following content:
|
|||||||
<meta charset="UTF-8" />
|
<meta charset="UTF-8" />
|
||||||
<title>OWL Todo App</title>
|
<title>OWL Todo App</title>
|
||||||
<link rel="stylesheet" href="app.css" />
|
<link rel="stylesheet" href="app.css" />
|
||||||
</head>
|
|
||||||
<body>
|
|
||||||
<script src="owl.js"></script>
|
<script src="owl.js"></script>
|
||||||
<script src="app.js"></script>
|
<script src="app.js"></script>
|
||||||
</body>
|
</head>
|
||||||
|
<body></body>
|
||||||
</html>
|
</html>
|
||||||
```
|
```
|
||||||
|
|
||||||
@@ -72,34 +71,45 @@ Note that we put everything inside an immediately executed function to avoid lea
|
|||||||
anything to the global scope.
|
anything to the global scope.
|
||||||
|
|
||||||
Finally, `owl.js` should be the last version downloaded from the Owl repository (you can use `owl.min.js` if you prefer). Be aware that you should download the `owl.iife.js` or `owl.iife.min.js`, because these files
|
Finally, `owl.js` should be the last version downloaded from the Owl repository (you can use `owl.min.js` if you prefer). Be aware that you should download the `owl.iife.js` or `owl.iife.min.js`, because these files
|
||||||
are built to run directly on the browser, and rename it `owl.js` (other files such as `owl.cjs.js` are
|
are built to run directly on the browser (other files such as `owl.cjs.js` are
|
||||||
built to be bundled by other tools).
|
built to be bundled by other tools).
|
||||||
|
|
||||||
Now, the project should be ready. Loading the `index.html` file into a browser
|
Now, the project should be ready. Loading the `index.html` file into a browser
|
||||||
should show an empty page, with the title `Owl Todo App`, and it should log a
|
should show an empty page, with the title `Owl Todo App`, and it should log a
|
||||||
message such as `hello owl 2.x.y` in the console.
|
message such as `hello owl 1.0.0` in the console.
|
||||||
|
|
||||||
## 2. Adding a first component
|
## 2. Adding a first component
|
||||||
|
|
||||||
An Owl application is made out of [components](../reference/component.md), with
|
An Owl application is made out of [components](../reference/component.md), with
|
||||||
a single root component. Let us start by defining a `Root` component. Replace the
|
a single root component. Let us start by defining an `App` component. Replace the
|
||||||
content of the function in `app.js` by the following code:
|
content of the function in `app.js` by the following code:
|
||||||
|
|
||||||
```js
|
```js
|
||||||
const { Component, mount, xml } = owl;
|
const { Component } = owl;
|
||||||
|
const { xml } = owl.tags;
|
||||||
|
const { whenReady } = owl.utils;
|
||||||
|
|
||||||
// Owl Components
|
// Owl Components
|
||||||
class Root extends Component {
|
class App extends Component {
|
||||||
static template = xml`<div>todo app</div>`;
|
static template = xml`<div>todo app</div>`;
|
||||||
}
|
}
|
||||||
|
|
||||||
mount(Root, document.body);
|
// Setup code
|
||||||
|
function setup() {
|
||||||
|
const app = new App();
|
||||||
|
app.mount(document.body);
|
||||||
|
}
|
||||||
|
|
||||||
|
whenReady(setup);
|
||||||
```
|
```
|
||||||
|
|
||||||
Now, reloading the page in a browser should display a message.
|
Now, reloading the page in a browser should display a message.
|
||||||
|
|
||||||
The code is pretty simple: we define a component with an inline template, then
|
The code is pretty simple, but let us explain the last line in more detail. The
|
||||||
mount it in the document body.
|
browser tries to execute the javascript code in `app.js` as quickly as possible,
|
||||||
|
and it could happen that the DOM is not ready yet when we try to mount the `App`
|
||||||
|
component. To avoid this situation, we use the [`whenReady`](../reference/utils.md#whenready)
|
||||||
|
helper to delay the execution of the `setup` function until the DOM is ready.
|
||||||
|
|
||||||
Note 1: in a larger project, we would split the code in multiple files, with
|
Note 1: in a larger project, we would split the code in multiple files, with
|
||||||
components in a sub folder, and a main file that would initialize the application.
|
components in a sub folder, and a main file that would initialize the application.
|
||||||
@@ -116,7 +126,7 @@ class App extends Component {}
|
|||||||
App.template = xml`<div>todo app</div>`;
|
App.template = xml`<div>todo app</div>`;
|
||||||
```
|
```
|
||||||
|
|
||||||
Note 3: writing inline templates with the [`xml` helper](../reference/templates.md#inline-templates)
|
Note 3: writing inline templates with the [`xml` helper](../reference/tags.md#xml-tag)
|
||||||
is nice, but there is no syntax highlighting, and this makes it very easy to
|
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.
|
have malformed xml. Some editors support syntax highlighting for this situation.
|
||||||
For example, VS Code has an addon `Comment tagged template`, which, if installed,
|
For example, VS Code has an addon `Comment tagged template`, which, if installed,
|
||||||
@@ -140,20 +150,20 @@ with the following keys:
|
|||||||
tasks. Since the title is something created/edited by the user, it offers
|
tasks. Since the title is something created/edited by the user, it offers
|
||||||
no guarantee that it is unique. So, we will generate a unique `id` number for
|
no guarantee that it is unique. So, we will generate a unique `id` number for
|
||||||
each task.
|
each task.
|
||||||
- `text`: a string, to explain what the task is about.
|
- `title`: a string, to explain what the task is about.
|
||||||
- `isCompleted`: a boolean, to keep track of the status of the task
|
- `isCompleted`: a boolean, to keep track of the status of the task
|
||||||
|
|
||||||
Now that we decided on the internal format of the state, let us add some demo
|
Now that we decided on the internal format of the state, let us add some demo
|
||||||
data and a template to the `App` component:
|
data and a template to the `App` component:
|
||||||
|
|
||||||
```js
|
```js
|
||||||
class Root extends Component {
|
class App extends Component {
|
||||||
static template = xml/* xml */ `
|
static template = xml/* xml */ `
|
||||||
<div class="task-list">
|
<div class="task-list">
|
||||||
<t t-foreach="tasks" t-as="task" t-key="task.id">
|
<t t-foreach="tasks" t-as="task" t-key="task.id">
|
||||||
<div class="task">
|
<div class="task">
|
||||||
<input type="checkbox" t-att-checked="task.isCompleted"/>
|
<input type="checkbox" t-att-checked="task.isCompleted"/>
|
||||||
<span><t t-esc="task.text"/></span>
|
<span><t t-esc="task.title"/></span>
|
||||||
</div>
|
</div>
|
||||||
</t>
|
</t>
|
||||||
</div>`;
|
</div>`;
|
||||||
@@ -161,26 +171,26 @@ class Root extends Component {
|
|||||||
tasks = [
|
tasks = [
|
||||||
{
|
{
|
||||||
id: 1,
|
id: 1,
|
||||||
text: "buy milk",
|
title: "buy milk",
|
||||||
isCompleted: true,
|
isCompleted: true,
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
id: 2,
|
id: 2,
|
||||||
text: "clean house",
|
title: "clean house",
|
||||||
isCompleted: false,
|
isCompleted: false,
|
||||||
},
|
},
|
||||||
];
|
];
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
The template contains a [`t-foreach`](../reference/templates.md#loops) loop to iterate
|
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
|
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
|
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`,
|
`t-key`, which is very common. There are two css classes: `task-list` and `task`,
|
||||||
that we will use in the next section.
|
that we will use in the next section.
|
||||||
|
|
||||||
Finally, notice the use of the `t-att-checked` attribute:
|
Finally, notice the use of the `t-att-checked` attribute:
|
||||||
prefixing an attribute by [`t-att`](../reference/templates.md#dynamic-attributes) makes
|
prefixing an attribute by [`t-att`](../reference/qweb_templating_language.md#dynamic-attributes) makes
|
||||||
it dynamic. Owl will evaluate the expression and set it as the value of the
|
it dynamic. Owl will evaluate the expression and set it as the value of the
|
||||||
attribute.
|
attribute.
|
||||||
|
|
||||||
@@ -236,25 +246,29 @@ a little bit:
|
|||||||
// -------------------------------------------------------------------------
|
// -------------------------------------------------------------------------
|
||||||
// Task Component
|
// Task Component
|
||||||
// -------------------------------------------------------------------------
|
// -------------------------------------------------------------------------
|
||||||
class Task extends Component {
|
const TASK_TEMPLATE = xml /* xml */`
|
||||||
static template = xml /* xml */`
|
|
||||||
<div class="task" t-att-class="props.task.isCompleted ? 'done' : ''">
|
<div class="task" t-att-class="props.task.isCompleted ? 'done' : ''">
|
||||||
<input type="checkbox" t-att-checked="props.task.isCompleted"/>
|
<input type="checkbox" t-att-checked="props.task.isCompleted"/>
|
||||||
<span><t t-esc="props.task.text"/></span>
|
<span><t t-esc="props.task.title"/></span>
|
||||||
</div>`;
|
</div>`;
|
||||||
static props = ["task"];
|
|
||||||
|
class Task extends Component {
|
||||||
|
static template = TASK_TEMPLATE;
|
||||||
|
static props = ["task"];
|
||||||
}
|
}
|
||||||
|
|
||||||
// -------------------------------------------------------------------------
|
// -------------------------------------------------------------------------
|
||||||
// Root Component
|
// App Component
|
||||||
// -------------------------------------------------------------------------
|
// -------------------------------------------------------------------------
|
||||||
class Root extends Component {
|
const APP_TEMPLATE = xml /* xml */`
|
||||||
static template = xml /* xml */`
|
|
||||||
<div class="task-list">
|
<div class="task-list">
|
||||||
<t t-foreach="tasks" t-as="task" t-key="task.id">
|
<t t-foreach="tasks" t-as="task" t-key="task.id">
|
||||||
<Task task="task"/>
|
<Task task="task"/>
|
||||||
</t>
|
</t>
|
||||||
</div>`;
|
</div>`;
|
||||||
|
|
||||||
|
class App extends Component {
|
||||||
|
static template = APP_TEMPLATE;
|
||||||
static components = { Task };
|
static components = { Task };
|
||||||
|
|
||||||
tasks = [
|
tasks = [
|
||||||
@@ -263,9 +277,15 @@ class Root extends Component {
|
|||||||
}
|
}
|
||||||
|
|
||||||
// -------------------------------------------------------------------------
|
// -------------------------------------------------------------------------
|
||||||
// Setup
|
// Setup code
|
||||||
// -------------------------------------------------------------------------
|
// -------------------------------------------------------------------------
|
||||||
mount(Root, document.body, {dev: true});
|
function setup() {
|
||||||
|
owl.config.mode = "dev";
|
||||||
|
const app = new App();
|
||||||
|
app.mount(document.body);
|
||||||
|
}
|
||||||
|
|
||||||
|
whenReady(setup);
|
||||||
```
|
```
|
||||||
|
|
||||||
A lot of stuff happened here:
|
A lot of stuff happened here:
|
||||||
@@ -274,22 +294,24 @@ A lot of stuff happened here:
|
|||||||
- whenever we define a sub component, it needs to be added to the static
|
- whenever we define a sub component, it needs to be added to the static
|
||||||
[`components`](../reference/component.md#static-properties)
|
[`components`](../reference/component.md#static-properties)
|
||||||
key of its parent, so Owl can get a reference to it,
|
key of its parent, so Owl can get a reference to it,
|
||||||
|
- the templates have been extracted out of the components, to make it easier to
|
||||||
|
differentiate the "view/template" code from the "script/behavior" code,
|
||||||
- the `Task` component has a `props` key: this is only useful for validation
|
- 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
|
purpose. It says that each `Task` should be given exactly one prop, named
|
||||||
`task`. If this is not the case, Owl will throw an
|
`task`. If this is not the case, Owl will throw an
|
||||||
[error](../reference/props.md#props-validation). This is extremely
|
[error](../reference/props_validation.md). This is extremely
|
||||||
useful when refactoring components
|
useful when refactoring components
|
||||||
- finally, to activate the props validation, we need to set Owl's
|
- finally, to activate the props validation, we need to set Owl's
|
||||||
[mode](../reference/app.md#configuration) to `dev`. This is done in the last argument
|
[mode](../reference/config.md#mode) to `dev`. This is done in the `setup`
|
||||||
of the `mount` function. Note that this should be removed when an app is used in a real
|
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
|
production environment, since `dev` mode is slightly slower, due to extra
|
||||||
checks and validations.
|
checks and validations.
|
||||||
|
|
||||||
## 6. Adding tasks (part 1)
|
## 6. Adding tasks (part 1)
|
||||||
|
|
||||||
We still use a list of hardcoded tasks. It's really time to give the user a way
|
We still use a list of hardcoded tasks. It's really time to give the user a way
|
||||||
to add tasks himself. The first step is to add an input to the `Root` component.
|
to add tasks himself. The first step is to add an input to the `App` component.
|
||||||
But this input will be outside of the task list, so we need to adapt `Root`
|
But this input will be outside of the task list, so we need to adapt `App`
|
||||||
template, js, and css:
|
template, js, and css:
|
||||||
|
|
||||||
```xml
|
```xml
|
||||||
@@ -307,9 +329,9 @@ template, js, and css:
|
|||||||
addTask(ev) {
|
addTask(ev) {
|
||||||
// 13 is keycode for ENTER
|
// 13 is keycode for ENTER
|
||||||
if (ev.keyCode === 13) {
|
if (ev.keyCode === 13) {
|
||||||
const text = ev.target.value.trim();
|
const title = ev.target.value.trim();
|
||||||
ev.target.value = "";
|
ev.target.value = "";
|
||||||
console.log('adding task', text);
|
console.log('adding task', title);
|
||||||
// todo
|
// todo
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
@@ -338,9 +360,10 @@ task. Notice that when you load the page, the input is not focused. But adding
|
|||||||
tasks is a core feature of a task list, so let us make it as fast as possible by
|
tasks is a core feature of a task list, so let us make it as fast as possible by
|
||||||
focusing the input.
|
focusing the input.
|
||||||
|
|
||||||
We need to execute code when the `Root` component is ready (mounted). Let's do
|
Since `App` is a component, it has a
|
||||||
that using the `onMounted` hook. We will also need to get a reference to the
|
[`mounted` lifecycle method](../reference/component.md#lifecycle) that we can
|
||||||
input, by using the `t-ref` directive with the [`useRef`](../reference/hooks.md#useref) hook:
|
implement. We will also need to get a reference to the input, by using the
|
||||||
|
`t-ref` directive with the [`useRef`](../reference/hooks.md#useref) hook:
|
||||||
|
|
||||||
```xml
|
```xml
|
||||||
<input placeholder="Enter a new task" t-on-keyup="addTask" t-ref="add-input"/>
|
<input placeholder="Enter a new task" t-on-keyup="addTask" t-ref="add-input"/>
|
||||||
@@ -348,21 +371,22 @@ input, by using the `t-ref` directive with the [`useRef`](../reference/hooks.md#
|
|||||||
|
|
||||||
```js
|
```js
|
||||||
// on top of file:
|
// on top of file:
|
||||||
const { Component, mount, xml, useRef, onMounted } = owl;
|
const { useRef } = owl.hooks;
|
||||||
```
|
```
|
||||||
|
|
||||||
```js
|
```js
|
||||||
// in App
|
// in App
|
||||||
setup() {
|
inputRef = useRef("add-input");
|
||||||
const inputRef = useRef("add-input");
|
|
||||||
onMounted(() => inputRef.el.focus());
|
mounted() {
|
||||||
|
this.inputRef.el.focus();
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
This is a very common situation: whenever we need to perform some actions depending
|
The `inputRef` is defined as a class field, so it is equivalent to defining it
|
||||||
on the lifecycle of a component, we need to do it in the `setup` method, by using
|
in the constructor. It simply instructs Owl to keep a reference to anything with
|
||||||
one of the lifecycle hook. Here, we first get a reference to the `inputRef`,
|
the corresponding `t-ref` keyword. We then implement the `mounted` lifecycle
|
||||||
then in the `onMounted` hook, we simply focus the html element.
|
method, where we now have an active reference that we can use to focus the input.
|
||||||
|
|
||||||
## 7. Adding tasks (part 2)
|
## 7. Adding tasks (part 2)
|
||||||
|
|
||||||
@@ -383,12 +407,12 @@ Now, the `addTask` method can be implemented:
|
|||||||
addTask(ev) {
|
addTask(ev) {
|
||||||
// 13 is keycode for ENTER
|
// 13 is keycode for ENTER
|
||||||
if (ev.keyCode === 13) {
|
if (ev.keyCode === 13) {
|
||||||
const text = ev.target.value.trim();
|
const title = ev.target.value.trim();
|
||||||
ev.target.value = "";
|
ev.target.value = "";
|
||||||
if (text) {
|
if (title) {
|
||||||
const newTask = {
|
const newTask = {
|
||||||
id: this.nextId++,
|
id: this.nextId++,
|
||||||
text: text,
|
title: title,
|
||||||
isCompleted: false,
|
isCompleted: false,
|
||||||
};
|
};
|
||||||
this.tasks.push(newTask);
|
this.tasks.push(newTask);
|
||||||
@@ -406,7 +430,7 @@ the user interface. We can fix the issue by making `tasks` reactive, with the
|
|||||||
|
|
||||||
```js
|
```js
|
||||||
// on top of the file
|
// on top of the file
|
||||||
const { Component, mount, xml, useRef, onMounted, useState } = owl;
|
const { useRef, useState } = owl.hooks;
|
||||||
|
|
||||||
// replace the task definition in App with the following:
|
// replace the task definition in App with the following:
|
||||||
tasks = useState([]);
|
tasks = useState([]);
|
||||||
@@ -421,8 +445,12 @@ did not change in opacity. This is because there is no code to modify the
|
|||||||
`isCompleted` flag.
|
`isCompleted` flag.
|
||||||
|
|
||||||
Now, this is an interesting situation: the task is displayed by the `Task`
|
Now, this is an interesting situation: the task is displayed by the `Task`
|
||||||
component, but it is not the owner of its state, so ideally, it should not modify it.
|
component, but it is not the owner of its state, so it cannot modify it. Instead,
|
||||||
However, for now, that's what we will do (this will be improved in a later step).
|
we want to communicate the request to toggle a task to the `App` component.
|
||||||
|
Since `App` is a parent of `Task`, we can
|
||||||
|
[trigger](../reference/event_handling.md) an event in `Task` and listen
|
||||||
|
for it in `App`.
|
||||||
|
|
||||||
In `Task`, change the `input` to:
|
In `Task`, change the `input` to:
|
||||||
|
|
||||||
```xml
|
```xml
|
||||||
@@ -433,23 +461,36 @@ and add the `toggleTask` method:
|
|||||||
|
|
||||||
```js
|
```js
|
||||||
toggleTask() {
|
toggleTask() {
|
||||||
this.props.task.isCompleted = !this.props.task.isCompleted;
|
this.trigger('toggle-task', {id: this.props.task.id});
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
We now need to listen for that event in the `App` template:
|
||||||
|
|
||||||
|
```xml
|
||||||
|
<div class="task-list" t-on-toggle-task="toggleTask">
|
||||||
|
```
|
||||||
|
|
||||||
|
and implement the `toggleTask` code:
|
||||||
|
|
||||||
|
```js
|
||||||
|
toggleTask(ev) {
|
||||||
|
const task = this.tasks.find(t => t.id === ev.detail.id);
|
||||||
|
task.isCompleted = !task.isCompleted;
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
## 9. Deleting tasks
|
## 9. Deleting tasks
|
||||||
|
|
||||||
Let us now add the possibility do delete tasks. This is different from the previous
|
Let us now add the possibility do delete tasks. To do that, we first need to add
|
||||||
feature: deleting task has to be done on the task itself, but the actual operation
|
a trash icon on each task, then we will proceed just like in the previous section.
|
||||||
need to be done on the task list. So, we need to communicate the request to the
|
|
||||||
`Root` component. This is usually done by providing a callback in a prop.
|
|
||||||
|
|
||||||
First, let us update the `Task` template, css and js:
|
First, let us update the `Task` template, css and js:
|
||||||
|
|
||||||
```xml
|
```xml
|
||||||
<div class="task" t-att-class="props.task.isCompleted ? 'done' : ''">
|
<div class="task" t-att-class="props.task.isCompleted ? 'done' : ''">
|
||||||
<input type="checkbox" t-att-checked="props.task.isCompleted" t-on-click="toggleTask"/>
|
<input type="checkbox" t-att-checked="props.task.isCompleted" t-on-click="toggleTask"/>
|
||||||
<span><t t-esc="props.task.text"/></span>
|
<span><t t-esc="props.task.title"/></span>
|
||||||
<span class="delete" t-on-click="deleteTask">🗑</span>
|
<span class="delete" t-on-click="deleteTask">🗑</span>
|
||||||
</div>
|
</div>
|
||||||
```
|
```
|
||||||
@@ -478,226 +519,220 @@ First, let us update the `Task` template, css and js:
|
|||||||
```
|
```
|
||||||
|
|
||||||
```js
|
```js
|
||||||
static props = ["task", "onDelete"];
|
|
||||||
|
|
||||||
deleteTask() {
|
deleteTask() {
|
||||||
this.props.onDelete(this.props.task);
|
this.trigger('delete-task', {id: this.props.task.id});
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
And now, we need to provide the `onDelete` callback to each tasks in the `Root`
|
And now, we need to listen to the `delete-task` event in `App`:
|
||||||
component:
|
|
||||||
|
|
||||||
```xml
|
```xml
|
||||||
<Task task="task" onDelete.bind="deleteTask"/>
|
<div class="task-list" t-on-toggle-task="toggleTask" t-on-delete-task="deleteTask">
|
||||||
```
|
```
|
||||||
|
|
||||||
```js
|
```js
|
||||||
deleteTask(task) {
|
deleteTask(ev) {
|
||||||
const index = this.tasks.findIndex(t => t.id === task.id);
|
const index = this.tasks.findIndex(t => t.id === ev.detail.id);
|
||||||
this.tasks.splice(index, 1);
|
this.tasks.splice(index, 1);
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
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.
|
|
||||||
|
|
||||||
## 10. Using a store
|
## 10. Using a store
|
||||||
|
|
||||||
Looking at the code, it is apparent that all the code handling tasks is scattered
|
Looking at the code, it is apparent that we now have code to handle tasks
|
||||||
all around the application. Also, it mixes UI code and business logic
|
scattered in more than one place. Also, it mixes UI code and business logic
|
||||||
code. Owl does not provide any high level abstraction to manage business logic,
|
code. Owl has a way to manage state separately from the user interface: a
|
||||||
but it is easy to do it with the basic reactivity primitives (`useState` and `reactive`).
|
[`Store`](../reference/store.md).
|
||||||
|
|
||||||
Let us use it in our application to implement a central store. This is a pretty
|
Let us use it in our application. This is a pretty large refactoring (for our
|
||||||
large refactoring (for our application), since it involves extracting all task
|
application), since it involves extracting all task related code out of the
|
||||||
related code out of the components. Here is the new content of the `app.js` file:
|
components. Here is the new content of the `app.js` file:
|
||||||
|
|
||||||
```js
|
```js
|
||||||
const { Component, mount, xml, useRef, onMounted, useState, reactive, useEnv } = owl;
|
const { Component, Store } = owl;
|
||||||
|
const { xml } = owl.tags;
|
||||||
|
const { whenReady } = owl.utils;
|
||||||
|
const { useRef, useDispatch, useStore } = owl.hooks;
|
||||||
|
|
||||||
// -------------------------------------------------------------------------
|
// -------------------------------------------------------------------------
|
||||||
// Store
|
// Store
|
||||||
// -------------------------------------------------------------------------
|
// -------------------------------------------------------------------------
|
||||||
function useStore() {
|
const actions = {
|
||||||
const env = useEnv();
|
addTask({ state }, title) {
|
||||||
return useState(env.store);
|
title = title.trim();
|
||||||
}
|
if (title) {
|
||||||
|
|
||||||
// -------------------------------------------------------------------------
|
|
||||||
// TaskList
|
|
||||||
// -------------------------------------------------------------------------
|
|
||||||
class TaskList {
|
|
||||||
nextId = 1;
|
|
||||||
tasks = [];
|
|
||||||
|
|
||||||
addTask(text) {
|
|
||||||
text = text.trim();
|
|
||||||
if (text) {
|
|
||||||
const task = {
|
const task = {
|
||||||
id: this.nextId++,
|
id: state.nextId++,
|
||||||
text: text,
|
title: title,
|
||||||
isCompleted: false,
|
isCompleted: false,
|
||||||
};
|
};
|
||||||
this.tasks.push(task);
|
state.tasks.push(task);
|
||||||
}
|
}
|
||||||
}
|
},
|
||||||
|
toggleTask({ state }, id) {
|
||||||
toggleTask(task) {
|
const task = state.tasks.find((t) => t.id === id);
|
||||||
task.isCompleted = !task.isCompleted;
|
task.isCompleted = !task.isCompleted;
|
||||||
}
|
},
|
||||||
|
deleteTask({ state }, id) {
|
||||||
deleteTask(task) {
|
const index = state.tasks.findIndex((t) => t.id === id);
|
||||||
const index = this.tasks.findIndex((t) => t.id === task.id);
|
state.tasks.splice(index, 1);
|
||||||
this.tasks.splice(index, 1);
|
},
|
||||||
}
|
};
|
||||||
}
|
const initialState = {
|
||||||
|
nextId: 1,
|
||||||
function createTaskStore() {
|
tasks: [],
|
||||||
return reactive(new TaskList());
|
};
|
||||||
}
|
|
||||||
|
|
||||||
// -------------------------------------------------------------------------
|
// -------------------------------------------------------------------------
|
||||||
// Task Component
|
// Task Component
|
||||||
// -------------------------------------------------------------------------
|
// -------------------------------------------------------------------------
|
||||||
class Task extends Component {
|
const TASK_TEMPLATE = xml/* xml */ `
|
||||||
static template = xml/* xml */ `
|
|
||||||
<div class="task" t-att-class="props.task.isCompleted ? 'done' : ''">
|
<div class="task" t-att-class="props.task.isCompleted ? 'done' : ''">
|
||||||
<input type="checkbox" t-att-checked="props.task.isCompleted" t-on-click="() => store.toggleTask(props.task)"/>
|
<input type="checkbox" t-att-checked="props.task.isCompleted"
|
||||||
<span><t t-esc="props.task.text"/></span>
|
t-on-click="dispatch('toggleTask', props.task.id)"/>
|
||||||
<span class="delete" t-on-click="() => store.deleteTask(props.task)">🗑</span>
|
<span><t t-esc="props.task.title"/></span>
|
||||||
|
<span class="delete" t-on-click="dispatch('deleteTask', props.task.id)">🗑</span>
|
||||||
</div>`;
|
</div>`;
|
||||||
|
|
||||||
|
class Task extends Component {
|
||||||
|
static template = TASK_TEMPLATE;
|
||||||
static props = ["task"];
|
static props = ["task"];
|
||||||
|
dispatch = useDispatch();
|
||||||
setup() {
|
|
||||||
this.store = useStore();
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
|
|
||||||
// -------------------------------------------------------------------------
|
// -------------------------------------------------------------------------
|
||||||
// Root Component
|
// App Component
|
||||||
// -------------------------------------------------------------------------
|
// -------------------------------------------------------------------------
|
||||||
class Root extends Component {
|
const APP_TEMPLATE = xml/* xml */ `
|
||||||
static template = xml/* xml */ `
|
|
||||||
<div class="todo-app">
|
<div class="todo-app">
|
||||||
<input placeholder="Enter a new task" t-on-keyup="addTask" t-ref="add-input"/>
|
<input placeholder="Enter a new task" t-on-keyup="addTask" t-ref="add-input"/>
|
||||||
<div class="task-list">
|
<div class="task-list">
|
||||||
<t t-foreach="store.tasks" t-as="task" t-key="task.id">
|
<t t-foreach="tasks" t-as="task" t-key="task.id">
|
||||||
<Task task="task"/>
|
<Task task="task"/>
|
||||||
</t>
|
</t>
|
||||||
</div>
|
</div>
|
||||||
</div>`;
|
</div>`;
|
||||||
|
|
||||||
|
class App extends Component {
|
||||||
|
static template = APP_TEMPLATE;
|
||||||
static components = { Task };
|
static components = { Task };
|
||||||
|
|
||||||
setup() {
|
inputRef = useRef("add-input");
|
||||||
const inputRef = useRef("add-input");
|
tasks = useStore((state) => state.tasks);
|
||||||
onMounted(() => inputRef.el.focus());
|
dispatch = useDispatch();
|
||||||
this.store = useStore();
|
|
||||||
|
mounted() {
|
||||||
|
this.inputRef.el.focus();
|
||||||
}
|
}
|
||||||
|
|
||||||
addTask(ev) {
|
addTask(ev) {
|
||||||
// 13 is keycode for ENTER
|
// 13 is keycode for ENTER
|
||||||
if (ev.keyCode === 13) {
|
if (ev.keyCode === 13) {
|
||||||
this.store.addTask(ev.target.value);
|
this.dispatch("addTask", ev.target.value);
|
||||||
ev.target.value = "";
|
ev.target.value = "";
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
// -------------------------------------------------------------------------
|
// -------------------------------------------------------------------------
|
||||||
// Setup
|
// Setup code
|
||||||
// -------------------------------------------------------------------------
|
// -------------------------------------------------------------------------
|
||||||
const env = {
|
function setup() {
|
||||||
store: createTaskStore(),
|
owl.config.mode = "dev";
|
||||||
};
|
const store = new Store({ actions, state: initialState });
|
||||||
mount(Root, document.body, { dev: true, env });
|
App.env.store = store;
|
||||||
|
const app = new App();
|
||||||
|
app.mount(document.body);
|
||||||
|
}
|
||||||
|
|
||||||
|
whenReady(setup);
|
||||||
```
|
```
|
||||||
|
|
||||||
## 11. Saving tasks in local storage
|
## 11-Saving tasks in local storage
|
||||||
|
|
||||||
Now, our TodoApp works great, except if the user closes or refresh the browser!
|
Now, our TodoApp works great, except if the user closes or refresh the browser!
|
||||||
It is really inconvenient to only keep the state of the application in memory.
|
It is really inconvenient to only keep the state of the application in memory.
|
||||||
To fix this, we will save the tasks in the local storage. With our current
|
To fix this, we will save the tasks in the local storage. With our current
|
||||||
codebase, it is a simple change: we need to save tasks to local storage and
|
codebase, it is a simple change: only the setup code needs to be updated.
|
||||||
listen to any change.
|
|
||||||
|
|
||||||
```js
|
```js
|
||||||
class TaskList {
|
function makeStore() {
|
||||||
constructor(tasks) {
|
const localState = window.localStorage.getItem("todoapp");
|
||||||
this.tasks = tasks || [];
|
const state = localState ? JSON.parse(localState) : initialState;
|
||||||
const taskIds = this.tasks.map((t) => t.id);
|
const store = new Store({ state, actions });
|
||||||
this.nextId = taskIds.length ? Math.max(...taskIds) + 1 : 1;
|
store.on("update", null, () => {
|
||||||
}
|
localStorage.setItem("todoapp", JSON.stringify(store.state));
|
||||||
// ...
|
});
|
||||||
|
return store;
|
||||||
}
|
}
|
||||||
|
|
||||||
function createTaskStore() {
|
function setup() {
|
||||||
const saveTasks = () => localStorage.setItem("todoapp", JSON.stringify(taskStore.tasks));
|
owl.config.mode = "dev";
|
||||||
const initialTasks = JSON.parse(localStorage.getItem("todoapp") || "[]");
|
App.env.store = makeStore();
|
||||||
const taskStore = reactive(new TaskList(initialTasks), saveTasks);
|
const app = new App();
|
||||||
saveTasks();
|
app.mount(document.body);
|
||||||
return taskStore;
|
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
The key point is that the `reactive` function takes a callback that will be called
|
The key point is to use the fact that the store is an
|
||||||
every time an observed value is changed. Note that we need to call the `saveTasks`
|
[`EventBus`](../reference/event_bus.md) which triggers an `update` event
|
||||||
method initially to make sure we observe all current values.
|
whenever it is updated.
|
||||||
|
|
||||||
## 12. Filtering tasks
|
## 12. Filtering tasks
|
||||||
|
|
||||||
We are almost done, we can add/update/delete tasks. The only missing feature is
|
We are almost done, we can add/update/delete tasks. The only missing feature is
|
||||||
the possibility to display the task according to their completed status. We will
|
the possibility to display the task according to their completed status. We will
|
||||||
need to keep track of the state of the filter in `Root`, then filter the visible
|
need to keep track of the state of the filter in `App`, then filter the visible
|
||||||
tasks according to its value.
|
tasks according to its value.
|
||||||
|
|
||||||
```js
|
```js
|
||||||
class Root extends Component {
|
// on top of file, readd useState:
|
||||||
static template = xml /* xml */`
|
const { useRef, useDispatch, useState, useStore } = owl.hooks;
|
||||||
<div class="todo-app">
|
|
||||||
<input placeholder="Enter a new task" t-on-keyup="addTask" t-ref="add-input"/>
|
// in App:
|
||||||
<div class="task-list">
|
filter = useState({value: "all"})
|
||||||
|
|
||||||
|
get displayedTasks() {
|
||||||
|
switch (this.filter.value) {
|
||||||
|
case "active": return this.tasks.filter(t => !t.isCompleted);
|
||||||
|
case "completed": return this.tasks.filter(t => t.isCompleted);
|
||||||
|
case "all": return this.tasks;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
setFilter(filter) {
|
||||||
|
this.filter.value = filter;
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
Finally, we need to display the visible filters. We can do that, and at the
|
||||||
|
same time, display the number of tasks in a small panel below the main list:
|
||||||
|
|
||||||
|
```xml
|
||||||
|
<div class="todo-app">
|
||||||
|
<input placeholder="Enter a new task" t-on-keyup="addTask" t-ref="add-input"/>
|
||||||
|
<div class="task-list">
|
||||||
<t t-foreach="displayedTasks" t-as="task" t-key="task.id">
|
<t t-foreach="displayedTasks" t-as="task" t-key="task.id">
|
||||||
<Task task="task"/>
|
<Task task="task"/>
|
||||||
</t>
|
</t>
|
||||||
</div>
|
</div>
|
||||||
<div class="task-panel" t-if="store.tasks.length">
|
<div class="task-panel" t-if="tasks.length">
|
||||||
<div class="task-counter">
|
<div class="task-counter">
|
||||||
<t t-esc="displayedTasks.length"/>
|
<t t-esc="displayedTasks.length"/>
|
||||||
<t t-if="displayedTasks.length lt store.tasks.length">
|
<t t-if="displayedTasks.length lt tasks.length">
|
||||||
/ <t t-esc="store.tasks.length"/>
|
/ <t t-esc="tasks.length"/>
|
||||||
</t>
|
</t>
|
||||||
task(s)
|
task(s)
|
||||||
</div>
|
</div>
|
||||||
<div>
|
<div>
|
||||||
<span t-foreach="['all', 'active', 'completed']"
|
<span t-foreach="['all', 'active', 'completed']"
|
||||||
t-as="f" t-key="f"
|
t-as="f" t-key="f"
|
||||||
t-att-class="{active: filter.value===f}"
|
t-att-class="{active: filter.value===f}"
|
||||||
t-on-click="() => this.setFilter(f)"
|
t-on-click="setFilter(f)"
|
||||||
t-esc="f"/>
|
t-esc="f"/>
|
||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
</div>`;
|
</div>
|
||||||
|
|
||||||
setup() {
|
|
||||||
...
|
|
||||||
this.filter = useState({ value: "all" });
|
|
||||||
}
|
|
||||||
|
|
||||||
get displayedTasks() {
|
|
||||||
const tasks = this.store.tasks;
|
|
||||||
switch (this.filter.value) {
|
|
||||||
case "active": return tasks.filter(t => !t.isCompleted);
|
|
||||||
case "completed": return tasks.filter(t => t.isCompleted);
|
|
||||||
case "all": return tasks;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
setFilter(filter) {
|
|
||||||
this.filter.value = filter;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
```
|
```
|
||||||
|
|
||||||
```css
|
```css
|
||||||
@@ -722,8 +757,8 @@ class Root extends Component {
|
|||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
Notice here that we set dynamically the css class of the filter with the object
|
Notice here that we set dynamically the class of the filter with the object
|
||||||
syntax.
|
syntax: each key is a class that we want to set if its value is truthy.
|
||||||
|
|
||||||
## 13. The Final Touch
|
## 13. The Final Touch
|
||||||
|
|
||||||
@@ -738,16 +773,16 @@ the user experience.
|
|||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
2. Make the text of a task clickable, to toggle its checkbox:
|
2. Make the title of a task clickable, to toggle its checkbox:
|
||||||
|
|
||||||
```xml
|
```xml
|
||||||
<input type="checkbox" t-att-checked="props.task.isCompleted"
|
<input type="checkbox" t-att-checked="props.task.isCompleted"
|
||||||
t-att-id="props.task.id"
|
t-att-id="props.task.id"
|
||||||
t-on-click="() => store.toggleTask(props.task)"/>
|
t-on-click="dispatch('toggleTask', props.task.id)"/>
|
||||||
<label t-att-for="props.task.id"><t t-esc="props.task.text"/></label>
|
<label t-att-for="props.task.id"><t t-esc="props.task.title"/></label>
|
||||||
```
|
```
|
||||||
|
|
||||||
3. Strike the text of completed task:
|
3. Strike the title of completed task:
|
||||||
|
|
||||||
```css
|
```css
|
||||||
.task.done label {
|
.task.done label {
|
||||||
@@ -779,145 +814,143 @@ For reference, here is the final code:
|
|||||||
|
|
||||||
```js
|
```js
|
||||||
(function () {
|
(function () {
|
||||||
const { Component, mount, xml, useRef, onMounted, useState, reactive, useEnv } = owl;
|
const { Component, Store } = owl;
|
||||||
|
const { xml } = owl.tags;
|
||||||
|
const { whenReady } = owl.utils;
|
||||||
|
const { useRef, useDispatch, useState, useStore } = owl.hooks;
|
||||||
|
|
||||||
// -------------------------------------------------------------------------
|
// -------------------------------------------------------------------------
|
||||||
// Store
|
// Store
|
||||||
// -------------------------------------------------------------------------
|
// -------------------------------------------------------------------------
|
||||||
function useStore() {
|
const actions = {
|
||||||
const env = useEnv();
|
addTask({ state }, title) {
|
||||||
return useState(env.store);
|
title = title.trim();
|
||||||
}
|
if (title) {
|
||||||
|
|
||||||
// -------------------------------------------------------------------------
|
|
||||||
// TaskList
|
|
||||||
// -------------------------------------------------------------------------
|
|
||||||
class TaskList {
|
|
||||||
constructor(tasks) {
|
|
||||||
this.tasks = tasks || [];
|
|
||||||
const taskIds = this.tasks.map((t) => t.id);
|
|
||||||
this.nextId = taskIds.length ? Math.max(...taskIds) + 1 : 1;
|
|
||||||
}
|
|
||||||
|
|
||||||
addTask(text) {
|
|
||||||
text = text.trim();
|
|
||||||
if (text) {
|
|
||||||
const task = {
|
const task = {
|
||||||
id: this.nextId++,
|
id: state.nextId++,
|
||||||
text: text,
|
title: title,
|
||||||
isCompleted: false,
|
isCompleted: false,
|
||||||
};
|
};
|
||||||
this.tasks.push(task);
|
state.tasks.push(task);
|
||||||
}
|
}
|
||||||
}
|
},
|
||||||
|
toggleTask({ state }, id) {
|
||||||
toggleTask(task) {
|
const task = state.tasks.find((t) => t.id === id);
|
||||||
task.isCompleted = !task.isCompleted;
|
task.isCompleted = !task.isCompleted;
|
||||||
}
|
},
|
||||||
|
deleteTask({ state }, id) {
|
||||||
|
const index = state.tasks.findIndex((t) => t.id === id);
|
||||||
|
state.tasks.splice(index, 1);
|
||||||
|
},
|
||||||
|
};
|
||||||
|
|
||||||
deleteTask(task) {
|
const initialState = {
|
||||||
const index = this.tasks.findIndex((t) => t.id === task.id);
|
nextId: 1,
|
||||||
this.tasks.splice(index, 1);
|
tasks: [],
|
||||||
}
|
};
|
||||||
}
|
|
||||||
|
|
||||||
function createTaskStore() {
|
|
||||||
const saveTasks = () => localStorage.setItem("todoapp", JSON.stringify(taskStore.tasks));
|
|
||||||
const initialTasks = JSON.parse(localStorage.getItem("todoapp") || "[]");
|
|
||||||
const taskStore = reactive(new TaskList(initialTasks), saveTasks);
|
|
||||||
saveTasks();
|
|
||||||
return taskStore;
|
|
||||||
}
|
|
||||||
|
|
||||||
// -------------------------------------------------------------------------
|
// -------------------------------------------------------------------------
|
||||||
// Task Component
|
// Task Component
|
||||||
// -------------------------------------------------------------------------
|
// -------------------------------------------------------------------------
|
||||||
|
const TASK_TEMPLATE = xml/* xml */ `
|
||||||
|
<div class="task" t-att-class="props.task.isCompleted ? 'done' : ''">
|
||||||
|
<input type="checkbox" t-att-checked="props.task.isCompleted"
|
||||||
|
t-att-id="props.task.id"
|
||||||
|
t-on-click="dispatch('toggleTask', props.task.id)"/>
|
||||||
|
<label t-att-for="props.task.id"><t t-esc="props.task.title"/></label>
|
||||||
|
<span class="delete" t-on-click="dispatch('deleteTask', props.task.id)">🗑</span>
|
||||||
|
</div>`;
|
||||||
|
|
||||||
class Task extends Component {
|
class Task extends Component {
|
||||||
static template = xml/* xml */ `
|
static template = TASK_TEMPLATE;
|
||||||
<div class="task" t-att-class="props.task.isCompleted ? 'done' : ''">
|
|
||||||
<input type="checkbox"
|
|
||||||
t-att-id="props.task.id"
|
|
||||||
t-att-checked="props.task.isCompleted"
|
|
||||||
t-on-click="() => store.toggleTask(props.task)"/>
|
|
||||||
<label t-att-for="props.task.id"><t t-esc="props.task.text"/></label>
|
|
||||||
<span class="delete" t-on-click="() => store.deleteTask(props.task)">🗑</span>
|
|
||||||
</div>`;
|
|
||||||
|
|
||||||
static props = ["task"];
|
static props = ["task"];
|
||||||
|
dispatch = useDispatch();
|
||||||
setup() {
|
|
||||||
this.store = useStore();
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
|
|
||||||
// -------------------------------------------------------------------------
|
// -------------------------------------------------------------------------
|
||||||
// Root Component
|
// App Component
|
||||||
// -------------------------------------------------------------------------
|
// -------------------------------------------------------------------------
|
||||||
class Root extends Component {
|
const APP_TEMPLATE = xml/* xml */ `
|
||||||
static template = xml/* xml */ `
|
<div class="todo-app">
|
||||||
<div class="todo-app">
|
|
||||||
<input placeholder="Enter a new task" t-on-keyup="addTask" t-ref="add-input"/>
|
<input placeholder="Enter a new task" t-on-keyup="addTask" t-ref="add-input"/>
|
||||||
<div class="task-list">
|
<div class="task-list">
|
||||||
<t t-foreach="displayedTasks" t-as="task" t-key="task.id">
|
<Task t-foreach="displayedTasks" t-as="task" t-key="task.id" task="task"/>
|
||||||
<Task task="task"/>
|
|
||||||
</t>
|
|
||||||
</div>
|
</div>
|
||||||
<div class="task-panel" t-if="store.tasks.length">
|
<div class="task-panel" t-if="tasks.length">
|
||||||
<div class="task-counter">
|
<div class="task-counter">
|
||||||
<t t-esc="displayedTasks.length"/>
|
<t t-esc="displayedTasks.length"/>
|
||||||
<t t-if="displayedTasks.length lt store.tasks.length">
|
<t t-if="displayedTasks.length lt tasks.length">
|
||||||
/ <t t-esc="store.tasks.length"/>
|
/ <t t-esc="tasks.length"/>
|
||||||
</t>
|
</t>
|
||||||
task(s)
|
task(s)
|
||||||
</div>
|
</div>
|
||||||
<div>
|
<div>
|
||||||
<span t-foreach="['all', 'active', 'completed']"
|
<span t-foreach="['all', 'active', 'completed']"
|
||||||
t-as="f" t-key="f"
|
t-as="f" t-key="f"
|
||||||
t-att-class="{active: filter.value===f}"
|
t-att-class="{active: filter.value===f}"
|
||||||
t-on-click="() => this.setFilter(f)"
|
t-on-click="setFilter(f)"
|
||||||
t-esc="f"/>
|
t-esc="f"/>
|
||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
</div>`;
|
</div>`;
|
||||||
|
|
||||||
|
class App extends Component {
|
||||||
|
static template = APP_TEMPLATE;
|
||||||
static components = { Task };
|
static components = { Task };
|
||||||
|
|
||||||
setup() {
|
inputRef = useRef("add-input");
|
||||||
const inputRef = useRef("add-input");
|
tasks = useStore((state) => state.tasks);
|
||||||
onMounted(() => inputRef.el.focus());
|
filter = useState({ value: "all" });
|
||||||
this.store = useStore();
|
dispatch = useDispatch();
|
||||||
this.filter = useState({ value: "all" });
|
|
||||||
|
mounted() {
|
||||||
|
this.inputRef.el.focus();
|
||||||
}
|
}
|
||||||
|
|
||||||
addTask(ev) {
|
addTask(ev) {
|
||||||
// 13 is keycode for ENTER
|
// 13 is keycode for ENTER
|
||||||
if (ev.keyCode === 13) {
|
if (ev.keyCode === 13) {
|
||||||
this.store.addTask(ev.target.value);
|
this.dispatch("addTask", ev.target.value);
|
||||||
ev.target.value = "";
|
ev.target.value = "";
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
get displayedTasks() {
|
get displayedTasks() {
|
||||||
const tasks = this.store.tasks;
|
|
||||||
switch (this.filter.value) {
|
switch (this.filter.value) {
|
||||||
case "active":
|
case "active":
|
||||||
return tasks.filter((t) => !t.isCompleted);
|
return this.tasks.filter((t) => !t.isCompleted);
|
||||||
case "completed":
|
case "completed":
|
||||||
return tasks.filter((t) => t.isCompleted);
|
return this.tasks.filter((t) => t.isCompleted);
|
||||||
case "all":
|
case "all":
|
||||||
return tasks;
|
return this.tasks;
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
setFilter(filter) {
|
setFilter(filter) {
|
||||||
this.filter.value = filter;
|
this.filter.value = filter;
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
// -------------------------------------------------------------------------
|
// -------------------------------------------------------------------------
|
||||||
// Setup
|
// Setup code
|
||||||
// -------------------------------------------------------------------------
|
// -------------------------------------------------------------------------
|
||||||
const env = { store: createTaskStore() };
|
function makeStore() {
|
||||||
mount(Root, document.body, { dev: true, env });
|
const localState = window.localStorage.getItem("todoapp");
|
||||||
|
const state = localState ? JSON.parse(localState) : initialState;
|
||||||
|
const store = new Store({ state, actions });
|
||||||
|
store.on("update", null, () => {
|
||||||
|
localStorage.setItem("todoapp", JSON.stringify(store.state));
|
||||||
|
});
|
||||||
|
return store;
|
||||||
|
}
|
||||||
|
|
||||||
|
function setup() {
|
||||||
|
owl.config.mode = "dev";
|
||||||
|
App.env.store = makeStore();
|
||||||
|
const app = new App();
|
||||||
|
app.mount(document.body);
|
||||||
|
}
|
||||||
|
|
||||||
|
whenReady(setup);
|
||||||
})();
|
})();
|
||||||
```
|
```
|
||||||
|
|
||||||
|
|||||||
@@ -1,68 +0,0 @@
|
|||||||
# 🦉 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).
|
|
||||||
@@ -4,7 +4,7 @@ OWL, React and Vue have the same main feature: they allow developers to build
|
|||||||
declarative user interfaces. To do that, all these frameworks uses a virtual dom. However, there are still obviously many differences.
|
declarative user interfaces. To do that, all these frameworks uses a virtual dom. However, there are still obviously many differences.
|
||||||
|
|
||||||
In this page, we try to highlight some of these differences. Obviously, a lot of
|
In this page, we try to highlight some of these differences. Obviously, a lot of
|
||||||
effort was put to be fair. However, if you disagree with some of the points
|
effort was done to be fair. However, if you disagree with some of the points
|
||||||
discussed, feel free to open an issue/submit a PR to correct this text.
|
discussed, feel free to open an issue/submit a PR to correct this text.
|
||||||
|
|
||||||
## Content
|
## Content
|
||||||
@@ -14,7 +14,8 @@ discussed, feel free to open an issue/submit a PR to correct this text.
|
|||||||
- [Tooling/Build Step](#toolingbuild-step)
|
- [Tooling/Build Step](#toolingbuild-step)
|
||||||
- [Templating](#templating)
|
- [Templating](#templating)
|
||||||
- [Asynchronous rendering](#asynchronous-rendering)
|
- [Asynchronous rendering](#asynchronous-rendering)
|
||||||
- [Reactivity](#reactivity)
|
- [Reactiveness](#reactiveness)
|
||||||
|
- [State Management](#state-management)
|
||||||
- [Hooks](#hooks)
|
- [Hooks](#hooks)
|
||||||
|
|
||||||
## Size
|
## Size
|
||||||
@@ -46,7 +47,7 @@ components are fast enough for all our usecases, and making it as simple as
|
|||||||
possible for developers is more valuable (for us).
|
possible for developers is more valuable (for us).
|
||||||
|
|
||||||
Also, functions or class based components are more than just syntax. Functions
|
Also, functions or class based components are more than just syntax. Functions
|
||||||
come with a mindset of composition and class are about inheritance. Clearly,
|
comes with a mindset of composition and class are about inheritance. Clearly,
|
||||||
both of these are important mechanisms for reusing code. Also, one does not
|
both of these are important mechanisms for reusing code. Also, one does not
|
||||||
exclude the other.
|
exclude the other.
|
||||||
|
|
||||||
@@ -78,7 +79,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.
|
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
|
Because of that, Owl did not have to write its own template parser. Another
|
||||||
example is the [`xml`](../reference/templates.md#inline-templates) tag helper function, which makes use of
|
example is the [`xml`](../reference/tags.md#xml-tag) tag helper function, which makes use of
|
||||||
native template literals to allow in a natural way to write `xml` templates
|
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
|
directly in the javascript code. This can be easily integrated with editor
|
||||||
plugins to have autocompletion inside the template.
|
plugins to have autocompletion inside the template.
|
||||||
@@ -126,7 +127,7 @@ structured than a template language. Note that the tooling is quite impressive:
|
|||||||
there is a syntax highlighter for jsx here on github!
|
there is a syntax highlighter for jsx here on github!
|
||||||
|
|
||||||
By comparison, here is the equivalent Owl component, written with the
|
By comparison, here is the equivalent Owl component, written with the
|
||||||
[`xml`](../reference/templates.md#inline-templates) tag helper:
|
[`xml`](../reference/tags.md#xml-tag) tag helper:
|
||||||
|
|
||||||
```js
|
```js
|
||||||
class Clock extends Component {
|
class Clock extends Component {
|
||||||
@@ -172,7 +173,7 @@ more convoluted. For example, in Vue, you need to use a dynamic import keyword
|
|||||||
that needs to be transpiled at build time in order for the component to be loaded
|
that needs to be transpiled at build time in order for the component to be loaded
|
||||||
asynchronously (see [the documentation](https://vuejs.org/v2/guide/components-dynamic-async.html#Async-Components)).
|
asynchronously (see [the documentation](https://vuejs.org/v2/guide/components-dynamic-async.html#Async-Components)).
|
||||||
|
|
||||||
## Reactivity
|
## Reactiveness
|
||||||
|
|
||||||
React has a simple model: whenever the state changes, it is
|
React has a simple model: whenever the state changes, it is
|
||||||
replaced with a new state (via the `setState` method). Then, the DOM is patched.
|
replaced with a new state (via the `setState` method). Then, the DOM is patched.
|
||||||
@@ -188,6 +189,95 @@ with a `Proxy`, which means that it is totally transparent to the developers.
|
|||||||
Adding new keys is supported. Once any part of the state has been changed, a
|
Adding new keys is supported. Once any part of the state has been changed, a
|
||||||
rendering is scheduled in the next microtask tick (promise queue).
|
rendering is scheduled in the next microtask tick (promise queue).
|
||||||
|
|
||||||
|
## State Management
|
||||||
|
|
||||||
|
Managing the state of an application is a tricky issue. Many solutions have
|
||||||
|
been proposed these last few years. It also depends on the kind of application we
|
||||||
|
are talking about. A small application may not need much more than a simple
|
||||||
|
object to contain its state.
|
||||||
|
|
||||||
|
However, there are some common solutions for React and Vue: redux and vuex.
|
||||||
|
Both of them are a centralized store that own the state, and they dictate how
|
||||||
|
the state can be mutated.
|
||||||
|
|
||||||
|
**Redux**
|
||||||
|
|
||||||
|
In Redux, the state is mutated by reducers. Reducers are functions
|
||||||
|
that modify the state by returning a different object:
|
||||||
|
|
||||||
|
```javascript
|
||||||
|
...
|
||||||
|
switch (action.type) {
|
||||||
|
case ADD_TODO: {
|
||||||
|
const { id, content } = action.payload;
|
||||||
|
return {
|
||||||
|
...state,
|
||||||
|
allIds: [...state.allIds, id],
|
||||||
|
byIds: {
|
||||||
|
...state.byIds,
|
||||||
|
[id]: {
|
||||||
|
content,
|
||||||
|
completed: false
|
||||||
|
}
|
||||||
|
}
|
||||||
|
};
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
This is a little bit awkward to write, but this allows the component system to
|
||||||
|
check if a part of the state was changed. This is exactly what is done by the
|
||||||
|
`connect` function: it create a _connected_ component, which is subscribed to
|
||||||
|
the state and triggers a rerender if some part of the state was modified.
|
||||||
|
|
||||||
|
**VueX**
|
||||||
|
|
||||||
|
VueX is based on a different principle: the state is mutated through
|
||||||
|
some special functions (the mutations), which modify the state in place:
|
||||||
|
|
||||||
|
```javascript
|
||||||
|
function ({state}, payload) {
|
||||||
|
const { id, content } = payload;
|
||||||
|
const message = {id, content, completed: false};
|
||||||
|
state.messages.push(message)
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
This is simpler, but there is a little bit more happening behind the scene:
|
||||||
|
each key from the state is silently replaced by getters and setters, and VueX
|
||||||
|
keeps track of who get data, and retrigger a render when it was changed.
|
||||||
|
|
||||||
|
**Owl**
|
||||||
|
|
||||||
|
Owl store is a little bit like a mix of redux and vuex: it has actions (but not
|
||||||
|
mutations), and like VueX, it keeps track of the state changes. However, it does
|
||||||
|
not notify a component when the state changes. Instead, components need to connect
|
||||||
|
to the store like in redux, with the `useStore` hook (see the [store documentation](../reference/store.md#connecting-a-component)).
|
||||||
|
|
||||||
|
```javascript
|
||||||
|
const actions = {
|
||||||
|
increment({ state }, val) {
|
||||||
|
state.counter.value += val;
|
||||||
|
},
|
||||||
|
};
|
||||||
|
|
||||||
|
const state = {
|
||||||
|
counter: { value: 0 },
|
||||||
|
};
|
||||||
|
const store = new owl.Store({ state, actions });
|
||||||
|
|
||||||
|
class Counter extends Component {
|
||||||
|
static template = xml`
|
||||||
|
<button t-name="Counter" t-on-click="dispatch('increment')">
|
||||||
|
Click Me! [<t t-esc="counter.value"/>]
|
||||||
|
</button>`;
|
||||||
|
counter = useStore((state) => state.counter);
|
||||||
|
dispatch = useDispatch();
|
||||||
|
}
|
||||||
|
|
||||||
|
Counter.env.store = store;
|
||||||
|
const counter = new Counter();
|
||||||
|
```
|
||||||
|
|
||||||
## Hooks
|
## Hooks
|
||||||
|
|
||||||
[Hooks](https://reactjs.org/docs/hooks-intro.html#motivation) recently took over
|
[Hooks](https://reactjs.org/docs/hooks-intro.html#motivation) recently took over
|
||||||
@@ -252,4 +342,4 @@ class Example extends Component {
|
|||||||
|
|
||||||
Since the Owl framework had hooks from early in its life, its main APIs
|
Since the Owl framework had hooks from early in its life, its main APIs
|
||||||
are designed to be interacted with hooks from the start. For example, the
|
are designed to be interacted with hooks from the start. For example, the
|
||||||
`Context` abstraction.
|
`Context` and `Store` abstractions.
|
||||||
|
|||||||
@@ -1,98 +0,0 @@
|
|||||||
# 🦉 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.
|
|
||||||
@@ -0,0 +1,32 @@
|
|||||||
|
# 🦉 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).
|
||||||
@@ -0,0 +1,18 @@
|
|||||||
|
# 🦉 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).
|
||||||
@@ -61,14 +61,14 @@ because a lot of the state is hidden in their internals.
|
|||||||
|
|
||||||
React or Vue have a huge community, and a lot of effort have been made into their
|
React or Vue have a huge community, and a lot of effort have been made into their
|
||||||
tooling. This is wonderful, but at the same time, a pretty big issue for Odoo:
|
tooling. This is wonderful, but at the same time, a pretty big issue for Odoo:
|
||||||
since the assets are totally dynamic (and could change whenever the user installs
|
since the assets are totally dynamic (and could change whenever the user install
|
||||||
or removes an addon), we need to have all that kind of tooling on the production
|
or remove an addon), we need to have all that kind of tooling on the production
|
||||||
servers. This is certainly not ideal.
|
servers. This is certainly not ideal.
|
||||||
|
|
||||||
Also, this makes it very complicated to setup Vue or React tools: Odoo code is
|
Also, this makes it very complicated to setup Vue or React tools: Odoo code is
|
||||||
not a simple file that import other files. It changes all the time, assets
|
not a simple file that import other files. It changes all the time, assets
|
||||||
are bundled differently in different contexts. This is the reason why Odoo has
|
are bundled differently in different contexts. This is the reason why Odoo has
|
||||||
its own module system, which are resolved at runtime, by the browser. The
|
its own module system, which are resolve at runtime, by the browser. The
|
||||||
dynamic nature of Odoo means that we often need to delay work as late as possible
|
dynamic nature of Odoo means that we often need to delay work as late as possible
|
||||||
(in other word, we want a JIT user interface!)
|
(in other word, we want a JIT user interface!)
|
||||||
|
|
||||||
@@ -78,12 +78,12 @@ deploy. Using React without JSX, or Vue without vue file is not very appealing.
|
|||||||
At the same time, Owl is designed to solve this issue: it compiles templates
|
At the same time, Owl is designed to solve this issue: it compiles templates
|
||||||
by the browser, it doesn't need much code for that, since we use the XML parser
|
by the browser, it doesn't need much code for that, since we use the XML parser
|
||||||
built into each browser. Owl works with or without any additional tooling. It
|
built into each browser. Owl works with or without any additional tooling. It
|
||||||
can use template strings to write single file components, and is easy to integrate
|
can use template strings to write single file component, and is easy to integrate
|
||||||
in any html page, with a simple `<script>` tag.
|
in any html page, with a simple `<script>` tag.
|
||||||
|
|
||||||
## Template based
|
## Template based
|
||||||
|
|
||||||
Odoo stores templates as XML documents in a database. This is very powerful, since
|
Odoo stores template as XML document in a database. This is very powerful, since
|
||||||
this allow the use of xpaths to customize other templates. This is a very
|
this allow the use of xpaths to customize other templates. This is a very
|
||||||
important feature of odoo, and one of the key to Odoo modularity.
|
important feature of odoo, and one of the key to Odoo modularity.
|
||||||
|
|
||||||
@@ -104,12 +104,12 @@ awkward, and very confusing.
|
|||||||
## Developer Experience
|
## Developer Experience
|
||||||
|
|
||||||
This brings us to the following point: developer experience. We see this choice
|
This brings us to the following point: developer experience. We see this choice
|
||||||
as an investment for the future, and we want to make onboarding developers as
|
as an investment for the future, and we want to make onboarding developer as
|
||||||
easy as possible.
|
easy as possible.
|
||||||
|
|
||||||
While many javascript professionals clearly think that react/vue is not difficult
|
While many javascript professionals clearly think that react/vue is not difficult
|
||||||
(which is true to some extent), it is alsy true that many non js specialists are
|
(which is true to some extent), it is alsy true that many non js specialists are
|
||||||
overwhelmed with the frontend world: functional components, hooks, and many other
|
overwhelmed with the frontend world: functional component, hooks, and many other
|
||||||
fancy words. Also, what is available in the compilation context may be difficult,
|
fancy words. Also, what is available in the compilation context may be difficult,
|
||||||
there is a lot of black magic going on in pretty much every framework. Vue
|
there is a lot of black magic going on in pretty much every framework. Vue
|
||||||
somehow join various namespaces into one, under the hood, and add various internal
|
somehow join various namespaces into one, under the hood, and add various internal
|
||||||
@@ -135,7 +135,7 @@ needs: Odoo will fetch templates from the database and need to compile them only
|
|||||||
at the last possible moment, so we can apply all necessary xpaths.
|
at the last possible moment, so we can apply all necessary xpaths.
|
||||||
|
|
||||||
Even more: Odoo needs to be able to generate (and compile) templates at runtime.
|
Even more: Odoo needs to be able to generate (and compile) templates at runtime.
|
||||||
Currently, Odoo form views interpret an xml description. But the form view code
|
Currently, Odoo form views interpret a xml description. But the form view code
|
||||||
then needs to do a lot of complicated operations. With Owl, we will be able to
|
then needs to do a lot of complicated operations. With Owl, we will be able to
|
||||||
transform a view description into a QWeb template, then compile that and use it
|
transform a view description into a QWeb template, then compile that and use it
|
||||||
immediately.
|
immediately.
|
||||||
@@ -147,16 +147,16 @@ For example, the reactivity system. We like the way Vue did it, but it has a
|
|||||||
flaw: it is not really optional. There is actually a way to opt out of the reactivity
|
flaw: it is not really optional. There is actually a way to opt out of the reactivity
|
||||||
system by freezing the state, but then, it is freezed.
|
system by freezing the state, but then, it is freezed.
|
||||||
|
|
||||||
And there certainly are situations where we need a state, which is not read-only,
|
And there certainly are situations where we need a state, which is not readonly,
|
||||||
and not observed. For example, imagine a spreadsheet component. It may have a
|
and not observed. For example, imagine a spreadsheet component. It may have a
|
||||||
very large internal state, and it knows exactly when it needs to be rendered
|
very large internal state, and it knows exactly when it needs to be rendered
|
||||||
(basically, whenever the user performs some action). Then, observing its state
|
(basically, whenever the user perform some action). Then, observing its state
|
||||||
is a net performance loss, both for the CPU and the memory.
|
is a net performance loss, both for the CPU and the memory.
|
||||||
|
|
||||||
## Concurrency
|
## Concurrency
|
||||||
|
|
||||||
Many applications are happy to simply display a spinner whenever a new asynchronous
|
Many applications are happy to simply display a spinner whenever a new asynchronous
|
||||||
action is performed, but Odoo wants a different user experience: most asynchronous
|
action is performed, but Odoo want a different user experience: most asynchronous
|
||||||
state changes are not displayed until ready. This is sometimes called a concurrent
|
state changes are not displayed until ready. This is sometimes called a concurrent
|
||||||
mode: the UI is rendered in memory, and displayed only when it is ready (and
|
mode: the UI is rendered in memory, and displayed only when it is ready (and
|
||||||
only if it has not been cancelled by subsequent user actions).
|
only if it has not been cancelled by subsequent user actions).
|
||||||
@@ -175,6 +175,6 @@ that current standard frameworks are not tailored to our needs. It is perfectly
|
|||||||
fine, because they each chose a different set of tradeoffs.
|
fine, because they each chose a different set of tradeoffs.
|
||||||
|
|
||||||
However, we feel that there is still room in the framework world for something
|
However, we feel that there is still room in the framework world for something
|
||||||
that is different. For a framework that makes choices compatible with Odoo.
|
that is different. For a framework that make choices compatible with Odoo.
|
||||||
|
|
||||||
And that is why we built Owl 🦉.
|
And that is why we built Owl 🦉.
|
||||||
|
|||||||
+44
-38
@@ -1,49 +1,55 @@
|
|||||||
# 🦉 Owl overview 🦉
|
# 🦉 OWL Documentation 🦉
|
||||||
|
|
||||||
Here is a list of everything exported by the Owl library:
|
## Learning Owl
|
||||||
|
|
||||||
Main entities:
|
Are you new to Owl? This is the place to start!
|
||||||
|
|
||||||
- [`App`](reference/app.md): represent an Owl application (mainly a root component,a set of templates, and a config)
|
- [Tutorial: create a TodoList application](learning/tutorial_todoapp.md)
|
||||||
- [`Component`](reference/component.md): the main class to define a concrete Owl component
|
- [Quick Overview](learning/overview.md)
|
||||||
- [`mount`](reference/app.md#mount-helper): main entry point for most application: mount a component to a target
|
- [How to start an Owl project](learning/quick_start.md)
|
||||||
- [`xml`](reference/templates.md#inline-templates): helper to define an inline template
|
- [How to test Components](learning/how_to_test.md)
|
||||||
|
- [How to write Single File Components](learning/how_to_write_sfc.md)
|
||||||
|
- [How to write debug Owl applications](learning/how_to_debug.md)
|
||||||
|
|
||||||
Reactivity
|
## Reference
|
||||||
|
|
||||||
- [`useState`](reference/reactivity.md#usestate): create a reactive object (hook, linked to a specific component)
|
You will find here a complete reference of every feature, class or object
|
||||||
- [`reactive`](reference/reactivity.md#reactive): create a reactive object (not linked to any component)
|
provided by Owl.
|
||||||
- [`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:
|
- [Animations](reference/animations.md)
|
||||||
|
- [Component](reference/component.md)
|
||||||
|
- [Content](reference/content.md)
|
||||||
|
- [Concurrency Model](reference/concurrency_model.md)
|
||||||
|
- [Configuration](reference/config.md)
|
||||||
|
- [Context](reference/context.md)
|
||||||
|
- [Environment](reference/environment.md)
|
||||||
|
- [Event Bus](reference/event_bus.md)
|
||||||
|
- [Event Handling](reference/event_handling.md)
|
||||||
|
- [Error Handling](reference/error_handling.md)
|
||||||
|
- [Hooks](reference/hooks.md)
|
||||||
|
- [Miscellaneous Components](reference/misc.md)
|
||||||
|
- [Observer](reference/observer.md)
|
||||||
|
- [Props](reference/props.md)
|
||||||
|
- [Props Validation](reference/props_validation.md)
|
||||||
|
- [QWeb Templating Language](reference/qweb_templating_language.md)
|
||||||
|
- [QWeb Engine](reference/qweb_engine.md)
|
||||||
|
- [Router](reference/router.md)
|
||||||
|
- [Store](reference/store.md)
|
||||||
|
- [Slots](reference/slots.md)
|
||||||
|
- [Tags](reference/tags.md)
|
||||||
|
- [Utils](reference/utils.md)
|
||||||
|
|
||||||
- [`onWillStart`](reference/component.md#willstart): hook to define asynchronous code that should be executed before component is rendered
|
## Other Topics
|
||||||
- [`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:
|
This section provides miscellaneous document that explains some topics
|
||||||
|
which cannot be considered either a tutorial, or reference documentation.
|
||||||
|
|
||||||
- [`useComponent`](reference/hooks.md#usecomponent): return a reference to the current component (useful to create derived hooks)
|
- [Owl architecture: the Virtual DOM](miscellaneous/vdom.md)
|
||||||
- [`useEffect`](reference/hooks.md#useeffect): define an effect with its dependencies
|
- [Owl architecture: the rendering pipeline](miscellaneous/rendering.md)
|
||||||
- [`useEnv`](reference/hooks.md#useenv): return a reference to the current env
|
- [Comparison with React/Vue](miscellaneous/comparison.md)
|
||||||
- [`useExternalListener`](reference/hooks.md#useexternallistener): add a listener outside of a component DOM
|
- [Why did Odoo built Owl?](miscellaneous/why_owl.md)
|
||||||
- [`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
|
Found an issue in the documentation? A broken link? Some outdated information?
|
||||||
- [`loadFile`](reference/utils.md#loadfile): an helper to load a file from the server
|
Please open an issue or submit a PR!
|
||||||
- [`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
|
|
||||||
|
|||||||
@@ -0,0 +1,95 @@
|
|||||||
|
# 🦉 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),
|
||||||
|
- the css class `name-enter-active` will be removed whenever a css transition
|
||||||
|
ends.
|
||||||
|
|
||||||
|
At node destruction:
|
||||||
|
|
||||||
|
- the css classes `name-leave` and `name-leave-active` will be added before the
|
||||||
|
node is removed to the DOM,
|
||||||
|
- the css class `name-leave` will be removed on the next animation frame (so it
|
||||||
|
can be used to trigger css transition effects),
|
||||||
|
- the css class `name-leave-active` will be removed whenever a css transition
|
||||||
|
ends. Only then will the element be removed from the DOM.
|
||||||
|
|
||||||
|
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).
|
||||||
@@ -1,123 +0,0 @@
|
|||||||
# 🦉 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
|
|
||||||
+649
-284
File diff suppressed because it is too large
Load Diff
@@ -11,7 +11,7 @@
|
|||||||
|
|
||||||
Owl was designed from the very beginning with asynchronous components. This comes
|
Owl was designed from the very beginning with asynchronous components. This comes
|
||||||
from the `willStart` and the `willUpdateProps` lifecycle hooks. With these
|
from the `willStart` and the `willUpdateProps` lifecycle hooks. With these
|
||||||
asynchronous hooks, it is possible to build complex highly concurrent applications.
|
methods, it is possible to build complex highly concurrent applications.
|
||||||
|
|
||||||
Owl concurrent mode has several benefits: it makes it possible to delay the
|
Owl concurrent mode has several benefits: it makes it possible to delay the
|
||||||
rendering until some asynchronous operation is complete, it makes it possible
|
rendering until some asynchronous operation is complete, it makes it possible
|
||||||
@@ -35,8 +35,7 @@ two phases: _virtual rendering_ and _patching_.
|
|||||||
|
|
||||||
### Virtual rendering
|
### Virtual rendering
|
||||||
|
|
||||||
This phase represent the process of rendering a template, in memory, which creates
|
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
|
||||||
a virtual representation of the desired component html). The output of this phase is a
|
|
||||||
virtual DOM.
|
virtual DOM.
|
||||||
|
|
||||||
It is asynchronous: each subcomponents needs to either be created (so, `willStart`
|
It is asynchronous: each subcomponents needs to either be created (so, `willStart`
|
||||||
@@ -95,7 +94,7 @@ component (with some code like `app.mount(document.body)`).
|
|||||||
5. The method `mounted` is called recursively on all components in the following
|
5. The method `mounted` is called recursively on all components in the following
|
||||||
order: `E`, `D`, `C`, `B`, `A`.
|
order: `E`, `D`, `C`, `B`, `A`.
|
||||||
|
|
||||||
**Scenario 2: updating a component**. Now, let's assume that the user clicked on some
|
**Scenario 2: rerendering 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:
|
button in `C`, and this results in a state update, which is supposed to:
|
||||||
|
|
||||||
- update `D`,
|
- update `D`,
|
||||||
@@ -137,7 +136,8 @@ Here is what Owl will do:
|
|||||||
6. `mounted` hook is called on `F`, `patched` hooks are called on `D`, `C`
|
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
|
Tags are very small helpers to make it easy to write inline templates. There is
|
||||||
only one currently available tag: `xml`.
|
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).
|
||||||
|
|
||||||
### Asynchronous Rendering
|
### Asynchronous Rendering
|
||||||
|
|
||||||
@@ -158,6 +158,26 @@ There are two different common problems with Owl asynchronous rendering model:
|
|||||||
Here are a few tips on how to work with asynchronous components:
|
Here are a few tips on how to work with asynchronous components:
|
||||||
|
|
||||||
1. Minimize the use of asynchronous components!
|
1. Minimize the use of asynchronous components!
|
||||||
2. Lazy loading external libraries is a good use case for async rendering. This
|
2. Maybe move the asynchronous logic in a store, which then triggers (mostly)
|
||||||
|
synchronous renderings
|
||||||
|
3. 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
|
is mostly fine, because we can assume that it will only takes a fraction of a
|
||||||
second, and only once.
|
second, and only once (see [`owl.utils.loadJS`](utils.md#loadjs))
|
||||||
|
4. 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>
|
||||||
|
```
|
||||||
|
|||||||
@@ -0,0 +1,44 @@
|
|||||||
|
# 🦉 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.
|
||||||
@@ -0,0 +1,36 @@
|
|||||||
|
# 🦉 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`.
|
||||||
|
|
||||||
|
```
|
||||||
|
Component misc
|
||||||
|
Context AsyncRoot
|
||||||
|
QWeb Portal
|
||||||
|
Store router
|
||||||
|
useState Link
|
||||||
|
config RouteComponent
|
||||||
|
mode Router
|
||||||
|
core tags
|
||||||
|
EventBus css
|
||||||
|
Observer xml
|
||||||
|
hooks utils
|
||||||
|
onWillStart debounce
|
||||||
|
onMounted escape
|
||||||
|
onWillUpdateProps loadJS
|
||||||
|
onWillPatch loadFile
|
||||||
|
onPatched shallowEqual
|
||||||
|
onWillUnmount whenReady
|
||||||
|
useContext
|
||||||
|
useState
|
||||||
|
useRef
|
||||||
|
useSubEnv
|
||||||
|
useStore
|
||||||
|
useDispatch
|
||||||
|
useGetters
|
||||||
|
```
|
||||||
|
|
||||||
|
Note that for convenience, the `useState` hook is also exported at the root of the `owl` object.
|
||||||
@@ -0,0 +1,105 @@
|
|||||||
|
# 🦉 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.
|
||||||
@@ -6,15 +6,15 @@
|
|||||||
- [Setting an Environment](#setting-an-environment)
|
- [Setting an Environment](#setting-an-environment)
|
||||||
- [Using a sub environment](#using-a-sub-environment)
|
- [Using a sub environment](#using-a-sub-environment)
|
||||||
- [Content of an Environment](#content-of-an-environment)
|
- [Content of an Environment](#content-of-an-environment)
|
||||||
|
- [Special keys](#special-keys)
|
||||||
|
|
||||||
## Overview
|
## Overview
|
||||||
|
|
||||||
An environment is a shared object given to all components in a tree. It is not
|
An environment is an object which contains a [`QWeb` instance](qweb_engine.md). Whenever
|
||||||
used by Owl itself, but it is useful for application developers to provide a
|
a root component is created, it is assigned an environment (see
|
||||||
simple communication channel between components (in addition to the props).
|
[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`
|
||||||
The `env` given to the [`App`](app.md) is assigned to the `env` component
|
property).
|
||||||
property.
|
|
||||||
|
|
||||||
```
|
```
|
||||||
Root
|
Root
|
||||||
@@ -22,55 +22,130 @@ property.
|
|||||||
A B
|
A B
|
||||||
```
|
```
|
||||||
|
|
||||||
Also, the `env` object is frozen when the application is started. This is done
|
This way, all components share the same `QWeb` instance. Owl internally requires
|
||||||
to ensure a simpler mental model of what's happening in runtime. Note that it
|
that the environment has a `qweb` key which maps to a
|
||||||
is only shallowly frozen, so sub objects can be modified.
|
[`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.
|
||||||
|
|
||||||
## Setting an environment
|
## Setting an environment
|
||||||
|
|
||||||
The correct way to customize an environment is to simply give it to the `App`,
|
An Owl application needs an [environment](environment.md) to be executed. The
|
||||||
whenever it is created.
|
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:
|
||||||
|
|
||||||
```js
|
```js
|
||||||
const env = {
|
App.env = {
|
||||||
_t: myTranslateFunction,
|
_t: myTranslateFunction,
|
||||||
user: {...},
|
user: {...},
|
||||||
services: {
|
services: {
|
||||||
...
|
...
|
||||||
},
|
},
|
||||||
};
|
};
|
||||||
|
const app = new App();
|
||||||
new App(Root, { env }).mount(document.body);
|
app.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
|
## Using a sub environment
|
||||||
|
|
||||||
It is sometimes useful to add one (or more) specific keys to the 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
|
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.
|
solution presented above will not work, since it sets the global environment.
|
||||||
|
|
||||||
There are two hooks for this situation: [`useSubEnv` and `useChildSubEnv`](hooks.md#usesubenv-and-usechildsubenv).
|
There is a hook for this situation: [`useSubEnv`](hooks.md#usesubenv).
|
||||||
|
|
||||||
```js
|
```js
|
||||||
class SomeComponent extends Component {
|
class FormComponent extends Component {
|
||||||
setup() {
|
constructor(parent, props) {
|
||||||
useSubEnv({ myKey: someValue }); // myKey is now available for all child components
|
super(parent, props);
|
||||||
|
useSubEnv({ myKey: someValue });
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
## Content of an Environment
|
## Content of an Environment
|
||||||
|
|
||||||
The `env` object content is totally up to the application developer. However,
|
Some good use cases for additional keys in the environment are:
|
||||||
some good use cases for additional keys in the environment are:
|
|
||||||
|
|
||||||
- some configuration keys,
|
- some configuration keys,
|
||||||
- session information,
|
- session information,
|
||||||
- generic services (such as doing rpcs).
|
- 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
|
Doing it this way means that components are easily testable: we can simply
|
||||||
create a test environment with mock services.
|
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() {
|
||||||
|
App.env = await myEnv();
|
||||||
|
const app = new App();
|
||||||
|
await app.mount(document.body);
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
## 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. This is particularly useful when one want
|
||||||
|
to test more advanced components, and be able to mock those methods.
|
||||||
|
|
||||||
|
More specifically, the `browser` object contains the following methods and objects:
|
||||||
|
|
||||||
|
- `setTimeout`
|
||||||
|
- `clearTimeout`
|
||||||
|
- `setInterval`
|
||||||
|
- `clearInterval`
|
||||||
|
- `requestAnimationFrame`
|
||||||
|
- `random`
|
||||||
|
- `Date`
|
||||||
|
- `fetch`
|
||||||
|
- `localStorage`
|
||||||
|
|||||||
@@ -3,30 +3,60 @@
|
|||||||
## Content
|
## Content
|
||||||
|
|
||||||
- [Overview](#overview)
|
- [Overview](#overview)
|
||||||
- [Managing Errors](#managing-errors)
|
|
||||||
- [Example](#example)
|
- [Example](#example)
|
||||||
|
- [Reference](#reference)
|
||||||
|
|
||||||
## Overview
|
## Overview
|
||||||
|
|
||||||
By default, whenever an error occurs in the rendering of an Owl application, we
|
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
|
destroy the whole application. Otherwise, we cannot offer any guarantee on the
|
||||||
state of the resulting component tree. It might be hopelessly corrupted, but
|
state of the resulting component tree. It might be hopelessly corrupted, but
|
||||||
without any user-visible feedback.
|
without any user-visible state.
|
||||||
|
|
||||||
Clearly, it is usually a little bit extreme to destroy the application. This
|
Clearly, it sometimes is a little bit extreme to destroy the application. This
|
||||||
is why we need a mechanism to handle rendering errors (and errors coming
|
is why we have a builtin mechanism to handle rendering errors (and errors coming
|
||||||
from lifecycle hooks): the `onError` hook.
|
from lifecycle hooks): the `catchError` hook.
|
||||||
|
|
||||||
The main idea is that the `onError` hook register a function that will be called
|
## Example
|
||||||
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.
|
|
||||||
|
|
||||||
## Managing Errors
|
For example, here is how we could implement an `ErrorBoundary` component:
|
||||||
|
|
||||||
Whenever the `onError` lifecycle hook is used, all errors coming from
|
```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
|
||||||
sub components rendering and/or lifecycle method calls will be caught and given
|
sub components rendering and/or lifecycle method calls will be caught and given
|
||||||
to the `onError` method. This allows us to properly handle the error, and to
|
to the `catchError` method. This allows us to properly handle the error, and to
|
||||||
not break the application.
|
not break the application.
|
||||||
|
|
||||||
There are important things to know:
|
There are important things to know:
|
||||||
@@ -35,41 +65,17 @@ There are important things to know:
|
|||||||
Owl will destroy the full application. This is done on purpose, because Owl
|
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.
|
cannot guarantee that the state is not corrupted from this point on.
|
||||||
|
|
||||||
- errors coming from event handlers are NOT managed by `onError` or any other
|
- errors coming from event handlers are NOT managed by `catchError` or any other
|
||||||
owl mechanism. This is up to the application developer to properly recover
|
owl mechanism. This is up to the application developer to properly recover
|
||||||
from an error
|
from an error
|
||||||
|
|
||||||
- if an error handler is unable to properly handle an error, it can just rethrow
|
Also, it may be useful to know that whenever an error is caught, it is then
|
||||||
an error, and Owl will try looking for another error handler up the component
|
broadcasted to the application by an event on the `qweb` instance. It may be
|
||||||
tree.
|
useful, for example, to log the error somewhere.
|
||||||
|
|
||||||
## 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
|
```js
|
||||||
class ErrorBoundary extends Component {
|
env.qweb.on("error", null, function (error) {
|
||||||
static template = xml`
|
// do something
|
||||||
<t t-if="error" t-slot="fallback">An error occurred</t>
|
// react to the error
|
||||||
<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).
|
|
||||||
|
|||||||
@@ -0,0 +1,27 @@
|
|||||||
|
# 🦉 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 |
|
||||||
|
|
||||||
|
Note that the [`Store`](store.md) is an example of an `EventBus`.
|
||||||
@@ -3,15 +3,22 @@
|
|||||||
## Content
|
## Content
|
||||||
|
|
||||||
- [Event Handling](#event-handling)
|
- [Event Handling](#event-handling)
|
||||||
|
- [Business DOM Events](#business-dom-events)
|
||||||
|
- [Inline Event Handlers](#inline-event-handlers)
|
||||||
- [Modifiers](#modifiers)
|
- [Modifiers](#modifiers)
|
||||||
- [Synthetic Events](#synthetic-events)
|
|
||||||
- [On Components](#on-components)
|
|
||||||
|
|
||||||
## Event Handling
|
## Event Handling
|
||||||
|
|
||||||
In a component's template, it is useful to be able to register handlers on DOM
|
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_. This
|
elements to some specific events. This is what makes a template _alive_. There
|
||||||
is done with the `t-on` directive. For example:
|
are four different use cases.
|
||||||
|
|
||||||
|
1. Register an event handler on a DOM node (_pure_ DOM event)
|
||||||
|
2. Register an event handler on a component (_pure_ DOM event)
|
||||||
|
3. Register an event handler on a DOM node (_business_ DOM event)
|
||||||
|
4. Register an event handler on a component (_business_ DOM event)
|
||||||
|
|
||||||
|
A _pure_ DOM event is directly triggered by a user interaction (e.g. a `click`).
|
||||||
|
|
||||||
```xml
|
```xml
|
||||||
<button t-on-click="someMethod">Do something</button>
|
<button t-on-click="someMethod">Do something</button>
|
||||||
@@ -24,28 +31,93 @@ button.addEventListener("click", component.someMethod.bind(component));
|
|||||||
```
|
```
|
||||||
|
|
||||||
The suffix (`click` in this example) is simply the name of the actual DOM
|
The suffix (`click` in this example) is simply the name of the actual DOM
|
||||||
event. The value of the `t-on` expression should be a valid javascript expression
|
event.
|
||||||
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,
|
## Business DOM Events
|
||||||
all the following expressions are valid:
|
|
||||||
|
A _business_ DOM event is triggered by a call to `trigger` on a component.
|
||||||
|
|
||||||
```xml
|
```xml
|
||||||
<button t-on-click="someMethod">Do something</button>
|
<MyComponent t-on-menu-loaded="someMethod" />
|
||||||
<button t-on-click="() => this.increment(3)">Add 3</button>
|
|
||||||
<button t-on-click="ev => this.doStuff(ev, 'value')">Do something</button>
|
|
||||||
```
|
```
|
||||||
|
|
||||||
Notice the use of the `this` keyword in the lambda function: this is the
|
```js
|
||||||
correct way to call a method on the component in a lambda function.
|
class MyComponent {
|
||||||
|
someWhere() {
|
||||||
|
const payload = ...;
|
||||||
|
this.trigger('menu-loaded', payload);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
One could use the following expression:
|
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,
|
||||||
|
|
||||||
```xml
|
```xml
|
||||||
<button t-on-click="() => increment(3)">Add 3</button>
|
<button t-on-click="someMethod(expr)">Do something</button>
|
||||||
```
|
```
|
||||||
|
|
||||||
But then, the increment function may be unbound (unless the component binds it
|
Here, `expr` is a valid Owl expression, so it could be `true` or some variable
|
||||||
in its setup function, for example).
|
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>
|
||||||
|
```
|
||||||
|
|
||||||
## Modifiers
|
## Modifiers
|
||||||
|
|
||||||
@@ -53,13 +125,12 @@ 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
|
`event.preventDefault`) and let them focus on data logic, _modifiers_ can be
|
||||||
specified as additional suffixes of the `t-on` directive.
|
specified as additional suffixes of the `t-on` directive.
|
||||||
|
|
||||||
| Modifier | Description |
|
| Modifier | Description |
|
||||||
| ------------ | ------------------------------------------------------------------------------------------------------------------------ |
|
| ---------- | ------------------------------------------------------------------------------------------------------------------------ |
|
||||||
| `.stop` | calls `event.stopPropagation()` before calling the method |
|
| `.stop` | calls `event.stopPropagation()` before calling the method |
|
||||||
| `.prevent` | calls `event.preventDefault()` 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 |
|
| `.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. |
|
| `.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
|
```xml
|
||||||
<button t-on-click.stop="someMethod">Do something</button>
|
<button t-on-click.stop="someMethod">Do something</button>
|
||||||
@@ -78,42 +149,3 @@ modifiers. For example,
|
|||||||
```
|
```
|
||||||
|
|
||||||
This will simply stop the propagation of the event.
|
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).
|
|
||||||
|
|||||||
+375
-252
@@ -3,17 +3,25 @@
|
|||||||
## Content
|
## Content
|
||||||
|
|
||||||
- [Overview](#overview)
|
- [Overview](#overview)
|
||||||
- [The Hook Rule](#the-hook-rule)
|
|
||||||
- [Lifecycle hooks](#lifecycle-hooks)
|
|
||||||
- [Other hooks](#other-hooks)
|
|
||||||
- [`useState`](#usestate)
|
|
||||||
- [`useRef`](#useref)
|
|
||||||
- [`useSubEnv` and `useChildSubEnv`](#usesubenv-and-usechildsubenv)
|
|
||||||
- [`useExternalListener`](#useexternallistener)
|
|
||||||
- [`useComponent`](#usecomponent)
|
|
||||||
- [`useEnv`](#useenv)
|
|
||||||
- [`useEffect`](#useeffect)
|
|
||||||
- [Example: Mouse Position](#example-mouse-position)
|
- [Example: Mouse Position](#example-mouse-position)
|
||||||
|
- [Example: Autofocus](#example-autofocus)
|
||||||
|
- [Reference](#reference)
|
||||||
|
- [One Rule](#one-rule)
|
||||||
|
- [`useState`](#usestate)
|
||||||
|
- [`onMounted`](#onmounted)
|
||||||
|
- [`onWillUnmount`](#onwillunmount)
|
||||||
|
- [`onWillPatch`](#onwillpatch)
|
||||||
|
- [`onPatched`](#onpatched)
|
||||||
|
- [`onWillStart`](#onwillstart)
|
||||||
|
- [`onWillUpdateProps`](#onwillupdateprops)
|
||||||
|
- [`useContext`](#usecontext)
|
||||||
|
- [`useRef`](#useref)
|
||||||
|
- [`useSubEnv`](#usesubenv)
|
||||||
|
- [`useExternalListener`](#useexternallistener)
|
||||||
|
- [`useStore`](#usestore)
|
||||||
|
- [`useDispatch`](#usedispatch)
|
||||||
|
- [`useGetters`](#usegetters)
|
||||||
|
- [Making customized hooks](#making-customized-hooks)
|
||||||
|
|
||||||
## Overview
|
## Overview
|
||||||
|
|
||||||
@@ -32,239 +40,67 @@ Hooks work beautifully with Owl components: they solve the problems mentioned
|
|||||||
above, and in particular, they are the perfect way to make your component
|
above, and in particular, they are the perfect way to make your component
|
||||||
reactive.
|
reactive.
|
||||||
|
|
||||||
## The Hook Rule
|
## Example: mouse position
|
||||||
|
|
||||||
There is only one rule: every hook for a component has to be called in the _setup_ method, or in class fields:
|
Here is the classical example of a non trivial hook to track the mouse position.
|
||||||
|
|
||||||
```js
|
```js
|
||||||
// ok
|
const { useState, onMounted, onWillUnmount } = owl.hooks;
|
||||||
class SomeComponent extends Component {
|
|
||||||
state = useState({ value: 0 });
|
|
||||||
}
|
|
||||||
|
|
||||||
// also ok
|
// We define here a custom behaviour: this hook tracks the state of the mouse
|
||||||
class SomeComponent extends Component {
|
// position
|
||||||
setup() {
|
function useMouse() {
|
||||||
this.state = useState({ value: 0 });
|
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;
|
||||||
}
|
}
|
||||||
|
|
||||||
// not ok: this is executed after the constructor is called
|
// Main root component
|
||||||
class SomeComponent extends Component {
|
class App extends owl.Component {
|
||||||
async willStart() {
|
|
||||||
this.state = useState({ value: 0 });
|
|
||||||
}
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
## Lifecycle Hooks
|
|
||||||
|
|
||||||
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`
|
|
||||||
|
|
||||||
The `useState` hook is certainly the most important hook for Owl components:
|
|
||||||
this is what allows a component to be reactive, to react to state change.
|
|
||||||
|
|
||||||
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, Component } = owl;
|
|
||||||
|
|
||||||
class Counter extends Component {
|
|
||||||
static template = xml`
|
static template = xml`
|
||||||
<button t-on-click="increment">
|
<div t-name="App">
|
||||||
Click Me! [<t t-esc="state.value"/>]
|
<div>Mouse: <t t-esc="mouse.x"/>, <t t-esc="mouse.y"/></div>
|
||||||
</button>`;
|
</div>`;
|
||||||
|
|
||||||
state = useState({ value: 0 });
|
// this hooks is bound to the 'mouse' property.
|
||||||
|
mouse = useMouse();
|
||||||
increment() {
|
|
||||||
this.state.value++;
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
It is important to remember that `useState` only works with objects or arrays. It
|
Note that we use the prefix `use` for hooks, just like in React. This is just
|
||||||
is necessary, since Owl needs to react to a change in state.
|
a convention.
|
||||||
|
|
||||||
### `useRef`
|
## Example: autofocus
|
||||||
|
|
||||||
The `useRef` hook is useful when we need a way to interact with some inside part
|
Hooks can be combined to create the desired effect. For example, the following
|
||||||
of a component, rendered by Owl. It only work on a html element tagged by the
|
hook combines the `useRef` hook with the `onPatched` and `onMounted` functions
|
||||||
`t-ref` directive:
|
to create an easy way to focus an input whenever it appears in the DOM:
|
||||||
|
|
||||||
```xml
|
|
||||||
<div>
|
|
||||||
<input t-ref="someDiv"/>
|
|
||||||
<span>hello</span>
|
|
||||||
</div>
|
|
||||||
```
|
|
||||||
|
|
||||||
In this example, the component will be able to access the `div` and the component
|
|
||||||
`SubComponent` with the `useRef` hook:
|
|
||||||
|
|
||||||
```js
|
|
||||||
class Parent extends Component {
|
|
||||||
inputRef = useRef("someComponent");
|
|
||||||
|
|
||||||
someMethod() {
|
|
||||||
// here, if component is mounted, refs are active:
|
|
||||||
// - this.inputRef.el is the input HTMLElement
|
|
||||||
}
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
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-`](templates.md#dynamic-attributes) and
|
|
||||||
`t-component` directives). For example,
|
|
||||||
|
|
||||||
```xml
|
|
||||||
<div t-ref="component_{{someCondition ? '1' : '2'}}"/>
|
|
||||||
```
|
|
||||||
|
|
||||||
Here, the references need to be set like this:
|
|
||||||
|
|
||||||
```js
|
|
||||||
this.ref1 = useRef("component_1");
|
|
||||||
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` 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 `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 {
|
|
||||||
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` 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`
|
|
||||||
|
|
||||||
The `useExternalListener` hook helps solve a very common problem: adding and removing
|
|
||||||
a listener on some target whenever a component is mounted/unmounted. For example,
|
|
||||||
a dropdown menu (or its parent) may need to listen to a `click` event on `window`
|
|
||||||
to be closed:
|
|
||||||
|
|
||||||
```js
|
|
||||||
useExternalListener(window, "click", this.closeMenu);
|
|
||||||
```
|
|
||||||
|
|
||||||
### `useComponent`
|
|
||||||
|
|
||||||
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.
|
|
||||||
|
|
||||||
```js
|
|
||||||
function useSomething() {
|
|
||||||
const env = useEnv();
|
|
||||||
// now, env is bound to the env of the current component
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
### `useEffect`
|
|
||||||
|
|
||||||
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).
|
|
||||||
|
|
||||||
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.
|
|
||||||
|
|
||||||
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. 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
|
```js
|
||||||
function useAutofocus(name) {
|
function useAutofocus(name) {
|
||||||
let ref = useRef(name);
|
let ref = useRef(name);
|
||||||
useEffect(
|
let isInDom = false;
|
||||||
(el) => el && el.focus(),
|
function updateFocus() {
|
||||||
() => [ref.el]
|
if (!isInDom && ref.el) {
|
||||||
);
|
isInDom = true;
|
||||||
|
ref.el.focus();
|
||||||
|
} else if (isInDom && !ref.el) {
|
||||||
|
isInDom = false;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
onPatched(updateFocus);
|
||||||
|
onMounted(updateFocus);
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
@@ -281,44 +117,331 @@ class SomeComponent extends Component {
|
|||||||
<input t-ref="myinput"/>
|
<input t-ref="myinput"/>
|
||||||
</div>`;
|
</div>`;
|
||||||
|
|
||||||
setup() {
|
constructor(...args) {
|
||||||
|
super(...args);
|
||||||
useAutofocus("myinput");
|
useAutofocus("myinput");
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
## Example: mouse position
|
## Reference
|
||||||
|
|
||||||
Here is the classical example of a non trivial hook to track the mouse position.
|
### One rule
|
||||||
|
|
||||||
|
There is only one rule: every hook for a component has to be called in the
|
||||||
|
constructor (or in class fields):
|
||||||
|
|
||||||
```js
|
```js
|
||||||
const { useState, onWillDestroy, Component } = owl;
|
// ok
|
||||||
|
class SomeComponent extends Component {
|
||||||
// We define here a custom behaviour: this hook tracks the state of the mouse
|
state = useState({ value: 0 });
|
||||||
// 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);
|
|
||||||
});
|
|
||||||
|
|
||||||
return position;
|
|
||||||
}
|
}
|
||||||
|
|
||||||
// Main root component
|
// also ok
|
||||||
class Root extends Component {
|
class SomeComponent extends Component {
|
||||||
static template = xml`<div>Mouse: <t t-esc="mouse.x"/>, <t t-esc="mouse.y"/></div>`;
|
constructor(...args) {
|
||||||
|
super(...args);
|
||||||
|
this.state = useState({ value: 0 });
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
// this hooks is bound to the 'mouse' property.
|
// not ok: this is executed after the constructor is called
|
||||||
mouse = useMouse();
|
class SomeComponent extends Component {
|
||||||
|
async willStart() {
|
||||||
|
this.state = useState({ value: 0 });
|
||||||
|
}
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
Note that we use the prefix `use` for hooks, just like in React. This is just
|
As you can see, the `useState` hook does not need to be given a reference to
|
||||||
a convention.
|
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.
|
||||||
|
|
||||||
|
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).
|
||||||
|
|
||||||
|
### `useState`
|
||||||
|
|
||||||
|
The `useState` hook is certainly the most important hook for Owl components:
|
||||||
|
this is what allows a component to be reactive, to react to state change.
|
||||||
|
|
||||||
|
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;
|
||||||
|
|
||||||
|
class Counter extends owl.Component {
|
||||||
|
static template = xml`
|
||||||
|
<button t-on-click="increment">
|
||||||
|
Click Me! [<t t-esc="state.value"/>]
|
||||||
|
</button>`;
|
||||||
|
|
||||||
|
state = useState({ value: 0 });
|
||||||
|
|
||||||
|
increment() {
|
||||||
|
this.state.value++;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
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:
|
||||||
|
|
||||||
|
```xml
|
||||||
|
<div>
|
||||||
|
<div t-ref="someDiv"/>
|
||||||
|
<SubComponent t-ref="someComponent"/>
|
||||||
|
</div>
|
||||||
|
```
|
||||||
|
|
||||||
|
In this example, the component will be able to access the `div` and the component
|
||||||
|
`SubComponent` using the `useRef` hook:
|
||||||
|
|
||||||
|
```js
|
||||||
|
class Parent extends Component {
|
||||||
|
subRef = useRef("someComponent");
|
||||||
|
divRef = useRef("someDiv");
|
||||||
|
|
||||||
|
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)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
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.
|
||||||
|
|
||||||
|
The `t-ref` directive also accepts dynamic values with string interpolation
|
||||||
|
(like the [`t-attf-`](qweb_templating_language.md#dynamic-attributes) and
|
||||||
|
`t-component` directives). For example,
|
||||||
|
|
||||||
|
```xml
|
||||||
|
<div t-ref="component_{{someCondition ? '1' : '2'}}"/>
|
||||||
|
```
|
||||||
|
|
||||||
|
Here, the references need to be set like this:
|
||||||
|
|
||||||
|
```js
|
||||||
|
this.ref1 = useRef("component_1");
|
||||||
|
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`
|
||||||
|
|
||||||
|
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
|
||||||
|
can access it:
|
||||||
|
|
||||||
|
```js
|
||||||
|
class FormComponent extends Component {
|
||||||
|
constructor(...args) {
|
||||||
|
super(...args);
|
||||||
|
const model = makeModel();
|
||||||
|
useSubEnv({ model });
|
||||||
|
}
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
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.
|
||||||
|
|
||||||
|
### `useExternalListener`
|
||||||
|
|
||||||
|
The `useExternalListener` hook helps solve a very common problem: adding and removing
|
||||||
|
a listener on some target whenever a component is mounted/unmounted. For example,
|
||||||
|
a dropdown menu (or its parent) may need to listen to a `click` event on `window`
|
||||||
|
to be closed:
|
||||||
|
|
||||||
|
```js
|
||||||
|
useExternalListener(window, "click", this.closeMenu);
|
||||||
|
```
|
||||||
|
|
||||||
|
### `useStore`
|
||||||
|
|
||||||
|
The `useStore` hook is the entry point for a component to connect to the store.
|
||||||
|
See the [store documentation](store.md) for more information.
|
||||||
|
|
||||||
|
### `useDispatch`
|
||||||
|
|
||||||
|
The `useDispatch` hook is the way for components to get a reference to the store
|
||||||
|
`dispatch` function. See the [store documentation](store.md) for more information.
|
||||||
|
|
||||||
|
### `useGetters`
|
||||||
|
|
||||||
|
The `useGetters` hook is the way for components to get a reference to the store
|
||||||
|
getters. See the [store documentation](store.md) for more information.
|
||||||
|
|
||||||
|
### Making customized hooks
|
||||||
|
|
||||||
|
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.
|
||||||
|
|
||||||
|
But, like every good things in life, hooks should be used with moderation. They are
|
||||||
|
not the solution to every problem.
|
||||||
|
|
||||||
|
- 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:
|
||||||
|
|
||||||
|
```js
|
||||||
|
// maybe overkill
|
||||||
|
class A extends Component {
|
||||||
|
constructor(...args) {
|
||||||
|
super(...args);
|
||||||
|
useMySpecificHook();
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// ok
|
||||||
|
class B extends Component {
|
||||||
|
constructor(...args) {
|
||||||
|
super(...args);
|
||||||
|
this.performSpecificTask();
|
||||||
|
}
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
Note that the second solution is easier to extend in sub components.
|
||||||
|
|
||||||
|
- 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:
|
||||||
|
|
||||||
|
```js
|
||||||
|
const router = new Router(...);
|
||||||
|
|
||||||
|
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() {
|
||||||
|
return Component.current.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: the code above makes use of the `Component.current` property. This is the
|
||||||
|
way hooks are able to get a reference to the component currently being created.
|
||||||
|
|||||||
@@ -1,92 +0,0 @@
|
|||||||
# 🦉 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.
|
|
||||||
@@ -0,0 +1,134 @@
|
|||||||
|
# 🦉 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 } = owl;
|
||||||
|
const { Portal } = owl.misc;
|
||||||
|
|
||||||
|
class TeleportedComponent extends Component {}
|
||||||
|
class App extends Component {
|
||||||
|
static components = { Portal, TeleportedComponent };
|
||||||
|
}
|
||||||
|
|
||||||
|
const app = new App();
|
||||||
|
app.mount(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.
|
||||||
@@ -0,0 +1,52 @@
|
|||||||
|
# 🦉 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.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.Observer();
|
||||||
|
const obj = observer.observe({ a: { b: 1 } });
|
||||||
|
|
||||||
|
observer.deepRevNumber(obj.a); // 1
|
||||||
|
obj.a.b = 2;
|
||||||
|
|
||||||
|
observer.deepRevNumber(obj.a); // 2
|
||||||
|
```
|
||||||
|
|
||||||
|
The `deepRevNumber` can also return 0, which indicates that the value is not
|
||||||
|
observed.
|
||||||
@@ -1,17 +0,0 @@
|
|||||||
# 🦉 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.
|
|
||||||
@@ -1,30 +0,0 @@
|
|||||||
# 🦉 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.
|
|
||||||
+23
-196
@@ -4,11 +4,8 @@
|
|||||||
|
|
||||||
- [Overview](#overview)
|
- [Overview](#overview)
|
||||||
- [Definition](#definition)
|
- [Definition](#definition)
|
||||||
- [Binding function props](#binding-function-props)
|
|
||||||
- [Dynamic Props](#dynamic-props)
|
|
||||||
- [Default Props](#default-props)
|
|
||||||
- [Props validation](#props-validation)
|
|
||||||
- [Good Practices](#good-practices)
|
- [Good Practices](#good-practices)
|
||||||
|
- [Dynamic Props](#dynamic-props)
|
||||||
|
|
||||||
## Overview
|
## Overview
|
||||||
|
|
||||||
@@ -21,7 +18,7 @@ class Child extends Component {
|
|||||||
}
|
}
|
||||||
|
|
||||||
class Parent extends Component {
|
class Parent extends Component {
|
||||||
static template = xml`<div><Child a="state.a" b="'string'"/></div>`;
|
static template = xml`<div><ComponentA a="state.a" b="'string'"/></div>`;
|
||||||
static components = { Child };
|
static components = { Child };
|
||||||
state = useState({ a: "fromparent" });
|
state = useState({ a: "fromparent" });
|
||||||
}
|
}
|
||||||
@@ -41,6 +38,8 @@ The `props` object is made of every attributes defined on the template, with the
|
|||||||
following exceptions:
|
following exceptions:
|
||||||
|
|
||||||
- every attribute starting with `t-` are not props (they are QWeb directives),
|
- 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:
|
In the following example:
|
||||||
|
|
||||||
@@ -48,6 +47,7 @@ In the following example:
|
|||||||
<div>
|
<div>
|
||||||
<ComponentA a="state.a" b="'string'"/>
|
<ComponentA a="state.a" b="'string'"/>
|
||||||
<ComponentB t-if="state.flag" model="model"/>
|
<ComponentB t-if="state.flag" model="model"/>
|
||||||
|
<ComponentC style="color:red;" class="left-pane" />
|
||||||
</div>
|
</div>
|
||||||
```
|
```
|
||||||
|
|
||||||
@@ -55,197 +55,7 @@ the `props` object contains the following keys:
|
|||||||
|
|
||||||
- for `ComponentA`: `a` and `b`,
|
- for `ComponentA`: `a` and `b`,
|
||||||
- for `ComponentB`: `model`,
|
- 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
|
## Good Practices
|
||||||
|
|
||||||
@@ -268,3 +78,20 @@ sent to the parent (for example, with an event).
|
|||||||
Any value can go in a props. Strings, objects, classes, or even callbacks could
|
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
|
be given to a child component (but then, in the case of callbacks, communicating
|
||||||
with events seems more appropriate).
|
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 } };
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|||||||
@@ -0,0 +1,103 @@
|
|||||||
|
# 🦉 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)
|
||||||
|
},
|
||||||
|
};
|
||||||
|
```
|
||||||
@@ -0,0 +1,153 @@
|
|||||||
|
# 🦉 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.
|
||||||
@@ -1,34 +1,30 @@
|
|||||||
# 🦉 Templates 🦉
|
# 🦉 QWeb Templating Language🦉
|
||||||
|
|
||||||
## Content
|
## Content
|
||||||
|
|
||||||
- [Overview](#overview)
|
- [Overview](#overview)
|
||||||
- [Directives](#directives)
|
- [Directives](#directives)
|
||||||
- [QWeb Template reference](#qweb-template-reference)
|
- [Reference](#reference)
|
||||||
- [White Spaces](#white-spaces)
|
- [White Spaces](#white-spaces)
|
||||||
|
- [Root Nodes](#root-nodes)
|
||||||
- [Expression Evaluation](#expression-evaluation)
|
- [Expression Evaluation](#expression-evaluation)
|
||||||
- [Static html Nodes](#static-html-nodes)
|
- [Static html Nodes](#static-html-nodes)
|
||||||
- [Outputting Data](#outputting-data)
|
- [Outputting Data](#outputting-data)
|
||||||
- [Setting Variables](#setting-variables)
|
- [Setting Variables](#setting-variables)
|
||||||
- [Conditionals](#conditionals)
|
- [Conditionals](#conditionals)
|
||||||
- [Dynamic Attributes](#dynamic-attributes)
|
- [Dynamic Attributes](#dynamic-attributes)
|
||||||
- [Dynamic Class Attribute](#dynamic-class-attribute)
|
|
||||||
- [Dynamic Tag Names](#dynamic-tag-names)
|
|
||||||
- [Loops](#loops)
|
- [Loops](#loops)
|
||||||
- [Sub Templates](#sub-templates)
|
- [Rendering Sub Templates](#rendering-sub-templates)
|
||||||
- [Dynamic Sub Templates](#dynamic-sub-templates)
|
- [Dynamic Sub Templates](#dynamic-sub-templates)
|
||||||
|
- [Translations](#translations)
|
||||||
- [Debugging](#debugging)
|
- [Debugging](#debugging)
|
||||||
- [Fragments](#fragments)
|
|
||||||
- [Inline templates](#inline-templates)
|
|
||||||
- [Rendering svg](#rendering-svg)
|
|
||||||
- [Restrictions](#restrictions)
|
|
||||||
|
|
||||||
## Overview
|
## Overview
|
||||||
|
|
||||||
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
|
[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
|
||||||
mostly to generate HTML. In OWL, QWeb templates are compiled into functions that
|
mostly to generate HTML. In OWL, QWeb templates are compiled into functions that
|
||||||
generate a virtual dom representation of the HTML. Also, since Owl is a live
|
generate a virtual dom representation of the HTML.
|
||||||
component system, there are additional directives specific to Owl (such as `t-on`).
|
|
||||||
|
|
||||||
```xml
|
```xml
|
||||||
<div>
|
<div>
|
||||||
@@ -55,33 +51,33 @@ extensions.
|
|||||||
|
|
||||||
For reference, here is a list of all standard QWeb directives:
|
For reference, here is a list of all standard QWeb directives:
|
||||||
|
|
||||||
| Name | Description |
|
| Name | Description |
|
||||||
| ------------------------------ | --------------------------------------------------------------- |
|
| ------------------------------ | -------------------------------------------------------------- |
|
||||||
| `t-esc` | [Outputting safely a value](#outputting-data) |
|
| `t-esc` | [Outputting safely a value](#outputting-data) |
|
||||||
| `t-out` | [Outputting value, possibly without escaping](#outputting-data) |
|
| `t-raw` | [Outputting value, without escaping](#outputting-data) |
|
||||||
| `t-set`, `t-value` | [Setting variables](#setting-variables) |
|
| `t-set`, `t-value` | [Setting variables](#setting-variables) |
|
||||||
| `t-if`, `t-elif`, `t-else`, | [conditionally rendering](#conditionals) |
|
| `t-if`, `t-elif`, `t-else`, | [conditionally rendering](#conditionals) |
|
||||||
| `t-foreach`, `t-as` | [Loops](#loops) |
|
| `t-foreach`, `t-as` | [Loops](#loops) |
|
||||||
| `t-att`, `t-attf-*`, `t-att-*` | [Dynamic attributes](#dynamic-attributes) |
|
| `t-att`, `t-attf-*`, `t-att-*` | [Dynamic attributes](#dynamic-attributes) |
|
||||||
| `t-call` | [Rendering sub templates](#sub-templates) |
|
| `t-call` | [Rendering sub templates](#rendering-sub-templates) |
|
||||||
| `t-debug`, `t-log` | [Debugging](#debugging) |
|
| `t-debug`, `t-log` | [Debugging](#debugging) |
|
||||||
| `t-translation` | [Disabling the translation of a node](translations.md) |
|
| `t-translation` | [Disabling the translation of a node](#translations) |
|
||||||
|
| `t-name` | [Defining a template (not really a directive)](qweb_engine.md) |
|
||||||
|
|
||||||
The component system in Owl requires additional directives, to express various
|
The component system in Owl requires additional directives, to express various
|
||||||
needs. Here is a list of all Owl specific directives:
|
needs. Here is a list of all Owl specific directives:
|
||||||
|
|
||||||
| Name | Description |
|
| Name | Description |
|
||||||
| -------------------------------------- | --------------------------------------------------------------- |
|
| ------------------------ | ------------------------------------------------------------------------------- |
|
||||||
| `t-component`, `t-props` | [Defining a sub component](component.md#sub-components) |
|
| `t-component`, `t-props` | [Defining a sub component](component.md#composition) |
|
||||||
| `t-ref` | [Setting a reference to a dom node or a sub component](refs.md) |
|
| `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-key` | [Defining a key (to help virtual dom reconciliation)](#loops) |
|
||||||
| `t-on-*` | [Event handling](event_handling.md) |
|
| `t-on-*` | [Event handling](event_handling.md) |
|
||||||
| `t-portal` | [Portal](portal.md) |
|
| `t-transition` | [Defining an animation](animations.md#css-transitions) |
|
||||||
| `t-slot`, `t-set-slot`, `t-slot-scope` | [Rendering a slot](slots.md) |
|
| `t-slot` | [Rendering a slot](slots.md) |
|
||||||
| `t-model` | [Form input bindings](input_bindings.md) |
|
| `t-model` | [Form input bindings](component.md#form-input-bindings) |
|
||||||
| `t-tag` | [Rendering nodes with dynamic tag name](#dynamic-tag-names) |
|
|
||||||
|
|
||||||
## QWeb Template Reference
|
## Reference
|
||||||
|
|
||||||
### White Spaces
|
### White Spaces
|
||||||
|
|
||||||
@@ -91,6 +87,32 @@ White spaces in a template are handled in a special way:
|
|||||||
- if a whitespace-only text node contains a linebreak, it is ignored
|
- 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
|
- 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
|
### Expression Evaluation
|
||||||
|
|
||||||
QWeb expressions are strings that will be processed at compile time. Each variable in
|
QWeb expressions are strings that will be processed at compile time. Each variable in
|
||||||
@@ -165,29 +187,24 @@ rendered with the value `value` set to `42` in the rendering context yields:
|
|||||||
<p>42</p>
|
<p>42</p>
|
||||||
```
|
```
|
||||||
|
|
||||||
The `t-out` directive is almost the same as `t-esc`, but possibly without the
|
The `t-raw` directive is almost the same as `t-esc`, but without the escaping.
|
||||||
escaping. The difference is that the value received by the `t-out` directive
|
This is mostly useful to inject a raw html string somewhere. Obviously, this
|
||||||
will only be not-escaped if it has been marked as such, using the `markup`
|
is unsafe to do in general, and should only be used for strings known to be safe.
|
||||||
utility function:
|
|
||||||
|
|
||||||
For example, in the following component:
|
```xml
|
||||||
|
<p><t t-raw="value"/></p>
|
||||||
```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>");
|
|
||||||
}
|
|
||||||
```
|
```
|
||||||
|
|
||||||
The first `t-out` will act as a `t-esc` directive, which means that the content
|
rendered with the value `value` set to `<span>foo</span>` in the rendering context yields:
|
||||||
of `value1` will be escaped. However, since `value2` has been tagged as a markup,
|
|
||||||
this will be injected as html.
|
```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.
|
||||||
|
|
||||||
### Setting Variables
|
### Setting Variables
|
||||||
|
|
||||||
@@ -290,11 +307,10 @@ 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
|
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
|
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. The dynamic elements can be
|
literal and dynamic elements, such as css classes.
|
||||||
specified with either `{{...}}` or `#{...}`:
|
|
||||||
|
|
||||||
```xml
|
```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> -->
|
<!-- result if values are set to 1,2 and 3: <div foo="a 0 is 1 of 2 ]"></div> -->
|
||||||
```
|
```
|
||||||
|
|
||||||
@@ -308,40 +324,6 @@ values) or a pair `[key, value]`. For example:
|
|||||||
<div t-att="['a', 'b']"/> <!-- <div a="b"></div> -->
|
<div t-att="['a', 'b']"/> <!-- <div a="b"></div> -->
|
||||||
```
|
```
|
||||||
|
|
||||||
### Dynamic class attribute
|
|
||||||
|
|
||||||
For convenience, Owl supports a special case for the `t-att-class` case: one can
|
|
||||||
use an object with keys describing the classes, and values boolean value denoting
|
|
||||||
if the class is or is not present:
|
|
||||||
|
|
||||||
```xml
|
|
||||||
<div t-att-class="{'a': true, 'b': true}"/> <!-- result: <div class="a b"></div> -->
|
|
||||||
|
|
||||||
<div t-att-class="{'a b': true, 'c': true}"/> <!-- result: <div class="a b c"></div> -->
|
|
||||||
```
|
|
||||||
|
|
||||||
Note that it can be combined with normal class attribute:
|
|
||||||
|
|
||||||
```xml
|
|
||||||
<div class="a" t-att-class="{'b': true}"/> <!-- result: <div class="a b"></div> -->
|
|
||||||
```
|
|
||||||
|
|
||||||
### Dynamic tag names
|
|
||||||
|
|
||||||
When writing generic components or templates, the specific concrete tag for an
|
|
||||||
HTML element is not known yet. In those situations, the `t-tag` directive is
|
|
||||||
useful. It simply evaluates dynamically an expression to use as a tag name. The
|
|
||||||
template:
|
|
||||||
|
|
||||||
```xml
|
|
||||||
<t t-tag="tag">
|
|
||||||
<span>content</span>
|
|
||||||
</t>
|
|
||||||
```
|
|
||||||
|
|
||||||
will be rendered as `<div><span>content</span></div>` if the `tag` context key
|
|
||||||
is set to `div`.
|
|
||||||
|
|
||||||
### Loops
|
### Loops
|
||||||
|
|
||||||
QWeb has an iteration directive `t-foreach` which take an expression returning the
|
QWeb has an iteration directive `t-foreach` which take an expression returning the
|
||||||
@@ -349,7 +331,7 @@ collection to iterate on, and a second parameter `t-as` providing the name to us
|
|||||||
for the current item of the iteration:
|
for the current item of the iteration:
|
||||||
|
|
||||||
```xml
|
```xml
|
||||||
<t t-foreach="[1, 2, 3]" t-as="i" t-key="i">
|
<t t-foreach="[1, 2, 3]" t-as="i">
|
||||||
<p><t t-esc="i"/></p>
|
<p><t t-esc="i"/></p>
|
||||||
</t>
|
</t>
|
||||||
```
|
```
|
||||||
@@ -365,17 +347,13 @@ will be rendered as:
|
|||||||
Like conditions, `t-foreach` applies to the element bearing the directive’s attribute, and
|
Like conditions, `t-foreach` applies to the element bearing the directive’s attribute, and
|
||||||
|
|
||||||
```xml
|
```xml
|
||||||
<p t-foreach="[1, 2, 3]" t-as="i" t-key="i">
|
<p t-foreach="[1, 2, 3]" t-as="i">
|
||||||
<t t-esc="i"/>
|
<t t-esc="i"/>
|
||||||
</p>
|
</p>
|
||||||
```
|
```
|
||||||
|
|
||||||
is equivalent to the previous example.
|
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)
|
`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).
|
or an object (the current item will be the current key).
|
||||||
|
|
||||||
@@ -401,7 +379,7 @@ into the global context.
|
|||||||
<t t-set="existing_variable" t-value="false"/>
|
<t t-set="existing_variable" t-value="false"/>
|
||||||
<!-- existing_variable now False -->
|
<!-- existing_variable now False -->
|
||||||
|
|
||||||
<p t-foreach="Array(3)" t-as="i" t-key="i">
|
<p t-foreach="Array(3)" t-as="i">
|
||||||
<t t-set="existing_variable" t-value="true"/>
|
<t t-set="existing_variable" t-value="true"/>
|
||||||
<t t-set="new_variable" t-value="true"/>
|
<t t-set="new_variable" t-value="true"/>
|
||||||
<!-- existing_variable and new_variable now true -->
|
<!-- existing_variable and new_variable now true -->
|
||||||
@@ -415,14 +393,17 @@ 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,
|
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
|
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
|
set as attribute in the DOM tree. This is why we use a virtual dom
|
||||||
algorithm to make sure we keep the actual DOM node instead of replacing it with
|
algorithm to keep the actual DOM node as much as possible.
|
||||||
a new one.
|
|
||||||
|
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.
|
||||||
|
|
||||||
Consider the following situation: we have a list of two items `[{text: "a"}, {text: "b"}]`
|
Consider the following situation: we have a list of two items `[{text: "a"}, {text: "b"}]`
|
||||||
and we render them in this template:
|
and we render them in this template:
|
||||||
|
|
||||||
```xml
|
```xml
|
||||||
<p t-foreach="items" t-as="item" t-key="item_index"><t t-esc="item.text"/></p>
|
<p t-foreach="items" t-as="item"><t t-esc="item.text"/></p>
|
||||||
```
|
```
|
||||||
|
|
||||||
The result will be two `<p>` tags with text `a` and `b`. Now, if we swap them,
|
The result will be two `<p>` tags with text `a` and `b`. Now, if we swap them,
|
||||||
@@ -483,7 +464,7 @@ using the `...` javascript operator. For example:
|
|||||||
The `...` operator will convert the `Set` (or any other iterables) into a list,
|
The `...` operator will convert the `Set` (or any other iterables) into a list,
|
||||||
which will work with Owl QWeb.
|
which will work with Owl QWeb.
|
||||||
|
|
||||||
### Sub Templates
|
### Rendering Sub Templates
|
||||||
|
|
||||||
QWeb templates can be used for top level rendering, but they can also be used
|
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
|
from within another template (to avoid duplication or give names to parts of
|
||||||
@@ -540,15 +521,6 @@ This can be used to define variables scoped to a sub template:
|
|||||||
<!-- "var" does not exist here -->
|
<!-- "var" does not exist here -->
|
||||||
```
|
```
|
||||||
|
|
||||||
Note: by default, the rendering context for a sub template is simply the current
|
|
||||||
rendering context (so, the current component). 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
|
### Dynamic sub templates
|
||||||
|
|
||||||
The `t-call` directive can also be used to dynamically call a sub template,
|
The `t-call` directive can also be used to dynamically call a sub template,
|
||||||
@@ -565,6 +537,21 @@ using string interpolation. For example:
|
|||||||
Here, the name of the template is obtained from the `template` value in the
|
Here, the name of the template is obtained from the `template` value in the
|
||||||
template rendering context.
|
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
|
### Debugging
|
||||||
|
|
||||||
The javascript QWeb implementation provides two useful debugging directives:
|
The javascript QWeb implementation provides two useful debugging directives:
|
||||||
@@ -587,117 +574,3 @@ will stop execution if the browser dev tools are open.
|
|||||||
```
|
```
|
||||||
|
|
||||||
will print 42 to the console.
|
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>
|
|
||||||
```
|
|
||||||
@@ -1,131 +0,0 @@
|
|||||||
# 🦉 Reactivity 🦉
|
|
||||||
|
|
||||||
## Content
|
|
||||||
|
|
||||||
- [Overview](#overview)
|
|
||||||
- [`useState`](#usestate)
|
|
||||||
- [`reactive`](#reactive)
|
|
||||||
- [`markRaw`](#markraw)
|
|
||||||
- [`toRaw`](#toraw)
|
|
||||||
|
|
||||||
## Overview
|
|
||||||
|
|
||||||
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 automatically
|
|
||||||
update accordingly to state changes. Also, we obviously want this to happen in
|
|
||||||
a performant way.
|
|
||||||
|
|
||||||
To solve this issue, Owl provides two reactivity primitives:
|
|
||||||
|
|
||||||
- `reactive`, which returns a proxy to its first argument, and tracks all read/update
|
|
||||||
operation going through it,
|
|
||||||
- `useState`: a hook, that internally uses `reactive`, and is linked to its
|
|
||||||
owner component: any read operation will be tracked (key by key), and any
|
|
||||||
updates to these tracked values will cause the component to be rerendered.
|
|
||||||
|
|
||||||
Most of the time, the `useState` hook is the best solution.
|
|
||||||
|
|
||||||
Since version 2.0, Owl applies the fine grained reactivity at the component
|
|
||||||
level: reactive objects received as props are automatically subscribed to by the
|
|
||||||
component, so Owl can track which part of these props are consumed by each
|
|
||||||
component, and is therefore able to only rerender the impacted components.
|
|
||||||
|
|
||||||
## `useState`
|
|
||||||
|
|
||||||
Let us start by an example of how `useState` could be used:
|
|
||||||
|
|
||||||
```js
|
|
||||||
class Counter extends Component {
|
|
||||||
static template = xml`
|
|
||||||
<div t-on-click="increment">
|
|
||||||
<t t-esc="state.value"/>
|
|
||||||
</div>`;
|
|
||||||
|
|
||||||
setup() {
|
|
||||||
this.state = useState({ value: 0 });
|
|
||||||
}
|
|
||||||
|
|
||||||
increment() {
|
|
||||||
this.state.value++;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
If one were to use a simple state object, Owl would not be aware that the value
|
|
||||||
was changed and that the component should be rerendered. With the `useState`
|
|
||||||
hook, `this.state` is now a reactive object, so this component works as expected.
|
|
||||||
|
|
||||||
## `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 will be 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 was not read
|
|
||||||
console.log(obj.a); // log 2, and reads the 'a' key => it is now tracked
|
|
||||||
obj.a = 3; // log 'changed' because we updated a tracked value
|
|
||||||
```
|
|
||||||
|
|
||||||
An important property of reactive objects is that they can be reobserved: this
|
|
||||||
will create an independant 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); // log 1, and reads the 'a' key => it is now tracked by observer 1
|
|
||||||
console.log(obj1.b); // log 2, and 'b' is now tracked by observer 1
|
|
||||||
console.log(obj2.b); // log 2, and 'b' is now tracked by observer 1
|
|
||||||
obj2.a = 3; // log 'observer1', because observer2 does not track a
|
|
||||||
obj2.b = 3; // log 'observer1' and 'observer2'
|
|
||||||
```
|
|
||||||
|
|
||||||
Obviously, one can use `reactive` on the result of a `useState` if wanted, this
|
|
||||||
is the proper way to watch for some state changes.
|
|
||||||
|
|
||||||
## `markRaw`
|
|
||||||
|
|
||||||
Marks an object so that it is ignored by the reactivity system. This function returns its argument.
|
|
||||||
|
|
||||||
```js
|
|
||||||
const someObject = markRaw(...);
|
|
||||||
const state = useState({
|
|
||||||
a: 1,
|
|
||||||
obj: someObject
|
|
||||||
});
|
|
||||||
// here, state.obj === someObject
|
|
||||||
```
|
|
||||||
|
|
||||||
This is useful in some rare cases. For example, some complex and large object such
|
|
||||||
that going through the reactivity system may cause a non trivial performance slowdown.
|
|
||||||
|
|
||||||
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!
|
|
||||||
|
|
||||||
## `toRaw`
|
|
||||||
|
|
||||||
Given a reactive object, this function returns the underlying, non-reactive,
|
|
||||||
corresponding object.
|
|
||||||
|
|
||||||
```js
|
|
||||||
// in setup
|
|
||||||
const state = useState({ value: 1 });
|
|
||||||
|
|
||||||
// later:
|
|
||||||
const rawState = toRaw(this.state);
|
|
||||||
rawState.value = 3; // will NOT be picked up by the reactivity system!!!
|
|
||||||
```
|
|
||||||
|
|
||||||
Here again, this is useful in some situations where we want to explicitely bypass
|
|
||||||
Owl, but using this function means that the responsability of coordinating
|
|
||||||
state update is given to the user code, instead of Owl. Subtle bugs may arise!
|
|
||||||
|
|
||||||
Also, normal (non-reactive objects) will be directly returned by `toRaw`:
|
|
||||||
|
|
||||||
```js
|
|
||||||
const obj = { a: 1 };
|
|
||||||
console.log(toRaw(obj) === obj); // true
|
|
||||||
```
|
|
||||||
@@ -1,37 +0,0 @@
|
|||||||
# 🦉 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.
|
|
||||||
@@ -0,0 +1,183 @@
|
|||||||
|
# 🦉 Router 🦉
|
||||||
|
|
||||||
|
Remove?
|
||||||
|
|
||||||
|
## Content
|
||||||
|
|
||||||
|
- [Overview](#overview)
|
||||||
|
- [Example](#example)
|
||||||
|
- [Reference](#reference)
|
||||||
|
- [Route Definition](#route-definition)
|
||||||
|
- [Router](#router)
|
||||||
|
- [Navigation Guards](#navigation-guards)
|
||||||
|
- [RouteComponent](#routecomponent)
|
||||||
|
- [Link](#link)
|
||||||
|
|
||||||
|
## Overview
|
||||||
|
|
||||||
|
It is often useful to organize an application around urls. If the application is
|
||||||
|
a single page application, then we need a way to manage those urls in the browser.
|
||||||
|
This is why there are many different routers for different frameworks. A generic
|
||||||
|
router can do the job just fine, but a specialized router for Owl can give a
|
||||||
|
better developer experience.
|
||||||
|
|
||||||
|
The Owl router support the following features:
|
||||||
|
|
||||||
|
- `history` or `hash` mode
|
||||||
|
- declarative routes
|
||||||
|
- route redirection
|
||||||
|
- navigation guards
|
||||||
|
- parameterized routes
|
||||||
|
- a `<Link/>` component
|
||||||
|
- a `<RouteComponent/>` component
|
||||||
|
|
||||||
|
Note that it is still in early stage of developments, and there are probably
|
||||||
|
still some issues.
|
||||||
|
|
||||||
|
## Example
|
||||||
|
|
||||||
|
To use the Owl router, there are some steps that needs to be done:
|
||||||
|
|
||||||
|
- declare some routes
|
||||||
|
- create a router
|
||||||
|
- add it to the environment
|
||||||
|
|
||||||
|
```js
|
||||||
|
async function protectRoute({ env, to }) {
|
||||||
|
if (!env.session.authUser) {
|
||||||
|
env.session.setNextRoute(to.name);
|
||||||
|
return { to: "SIGN_IN" };
|
||||||
|
}
|
||||||
|
return true;
|
||||||
|
}
|
||||||
|
|
||||||
|
export const ROUTES = [
|
||||||
|
{ name: "LANDING", path: "/", component: Landing },
|
||||||
|
{ name: "TASK", path: "/tasks/{{id}}", component: Task },
|
||||||
|
{ name: "SIGN_UP", path: "/signup", component: SignUp },
|
||||||
|
{ name: "SIGN_IN", path: "/signin", component: SignIn },
|
||||||
|
{ name: "ADMIN", path: "/admin", component: Admin, beforeRouteEnter: protectRoute },
|
||||||
|
{ name: "ACCOUNT", path: "/account", component: Account, beforeRouteEnter: protectRoute },
|
||||||
|
{ name: "UNKNOWN", path: "*", redirect: { to: "LANDING" } }
|
||||||
|
];
|
||||||
|
|
||||||
|
function makeEnvironment() {
|
||||||
|
...
|
||||||
|
const env = { qweb };
|
||||||
|
env.session = new Session(env);
|
||||||
|
env.router = new owl.router.Router(env, ROUTES);
|
||||||
|
await env.router.start();
|
||||||
|
return env;
|
||||||
|
}
|
||||||
|
|
||||||
|
App.env = makeEnvironment();
|
||||||
|
// create root component here
|
||||||
|
```
|
||||||
|
|
||||||
|
Notice that the router needs to be started. This is an asynchronous operation
|
||||||
|
because it needs to apply the potential navigation guards on the current route
|
||||||
|
(which may or may not mean that the application is redirected to another route).
|
||||||
|
|
||||||
|
## Reference
|
||||||
|
|
||||||
|
### Route definition
|
||||||
|
|
||||||
|
A route need to be defined as an object with the following keys:
|
||||||
|
|
||||||
|
- `name` (optional): a (unique) string useful to identify the current route. If not
|
||||||
|
given, it will be assigned an automatic name,
|
||||||
|
- `path`: a string describing the url. It can be static: `/admin` or dynamic: `/users/{{id}}`.
|
||||||
|
It also can be `*`, to catch all remaining routes.
|
||||||
|
- `component` (optional): an Owl component that will be used by the `t-routecomponent`
|
||||||
|
directive if the route is active
|
||||||
|
- `redirect` (optional): should be destination object (with optional keys `path`, `to` and `params`) if given, the application will be redirected to the destination whenever we match this route
|
||||||
|
- `beforeRouteEnter`: defines a [navigation guard](#navigation-guards).
|
||||||
|
|
||||||
|
### `Router`
|
||||||
|
|
||||||
|
The `Router` constructor takes three arguments:
|
||||||
|
|
||||||
|
- `env`: a valid environment,
|
||||||
|
- a list of routes,
|
||||||
|
- an optional object (with the only key `mode` which can be `history` (default
|
||||||
|
value) or `hash`).
|
||||||
|
|
||||||
|
`history` will use the browser [History API](https://developer.mozilla.org/en-US/docs/Web/API/History_API) as the mechanism to manage URL.\
|
||||||
|
Example: `https://yourdomain.tld/my_custom_route`.\
|
||||||
|
For this mechanism to work, you need a way to configure your web server accordingly.
|
||||||
|
|
||||||
|
`hash` will manipulate the hash of the URL.\
|
||||||
|
Example: `https://yourdomain.tld/index.html#/my_custom_route`.
|
||||||
|
|
||||||
|
```js
|
||||||
|
const ROUTES = [...];
|
||||||
|
const router = new owl.router.Router(env, ROUTES, {mode: 'history'});
|
||||||
|
```
|
||||||
|
|
||||||
|
Note that the route are defined in a list, and the order matters: the router
|
||||||
|
tries to find a match by going down the list.
|
||||||
|
|
||||||
|
The router needs to be added to the environment in the `router` sub key.
|
||||||
|
|
||||||
|
Once a router is created, it needs to be started. This is necessary to initialize
|
||||||
|
its current state to the current URL (and also, to potentially apply any
|
||||||
|
navigation guards and/or redirecting).
|
||||||
|
|
||||||
|
```js
|
||||||
|
await router.start();
|
||||||
|
```
|
||||||
|
|
||||||
|
Once started, the router will keep track of the current url and reflect its
|
||||||
|
value in two keys:
|
||||||
|
|
||||||
|
- `router.currentRoute`
|
||||||
|
- `router.currentParams`
|
||||||
|
|
||||||
|
The router also has a `navigate` method, useful to programmatically change the
|
||||||
|
application to another state (and the url):
|
||||||
|
|
||||||
|
```js
|
||||||
|
router.navigate({ to: "USER", params: { id: 51 } });
|
||||||
|
```
|
||||||
|
|
||||||
|
### Navigation Guards
|
||||||
|
|
||||||
|
Navigation guards are very useful to be able to execute some business logic/
|
||||||
|
perform some actions or redirect to other routes whenever the application is
|
||||||
|
entering a new route. For example, the following guard checks if there is an
|
||||||
|
authenticated user, and if it is not the case, redirect to the sign in route.
|
||||||
|
|
||||||
|
```js
|
||||||
|
async function protectRoute({ env, to }) {
|
||||||
|
if (!env.session.authUser) {
|
||||||
|
env.session.setNextRoute(to.name);
|
||||||
|
return { to: "SIGN_IN" };
|
||||||
|
}
|
||||||
|
return true;
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
A navigation guard is a function that returns a promise, which either resolves
|
||||||
|
to `true` (the navigation is accepted), or to another destination object.
|
||||||
|
|
||||||
|
### `RouteComponent`
|
||||||
|
|
||||||
|
The `RouteComponent` component directs Owl to render the component associated
|
||||||
|
to the currently active route (if any):
|
||||||
|
|
||||||
|
```xml
|
||||||
|
<div t-name="App">
|
||||||
|
<NavBar />
|
||||||
|
<RouteComponent />
|
||||||
|
</div>
|
||||||
|
```
|
||||||
|
|
||||||
|
### `Link`
|
||||||
|
|
||||||
|
The `Link` component is a Owl component which render as a `<a>` tag with any
|
||||||
|
content. It will compute the proper href from its props, and allow Owl to
|
||||||
|
properly navigate to a given url if clicked on it.
|
||||||
|
|
||||||
|
```xml
|
||||||
|
<Link to="'HOME'">Home</Link>
|
||||||
|
```
|
||||||
+48
-212
@@ -3,92 +3,67 @@
|
|||||||
## Content
|
## Content
|
||||||
|
|
||||||
- [Overview](#overview)
|
- [Overview](#overview)
|
||||||
- [Named slots](#named-slots)
|
- [Example](#example)
|
||||||
- [Rendering Context](#rendering-context)
|
- [Reference](#reference)
|
||||||
- [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
|
## Overview
|
||||||
|
|
||||||
Owl is a template based component system. There is therefore a need to be able
|
Owl is a template based component system. There is therefore a need to be able
|
||||||
to make generic components. For example, imagine a generic `Navbar`
|
to make generic components. For example, imagine a generic `Dialog`
|
||||||
component, which displays a navbar, but with some customizable content. Since
|
component, which is able to display some arbitrary content.
|
||||||
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:
|
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.
|
||||||
|
|
||||||
```xml
|
```xml
|
||||||
<div>
|
<div t-name="Dialog" class="modal">
|
||||||
<Navbar>
|
<div class="modal-title"><t t-esc="props.title"/></div>
|
||||||
<span>Hello Owl</span>
|
<div class="modal-content">
|
||||||
</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"/>
|
<t t-slot="content"/>
|
||||||
</div>
|
</div>
|
||||||
|
<div class="modal-footer">
|
||||||
|
<t t-slot="footer"/>
|
||||||
|
</div>
|
||||||
</div>
|
</div>
|
||||||
```
|
```
|
||||||
|
|
||||||
And one could use it with the `t-set-slot` directive:
|
Slots are defined by the caller, with the `t-set-slot` directive:
|
||||||
|
|
||||||
```xml
|
```xml
|
||||||
<InfoBox>
|
<div t-name="SomeComponent">
|
||||||
<t t-set-slot="title">
|
<div>some component</div>
|
||||||
Specific Title. It could be html also.
|
<Dialog title="Some Dialog">
|
||||||
</t>
|
<t t-set-slot="content">
|
||||||
<t t-set-slot="content">
|
<div>hey</div>
|
||||||
<!-- some template here, with html, events, whatever -->
|
</t>
|
||||||
</t>
|
<t t-set-slot="footer">
|
||||||
</InfoBox>
|
<button t-on-click="doSomething">ok</button>
|
||||||
|
</t>
|
||||||
|
</Dialog>
|
||||||
|
</div>
|
||||||
```
|
```
|
||||||
|
|
||||||
## Rendering context
|
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.
|
||||||
|
|
||||||
The content of the slots is actually rendered with the rendering context corresponding
|
Note: Owl previously used the `t-set` directive to define the content of a slot.
|
||||||
to where it was defined, not where it is positioned. This allows the user to define
|
This is deprecated and should no longer be used in new code.
|
||||||
event handlers that will be bound to the correct component (usually, the
|
|
||||||
grandparent of the slot content).
|
|
||||||
|
|
||||||
## Default Slot
|
## Reference
|
||||||
|
|
||||||
All elements inside the component which are not a named slot will be treated as
|
Default slot: the first element inside the component which is not a named slot will
|
||||||
part of the content of the `default` slot. For example:
|
be considered the `default` slot. For example:
|
||||||
|
|
||||||
```xml
|
```xml
|
||||||
<div t-name="Parent">
|
<div t-name="Parent">
|
||||||
@@ -102,22 +77,7 @@ part of the content of the `default` slot. For example:
|
|||||||
</div>
|
</div>
|
||||||
```
|
```
|
||||||
|
|
||||||
One can mix default slot and named slots:
|
Default content: slots can define a default content, in case the parent did not define them:
|
||||||
|
|
||||||
```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:
|
|
||||||
|
|
||||||
```xml
|
```xml
|
||||||
<div t-name="Parent">
|
<div t-name="Parent">
|
||||||
@@ -130,131 +90,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> -->
|
<!-- will be rendered as: <div><span>default content</span></div> -->
|
||||||
```
|
```
|
||||||
|
|
||||||
## Dynamic Slots
|
Rendering context: the content of the slots is actually rendered with the
|
||||||
|
rendering context corresponding to where it was defined, not where it is
|
||||||
The `t-slot` directive is actually able to use any expressions, using string
|
positioned. This allows the user to define event handlers that will be bound
|
||||||
interplolation:
|
to the correct component (usually, the grandparent of the slot content).
|
||||||
|
|
||||||
```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.
|
|
||||||
|
|||||||
@@ -0,0 +1,349 @@
|
|||||||
|
# 🦉 Store 🦉
|
||||||
|
|
||||||
|
## Content
|
||||||
|
|
||||||
|
- [Overview](#overview)
|
||||||
|
- [Example](#example)
|
||||||
|
- [Reference](#reference)
|
||||||
|
- [Store](#store)
|
||||||
|
- [Actions](#actions)
|
||||||
|
- [Getters](#getters)
|
||||||
|
- [Connecting a Component](#connecting-a-component)
|
||||||
|
- [`useStore`](#usestore)
|
||||||
|
- [`useDispatch`](#usedispatch)
|
||||||
|
- [`useGetters`](#usegetters)
|
||||||
|
- [Semantics](#semantics)
|
||||||
|
- [Good Practices](#good-practices)
|
||||||
|
|
||||||
|
## Overview
|
||||||
|
|
||||||
|
Managing the state in an application is not an easy task. In some cases, the
|
||||||
|
state of an application can be part of the component tree, in a natural way.
|
||||||
|
However, there are situations where some parts of the state need to be displayed
|
||||||
|
in various parts of the user interface, and then, it is not obvious which
|
||||||
|
component should own which part of the state.
|
||||||
|
|
||||||
|
Owl's solution to this issue is a centralized store. It is a class that owns
|
||||||
|
some (or all) state, and lets the developer update it in a structured way, with
|
||||||
|
`actions`. Owl components can then connect to the store to read their relevant
|
||||||
|
state, and they will be rerendered if the state is updated.
|
||||||
|
|
||||||
|
Note: Owl store is inspired by React Redux and VueX.
|
||||||
|
|
||||||
|
## Example
|
||||||
|
|
||||||
|
Here is what a simple store looks like:
|
||||||
|
|
||||||
|
```js
|
||||||
|
const actions = {
|
||||||
|
addTodo({ state }, message) {
|
||||||
|
state.todos.push({
|
||||||
|
id: state.nextId++,
|
||||||
|
message,
|
||||||
|
isCompleted: false,
|
||||||
|
});
|
||||||
|
},
|
||||||
|
};
|
||||||
|
|
||||||
|
const state = {
|
||||||
|
todos: [],
|
||||||
|
nextId: 1,
|
||||||
|
};
|
||||||
|
|
||||||
|
const store = new owl.Store({ state, actions });
|
||||||
|
store.on("update", null, () => console.log(store.state));
|
||||||
|
|
||||||
|
// updating the state
|
||||||
|
store.dispatch("addTodo", "fix all bugs");
|
||||||
|
```
|
||||||
|
|
||||||
|
This example shows how a store can be defined and used. Note that in most cases,
|
||||||
|
actions will be dispatched by connected components.
|
||||||
|
|
||||||
|
## Reference
|
||||||
|
|
||||||
|
### `Store`
|
||||||
|
|
||||||
|
The store is a simple [`owl.EventBus`](event_bus.md) that triggers `update` events
|
||||||
|
whenever its state is changed. Note that these events are triggered only after a
|
||||||
|
microtask tick, so only one event will be triggered for any number of state changes in a
|
||||||
|
call stack.
|
||||||
|
|
||||||
|
Also, it is important to mention that the state is observed (with an `owl.Observer`),
|
||||||
|
which is the reason why it is able to know if it was changed. See the
|
||||||
|
[Observer](observer.md)'s documentation for more details.
|
||||||
|
|
||||||
|
The `Store` class is quite small. It has two public methods:
|
||||||
|
|
||||||
|
- its constructor
|
||||||
|
- `dispatch`
|
||||||
|
|
||||||
|
The constructor takes a configuration object with four (optional) keys:
|
||||||
|
|
||||||
|
- the initial state
|
||||||
|
- the actions
|
||||||
|
- the getters
|
||||||
|
- the environment
|
||||||
|
|
||||||
|
```javascript
|
||||||
|
const config = {
|
||||||
|
state,
|
||||||
|
actions,
|
||||||
|
getters,
|
||||||
|
env,
|
||||||
|
};
|
||||||
|
const store = new Store(config);
|
||||||
|
```
|
||||||
|
|
||||||
|
### Actions
|
||||||
|
|
||||||
|
Actions are used to coordinate state changes. It can be used for both synchronous
|
||||||
|
and asynchronous logic.
|
||||||
|
|
||||||
|
```js
|
||||||
|
const actions = {
|
||||||
|
async login({ state }, info) {
|
||||||
|
state.loginState = "pending";
|
||||||
|
try {
|
||||||
|
const loginInfo = await doSomeRPC("/login/", info);
|
||||||
|
state.loginState = loginInfo;
|
||||||
|
} catch (e) {
|
||||||
|
state.loginState = "error";
|
||||||
|
}
|
||||||
|
},
|
||||||
|
};
|
||||||
|
```
|
||||||
|
|
||||||
|
The first argument to an action method is an object with four keys:
|
||||||
|
|
||||||
|
- `state`: the current state of the store content,
|
||||||
|
- `dispatch`: a function that can be used to dispatch other actions,
|
||||||
|
- `getters`: an object containing all getters defined in the store,
|
||||||
|
- `env`: the current environment. This is useful sometimes, in particular if
|
||||||
|
an action needs to apply some side effects (such as performing an rpc), and
|
||||||
|
the `rpc` method is located in the environment.
|
||||||
|
|
||||||
|
Actions are called with the `dispatch` method on the store, and can receive an
|
||||||
|
arbitrary number of arguments.
|
||||||
|
|
||||||
|
```js
|
||||||
|
store.dispatch("login", someInfo);
|
||||||
|
```
|
||||||
|
|
||||||
|
Note that anything returned by an action will also be returned by the `dispatch`
|
||||||
|
call.
|
||||||
|
|
||||||
|
Also, it is important to be aware that we need to be careful with asynchronous
|
||||||
|
logic. Each state change will potentially trigger a rerendering, so we need to
|
||||||
|
make sure that we do not have a partially corrupted state. Here is an example that
|
||||||
|
is likely not a good idea:
|
||||||
|
|
||||||
|
```javascript
|
||||||
|
const actions = {
|
||||||
|
async fetchSomeData({ state }, recordId) {
|
||||||
|
state.recordId = recordId;
|
||||||
|
const data = await doSomeRPC("/read/", recordId);
|
||||||
|
state.recordData = data;
|
||||||
|
},
|
||||||
|
};
|
||||||
|
```
|
||||||
|
|
||||||
|
In the previous example, there is a period of time in which the state has a
|
||||||
|
`recordId` which does not correspond to the `recordData`. It is more likely that
|
||||||
|
we want an atomic update: updating the `recordId` at the same time as the `recordData`
|
||||||
|
values:
|
||||||
|
|
||||||
|
```javascript
|
||||||
|
const actions = {
|
||||||
|
async fetchSomeData({ state }, recordId) {
|
||||||
|
const data = await doSomeRPC("/read/", recordId);
|
||||||
|
state.recordId = recordId;
|
||||||
|
state.recordData = data;
|
||||||
|
},
|
||||||
|
};
|
||||||
|
```
|
||||||
|
|
||||||
|
### Getters
|
||||||
|
|
||||||
|
Usually, data contained in the store will be stored in a normalized way. For
|
||||||
|
example,
|
||||||
|
|
||||||
|
```js
|
||||||
|
{
|
||||||
|
posts: [{id: 11, authorId: 4, content: 'Greetings'}],
|
||||||
|
authors: [{id: 4, name: 'John'}]
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
However, the user interface will probably need some denormalized data like
|
||||||
|
|
||||||
|
```js
|
||||||
|
{id: 11, author: {id: 4, name: 'John'}, content: 'Greetings'}
|
||||||
|
```
|
||||||
|
|
||||||
|
This is what `getters` are for: they give a centralized way to process and
|
||||||
|
transform the data contained in the store.
|
||||||
|
|
||||||
|
```js
|
||||||
|
const getters = {
|
||||||
|
getPost({ state }, id) {
|
||||||
|
const post = state.posts.find((p) => p.id === id);
|
||||||
|
const author = state.authors.find((a) => a.id === post.id);
|
||||||
|
return {
|
||||||
|
id,
|
||||||
|
author,
|
||||||
|
content: post.content,
|
||||||
|
};
|
||||||
|
},
|
||||||
|
};
|
||||||
|
|
||||||
|
// somewhere else
|
||||||
|
const post = store.getters.getPost(id);
|
||||||
|
```
|
||||||
|
|
||||||
|
Getters take _at most_ one argument.
|
||||||
|
|
||||||
|
Note that getters are not cached.
|
||||||
|
|
||||||
|
### Connecting a Component
|
||||||
|
|
||||||
|
At some point, we need a way to interact with the store from a component. This
|
||||||
|
means that the component needs a reference to the store. By default, it looks
|
||||||
|
for it in the `env.store` key. However, this can be configured with the `useStore`
|
||||||
|
hook.
|
||||||
|
|
||||||
|
Every component-store interactions are done with the help of the three store hooks:
|
||||||
|
|
||||||
|
- [`useStore`](#usestore) to subscribe a component to some part of the store state,
|
||||||
|
- [`useDispatch`](#usedispatch) to get a reference to a dispatch function,
|
||||||
|
- [`useGetters`](#usegetters) to get a reference to the getters defined in the store.
|
||||||
|
|
||||||
|
Assume we have this store:
|
||||||
|
|
||||||
|
```javascript
|
||||||
|
const actions = {
|
||||||
|
increment({ state }, val) {
|
||||||
|
state.counter.value += val;
|
||||||
|
},
|
||||||
|
};
|
||||||
|
|
||||||
|
const state = {
|
||||||
|
counter: { value: 0 },
|
||||||
|
};
|
||||||
|
const store = new owl.Store({ state, actions });
|
||||||
|
```
|
||||||
|
|
||||||
|
To make it accessible to the complete application, we will put it in the
|
||||||
|
environment:
|
||||||
|
|
||||||
|
```js
|
||||||
|
// in this example, the root component is App
|
||||||
|
App.env.store = store;
|
||||||
|
```
|
||||||
|
|
||||||
|
A counter component can then select this value and dispatch an action like this:
|
||||||
|
|
||||||
|
```js
|
||||||
|
class Counter extends Component {
|
||||||
|
counter = useStore((state) => state.counter);
|
||||||
|
dispatch = useDispatch();
|
||||||
|
}
|
||||||
|
|
||||||
|
const counter = new Counter({ store, qweb });
|
||||||
|
```
|
||||||
|
|
||||||
|
```xml
|
||||||
|
<button t-name="Counter" t-on-click="dispatch('increment')">
|
||||||
|
Click Me! [<t t-esc="counter.value"/>]
|
||||||
|
</button>
|
||||||
|
```
|
||||||
|
|
||||||
|
### `useStore`
|
||||||
|
|
||||||
|
The `useStore` hook is used to select some part of the store state. It accepts
|
||||||
|
two arguments:
|
||||||
|
|
||||||
|
- a selector function, which takes the store state as first argument (and the
|
||||||
|
component props as second argument) and which must return the part of the
|
||||||
|
store state that will be made available and observed for changes,
|
||||||
|
- optionally, an object which can have the following optional keys:
|
||||||
|
- a `store` key containing a store object if we want to use another store than
|
||||||
|
the default store,
|
||||||
|
- an `isEqual` key containing an equality function if we want to specialize
|
||||||
|
the comparison (the function must accept two arguments: the previous result
|
||||||
|
and the new result, and must return whether they are equal),
|
||||||
|
- and an `onUpdate` key containing an update function if we want to execute an
|
||||||
|
arbitrary code every time the selected state changes (the function will
|
||||||
|
receive one argument, the new result, and can execute arbitrary code).
|
||||||
|
|
||||||
|
If the `useStore` selector returns a sub part of the store state, the component
|
||||||
|
will only be rerendered whenever this part of the state changes. Otherwise, it
|
||||||
|
will perform a strict equality check (unless the `isEqual` option is defined,
|
||||||
|
then it will call it) and will update the component every time this check fails.
|
||||||
|
|
||||||
|
Note that if the selector function returns a primitive type, the result of
|
||||||
|
`useStore` will be immutable and it will not react to changes. In this case, it
|
||||||
|
is important to define the `onUpdate` option to properly update the value
|
||||||
|
manually when it changes.
|
||||||
|
|
||||||
|
Also, the return value from `useStore` is not supposed to be modified. The store
|
||||||
|
state should only be updated with actions.
|
||||||
|
|
||||||
|
### `useDispatch`
|
||||||
|
|
||||||
|
The `useDispatch` hook is useful when a component needs to be able to dispatch
|
||||||
|
actions. It takes an optional argument, which is a store. If not given, it will
|
||||||
|
use the store in the environment.
|
||||||
|
|
||||||
|
Note that a component does not need to be connected in any other way to the store.
|
||||||
|
For example:
|
||||||
|
|
||||||
|
```js
|
||||||
|
class DoSomethingButton extends Component {
|
||||||
|
static template = xml`<button t-on-click="dispatch('something')">Click</button>`;
|
||||||
|
dispatch = useDispatch();
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
### `useGetters`
|
||||||
|
|
||||||
|
The `useGetters` hook is useful when a component needs to be able to use the
|
||||||
|
getters defined in a store. It takes an optional argument, which is a store. If
|
||||||
|
not given, it will use the store in the environment.
|
||||||
|
|
||||||
|
Note that a component does not need to be connected in any other way to the store.
|
||||||
|
For example:
|
||||||
|
|
||||||
|
```js
|
||||||
|
class InfoButton extends Component {
|
||||||
|
static template = xml`<span><t t-esc="getters.somevalue()"></span>`;
|
||||||
|
getters = useGetters();
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
### Semantics
|
||||||
|
|
||||||
|
The `Store` class and the `useStore` hook try to be smart and to optimize as much
|
||||||
|
as possible the rendering and update process. What is important to know is:
|
||||||
|
|
||||||
|
- components are always updated in the order of their creation (so, parent
|
||||||
|
before children),
|
||||||
|
- they are updated only if they are in the DOM,
|
||||||
|
- if a parent is asynchronous, the system will wait for it to complete its
|
||||||
|
update before updating other components,
|
||||||
|
- in general, updates are not coordinated. This is not a problem for synchronous
|
||||||
|
components, but if there are many asynchronous components, this could lead to
|
||||||
|
a situation where some part of the UI is updated and some other part of the UI is
|
||||||
|
not updated.
|
||||||
|
|
||||||
|
### Good Practices
|
||||||
|
|
||||||
|
- avoid asynchronous components as much as possible. Asynchronous components
|
||||||
|
lead to situations where parts of the UI is not updated immediately,
|
||||||
|
- do not be afraid to connect many components, parent or children if needed. For
|
||||||
|
example, a `MessageList` component could get a list of ids in its `useStore`
|
||||||
|
call and a `Message` component could get the data of its own
|
||||||
|
message,
|
||||||
|
- since the `useStore` function is called for each connected component,
|
||||||
|
for each state update, it is important to make sure that these functions are
|
||||||
|
as fast as possible.
|
||||||
@@ -0,0 +1,184 @@
|
|||||||
|
# 🦉 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 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;
|
||||||
|
}
|
||||||
|
`;
|
||||||
|
}
|
||||||
|
```
|
||||||
@@ -1,70 +0,0 @@
|
|||||||
# 🦉 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...
|
|
||||||
```
|
|
||||||
+103
-35
@@ -6,9 +6,11 @@ functions are all available in the `owl.utils` namespace.
|
|||||||
## Content
|
## Content
|
||||||
|
|
||||||
- [`whenReady`](#whenready): executing code when DOM is ready
|
- [`whenReady`](#whenready): executing code when DOM is ready
|
||||||
|
- [`loadJS`](#loadjs): loading script files
|
||||||
- [`loadFile`](#loadfile): loading a file (useful for templates)
|
- [`loadFile`](#loadfile): loading a file (useful for templates)
|
||||||
- [`EventBus`](#eventbus): a simple EventBus
|
- [`escape`](#escape): sanitizing strings
|
||||||
- [`validate`](#validate): a validation function
|
- [`debounce`](#debounce): limiting rate of function calls
|
||||||
|
- [`shallowEqual`](#shallowequal): shallow object comparison
|
||||||
|
|
||||||
## `whenReady`
|
## `whenReady`
|
||||||
|
|
||||||
@@ -17,20 +19,40 @@ not ready yet, resolved directly otherwise). If called with a callback as
|
|||||||
argument, it executes it as soon as the DOM ready (or directly).
|
argument, it executes it as soon as the DOM ready (or directly).
|
||||||
|
|
||||||
```js
|
```js
|
||||||
const { whenReady } = owl;
|
Promise.all([loadFile("templates.xml"), owl.utils.whenReady()]).then(function ([templates]) {
|
||||||
|
const qweb = new owl.QWeb({ templates });
|
||||||
await whenReady();
|
const app = new App({ qweb });
|
||||||
// do something
|
app.mount(document.body);
|
||||||
|
});
|
||||||
```
|
```
|
||||||
|
|
||||||
or alternatively:
|
or alternatively:
|
||||||
|
|
||||||
```js
|
```js
|
||||||
whenReady(function () {
|
owl.utils.whenReady(function () {
|
||||||
// do something
|
const qweb = new owl.QWeb();
|
||||||
|
const app = new App({ qweb });
|
||||||
|
app.mount(document.body);
|
||||||
});
|
});
|
||||||
```
|
```
|
||||||
|
|
||||||
|
## `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`
|
||||||
|
|
||||||
`loadFile` is a helper function to fetch a file. It simply
|
`loadFile` is a helper function to fetch a file. It simply
|
||||||
@@ -38,43 +60,89 @@ 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:
|
initial usecase for this function is to load a template file. For example:
|
||||||
|
|
||||||
```js
|
```js
|
||||||
const { loadFile } = owl;
|
|
||||||
|
|
||||||
async function makeEnv() {
|
async function makeEnv() {
|
||||||
const templates = await loadFile("templates.xml");
|
const templates = await owl.utils.loadFile("templates.xml");
|
||||||
// do something
|
const qweb = new owl.QWeb({ templates });
|
||||||
|
return { qweb };
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
## `EventBus`
|
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.
|
||||||
|
|
||||||
It is a simple `EventBus`, with the same API as usual DOM elements, and an
|
## `escape`
|
||||||
additional `trigger` method to dispatch events:
|
|
||||||
|
|
||||||
```js
|
Sometimes, we need to display dynamic data (for example user-generated data) in
|
||||||
const bus = new EventBus();
|
the user interface. If this is done by a `QWeb` template, it is not an issue:
|
||||||
bus.addEventListener("event", () => console.log("something happened"));
|
|
||||||
|
|
||||||
bus.trigger("event"); // 'something happened' is logged
|
```xml
|
||||||
|
<div><t t-esc="user.data"/></div>
|
||||||
```
|
```
|
||||||
|
|
||||||
## `validate`
|
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,
|
||||||
The `validate` function is a function that validates if a given object satisfies a
|
it may be a problem if this is done with some javascript code like this:
|
||||||
specified schema. It is actually used by Owl itself to perform
|
|
||||||
[props validation](props.md#props-validation). For example:
|
|
||||||
|
|
||||||
```js
|
```js
|
||||||
validate(
|
class BadComponent extends Component {
|
||||||
{ a: "hey" },
|
// some template with a ref to a div
|
||||||
{
|
// some code ...
|
||||||
id: Number,
|
|
||||||
url: [Boolean, { type: Array, element: Number }],
|
mounted() {
|
||||||
|
this.divRef.el.innerHTML = this.state.value;
|
||||||
}
|
}
|
||||||
);
|
}
|
||||||
|
```
|
||||||
// throws an error with the following information:
|
|
||||||
// - unknown key 'a',
|
In this case, the content of the `div` will be parsed as html, which may inject
|
||||||
// - 'id' is missing (should be a number),
|
unwanted behaviour. To fix this, the `escape` function will simply transform a
|
||||||
// - 'url' is missing (should be a boolean or list of numbers),
|
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: `"<ok>"`). 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);
|
||||||
```
|
```
|
||||||
|
|||||||
+13
-23
@@ -1,34 +1,29 @@
|
|||||||
{
|
{
|
||||||
"name": "@odoo/owl",
|
"name": "@odoo/owl",
|
||||||
"version": "2.0.0-beta-12",
|
"version": "1.0.13",
|
||||||
"description": "Odoo Web Library (OWL)",
|
"description": "Odoo Web Library (OWL)",
|
||||||
"main": "dist/owl.cjs.js",
|
"main": "dist/owl.cjs.js",
|
||||||
"browser": "dist/owl.iife.js",
|
"browser": "dist/owl.iife.js",
|
||||||
"module": "dist/owl.es.js",
|
"module": "dist/owl.es.js",
|
||||||
"types": "dist/types/owl.d.ts",
|
"types": "dist/types/index.d.ts",
|
||||||
"files": [
|
"files": [
|
||||||
"dist"
|
"dist"
|
||||||
],
|
],
|
||||||
"engines": {
|
"engines": {
|
||||||
"node": ">=12.18.3"
|
"node": ">=10.15.3"
|
||||||
},
|
},
|
||||||
"scripts": {
|
"scripts": {
|
||||||
"build:bundle": "rollup -c --failAfterWarnings",
|
"build:bundle": "rollup -c",
|
||||||
"build:runtime": "rollup -c --failAfterWarnings runtime",
|
|
||||||
"build:compiler": "rollup -c --failAfterWarnings compiler",
|
|
||||||
"build": "npm run build:bundle",
|
"build": "npm run build:bundle",
|
||||||
"test": "jest",
|
"test": "jest",
|
||||||
"test:debug": "node --inspect-brk node_modules/.bin/jest --runInBand --watch --testTimeout=5000000",
|
|
||||||
"test:watch": "jest --watch",
|
"test:watch": "jest --watch",
|
||||||
"playground:serve": "python3 tools/server.py || python tools/server.py",
|
"tools:serve": "python3 tools/server.py || python tools/server.py",
|
||||||
"playground": "npm run build && npm run playground:serve",
|
"tools": "npm run build && npm run tools:serve",
|
||||||
"preplayground:watch": "npm run build",
|
"pretools:watch": "npm run build",
|
||||||
"playground:watch": "npm-run-all --parallel playground:serve \"build:* -- --watch\"",
|
"tools:watch": "npm-run-all --parallel tools:serve \"build:* -- --watch\"",
|
||||||
"prettier": "prettier {src/*.ts,src/**/*.ts,tests/*.ts,tests/**/*.ts,doc/*.md,doc/**/*.md} --write",
|
"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",
|
|
||||||
"publish": "npm run build && npm publish",
|
"publish": "npm run build && npm publish",
|
||||||
"release": "node tools/release.js",
|
"release": "node tools/release.js"
|
||||||
"compile_templates": "node tools/compile_xml.js"
|
|
||||||
},
|
},
|
||||||
"repository": {
|
"repository": {
|
||||||
"type": "git",
|
"type": "git",
|
||||||
@@ -45,23 +40,20 @@
|
|||||||
"@types/node": "^14.11.8",
|
"@types/node": "^14.11.8",
|
||||||
"chalk": "^3.0.0",
|
"chalk": "^3.0.0",
|
||||||
"cpx": "^1.5.0",
|
"cpx": "^1.5.0",
|
||||||
"current-git-branch": "^1.1.0",
|
|
||||||
"git-rev-sync": "^1.12.0",
|
"git-rev-sync": "^1.12.0",
|
||||||
"github-api": "^3.3.0",
|
"github-api": "^3.3.0",
|
||||||
"jest": "^27.1.0",
|
"jest": "^27.1.0",
|
||||||
"jest-diff": "^27.3.1",
|
|
||||||
"jest-environment-jsdom": "^27.1.0",
|
"jest-environment-jsdom": "^27.1.0",
|
||||||
"live-server": "^1.2.1",
|
"live-server": "^1.2.1",
|
||||||
"npm-run-all": "^4.1.5",
|
"npm-run-all": "^4.1.5",
|
||||||
"prettier": "2.4.1",
|
"prettier": "^2.0.4",
|
||||||
"rollup": "^2.56.3",
|
"rollup": "^2.56.3",
|
||||||
"rollup-plugin-dts": "^4.2.2",
|
|
||||||
"rollup-plugin-terser": "^7.0.2",
|
"rollup-plugin-terser": "^7.0.2",
|
||||||
"rollup-plugin-typescript2": "^0.31.1",
|
"rollup-plugin-typescript2": "^0.30.0",
|
||||||
"sass": "^1.16.1",
|
"sass": "^1.16.1",
|
||||||
"source-map-support": "^0.5.10",
|
"source-map-support": "^0.5.10",
|
||||||
"ts-jest": "^27.0.5",
|
"ts-jest": "^27.0.5",
|
||||||
"typescript": "4.5.2",
|
"typescript": "3.9.6",
|
||||||
"uglify-es": "^3.3.9"
|
"uglify-es": "^3.3.9"
|
||||||
},
|
},
|
||||||
"jest": {
|
"jest": {
|
||||||
@@ -70,9 +62,7 @@
|
|||||||
"<rootDir>/src",
|
"<rootDir>/src",
|
||||||
"<rootDir>/tests"
|
"<rootDir>/tests"
|
||||||
],
|
],
|
||||||
"setupFiles": [
|
"setupFiles": ["./tests/mocks/mockEventTarget.js"],
|
||||||
"./tests/mocks/mockEventTarget.js"
|
|
||||||
],
|
|
||||||
"transform": {
|
"transform": {
|
||||||
"^.+\\.ts?$": "ts-jest"
|
"^.+\\.ts?$": "ts-jest"
|
||||||
},
|
},
|
||||||
|
|||||||
+1
-1
@@ -1,6 +1,6 @@
|
|||||||
# 🦉 OWL Roadmap 🦉
|
# 🦉 OWL Roadmap 🦉
|
||||||
|
|
||||||
- Current version: 1.4.10
|
- Current version: 1.0.13
|
||||||
- Status: stable
|
- Status: stable
|
||||||
|
|
||||||
This roadmap is only an attempt at predicting Owl's future. Everything may
|
This roadmap is only an attempt at predicting Owl's future. Everything may
|
||||||
|
|||||||
+35
-50
@@ -2,10 +2,14 @@ import pkg from "./package.json";
|
|||||||
import git from "git-rev-sync";
|
import git from "git-rev-sync";
|
||||||
import typescript from 'rollup-plugin-typescript2';
|
import typescript from 'rollup-plugin-typescript2';
|
||||||
import { terser } from "rollup-plugin-terser";
|
import { terser } from "rollup-plugin-terser";
|
||||||
import dts from "rollup-plugin-dts";
|
|
||||||
|
|
||||||
let input, output;
|
const name = "owl";
|
||||||
|
const extend = true;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Meta data to be added on the __info__ object.
|
||||||
|
* Used to let external tools know the current owl version.
|
||||||
|
*/
|
||||||
const outro = `
|
const outro = `
|
||||||
__info__.version = '${pkg.version}';
|
__info__.version = '${pkg.version}';
|
||||||
__info__.date = '${new Date().toISOString()}';
|
__info__.date = '${new Date().toISOString()}';
|
||||||
@@ -13,39 +17,13 @@ __info__.hash = '${git.short()}';
|
|||||||
__info__.url = 'https://github.com/odoo/owl';
|
__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(pkg.module, 'runtime'), outro),
|
|
||||||
getConfigForFormat('cjs', addSuffix(pkg.main, 'runtime'), outro),
|
|
||||||
getConfigForFormat('iife', addSuffix(pkg.browser, 'runtime'), outro),
|
|
||||||
getConfigForFormat('iife', addSuffix(pkg.browser, 'runtime'), outro, true),
|
|
||||||
]
|
|
||||||
break;
|
|
||||||
default:
|
|
||||||
input = "src/index.ts",
|
|
||||||
output = [
|
|
||||||
getConfigForFormat('esm', pkg.module, outro),
|
|
||||||
getConfigForFormat('cjs', pkg.main, outro),
|
|
||||||
getConfigForFormat('iife', pkg.browser, outro),
|
|
||||||
getConfigForFormat('iife', pkg.browser, outro, true),
|
|
||||||
]
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Generate from a string depicting a path a new path for the minified version.
|
* Generate from a string depicting a path a new path for the minified version.
|
||||||
* @param {string} pkgFileName file name
|
* @param {string} pkgFileName file name
|
||||||
*/
|
*/
|
||||||
function addSuffix(pkgFileName, suffix) {
|
function generateMinifiedNameFromPkgName(pkgFileName) {
|
||||||
const parts = pkgFileName.split('.');
|
const parts = pkgFileName.split('.');
|
||||||
parts.splice(parts.length - 1, 0, suffix);
|
parts.splice(parts.length - 1, 0, "min");
|
||||||
return parts.join('.');
|
return parts.join('.');
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -55,12 +33,12 @@ function addSuffix(pkgFileName, suffix) {
|
|||||||
* @param {string} generatedFileName generated file name
|
* @param {string} generatedFileName generated file name
|
||||||
* @param {boolean} minified should it be minified
|
* @param {boolean} minified should it be minified
|
||||||
*/
|
*/
|
||||||
function getConfigForFormat(format, generatedFileName, outro, minified = false) {
|
function getConfigForFormat(format, generatedFileName, minified = false) {
|
||||||
return {
|
return {
|
||||||
file: minified ? addSuffix(generatedFileName, "min") : generatedFileName,
|
file: minified ? generateMinifiedNameFromPkgName(generatedFileName) : generatedFileName,
|
||||||
format: format,
|
format: format,
|
||||||
name: "owl",
|
name: name,
|
||||||
extend: true,
|
extend: extend,
|
||||||
outro: outro,
|
outro: outro,
|
||||||
freeze: false,
|
freeze: false,
|
||||||
plugins: minified ? [terser()] : [],
|
plugins: minified ? [terser()] : [],
|
||||||
@@ -68,19 +46,26 @@ function getConfigForFormat(format, generatedFileName, outro, minified = false)
|
|||||||
};
|
};
|
||||||
}
|
}
|
||||||
|
|
||||||
export default [
|
export default {
|
||||||
{
|
input: "src/index.ts",
|
||||||
input,
|
output: [
|
||||||
output,
|
|
||||||
plugins: [
|
/**
|
||||||
typescript({
|
* Read about module formats:
|
||||||
useTsconfigDeclarationDir: true
|
* https://auth0.com/blog/javascript-module-systems-showdown/
|
||||||
}),
|
* https://medium.com/@kelin2025/so-you-wanna-use-es6-modules-714f48b3a953
|
||||||
]
|
*/
|
||||||
},
|
|
||||||
{
|
getConfigForFormat('esm', pkg.module),
|
||||||
input: "dist/types/index.d.ts",
|
getConfigForFormat('esm', pkg.module, true),
|
||||||
output: [{ file: "dist/types/owl.d.ts", format: "es" }],
|
getConfigForFormat('cjs', pkg.main),
|
||||||
plugins: [dts()],
|
getConfigForFormat('cjs', pkg.main, true),
|
||||||
},
|
getConfigForFormat('iife', pkg.browser),
|
||||||
];
|
getConfigForFormat('iife', pkg.browser, true),
|
||||||
|
],
|
||||||
|
plugins: [
|
||||||
|
typescript({
|
||||||
|
useTsconfigDeclarationDir: true
|
||||||
|
}),
|
||||||
|
]
|
||||||
|
};
|
||||||
|
|||||||
+45
@@ -0,0 +1,45 @@
|
|||||||
|
import { Component } from "./component/component";
|
||||||
|
import { ComponentNode } from "./component/component_node";
|
||||||
|
import { Scheduler } from "./component/scheduler";
|
||||||
|
import { TemplateSet } from "./qweb/template_helpers";
|
||||||
|
|
||||||
|
// reimplement dev mode stuff see last change in 0f7a8289a6fb8387c3c1af41c6664b2a8448758f
|
||||||
|
|
||||||
|
export class App<T extends typeof Component = any> extends TemplateSet {
|
||||||
|
Root: T;
|
||||||
|
props: any;
|
||||||
|
env: any = {};
|
||||||
|
scheduler = new Scheduler(window.requestAnimationFrame.bind(window));
|
||||||
|
root: ComponentNode | null = null;
|
||||||
|
dev: boolean = true;
|
||||||
|
|
||||||
|
constructor(Root: T, props?: any) {
|
||||||
|
super();
|
||||||
|
this.Root = Root;
|
||||||
|
this.props = props;
|
||||||
|
}
|
||||||
|
|
||||||
|
configure(params: any) {
|
||||||
|
if (params.env) {
|
||||||
|
this.env = params.env;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
mount(target: HTMLElement): Promise<InstanceType<T>> {
|
||||||
|
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");
|
||||||
|
}
|
||||||
|
const node = new ComponentNode(this.Root, this.props, this);
|
||||||
|
this.root = node;
|
||||||
|
return node.mountComponent(target);
|
||||||
|
}
|
||||||
|
|
||||||
|
destroy() {
|
||||||
|
if (this.root) {
|
||||||
|
this.root.destroy();
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -1,6 +1,6 @@
|
|||||||
import type { Setter } from "./block_compiler";
|
import type { Setter } from "./block_compiler";
|
||||||
|
|
||||||
const { setAttribute: elemSetAttribute, removeAttribute } = Element.prototype;
|
const { setAttribute, removeAttribute } = Element.prototype;
|
||||||
const tokenList = DOMTokenList.prototype;
|
const tokenList = DOMTokenList.prototype;
|
||||||
const tokenListAdd = tokenList.add;
|
const tokenListAdd = tokenList.add;
|
||||||
const tokenListRemove = tokenList.remove;
|
const tokenListRemove = tokenList.remove;
|
||||||
@@ -14,23 +14,11 @@ const wordRegexp = /\s+/;
|
|||||||
* file.
|
* file.
|
||||||
*/
|
*/
|
||||||
|
|
||||||
function setAttribute(this: HTMLElement, key: string, value: any) {
|
|
||||||
switch (value) {
|
|
||||||
case false:
|
|
||||||
case undefined:
|
|
||||||
removeAttribute.call(this, key);
|
|
||||||
break;
|
|
||||||
case true:
|
|
||||||
elemSetAttribute.call(this, key, "");
|
|
||||||
break;
|
|
||||||
default:
|
|
||||||
elemSetAttribute.call(this, key, value);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
export function createAttrUpdater(attr: string): Setter<HTMLElement> {
|
export function createAttrUpdater(attr: string): Setter<HTMLElement> {
|
||||||
return function (this: HTMLElement, value: any) {
|
return function (this: HTMLElement, value: any) {
|
||||||
setAttribute.call(this, attr, value);
|
if (value !== false) {
|
||||||
|
setAttribute.call(this, attr, value === true ? "" : value);
|
||||||
|
}
|
||||||
};
|
};
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -93,10 +81,6 @@ function toClassObj(expr: string | number | { [c: string]: any }) {
|
|||||||
for (let key in expr as any) {
|
for (let key in expr as any) {
|
||||||
const value = (expr as any)[key];
|
const value = (expr as any)[key];
|
||||||
if (value) {
|
if (value) {
|
||||||
key = trim.call(key);
|
|
||||||
if (!key) {
|
|
||||||
continue;
|
|
||||||
}
|
|
||||||
const words = split.call(key, wordRegexp);
|
const words = split.call(key, wordRegexp);
|
||||||
for (let word of words) {
|
for (let word of words) {
|
||||||
result[word] = value;
|
result[word] = value;
|
||||||
@@ -143,8 +127,7 @@ export function updateClass(this: HTMLElement, val: any, oldVal: any) {
|
|||||||
|
|
||||||
export function makePropSetter(name: string): Setter<HTMLElement> {
|
export function makePropSetter(name: string): Setter<HTMLElement> {
|
||||||
return function setProp(this: HTMLElement, value: any) {
|
return function setProp(this: HTMLElement, value: any) {
|
||||||
// support 0, fallback to empty string for other falsy values
|
(this as any)[name] = value;
|
||||||
(this as any)[name] = value === 0 ? 0 : value || "";
|
|
||||||
};
|
};
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -161,10 +144,10 @@ export function isProp(tag: string, key: string): boolean {
|
|||||||
case "option":
|
case "option":
|
||||||
return key === "selected" || key === "disabled";
|
return key === "selected" || key === "disabled";
|
||||||
case "textarea":
|
case "textarea":
|
||||||
return key === "value" || key === "readonly" || key === "disabled";
|
return key === "readonly" || key === "disabled";
|
||||||
case "select":
|
break;
|
||||||
return key === "value" || key === "disabled";
|
|
||||||
case "button":
|
case "button":
|
||||||
|
case "select":
|
||||||
case "optgroup":
|
case "optgroup":
|
||||||
return key === "disabled";
|
return key === "disabled";
|
||||||
}
|
}
|
||||||
@@ -113,10 +113,9 @@ interface IntermediateTree {
|
|||||||
nextSibling: IntermediateTree | null;
|
nextSibling: IntermediateTree | null;
|
||||||
el: Node;
|
el: Node;
|
||||||
info: DynamicInfo[];
|
info: DynamicInfo[];
|
||||||
isRef?: boolean;
|
forceRef?: boolean;
|
||||||
refIdx?: number;
|
refIdx?: number;
|
||||||
refN: number;
|
refN: number;
|
||||||
currentNS: string | null;
|
|
||||||
}
|
}
|
||||||
|
|
||||||
function buildTree(
|
function buildTree(
|
||||||
@@ -125,9 +124,9 @@ function buildTree(
|
|||||||
domParentTree: IntermediateTree | null = null
|
domParentTree: IntermediateTree | null = null
|
||||||
): IntermediateTree {
|
): IntermediateTree {
|
||||||
switch (node.nodeType) {
|
switch (node.nodeType) {
|
||||||
case Node.ELEMENT_NODE: {
|
case 1: {
|
||||||
// HTMLElement
|
// HTMLElement
|
||||||
let currentNS = domParentTree && domParentTree.currentNS;
|
let isActive = false;
|
||||||
const tagName = (node as Element).tagName;
|
const tagName = (node as Element).tagName;
|
||||||
let el: Node | undefined = undefined;
|
let el: Node | undefined = undefined;
|
||||||
const info: DynamicInfo[] = [];
|
const info: DynamicInfo[] = [];
|
||||||
@@ -135,31 +134,25 @@ function buildTree(
|
|||||||
const index = parseInt(tagName.slice(11), 10);
|
const index = parseInt(tagName.slice(11), 10);
|
||||||
info.push({ type: "text", idx: index });
|
info.push({ type: "text", idx: index });
|
||||||
el = document.createTextNode("");
|
el = document.createTextNode("");
|
||||||
|
isActive = true;
|
||||||
}
|
}
|
||||||
if (tagName.startsWith("block-child-")) {
|
if (tagName.startsWith("block-child-")) {
|
||||||
if (!domParentTree!.isRef) {
|
domParentTree!.forceRef = true;
|
||||||
addRef(domParentTree!);
|
|
||||||
}
|
|
||||||
const index = parseInt(tagName.slice(12), 10);
|
const index = parseInt(tagName.slice(12), 10);
|
||||||
info.push({ type: "child", idx: index });
|
info.push({ type: "child", idx: index });
|
||||||
el = document.createTextNode("");
|
el = document.createTextNode("");
|
||||||
}
|
isActive = true;
|
||||||
const attrs = (node as Element).attributes;
|
|
||||||
const ns = attrs.getNamedItem("block-ns");
|
|
||||||
if (ns) {
|
|
||||||
attrs.removeNamedItem("block-ns");
|
|
||||||
currentNS = ns.value;
|
|
||||||
}
|
}
|
||||||
if (!el) {
|
if (!el) {
|
||||||
el = currentNS
|
el = document.createElement(tagName);
|
||||||
? document.createElementNS(currentNS, tagName)
|
|
||||||
: document.createElement(tagName);
|
|
||||||
}
|
}
|
||||||
if (el instanceof Element) {
|
if (el instanceof HTMLElement) {
|
||||||
|
const attrs = (node as Element).attributes;
|
||||||
for (let i = 0; i < attrs.length; i++) {
|
for (let i = 0; i < attrs.length; i++) {
|
||||||
const attrName = attrs[i].name;
|
const attrName = attrs[i].name;
|
||||||
const attrValue = attrs[i].value;
|
const attrValue = attrs[i].value;
|
||||||
if (attrName.startsWith("block-handler-")) {
|
if (attrName.startsWith("block-handler-")) {
|
||||||
|
isActive = true;
|
||||||
const idx = parseInt(attrName.slice(14), 10);
|
const idx = parseInt(attrName.slice(14), 10);
|
||||||
info.push({
|
info.push({
|
||||||
type: "handler",
|
type: "handler",
|
||||||
@@ -167,6 +160,7 @@ function buildTree(
|
|||||||
event: attrValue,
|
event: attrValue,
|
||||||
});
|
});
|
||||||
} else if (attrName.startsWith("block-attribute-")) {
|
} else if (attrName.startsWith("block-attribute-")) {
|
||||||
|
isActive = true;
|
||||||
const idx = parseInt(attrName.slice(16), 10);
|
const idx = parseInt(attrName.slice(16), 10);
|
||||||
info.push({
|
info.push({
|
||||||
type: "attribute",
|
type: "attribute",
|
||||||
@@ -175,11 +169,13 @@ function buildTree(
|
|||||||
tag: tagName,
|
tag: tagName,
|
||||||
});
|
});
|
||||||
} else if (attrName === "block-attributes") {
|
} else if (attrName === "block-attributes") {
|
||||||
|
isActive = true;
|
||||||
info.push({
|
info.push({
|
||||||
type: "attributes",
|
type: "attributes",
|
||||||
idx: parseInt(attrValue, 10),
|
idx: parseInt(attrValue, 10),
|
||||||
});
|
});
|
||||||
} else if (attrName === "block-ref") {
|
} else if (attrName === "block-ref") {
|
||||||
|
isActive = true;
|
||||||
info.push({
|
info.push({
|
||||||
type: "ref",
|
type: "ref",
|
||||||
idx: parseInt(attrValue, 10),
|
idx: parseInt(attrValue, 10),
|
||||||
@@ -196,20 +192,21 @@ function buildTree(
|
|||||||
nextSibling: null,
|
nextSibling: null,
|
||||||
el,
|
el,
|
||||||
info,
|
info,
|
||||||
refN: 0,
|
refN: isActive ? 1 : 0,
|
||||||
currentNS,
|
|
||||||
};
|
};
|
||||||
|
|
||||||
if (node.firstChild) {
|
if (node.firstChild) {
|
||||||
const childNode = node.childNodes[0];
|
const childNode = node.childNodes[0];
|
||||||
if (
|
if (
|
||||||
node.childNodes.length === 1 &&
|
node.childNodes.length === 1 &&
|
||||||
childNode.nodeType === Node.ELEMENT_NODE &&
|
childNode.nodeType === 1 &&
|
||||||
(childNode as Element).tagName.startsWith("block-child-")
|
(childNode as Element).tagName.startsWith("block-child-")
|
||||||
) {
|
) {
|
||||||
const tagName = (childNode as Element).tagName;
|
const tagName = (childNode as Element).tagName;
|
||||||
const index = parseInt(tagName.slice(12), 10);
|
const index = parseInt(tagName.slice(12), 10);
|
||||||
info.push({ idx: index, type: "child", isOnlyChild: true });
|
info.push({ idx: index, type: "child", isOnlyChild: true });
|
||||||
|
isActive = true;
|
||||||
|
tree.refN = 1;
|
||||||
} else {
|
} else {
|
||||||
tree.firstChild = buildTree(node.firstChild, tree, tree);
|
tree.firstChild = buildTree(node.firstChild, tree, tree);
|
||||||
el.appendChild(tree.firstChild.el);
|
el.appendChild(tree.firstChild.el);
|
||||||
@@ -222,16 +219,19 @@ function buildTree(
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
if (tree.info.length) {
|
if (isActive) {
|
||||||
addRef(tree);
|
let cur: IntermediateTree | null = tree;
|
||||||
|
while ((cur = cur.parent)) {
|
||||||
|
cur.refN++;
|
||||||
|
}
|
||||||
}
|
}
|
||||||
return tree;
|
return tree;
|
||||||
}
|
}
|
||||||
case Node.TEXT_NODE:
|
case 3:
|
||||||
case Node.COMMENT_NODE: {
|
case 8: {
|
||||||
// text node or comment node
|
// text node or comment node
|
||||||
const el =
|
const el =
|
||||||
node.nodeType === Node.TEXT_NODE
|
node.nodeType === 3
|
||||||
? document.createTextNode(node.textContent!)
|
? document.createTextNode(node.textContent!)
|
||||||
: document.createComment(node.textContent!);
|
: document.createComment(node.textContent!);
|
||||||
return {
|
return {
|
||||||
@@ -241,20 +241,12 @@ function buildTree(
|
|||||||
el,
|
el,
|
||||||
info: [],
|
info: [],
|
||||||
refN: 0,
|
refN: 0,
|
||||||
currentNS: null,
|
|
||||||
};
|
};
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
throw new Error("boom");
|
throw new Error("boom");
|
||||||
}
|
}
|
||||||
|
|
||||||
function addRef(tree: IntermediateTree) {
|
|
||||||
tree.isRef = true;
|
|
||||||
do {
|
|
||||||
tree.refN++;
|
|
||||||
} while ((tree = tree.parent as any));
|
|
||||||
}
|
|
||||||
|
|
||||||
function parentTree(tree: IntermediateTree): IntermediateTree | null {
|
function parentTree(tree: IntermediateTree): IntermediateTree | null {
|
||||||
let parent = tree.parent;
|
let parent = tree.parent;
|
||||||
while (parent && parent.nextSibling === tree) {
|
while (parent && parent.nextSibling === tree) {
|
||||||
@@ -299,18 +291,23 @@ interface BlockCtx {
|
|||||||
locations: IndexedLocation[];
|
locations: IndexedLocation[];
|
||||||
children: Child[];
|
children: Child[];
|
||||||
cbRefs: number[];
|
cbRefs: number[];
|
||||||
refList: (() => void)[][];
|
|
||||||
}
|
}
|
||||||
|
|
||||||
function buildContext(tree: IntermediateTree, ctx?: BlockCtx, fromIdx?: number): BlockCtx {
|
function buildContext(
|
||||||
|
tree: IntermediateTree,
|
||||||
|
ctx?: BlockCtx,
|
||||||
|
fromIdx?: number,
|
||||||
|
toIdx?: number
|
||||||
|
): BlockCtx {
|
||||||
if (!ctx) {
|
if (!ctx) {
|
||||||
const children = new Array(tree.info.filter((v) => v.type === "child").length);
|
const children = new Array(tree.info.filter((v) => v.type === "child").length);
|
||||||
ctx = { collectors: [], locations: [], children, cbRefs: [], refN: tree.refN, refList: [] };
|
ctx = { collectors: [], locations: [], children, cbRefs: [], refN: tree.refN };
|
||||||
fromIdx = 0;
|
fromIdx = 0;
|
||||||
|
toIdx = tree.refN - 1;
|
||||||
}
|
}
|
||||||
if (tree.refN) {
|
if (tree.refN) {
|
||||||
const initialIdx = fromIdx!;
|
const initialIdx = fromIdx!;
|
||||||
const isRef = tree.isRef;
|
const isRef = tree.forceRef || tree.info.length > 0;
|
||||||
const firstChild = tree.firstChild ? tree.firstChild.refN : 0;
|
const firstChild = tree.firstChild ? tree.firstChild.refN : 0;
|
||||||
const nextSibling = tree.nextSibling ? tree.nextSibling.refN : 0;
|
const nextSibling = tree.nextSibling ? tree.nextSibling.refN : 0;
|
||||||
|
|
||||||
@@ -328,13 +325,13 @@ function buildContext(tree: IntermediateTree, ctx?: BlockCtx, fromIdx?: number):
|
|||||||
if (nextSibling) {
|
if (nextSibling) {
|
||||||
const idx = fromIdx! + firstChild;
|
const idx = fromIdx! + firstChild;
|
||||||
ctx.collectors.push({ idx, prevIdx: initialIdx, getVal: nodeGetNextSibling });
|
ctx.collectors.push({ idx, prevIdx: initialIdx, getVal: nodeGetNextSibling });
|
||||||
buildContext(tree.nextSibling!, ctx, idx);
|
buildContext(tree.nextSibling!, ctx, idx, toIdx);
|
||||||
}
|
}
|
||||||
|
|
||||||
// left
|
// left
|
||||||
if (firstChild) {
|
if (firstChild) {
|
||||||
ctx.collectors.push({ idx: fromIdx!, prevIdx: initialIdx, getVal: nodeGetFirstChild });
|
ctx.collectors.push({ idx: fromIdx!, prevIdx: initialIdx, getVal: nodeGetFirstChild });
|
||||||
buildContext(tree.firstChild!, ctx, fromIdx!);
|
buildContext(tree.firstChild!, ctx, fromIdx!, toIdx! - nextSibling);
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -399,21 +396,21 @@ function updateCtx(ctx: BlockCtx, tree: IntermediateTree) {
|
|||||||
});
|
});
|
||||||
break;
|
break;
|
||||||
case "handler": {
|
case "handler": {
|
||||||
const { setup, update } = createEventHandler(info.event!);
|
const setupHandler = createEventHandler(info.event!);
|
||||||
ctx.locations.push({
|
ctx.locations.push({
|
||||||
idx: info.idx,
|
idx: info.idx,
|
||||||
refIdx: info.refIdx!,
|
refIdx: info.refIdx!,
|
||||||
setData: setup,
|
setData: setupHandler,
|
||||||
updateData: update,
|
updateData: setupHandler,
|
||||||
});
|
});
|
||||||
break;
|
break;
|
||||||
}
|
}
|
||||||
case "ref":
|
case "ref":
|
||||||
const index = ctx.cbRefs.push(info.idx) - 1;
|
ctx.cbRefs.push(info.idx);
|
||||||
ctx.locations.push({
|
ctx.locations.push({
|
||||||
idx: info.idx,
|
idx: info.idx,
|
||||||
refIdx: info.refIdx!,
|
refIdx: info.refIdx!,
|
||||||
setData: makeRefSetter(index, ctx.refList),
|
setData: setRef,
|
||||||
updateData: NO_OP,
|
updateData: NO_OP,
|
||||||
});
|
});
|
||||||
}
|
}
|
||||||
@@ -427,21 +424,12 @@ function buildBlock(template: HTMLElement, ctx: BlockCtx): BlockType {
|
|||||||
let B = createBlockClass(template, ctx);
|
let B = createBlockClass(template, ctx);
|
||||||
|
|
||||||
if (ctx.cbRefs.length) {
|
if (ctx.cbRefs.length) {
|
||||||
const cbRefs = ctx.cbRefs;
|
const refs = ctx.cbRefs;
|
||||||
const refList = ctx.refList;
|
|
||||||
let cbRefsNumber = cbRefs.length;
|
|
||||||
B = class extends B {
|
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() {
|
remove() {
|
||||||
super.remove();
|
super.remove();
|
||||||
for (let cbRef of cbRefs) {
|
for (let ref of refs) {
|
||||||
let fn = (this as any).data[cbRef];
|
let fn = (this as any).data[ref];
|
||||||
fn(null);
|
fn(null);
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
@@ -486,12 +474,12 @@ function createBlockClass(template: HTMLElement, ctx: BlockCtx): BlockClass {
|
|||||||
const nodeInsertBefore = nodeProto.insertBefore;
|
const nodeInsertBefore = nodeProto.insertBefore;
|
||||||
const elementRemove = elementProto.remove;
|
const elementRemove = elementProto.remove;
|
||||||
|
|
||||||
class Block {
|
return class Block {
|
||||||
el: HTMLElement | undefined;
|
el: HTMLElement | undefined;
|
||||||
parentEl?: HTMLElement | undefined;
|
|
||||||
data: any[] | undefined;
|
|
||||||
children?: (VNode | undefined)[];
|
|
||||||
refs: Node[] | undefined;
|
refs: Node[] | undefined;
|
||||||
|
data: any[] | undefined;
|
||||||
|
parentEl?: HTMLElement | undefined;
|
||||||
|
children?: (VNode | undefined)[];
|
||||||
|
|
||||||
constructor(data?: any[]) {
|
constructor(data?: any[]) {
|
||||||
this.data = data;
|
this.data = data;
|
||||||
@@ -512,62 +500,46 @@ function createBlockClass(template: HTMLElement, ctx: BlockCtx): BlockClass {
|
|||||||
nodeInsertBefore.call(this.parentEl, this.el!, target);
|
nodeInsertBefore.call(this.parentEl, this.el!, target);
|
||||||
}
|
}
|
||||||
|
|
||||||
toString() {
|
|
||||||
const div = document.createElement("div");
|
|
||||||
this.mount(div, null);
|
|
||||||
return div.innerHTML;
|
|
||||||
}
|
|
||||||
|
|
||||||
mount(parent: HTMLElement, afterNode: Node | null) {
|
mount(parent: HTMLElement, afterNode: Node | null) {
|
||||||
const el = nodeCloneNode.call(template, true) as HTMLElement;
|
|
||||||
nodeInsertBefore.call(parent, el, afterNode);
|
|
||||||
this.el = el;
|
|
||||||
this.parentEl = parent;
|
|
||||||
}
|
|
||||||
patch(other: Block, withBeforeRemove: boolean) {}
|
|
||||||
}
|
|
||||||
|
|
||||||
if (isDynamic) {
|
|
||||||
Block.prototype.mount = function mount(parent: HTMLElement, afterNode: Node | null) {
|
|
||||||
const el = nodeCloneNode.call(template, true);
|
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]);
|
|
||||||
}
|
|
||||||
|
|
||||||
// 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);
|
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]);
|
||||||
|
}
|
||||||
|
|
||||||
// preparing all children
|
// applying data to all update points
|
||||||
if (childN) {
|
if (locN) {
|
||||||
const children = this.children;
|
const data = this.data!;
|
||||||
for (let i = 0; i < childN; i++) {
|
for (let i = 0; i < locN; i++) {
|
||||||
const child = children![i];
|
const loc = locations[i];
|
||||||
if (child) {
|
loc.setData.call(refs[loc.refIdx], data[i]);
|
||||||
const loc = childrenLocs[i];
|
}
|
||||||
const afterNode = loc.afterRefIdx ? refs[loc.afterRefIdx] : null;
|
}
|
||||||
child.isOnlyChild = loc.isOnlyChild;
|
|
||||||
child.mount(refs[loc.parentRefIdx] as any, 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.el = el as HTMLElement;
|
||||||
this.parentEl = parent;
|
this.parentEl = parent;
|
||||||
};
|
}
|
||||||
|
patch(other: Block, withBeforeRemove: boolean) {
|
||||||
Block.prototype.patch = function patch(other: Block, withBeforeRemove: boolean) {
|
|
||||||
if (this === other) {
|
if (this === other) {
|
||||||
return;
|
return;
|
||||||
}
|
}
|
||||||
@@ -612,17 +584,19 @@ function createBlockClass(template: HTMLElement, ctx: BlockCtx): BlockClass {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
};
|
}
|
||||||
}
|
toString() {
|
||||||
return Block;
|
const div = document.createElement("div");
|
||||||
|
this.mount(div, null);
|
||||||
|
return div.innerHTML;
|
||||||
|
}
|
||||||
|
};
|
||||||
}
|
}
|
||||||
|
|
||||||
function setText(this: Text, value: any) {
|
function setText(this: Text, value: any) {
|
||||||
characterDataSetData.call(this, toText(value));
|
characterDataSetData.call(this, toText(value));
|
||||||
}
|
}
|
||||||
|
|
||||||
function makeRefSetter(index: number, refs: (() => void)[][]): Setter<HTMLElement> {
|
function setRef(this: HTMLElement, fn: any) {
|
||||||
return function setRef(this: HTMLElement, fn: any) {
|
fn(this);
|
||||||
refs[refs.length - 1][index] = () => fn(this);
|
|
||||||
};
|
|
||||||
}
|
}
|
||||||
@@ -1,13 +1,3 @@
|
|||||||
export function filterOutModifiersFromData(dataList: any[]): { modifiers: string[]; data: any[] } {
|
|
||||||
dataList = dataList.slice();
|
|
||||||
const modifiers = [];
|
|
||||||
let elm;
|
|
||||||
while ((elm = dataList[0]) && typeof elm === "string") {
|
|
||||||
modifiers.push(dataList.shift());
|
|
||||||
}
|
|
||||||
return { modifiers, data: dataList };
|
|
||||||
}
|
|
||||||
|
|
||||||
export const config = {
|
export const config = {
|
||||||
// whether or not blockdom should normalize DOM whenever a block is created.
|
// whether or not blockdom should normalize DOM whenever a block is created.
|
||||||
// Normalizing dom mean removing empty text nodes (or containing only spaces)
|
// Normalizing dom mean removing empty text nodes (or containing only spaces)
|
||||||
@@ -16,13 +6,11 @@ export const config = {
|
|||||||
// this is the main event handler. Every event handler registered with blockdom
|
// this is the main event handler. Every event handler registered with blockdom
|
||||||
// will go through this function, giving it the data registered in the block
|
// will go through this function, giving it the data registered in the block
|
||||||
// and the event
|
// and the event
|
||||||
mainEventHandler: (data: any, ev: Event, currentTarget?: EventTarget | null): boolean => {
|
mainEventHandler: (data: any, ev: Event) => {
|
||||||
if (typeof data === "function") {
|
if (typeof data === "function") {
|
||||||
data(ev);
|
data(ev);
|
||||||
} else if (Array.isArray(data)) {
|
} else if (Array.isArray(data)) {
|
||||||
data = filterOutModifiersFromData(data).data;
|
|
||||||
data[0](data[1], ev);
|
data[0](data[1], ev);
|
||||||
}
|
}
|
||||||
return false;
|
|
||||||
},
|
},
|
||||||
};
|
};
|
||||||
@@ -0,0 +1,32 @@
|
|||||||
|
import { config } from "./config";
|
||||||
|
|
||||||
|
export function createEventHandler(event: string) {
|
||||||
|
setupSyntheticEvent(event);
|
||||||
|
const key = `__event__${event}`;
|
||||||
|
return function setupHandler(this: HTMLElement, data: any) {
|
||||||
|
(this as any)[key] = data;
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
|
function nativeToSyntheticEvent(event: Event, name: string) {
|
||||||
|
const eventKey = `__event__${name}`;
|
||||||
|
let dom = event.target;
|
||||||
|
while (dom !== null) {
|
||||||
|
const data = (dom as any)[eventKey];
|
||||||
|
if (data) {
|
||||||
|
config.mainEventHandler(data, event);
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
dom = (dom as any).parentNode;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
const CONFIGURED_SYNTHETIC_EVENTS: { [event: string]: boolean } = {};
|
||||||
|
|
||||||
|
function setupSyntheticEvent(name: string) {
|
||||||
|
if (CONFIGURED_SYNTHETIC_EVENTS[name]) {
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
document.addEventListener(name, (event) => nativeToSyntheticEvent(event, name));
|
||||||
|
CONFIGURED_SYNTHETIC_EVENTS[name] = true;
|
||||||
|
}
|
||||||
@@ -61,7 +61,6 @@ class VHtml {
|
|||||||
// remove current content
|
// remove current content
|
||||||
this.remove();
|
this.remove();
|
||||||
this.content = content;
|
this.content = content;
|
||||||
this.html = other.html;
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -4,9 +4,8 @@ export { toggler } from "./toggler";
|
|||||||
export { createBlock } from "./block_compiler";
|
export { createBlock } from "./block_compiler";
|
||||||
export { list } from "./list";
|
export { list } from "./list";
|
||||||
export { multi } from "./multi";
|
export { multi } from "./multi";
|
||||||
export { text, comment } from "./text";
|
export { text } from "./text";
|
||||||
export { html } from "./html";
|
export { html } from "./html";
|
||||||
export { createCatcher } from "./event_catcher";
|
|
||||||
|
|
||||||
export interface VNode<T = any> {
|
export interface VNode<T = any> {
|
||||||
mount(parent: HTMLElement, afterNode: Node | null): void;
|
mount(parent: HTMLElement, afterNode: Node | null): void;
|
||||||
@@ -24,8 +23,8 @@ export interface VNode<T = any> {
|
|||||||
|
|
||||||
export type BDom = VNode<any>;
|
export type BDom = VNode<any>;
|
||||||
|
|
||||||
export function mount(vnode: VNode, fixture: HTMLElement, afterNode: Node | null = null) {
|
export function mount(vnode: VNode, fixture: HTMLElement) {
|
||||||
vnode.mount(fixture, afterNode);
|
vnode.mount(fixture, null);
|
||||||
}
|
}
|
||||||
|
|
||||||
export function patch(vnode1: VNode, vnode2: VNode, withBeforeRemove: boolean = false) {
|
export function patch(vnode1: VNode, vnode2: VNode, withBeforeRemove: boolean = false) {
|
||||||
@@ -98,6 +98,7 @@ class VList {
|
|||||||
let endVn2 = ch2[endIdx2];
|
let endVn2 = ch2[endIdx2];
|
||||||
|
|
||||||
let mapping: any = undefined;
|
let mapping: any = undefined;
|
||||||
|
// let noFullRemove = this.hasNoComponent;
|
||||||
|
|
||||||
while (startIdx1 <= endIdx1 && startIdx2 <= endIdx2) {
|
while (startIdx1 <= endIdx1 && startIdx2 <= endIdx2) {
|
||||||
// -------------------------------------------------------------------
|
// -------------------------------------------------------------------
|
||||||
@@ -125,7 +125,7 @@ export class VMulti {
|
|||||||
}
|
}
|
||||||
|
|
||||||
toString(): string {
|
toString(): string {
|
||||||
return this.children.map((c) => (c ? c!.toString() : "")).join("");
|
return this.children.map((c) => c!.toString()).join("");
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -8,17 +8,18 @@ const nodeInsertBefore = nodeProto.insertBefore;
|
|||||||
const characterDataSetData = getDescriptor(characterDataProto, "data").set!;
|
const characterDataSetData = getDescriptor(characterDataProto, "data").set!;
|
||||||
const nodeRemoveChild = nodeProto.removeChild;
|
const nodeRemoveChild = nodeProto.removeChild;
|
||||||
|
|
||||||
abstract class VSimpleNode {
|
class VText {
|
||||||
text: string | String;
|
text: string;
|
||||||
parentEl?: HTMLElement | undefined;
|
parentEl?: HTMLElement | undefined;
|
||||||
el?: any;
|
el?: Text;
|
||||||
|
|
||||||
constructor(text: string | String) {
|
constructor(text: string) {
|
||||||
this.text = text;
|
this.text = text;
|
||||||
}
|
}
|
||||||
|
|
||||||
mountNode(node: Node, parent: HTMLElement, afterNode: Node | null) {
|
mount(parent: HTMLElement, afterNode: Node | null) {
|
||||||
this.parentEl = parent;
|
this.parentEl = parent;
|
||||||
|
const node = document.createTextNode(toText(this.text));
|
||||||
nodeInsertBefore.call(parent, node, afterNode);
|
nodeInsertBefore.call(parent, node, afterNode);
|
||||||
this.el = node;
|
this.el = node;
|
||||||
}
|
}
|
||||||
@@ -28,6 +29,14 @@ abstract class VSimpleNode {
|
|||||||
nodeInsertBefore.call(this.parentEl, this.el!, target);
|
nodeInsertBefore.call(this.parentEl, this.el!, target);
|
||||||
}
|
}
|
||||||
|
|
||||||
|
patch(other: VText) {
|
||||||
|
const text2 = other.text;
|
||||||
|
if (this.text !== text2) {
|
||||||
|
characterDataSetData.call(this.el!, toText(text2));
|
||||||
|
this.text = text2;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
beforeRemove() {}
|
beforeRemove() {}
|
||||||
|
|
||||||
remove() {
|
remove() {
|
||||||
@@ -43,36 +52,10 @@ abstract class VSimpleNode {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
class VText extends VSimpleNode {
|
export function text(str: string): VNode<VText> {
|
||||||
mount(parent: HTMLElement, afterNode: Node | null) {
|
|
||||||
this.mountNode(document.createTextNode(toText(this.text)), parent, afterNode);
|
|
||||||
}
|
|
||||||
|
|
||||||
patch(other: VText) {
|
|
||||||
const text2 = other.text;
|
|
||||||
if (this.text !== text2) {
|
|
||||||
characterDataSetData.call(this.el!, toText(text2));
|
|
||||||
this.text = text2;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
class VComment extends VSimpleNode {
|
|
||||||
mount(parent: HTMLElement, afterNode: Node | null) {
|
|
||||||
this.mountNode(document.createComment(toText(this.text)), parent, afterNode);
|
|
||||||
}
|
|
||||||
|
|
||||||
patch() {}
|
|
||||||
}
|
|
||||||
|
|
||||||
export function text(str: string | String): VNode<VText> {
|
|
||||||
return new VText(str);
|
return new VText(str);
|
||||||
}
|
}
|
||||||
|
|
||||||
export function comment(str: string): VNode<VComment> {
|
|
||||||
return new VComment(str);
|
|
||||||
}
|
|
||||||
|
|
||||||
export function toText(value: any): string {
|
export function toText(value: any): string {
|
||||||
switch (typeof value) {
|
switch (typeof value) {
|
||||||
case "string":
|
case "string":
|
||||||
@@ -43,9 +43,7 @@ class VToggler {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
beforeRemove() {
|
beforeRemove() {}
|
||||||
this.child.beforeRemove();
|
|
||||||
}
|
|
||||||
|
|
||||||
remove() {
|
remove() {
|
||||||
this.child.remove();
|
this.child.remove();
|
||||||
File diff suppressed because it is too large
Load Diff
@@ -1,31 +0,0 @@
|
|||||||
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 = (app: TemplateSet, bdom: any, helpers: any) => Template;
|
|
||||||
|
|
||||||
interface CompileOptions extends Config {
|
|
||||||
name?: string;
|
|
||||||
}
|
|
||||||
export function compile(
|
|
||||||
template: string | Element,
|
|
||||||
options: CompileOptions = {}
|
|
||||||
): TemplateFunction {
|
|
||||||
// parsing
|
|
||||||
const ast = parse(template);
|
|
||||||
|
|
||||||
// some work
|
|
||||||
const hasSafeContext =
|
|
||||||
template instanceof Node
|
|
||||||
? !(template instanceof Element) || template.querySelector("[t-set], [t-call]") === null
|
|
||||||
: !template.includes("t-set") && !template.includes("t-call");
|
|
||||||
|
|
||||||
// code generation
|
|
||||||
const codeGenerator = new CodeGenerator(ast, { ...options, hasSafeContext });
|
|
||||||
const code = codeGenerator.generateCode();
|
|
||||||
// template function
|
|
||||||
return new Function("app, bdom, helpers", code) as TemplateFunction;
|
|
||||||
}
|
|
||||||
@@ -0,0 +1,29 @@
|
|||||||
|
import type { ComponentNode } from "./component_node";
|
||||||
|
|
||||||
|
// -----------------------------------------------------------------------------
|
||||||
|
// Component Class
|
||||||
|
// -----------------------------------------------------------------------------
|
||||||
|
|
||||||
|
export class Component {
|
||||||
|
static template: string = "";
|
||||||
|
|
||||||
|
props: any;
|
||||||
|
env: any;
|
||||||
|
__owl__: ComponentNode;
|
||||||
|
|
||||||
|
constructor(props: any, env: any, node: ComponentNode) {
|
||||||
|
this.props = props;
|
||||||
|
this.env = env;
|
||||||
|
this.__owl__ = node;
|
||||||
|
}
|
||||||
|
get el(): HTMLElement | Text | undefined {
|
||||||
|
const node = this.__owl__;
|
||||||
|
return node.bdom ? (node.bdom.firstNode() as any) : undefined;
|
||||||
|
}
|
||||||
|
|
||||||
|
setup() {}
|
||||||
|
|
||||||
|
render(): Promise<void> {
|
||||||
|
return this.__owl__.render();
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,256 @@
|
|||||||
|
import type { App } from "../app";
|
||||||
|
import { BDom, VNode } from "../blockdom";
|
||||||
|
import { Component } from "./component";
|
||||||
|
import {
|
||||||
|
Fiber,
|
||||||
|
makeChildFiber,
|
||||||
|
makeRootFiber,
|
||||||
|
MountFiber,
|
||||||
|
RootFiber,
|
||||||
|
__internal__destroyed,
|
||||||
|
} from "./fibers";
|
||||||
|
import { STATUS } from "./status";
|
||||||
|
|
||||||
|
export function component(
|
||||||
|
name: string | typeof Component,
|
||||||
|
props: any,
|
||||||
|
key: string,
|
||||||
|
ctx: ComponentNode,
|
||||||
|
parent: any
|
||||||
|
): ComponentNode {
|
||||||
|
let node: any = ctx.children[key];
|
||||||
|
let isDynamic = typeof name !== "string";
|
||||||
|
|
||||||
|
if (node && node.status < STATUS.MOUNTED) {
|
||||||
|
node.destroy();
|
||||||
|
node = undefined;
|
||||||
|
}
|
||||||
|
if (isDynamic && node && node.component.constructor !== name) {
|
||||||
|
node = undefined;
|
||||||
|
}
|
||||||
|
|
||||||
|
const parentFiber = ctx.fiber!;
|
||||||
|
if (node) {
|
||||||
|
node.updateAndRender(props, parentFiber);
|
||||||
|
} else {
|
||||||
|
// new component
|
||||||
|
const C = isDynamic ? name : parent.constructor.components[name as any];
|
||||||
|
node = new ComponentNode(C, props, ctx.app);
|
||||||
|
ctx.children[key] = node;
|
||||||
|
|
||||||
|
const fiber = makeChildFiber(node, parentFiber);
|
||||||
|
node.initiateRender(fiber);
|
||||||
|
}
|
||||||
|
return node;
|
||||||
|
}
|
||||||
|
|
||||||
|
// -----------------------------------------------------------------------------
|
||||||
|
// Component VNode
|
||||||
|
// -----------------------------------------------------------------------------
|
||||||
|
|
||||||
|
let currentNode: ComponentNode | null = null;
|
||||||
|
|
||||||
|
export function getCurrent(): ComponentNode | null {
|
||||||
|
return currentNode;
|
||||||
|
}
|
||||||
|
|
||||||
|
type LifecycleHook = Function;
|
||||||
|
|
||||||
|
export class ComponentNode<T extends typeof Component = any> implements VNode<ComponentNode> {
|
||||||
|
el?: HTMLElement | Text | undefined;
|
||||||
|
handlers: any = null;
|
||||||
|
app: App;
|
||||||
|
fiber: Fiber | null = null;
|
||||||
|
component: InstanceType<T>;
|
||||||
|
bdom: BDom | null = null;
|
||||||
|
status: STATUS = STATUS.NEW;
|
||||||
|
|
||||||
|
renderFn: Function;
|
||||||
|
children: { [key: string]: ComponentNode } = Object.create(null);
|
||||||
|
slots: any = {};
|
||||||
|
refs: any = {};
|
||||||
|
|
||||||
|
willStart: LifecycleHook[] = [];
|
||||||
|
willUpdateProps: LifecycleHook[] = [];
|
||||||
|
willUnmount: LifecycleHook[] = [];
|
||||||
|
mounted: LifecycleHook[] = [];
|
||||||
|
willPatch: LifecycleHook[] = [];
|
||||||
|
patched: LifecycleHook[] = [];
|
||||||
|
destroyed: LifecycleHook[] = [];
|
||||||
|
|
||||||
|
constructor(C: T, props: any, app: App) {
|
||||||
|
currentNode = this;
|
||||||
|
this.app = app;
|
||||||
|
this.component = new C(props, app.env, this) as any;
|
||||||
|
this.renderFn = app.getTemplate(C.template).bind(null, this.component, this);
|
||||||
|
this.component.setup();
|
||||||
|
}
|
||||||
|
|
||||||
|
mountComponent(target: any): Promise<InstanceType<T>> {
|
||||||
|
const fiber = new MountFiber(this, target);
|
||||||
|
this.app.scheduler.addFiber(fiber);
|
||||||
|
this.initiateRender(fiber);
|
||||||
|
return fiber.promise.then(() => this.component);
|
||||||
|
}
|
||||||
|
|
||||||
|
async initiateRender(fiber: Fiber | MountFiber) {
|
||||||
|
if (this.mounted.length) {
|
||||||
|
fiber.root.mounted.push(fiber);
|
||||||
|
}
|
||||||
|
const component = this.component;
|
||||||
|
const prom = Promise.all(this.willStart.map((f) => f.call(component)));
|
||||||
|
await prom;
|
||||||
|
if (this.status === STATUS.NEW && this.fiber === fiber) {
|
||||||
|
this._render(fiber);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
async render() {
|
||||||
|
if (this.fiber && !this.fiber.bdom) {
|
||||||
|
return this.fiber.root.promise;
|
||||||
|
}
|
||||||
|
if (!this.bdom && !this.fiber) {
|
||||||
|
// should find a way to return the future mounting promise
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
const fiber = makeRootFiber(this);
|
||||||
|
this.app.scheduler.addFiber(fiber);
|
||||||
|
await Promise.resolve();
|
||||||
|
if (this.status === STATUS.DESTROYED) {
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
if (this.fiber === fiber) {
|
||||||
|
this._render(fiber);
|
||||||
|
}
|
||||||
|
return fiber.root.promise;
|
||||||
|
}
|
||||||
|
|
||||||
|
_render(fiber: Fiber | RootFiber) {
|
||||||
|
try {
|
||||||
|
fiber.bdom = this.renderFn();
|
||||||
|
} catch (e) {
|
||||||
|
fiber.root.error = e;
|
||||||
|
this.handleError(fiber);
|
||||||
|
}
|
||||||
|
fiber.root.counter--;
|
||||||
|
}
|
||||||
|
|
||||||
|
handleError(fiber: Fiber) {
|
||||||
|
fiber.node.app.destroy();
|
||||||
|
}
|
||||||
|
|
||||||
|
destroy() {
|
||||||
|
if (this.status === STATUS.MOUNTED) {
|
||||||
|
callWillUnmount(this);
|
||||||
|
this.bdom!.remove();
|
||||||
|
}
|
||||||
|
callDestroyed(this);
|
||||||
|
|
||||||
|
function callWillUnmount(node: ComponentNode) {
|
||||||
|
const component = node.component;
|
||||||
|
for (let cb of node.willUnmount) {
|
||||||
|
cb.call(component);
|
||||||
|
}
|
||||||
|
for (let child of Object.values(node.children)) {
|
||||||
|
if (child.status === STATUS.MOUNTED) {
|
||||||
|
callWillUnmount(child);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
function callDestroyed(node: ComponentNode) {
|
||||||
|
const component = node.component;
|
||||||
|
node.status = STATUS.DESTROYED;
|
||||||
|
for (let child of Object.values(node.children)) {
|
||||||
|
callDestroyed(child);
|
||||||
|
}
|
||||||
|
for (let cb of node.destroyed) {
|
||||||
|
cb.call(component);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
async updateAndRender(props: any, parentFiber: Fiber) {
|
||||||
|
// update
|
||||||
|
const fiber = makeChildFiber(this, parentFiber);
|
||||||
|
if (this.willPatch.length) {
|
||||||
|
parentFiber.root.willPatch.push(fiber);
|
||||||
|
}
|
||||||
|
if (this.patched.length) {
|
||||||
|
parentFiber.root.patched.push(fiber);
|
||||||
|
}
|
||||||
|
const component = this.component;
|
||||||
|
const prom = Promise.all(this.willUpdateProps.map((f) => f.call(component, props)));
|
||||||
|
await prom;
|
||||||
|
if (fiber !== this.fiber) {
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
this.component.props = props;
|
||||||
|
this._render(fiber);
|
||||||
|
}
|
||||||
|
|
||||||
|
// ---------------------------------------------------------------------------
|
||||||
|
// 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;
|
||||||
|
if (this.handlers) {
|
||||||
|
for (let i = 0; i < this.handlers.length; i++) {
|
||||||
|
const handler = this.handlers[i];
|
||||||
|
const eventType = handler[0];
|
||||||
|
const el = bdom.el!;
|
||||||
|
el.addEventListener(eventType, (ev: Event) => {
|
||||||
|
const info = this.handlers![i];
|
||||||
|
const [, ctx, method] = info;
|
||||||
|
(ctx.__owl__.component as any)[method](ev);
|
||||||
|
});
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
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() {
|
||||||
|
visitRemovedNodes(this);
|
||||||
|
}
|
||||||
|
|
||||||
|
remove() {
|
||||||
|
this.bdom!.remove();
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
function visitRemovedNodes(node: ComponentNode) {
|
||||||
|
if (node.status === STATUS.MOUNTED) {
|
||||||
|
const component = node.component;
|
||||||
|
for (let cb of node.willUnmount) {
|
||||||
|
cb.call(component);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
for (let child of Object.values(node.children)) {
|
||||||
|
visitRemovedNodes(child);
|
||||||
|
}
|
||||||
|
node.status = STATUS.DESTROYED;
|
||||||
|
if (node.destroyed.length) {
|
||||||
|
__internal__destroyed.push(node);
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,185 @@
|
|||||||
|
import type { BDom } from "../blockdom";
|
||||||
|
import { mount } from "../blockdom";
|
||||||
|
import type { ComponentNode } from "./component_node";
|
||||||
|
import { STATUS } from "./status";
|
||||||
|
// import { mountBlock } from "./bdom/block";
|
||||||
|
|
||||||
|
export function makeChildFiber(node: ComponentNode, parent: Fiber): Fiber {
|
||||||
|
let current = node.fiber;
|
||||||
|
if (current) {
|
||||||
|
// current is necessarily a rootfiber here
|
||||||
|
let root = parent.root;
|
||||||
|
cancelFibers(root, current.children);
|
||||||
|
current.children = [];
|
||||||
|
current.parent = parent;
|
||||||
|
root.counter++;
|
||||||
|
current.root = root;
|
||||||
|
return current;
|
||||||
|
}
|
||||||
|
return new Fiber(node, parent);
|
||||||
|
}
|
||||||
|
|
||||||
|
export function makeRootFiber(node: ComponentNode): Fiber {
|
||||||
|
let current = node.fiber;
|
||||||
|
if (current) {
|
||||||
|
let root = current.root;
|
||||||
|
root.counter -= cancelFibers(root, current.children);
|
||||||
|
current.children = [];
|
||||||
|
root.counter++;
|
||||||
|
current.bdom = null;
|
||||||
|
return current;
|
||||||
|
}
|
||||||
|
const fiber = new RootFiber(node);
|
||||||
|
if (node.willPatch.length) {
|
||||||
|
fiber.willPatch.push(fiber);
|
||||||
|
}
|
||||||
|
if (node.patched.length) {
|
||||||
|
fiber.patched.push(fiber);
|
||||||
|
}
|
||||||
|
|
||||||
|
return fiber;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @returns number of not-yet rendered fibers cancelled
|
||||||
|
*/
|
||||||
|
function cancelFibers(root: any, fibers: Fiber[]): number {
|
||||||
|
let result = 0;
|
||||||
|
for (let fiber of fibers) {
|
||||||
|
fiber.node.fiber = null;
|
||||||
|
fiber.root = root;
|
||||||
|
if (!fiber.bdom) {
|
||||||
|
result++;
|
||||||
|
}
|
||||||
|
result += cancelFibers(root, fiber.children);
|
||||||
|
}
|
||||||
|
return result;
|
||||||
|
}
|
||||||
|
|
||||||
|
export class Fiber {
|
||||||
|
node: ComponentNode;
|
||||||
|
bdom: BDom | null = null;
|
||||||
|
root: RootFiber;
|
||||||
|
parent: Fiber | null;
|
||||||
|
children: Fiber[] = [];
|
||||||
|
appliedToDom = false;
|
||||||
|
|
||||||
|
constructor(node: ComponentNode, parent: Fiber | null) {
|
||||||
|
this.node = node;
|
||||||
|
node.fiber = this;
|
||||||
|
this.parent = parent;
|
||||||
|
if (parent) {
|
||||||
|
const root = parent.root;
|
||||||
|
root.counter++;
|
||||||
|
this.root = root;
|
||||||
|
parent.children.push(this);
|
||||||
|
} else {
|
||||||
|
this.root = this as any;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
export class RootFiber extends Fiber {
|
||||||
|
counter: number = 1;
|
||||||
|
error: Error | null = null;
|
||||||
|
resolve: any;
|
||||||
|
promise: Promise<any>;
|
||||||
|
reject: any;
|
||||||
|
|
||||||
|
// only add stuff in this if they have registered some hooks
|
||||||
|
willPatch: Fiber[] = [];
|
||||||
|
patched: Fiber[] = [];
|
||||||
|
mounted: Fiber[] = [];
|
||||||
|
|
||||||
|
constructor(node: ComponentNode) {
|
||||||
|
super(node, null);
|
||||||
|
this.counter = 1;
|
||||||
|
|
||||||
|
this.promise = new Promise((resolve, reject) => {
|
||||||
|
this.resolve = resolve;
|
||||||
|
this.reject = reject;
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
complete() {
|
||||||
|
const node = this.node;
|
||||||
|
|
||||||
|
// Step 1: calling all willPatch lifecycle hooks
|
||||||
|
for (let fiber of this.willPatch) {
|
||||||
|
// because of the asynchronous nature of the rendering, some parts of the
|
||||||
|
// UI may have been rendered, then deleted in a followup rendering, and we
|
||||||
|
// do not want to call onWillPatch in that case.
|
||||||
|
let node = fiber.node;
|
||||||
|
if (node.fiber === fiber) {
|
||||||
|
const component = node.component;
|
||||||
|
for (let cb of node.willPatch) {
|
||||||
|
cb.call(component);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Step 2: patching the dom
|
||||||
|
node.bdom!.patch(this.bdom!, Object.keys(node.children).length > 0);
|
||||||
|
this.appliedToDom = true;
|
||||||
|
|
||||||
|
// Step 3: calling all destroyed hooks
|
||||||
|
for (let node of __internal__destroyed) {
|
||||||
|
for (let cb of node.destroyed) {
|
||||||
|
cb();
|
||||||
|
}
|
||||||
|
}
|
||||||
|
__internal__destroyed.length = 0;
|
||||||
|
|
||||||
|
// Step 4: calling all mounted lifecycle hooks
|
||||||
|
let current;
|
||||||
|
let mountedFibers = this.mounted;
|
||||||
|
while ((current = mountedFibers.pop())) {
|
||||||
|
if (current.appliedToDom) {
|
||||||
|
for (let cb of current.node.mounted) {
|
||||||
|
cb();
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Step 5: calling all patched hooks
|
||||||
|
let patchedFibers = this.patched;
|
||||||
|
while ((current = patchedFibers.pop())) {
|
||||||
|
if (current.appliedToDom) {
|
||||||
|
for (let cb of current.node.patched) {
|
||||||
|
cb();
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// unregistering the fiber
|
||||||
|
node.fiber = null;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
export let __internal__destroyed: ComponentNode[] = [];
|
||||||
|
|
||||||
|
export class MountFiber extends RootFiber {
|
||||||
|
target: HTMLElement;
|
||||||
|
|
||||||
|
constructor(node: ComponentNode, target: HTMLElement) {
|
||||||
|
super(node);
|
||||||
|
this.target = target;
|
||||||
|
}
|
||||||
|
complete() {
|
||||||
|
const node = this.node;
|
||||||
|
node.bdom = this.bdom;
|
||||||
|
mount(node.bdom!, this.target);
|
||||||
|
node.status = STATUS.MOUNTED;
|
||||||
|
this.appliedToDom = true;
|
||||||
|
let current;
|
||||||
|
let mountedFibers = this.mounted;
|
||||||
|
while ((current = mountedFibers.pop())) {
|
||||||
|
if (current.appliedToDom) {
|
||||||
|
for (let cb of current.node.mounted) {
|
||||||
|
cb();
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
node.fiber = null;
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,10 @@
|
|||||||
|
export function mainEventHandler(data: any, ev: Event) {
|
||||||
|
if (typeof data === "function") {
|
||||||
|
data(ev);
|
||||||
|
} else {
|
||||||
|
const ctx = data[0];
|
||||||
|
const method = data[1];
|
||||||
|
const args = data[2] || [];
|
||||||
|
ctx.__owl__.component[method](...args, ev);
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,79 @@
|
|||||||
|
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 is wrong! should be something like
|
||||||
|
// if (this.tasks.has(fiber.root)) {
|
||||||
|
// // parent rendering has completed
|
||||||
|
// fiber.resolve();
|
||||||
|
// this.tasks.delete(fiber);
|
||||||
|
// }
|
||||||
|
this.tasks.delete(fiber);
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
if (fiber.error) {
|
||||||
|
this.tasks.delete(fiber);
|
||||||
|
fiber.reject(fiber.error);
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
if (fiber.node.status === STATUS.DESTROYED) {
|
||||||
|
this.tasks.delete(fiber);
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
if (fiber.counter === 0) {
|
||||||
|
if (!fiber.error) {
|
||||||
|
fiber.complete();
|
||||||
|
}
|
||||||
|
fiber.resolve();
|
||||||
|
this.tasks.delete(fiber);
|
||||||
|
}
|
||||||
|
});
|
||||||
|
if (this.tasks.size === 0) {
|
||||||
|
this.stop();
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
scheduleTasks() {
|
||||||
|
this.requestAnimationFrame(() => {
|
||||||
|
this.flush();
|
||||||
|
if (this.isRunning) {
|
||||||
|
this.scheduleTasks();
|
||||||
|
}
|
||||||
|
});
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,5 @@
|
|||||||
|
export class EventBus extends EventTarget {
|
||||||
|
trigger(name: string, payload?: any) {
|
||||||
|
this.dispatchEvent(new CustomEvent(name, { detail: payload }));
|
||||||
|
}
|
||||||
|
}
|
||||||
+70
-13
@@ -1,16 +1,73 @@
|
|||||||
import { TemplateSet } from "./runtime/template_set";
|
import {
|
||||||
import { compile } from "./compiler";
|
config,
|
||||||
|
createBlock,
|
||||||
|
html,
|
||||||
|
list,
|
||||||
|
mount as blockMount,
|
||||||
|
multi,
|
||||||
|
patch,
|
||||||
|
remove,
|
||||||
|
text,
|
||||||
|
toggler,
|
||||||
|
} from "./blockdom";
|
||||||
|
import { mainEventHandler } from "./component/handler";
|
||||||
|
|
||||||
export * from "./runtime";
|
config.shouldNormalizeDom = false;
|
||||||
|
config.mainEventHandler = mainEventHandler;
|
||||||
|
|
||||||
TemplateSet.prototype._compileTemplate = function _compileTemplate(
|
export const blockDom = {
|
||||||
name: string,
|
config,
|
||||||
template: string | Element
|
// bdom entry points
|
||||||
) {
|
mount: blockMount,
|
||||||
return compile(template, {
|
patch,
|
||||||
name,
|
remove,
|
||||||
dev: this.dev,
|
// bdom block types
|
||||||
translateFn: this.translateFn,
|
list,
|
||||||
translatableAttributes: this.translatableAttributes,
|
multi,
|
||||||
});
|
text,
|
||||||
|
toggler,
|
||||||
|
createBlock,
|
||||||
|
html,
|
||||||
};
|
};
|
||||||
|
|
||||||
|
// import { makeBlockClass } from "./_old_bdom/element";
|
||||||
|
import { App } from "./app";
|
||||||
|
import { Component } from "./component/component";
|
||||||
|
import { getCurrent } from "./component/component_node";
|
||||||
|
// import { getCurrent } from "./b_node";
|
||||||
|
|
||||||
|
export { App, Component };
|
||||||
|
|
||||||
|
export async function mount<T extends typeof Component>(
|
||||||
|
C: T,
|
||||||
|
target: HTMLElement
|
||||||
|
): Promise<InstanceType<T>> {
|
||||||
|
const app = new App(C);
|
||||||
|
return app.mount(target);
|
||||||
|
}
|
||||||
|
|
||||||
|
export function useComponent(): Component {
|
||||||
|
const current = getCurrent();
|
||||||
|
return current!.component;
|
||||||
|
}
|
||||||
|
|
||||||
|
export { status } from "./component/status";
|
||||||
|
export { Portal } from "./misc/portal";
|
||||||
|
export { Memo } from "./misc/memo";
|
||||||
|
export { xml } from "./tags";
|
||||||
|
export { useState } from "./reactivity";
|
||||||
|
export { useRef } from "./refs";
|
||||||
|
export { EventBus } from "./event_bus";
|
||||||
|
|
||||||
|
export {
|
||||||
|
onWillStart,
|
||||||
|
onMounted,
|
||||||
|
onWillUnmount,
|
||||||
|
onWillUpdateProps,
|
||||||
|
onWillPatch,
|
||||||
|
onPatched,
|
||||||
|
onRender,
|
||||||
|
onDestroyed,
|
||||||
|
} from "./lifecycle_hooks";
|
||||||
|
|
||||||
|
export const __info__ = {};
|
||||||
|
|||||||
@@ -0,0 +1,49 @@
|
|||||||
|
import { getCurrent } from "./component/component_node";
|
||||||
|
|
||||||
|
// -----------------------------------------------------------------------------
|
||||||
|
// 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.push(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.push(fn);
|
||||||
|
}
|
||||||
|
|
||||||
|
export function onDestroyed(fn: () => Promise<void> | void | any) {
|
||||||
|
const node = getCurrent()!;
|
||||||
|
node.destroyed.push(fn);
|
||||||
|
}
|
||||||
|
|
||||||
|
export function onRender(fn: () => void | any) {
|
||||||
|
const node = getCurrent()!;
|
||||||
|
const renderFn = node.renderFn;
|
||||||
|
node.renderFn = () => {
|
||||||
|
fn();
|
||||||
|
return renderFn();
|
||||||
|
};
|
||||||
|
}
|
||||||
@@ -0,0 +1,47 @@
|
|||||||
|
import { Component } from "../component/component";
|
||||||
|
import type { ComponentNode } from "../component/component_node";
|
||||||
|
import { xml } from "../tags";
|
||||||
|
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 (p1[k] !== p2[k]) {
|
||||||
|
return false;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return true;
|
||||||
|
}
|
||||||
@@ -1,6 +1,7 @@
|
|||||||
import { onWillUnmount } from "./lifecycle_hooks";
|
import type { ComponentNode } from "../component/component_node";
|
||||||
import { BDom, text, VNode } from "./blockdom";
|
import { Component } from "../component/component";
|
||||||
import { Component } from "./component";
|
import { xml } from "../tags";
|
||||||
|
import { BDom, text, VNode } from "../blockdom";
|
||||||
|
|
||||||
const VText: any = text("").constructor;
|
const VText: any = text("").constructor;
|
||||||
|
|
||||||
@@ -34,11 +35,9 @@ class VPortal extends VText implements Partial<VNode<VPortal>> {
|
|||||||
this.realBDom!.beforeRemove();
|
this.realBDom!.beforeRemove();
|
||||||
}
|
}
|
||||||
remove() {
|
remove() {
|
||||||
if (this.realBDom) {
|
super.remove();
|
||||||
super.remove();
|
this.realBDom!.remove();
|
||||||
this.realBDom!.remove();
|
this.realBDom = null;
|
||||||
this.realBDom = null;
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
|
|
||||||
patch(other: VPortal) {
|
patch(other: VPortal) {
|
||||||
@@ -52,33 +51,15 @@ class VPortal extends VText implements Partial<VNode<VPortal>> {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
|
||||||
* <t t-slot="default"/>
|
|
||||||
*/
|
|
||||||
export function portalTemplate(app: any, bdom: any, helpers: any) {
|
|
||||||
let { callSlot } = helpers;
|
|
||||||
return function template(ctx: any, node: any, key = "") {
|
|
||||||
return callSlot(ctx, node, key, "default", false, null);
|
|
||||||
};
|
|
||||||
}
|
|
||||||
|
|
||||||
export class Portal extends Component {
|
export class Portal extends Component {
|
||||||
static template = "__portal__";
|
static template = xml`<t t-slot="default"/>`;
|
||||||
static props = {
|
|
||||||
target: {
|
|
||||||
type: String,
|
|
||||||
},
|
|
||||||
slots: true,
|
|
||||||
};
|
|
||||||
|
|
||||||
setup() {
|
constructor(props: any, env: any, node: ComponentNode) {
|
||||||
const node = this.__owl__;
|
super(props, env, node);
|
||||||
const renderFn = node.renderFn;
|
node._render = function (fiber: any) {
|
||||||
node.renderFn = () => new VPortal(this.props.target, renderFn());
|
const bdom = new VPortal(props.target, this.renderFn());
|
||||||
onWillUnmount(() => {
|
fiber.bdom = bdom;
|
||||||
if (node.bdom) {
|
fiber.root.counter--;
|
||||||
node.bdom.remove();
|
};
|
||||||
}
|
|
||||||
});
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
@@ -0,0 +1,997 @@
|
|||||||
|
import { BDom } from "../blockdom";
|
||||||
|
import { compileExpr, compileExprToArray, interpolate, INTERP_REGEXP } from "./inline_expressions";
|
||||||
|
import {
|
||||||
|
AST,
|
||||||
|
ASTComment,
|
||||||
|
ASTComponent,
|
||||||
|
ASTDebug,
|
||||||
|
ASTDomNode,
|
||||||
|
ASTLog,
|
||||||
|
ASTMulti,
|
||||||
|
ASTSlot,
|
||||||
|
ASTTCall,
|
||||||
|
ASTTCallBlock,
|
||||||
|
ASTTEsc,
|
||||||
|
ASTText,
|
||||||
|
ASTTForEach,
|
||||||
|
ASTTif,
|
||||||
|
ASTTKey,
|
||||||
|
ASTTRaw,
|
||||||
|
ASTTSet,
|
||||||
|
ASTType,
|
||||||
|
parse,
|
||||||
|
} from "./parser";
|
||||||
|
|
||||||
|
export type Template = (context: any, vnode: any, key?: string) => BDom;
|
||||||
|
export type TemplateFunction = (blocks: any, utils: any) => Template;
|
||||||
|
|
||||||
|
type BlockType = "block" | "text" | "multi" | "list" | "html";
|
||||||
|
|
||||||
|
export function compileTemplate(template: string, name?: string): TemplateFunction {
|
||||||
|
const compiler = new QWebCompiler(template, name);
|
||||||
|
return compiler.compile();
|
||||||
|
}
|
||||||
|
|
||||||
|
// using a non-html document so that <inner/outer>HTML serializes as XML instead
|
||||||
|
// of HTML (as we will parse it as xml later)
|
||||||
|
const xmlDoc = document.implementation.createDocument(null, null, null);
|
||||||
|
|
||||||
|
// -----------------------------------------------------------------------------
|
||||||
|
// BlockDescription
|
||||||
|
// -----------------------------------------------------------------------------
|
||||||
|
|
||||||
|
class BlockDescription {
|
||||||
|
static nextBlockId = 1;
|
||||||
|
static nextDataId = 1;
|
||||||
|
|
||||||
|
varName: string;
|
||||||
|
blockName: string;
|
||||||
|
isRoot: boolean = false;
|
||||||
|
hasDynamicChildren: boolean = false;
|
||||||
|
children: BlockDescription[] = [];
|
||||||
|
data: string[] = [];
|
||||||
|
dom?: Node;
|
||||||
|
currentDom?: Element;
|
||||||
|
childNumber: number = 0;
|
||||||
|
target: CodeTarget;
|
||||||
|
type: BlockType;
|
||||||
|
parentVar: string = "";
|
||||||
|
id: number;
|
||||||
|
|
||||||
|
constructor(target: CodeTarget, type: BlockType) {
|
||||||
|
this.id = BlockDescription.nextBlockId++;
|
||||||
|
this.varName = "b" + this.id;
|
||||||
|
this.blockName = "block" + this.id;
|
||||||
|
this.target = target;
|
||||||
|
this.type = type;
|
||||||
|
}
|
||||||
|
|
||||||
|
insertData(str: string): number {
|
||||||
|
const id = "d" + BlockDescription.nextDataId++;
|
||||||
|
this.target.addLine(`let ${id} = ${str};`);
|
||||||
|
return this.data.push(id) - 1;
|
||||||
|
}
|
||||||
|
|
||||||
|
insert(dom: Node) {
|
||||||
|
if (this.currentDom) {
|
||||||
|
this.currentDom.appendChild(dom);
|
||||||
|
} else {
|
||||||
|
this.dom = dom;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
generateExpr(expr: string): string {
|
||||||
|
if (this.type === "block") {
|
||||||
|
const hasChildren = this.children.length;
|
||||||
|
let params = this.data.length ? `[${this.data.join(", ")}]` : hasChildren ? "[]" : "";
|
||||||
|
if (hasChildren) {
|
||||||
|
params += ", [" + this.children.map((c) => c.varName).join(", ") + "]";
|
||||||
|
}
|
||||||
|
return `${this.blockName}(${params})`;
|
||||||
|
} else if (this.type === "list") {
|
||||||
|
return `list(c${this.id})`;
|
||||||
|
}
|
||||||
|
return expr;
|
||||||
|
}
|
||||||
|
|
||||||
|
asXmlString() {
|
||||||
|
// Can't use outerHTML on text/comment nodes
|
||||||
|
// append dom to any element and use innerHTML instead
|
||||||
|
const t = xmlDoc.createElement('t');
|
||||||
|
t.appendChild(this.dom!);
|
||||||
|
return t.innerHTML;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// -----------------------------------------------------------------------------
|
||||||
|
// Compiler code
|
||||||
|
// -----------------------------------------------------------------------------
|
||||||
|
const FNAMEREGEXP = /^[$A-Z_][0-9A-Z_$]*$/i;
|
||||||
|
|
||||||
|
interface Context {
|
||||||
|
block: BlockDescription | null;
|
||||||
|
index: number | string;
|
||||||
|
forceNewBlock: boolean;
|
||||||
|
preventRoot?: boolean;
|
||||||
|
isLast?: boolean;
|
||||||
|
}
|
||||||
|
|
||||||
|
class CodeTarget {
|
||||||
|
name: string;
|
||||||
|
signature: string = "";
|
||||||
|
indentLevel = 0;
|
||||||
|
loopLevel = 0;
|
||||||
|
code: string[] = [];
|
||||||
|
hasRoot = false;
|
||||||
|
hasCache = false;
|
||||||
|
|
||||||
|
constructor(name: string) {
|
||||||
|
this.name = name;
|
||||||
|
}
|
||||||
|
|
||||||
|
addLine(line: string, idx?: number) {
|
||||||
|
const prefix = new Array(this.indentLevel + 2).join(" ");
|
||||||
|
if (idx === undefined) {
|
||||||
|
this.code.push(prefix + line);
|
||||||
|
} else {
|
||||||
|
this.code.splice(idx, 0, prefix + line);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
export class QWebCompiler {
|
||||||
|
blocks: BlockDescription[] = [];
|
||||||
|
nextId = 1;
|
||||||
|
nextBlockId = 1;
|
||||||
|
shouldProtectScope: boolean = false;
|
||||||
|
shouldDefineAssign: boolean = false;
|
||||||
|
shouldDefineKey0: boolean = false;
|
||||||
|
hasSafeContext: boolean | null = null;
|
||||||
|
hasRef: boolean = false;
|
||||||
|
// hasTCall: boolean = false;
|
||||||
|
isDebug: boolean = false;
|
||||||
|
functions: CodeTarget[] = [];
|
||||||
|
target = new CodeTarget("main");
|
||||||
|
templateName: string;
|
||||||
|
template: string;
|
||||||
|
ast: AST;
|
||||||
|
staticCalls: { id: string; template: string }[] = [];
|
||||||
|
|
||||||
|
constructor(template: string, name?: string) {
|
||||||
|
this.template = template;
|
||||||
|
this.ast = parse(template);
|
||||||
|
// console.warn(this.ast);
|
||||||
|
if (name) {
|
||||||
|
this.templateName = name;
|
||||||
|
} else {
|
||||||
|
if (template.length > 250) {
|
||||||
|
this.templateName = template.slice(0, 250) + "...";
|
||||||
|
} else {
|
||||||
|
this.templateName = template;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
compile(): TemplateFunction {
|
||||||
|
const ast = this.ast;
|
||||||
|
this.isDebug = ast.type === ASTType.TDebug;
|
||||||
|
BlockDescription.nextBlockId = 1;
|
||||||
|
BlockDescription.nextDataId = 1;
|
||||||
|
this.compileAST(ast, { block: null, index: 0, forceNewBlock: false, isLast: true });
|
||||||
|
const code = this.generateCode();
|
||||||
|
// console.warn(code);
|
||||||
|
return new Function("bdom, helpers", code) as TemplateFunction;
|
||||||
|
}
|
||||||
|
|
||||||
|
addLine(line: string) {
|
||||||
|
this.target.addLine(line);
|
||||||
|
}
|
||||||
|
|
||||||
|
generateId(prefix: string = ""): string {
|
||||||
|
return `${prefix}${this.nextId++}`;
|
||||||
|
}
|
||||||
|
|
||||||
|
generateBlockName(): string {
|
||||||
|
return `block${this.blocks.length + 1}`;
|
||||||
|
}
|
||||||
|
|
||||||
|
insertAnchor(block: BlockDescription) {
|
||||||
|
const tag = `block-child-${block.children.length}`;
|
||||||
|
const anchor = xmlDoc.createElement(tag);
|
||||||
|
block.insert(anchor);
|
||||||
|
}
|
||||||
|
|
||||||
|
createBlock(
|
||||||
|
parentBlock: BlockDescription | null,
|
||||||
|
type: BlockType,
|
||||||
|
ctx: Context
|
||||||
|
): BlockDescription {
|
||||||
|
const hasRoot = this.target.hasRoot;
|
||||||
|
const block = new BlockDescription(this.target, type);
|
||||||
|
if (!hasRoot && !ctx.preventRoot) {
|
||||||
|
this.target.hasRoot = true;
|
||||||
|
block.isRoot = true;
|
||||||
|
}
|
||||||
|
if (parentBlock) {
|
||||||
|
parentBlock.children.push(block);
|
||||||
|
if (parentBlock.type === "list") {
|
||||||
|
block.parentVar = `c${parentBlock.id}`;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return block;
|
||||||
|
}
|
||||||
|
|
||||||
|
insertBlock(expression: string, block: BlockDescription, ctx: Context): string | null {
|
||||||
|
let id: string | null = null;
|
||||||
|
const blockExpr = block.generateExpr(expression);
|
||||||
|
if (block.parentVar) {
|
||||||
|
this.addLine(
|
||||||
|
`${block.parentVar}[${ctx.index}] = withKey(${blockExpr}, key${this.target.loopLevel});`
|
||||||
|
);
|
||||||
|
} else if (block.isRoot && !ctx.preventRoot) {
|
||||||
|
this.addLine(`return ${blockExpr};`);
|
||||||
|
} else {
|
||||||
|
this.addLine(`let ${block.varName} = ${blockExpr};`);
|
||||||
|
}
|
||||||
|
return id;
|
||||||
|
}
|
||||||
|
|
||||||
|
generateCode(): string {
|
||||||
|
let mainCode = this.target.code;
|
||||||
|
this.target.code = [];
|
||||||
|
this.target.indentLevel = 0;
|
||||||
|
// define blocks and utility functions
|
||||||
|
this.addLine(`let { text, createBlock, list, multi, html, toggler, component } = bdom;`);
|
||||||
|
this.addLine(
|
||||||
|
`let { withDefault, getTemplate, prepareList, withKey, zero, call, callSlot, capture, shallowEqual } = helpers;`
|
||||||
|
);
|
||||||
|
if (this.shouldDefineAssign) {
|
||||||
|
this.addLine(`let assign = Object.assign;`);
|
||||||
|
}
|
||||||
|
|
||||||
|
for (let { id, template } of this.staticCalls) {
|
||||||
|
this.addLine(`const ${id} = getTemplate(${template});`);
|
||||||
|
}
|
||||||
|
|
||||||
|
// define all blocks
|
||||||
|
if (this.blocks.length) {
|
||||||
|
this.addLine(``);
|
||||||
|
for (let block of this.blocks) {
|
||||||
|
if (block.dom) {
|
||||||
|
this.addLine(`let ${block.blockName} = createBlock(\`${block.asXmlString()}\`);`);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// define all slots
|
||||||
|
for (let fn of this.functions) {
|
||||||
|
this.generateFunctions(fn);
|
||||||
|
}
|
||||||
|
|
||||||
|
// // generate main code
|
||||||
|
this.target.indentLevel = 0;
|
||||||
|
this.addLine(``);
|
||||||
|
this.addLine(`return function template(ctx, node, key = "") {`);
|
||||||
|
if (this.hasRef) {
|
||||||
|
this.addLine(` const refs = ctx.__owl__.refs;`);
|
||||||
|
}
|
||||||
|
if (this.shouldProtectScope) {
|
||||||
|
this.addLine(` ctx = Object.create(ctx);`);
|
||||||
|
}
|
||||||
|
if (this.target.hasCache) {
|
||||||
|
this.addLine(` let cache = ctx.cache || {};`);
|
||||||
|
this.addLine(` let nextCache = ctx.cache = {};`);
|
||||||
|
}
|
||||||
|
// if (this.shouldDefineKey0) {
|
||||||
|
// this.addLine(` let key0;`);
|
||||||
|
// }
|
||||||
|
for (let line of mainCode) {
|
||||||
|
this.addLine(line);
|
||||||
|
}
|
||||||
|
// console.warn(this.target.code.join('\n'))
|
||||||
|
if (!this.target.hasRoot) {
|
||||||
|
throw new Error("missing root block");
|
||||||
|
}
|
||||||
|
this.addLine("}");
|
||||||
|
const code = this.target.code.join("\n");
|
||||||
|
|
||||||
|
if (this.isDebug) {
|
||||||
|
const msg = `[Owl Debug]\n${code}`;
|
||||||
|
console.log(msg);
|
||||||
|
}
|
||||||
|
return code;
|
||||||
|
}
|
||||||
|
|
||||||
|
generateFunctions(fn: CodeTarget) {
|
||||||
|
this.addLine("");
|
||||||
|
this.addLine(`const ${fn.name} = ${fn.signature}`);
|
||||||
|
if (fn.hasCache) {
|
||||||
|
this.addLine(`let cache = ctx.cache || {};`);
|
||||||
|
this.addLine(`let nextCache = ctx.cache = {};`);
|
||||||
|
}
|
||||||
|
for (let line of fn.code) {
|
||||||
|
this.addLine(line);
|
||||||
|
}
|
||||||
|
this.addLine(`}`);
|
||||||
|
}
|
||||||
|
|
||||||
|
captureExpression(expr: string): string {
|
||||||
|
const tokens = compileExprToArray(expr);
|
||||||
|
const mapping = new Map<string, string>();
|
||||||
|
return tokens
|
||||||
|
.map((tok) => {
|
||||||
|
if (tok.varName) {
|
||||||
|
if (!mapping.has(tok.varName)) {
|
||||||
|
const varId = this.generateId("v");
|
||||||
|
mapping.set(tok.varName, varId);
|
||||||
|
this.addLine(`const ${varId} = ${tok.value};`);
|
||||||
|
}
|
||||||
|
tok.value = mapping.get(tok.varName)!;
|
||||||
|
}
|
||||||
|
return tok.value;
|
||||||
|
})
|
||||||
|
.join("");
|
||||||
|
}
|
||||||
|
|
||||||
|
compileAST(ast: AST, ctx: Context) {
|
||||||
|
switch (ast.type) {
|
||||||
|
case ASTType.Comment:
|
||||||
|
this.compileComment(ast, ctx);
|
||||||
|
break;
|
||||||
|
case ASTType.Text:
|
||||||
|
this.compileText(ast, ctx);
|
||||||
|
break;
|
||||||
|
case ASTType.DomNode:
|
||||||
|
this.compileTDomNode(ast, ctx);
|
||||||
|
break;
|
||||||
|
case ASTType.TEsc:
|
||||||
|
this.compileTEsc(ast, ctx);
|
||||||
|
break;
|
||||||
|
case ASTType.TRaw:
|
||||||
|
this.compileTRaw(ast, ctx);
|
||||||
|
break;
|
||||||
|
case ASTType.TIf:
|
||||||
|
this.compileTIf(ast, ctx);
|
||||||
|
break;
|
||||||
|
case ASTType.TForEach:
|
||||||
|
this.compileTForeach(ast, ctx);
|
||||||
|
break;
|
||||||
|
case ASTType.TKey:
|
||||||
|
this.compileTKey(ast, ctx);
|
||||||
|
break;
|
||||||
|
case ASTType.Multi:
|
||||||
|
this.compileMulti(ast, ctx);
|
||||||
|
break;
|
||||||
|
case ASTType.TCall:
|
||||||
|
this.compileTCall(ast, ctx);
|
||||||
|
break;
|
||||||
|
case ASTType.TCallBlock:
|
||||||
|
this.compileTCallBlock(ast, ctx);
|
||||||
|
break;
|
||||||
|
case ASTType.TSet:
|
||||||
|
this.compileTSet(ast, ctx);
|
||||||
|
break;
|
||||||
|
case ASTType.TComponent:
|
||||||
|
this.compileComponent(ast, ctx);
|
||||||
|
break;
|
||||||
|
case ASTType.TDebug:
|
||||||
|
this.compileDebug(ast, ctx);
|
||||||
|
break;
|
||||||
|
case ASTType.TLog:
|
||||||
|
this.compileLog(ast, ctx);
|
||||||
|
break;
|
||||||
|
case ASTType.TSlot:
|
||||||
|
this.compileTSlot(ast, ctx);
|
||||||
|
break;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
compileDebug(ast: ASTDebug, ctx: Context) {
|
||||||
|
this.addLine(`debugger;`);
|
||||||
|
if (ast.content) {
|
||||||
|
this.compileAST(ast.content, ctx);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
compileLog(ast: ASTLog, ctx: Context) {
|
||||||
|
this.addLine(`console.log(${compileExpr(ast.expr)});`);
|
||||||
|
if (ast.content) {
|
||||||
|
this.compileAST(ast.content, ctx);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
compileComment(ast: ASTComment, ctx: Context) {
|
||||||
|
let { block, forceNewBlock } = ctx;
|
||||||
|
const isNewBlock = !block || forceNewBlock;
|
||||||
|
if (isNewBlock) {
|
||||||
|
block = this.createBlock(block, "block", ctx);
|
||||||
|
this.blocks.push(block);
|
||||||
|
}
|
||||||
|
const text = xmlDoc.createComment(ast.value);
|
||||||
|
block!.insert(text);
|
||||||
|
if (isNewBlock) {
|
||||||
|
this.insertBlock("", block!, ctx);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
compileText(ast: ASTText, ctx: Context) {
|
||||||
|
let { block, forceNewBlock } = ctx;
|
||||||
|
if (!block || forceNewBlock) {
|
||||||
|
block = this.createBlock(block, "text", ctx);
|
||||||
|
this.insertBlock(`text(\`${ast.value}\`)`, block, {
|
||||||
|
...ctx,
|
||||||
|
forceNewBlock: forceNewBlock && !block,
|
||||||
|
});
|
||||||
|
} else {
|
||||||
|
const createFn = ast.type === ASTType.Text ? xmlDoc.createTextNode : xmlDoc.createComment;
|
||||||
|
block.insert(createFn.call(xmlDoc, ast.value));
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
generateHandlerCode(handler: string, event: string = ""): string {
|
||||||
|
let args: string = "";
|
||||||
|
const name: string = handler.replace(/\(.*\)/, function (_args) {
|
||||||
|
args = _args.slice(1, -1);
|
||||||
|
return "";
|
||||||
|
});
|
||||||
|
const isMethodCall = name.match(FNAMEREGEXP);
|
||||||
|
if (isMethodCall) {
|
||||||
|
let handlerFn: string;
|
||||||
|
if (args) {
|
||||||
|
const argId = this.generateId("arg");
|
||||||
|
this.addLine(`const ${argId} = [${compileExpr(args)}];`);
|
||||||
|
handlerFn = `'${name}', ${argId}`;
|
||||||
|
} else {
|
||||||
|
handlerFn = `'${name}'`;
|
||||||
|
}
|
||||||
|
return `[${event ? `\`${event}\`` + ", " : ""}ctx, ${handlerFn!}]`;
|
||||||
|
} else {
|
||||||
|
let code = this.captureExpression(handler);
|
||||||
|
code = `{const res = (() => { return ${code} })(); if (typeof res === 'function') { res(e) }}`;
|
||||||
|
let handlerFn = `(e) => ${code}`;
|
||||||
|
if (event) {
|
||||||
|
handlerFn = `[\`${event}\`, ${handlerFn}]`;
|
||||||
|
}
|
||||||
|
return handlerFn;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
compileTDomNode(ast: ASTDomNode, ctx: Context) {
|
||||||
|
let { block, forceNewBlock } = ctx;
|
||||||
|
const isNewBlock = !block || forceNewBlock;
|
||||||
|
let codeIdx = this.target.code.length;
|
||||||
|
if (isNewBlock) {
|
||||||
|
block = this.createBlock(block, "block", ctx);
|
||||||
|
this.blocks.push(block);
|
||||||
|
}
|
||||||
|
|
||||||
|
// attributes
|
||||||
|
const attrs: { [key: string]: string } = {};
|
||||||
|
for (let key in ast.attrs) {
|
||||||
|
if (key.startsWith("t-attf")) {
|
||||||
|
let expr = interpolate(ast.attrs[key]);
|
||||||
|
const idx = block!.insertData(expr);
|
||||||
|
attrs["block-attribute-" + idx] = key.slice(7);
|
||||||
|
// console.warn('ccc', staticAttrs)
|
||||||
|
} else if (key.startsWith("t-att")) {
|
||||||
|
let expr = compileExpr(ast.attrs[key]);
|
||||||
|
const idx = block!.insertData(expr);
|
||||||
|
if (key === "t-att") {
|
||||||
|
attrs[`block-attributes`] = String(idx);
|
||||||
|
} else {
|
||||||
|
attrs[`block-attribute-${idx}`] = key.slice(6);
|
||||||
|
}
|
||||||
|
} else {
|
||||||
|
attrs[key] = ast.attrs[key];
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// event handlers
|
||||||
|
for (let ev in ast.on) {
|
||||||
|
const name = this.generateHandlerCode(ast.on[ev]);
|
||||||
|
const idx = block!.insertData(name);
|
||||||
|
attrs[`block-handler-${idx}`] = ev;
|
||||||
|
}
|
||||||
|
|
||||||
|
// t-ref
|
||||||
|
if (ast.ref) {
|
||||||
|
this.hasRef = true;
|
||||||
|
const isDynamic = INTERP_REGEXP.test(ast.ref);
|
||||||
|
if (isDynamic) {
|
||||||
|
const str = ast.ref.replace(
|
||||||
|
INTERP_REGEXP,
|
||||||
|
(expr) => "${" + this.captureExpression(expr.slice(2, -2)) + "}"
|
||||||
|
);
|
||||||
|
const idx = block!.insertData(`(el) => refs[\`${str}\`] = el`);
|
||||||
|
attrs["block-ref"] = String(idx);
|
||||||
|
} else {
|
||||||
|
const idx = block!.insertData(`(el) => refs[\`${ast.ref}\`] = el`);
|
||||||
|
attrs["block-ref"] = String(idx);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
const dom = xmlDoc.createElement(ast.tag);
|
||||||
|
for (const [attr, val] of Object.entries(attrs)) {
|
||||||
|
if (!(attr === "class" && val === "")) {
|
||||||
|
dom.setAttribute(attr, val);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
block!.insert(dom);
|
||||||
|
if (ast.content.length) {
|
||||||
|
const initialDom = block!.currentDom;
|
||||||
|
block!.currentDom = dom;
|
||||||
|
const children = ast.content;
|
||||||
|
for (let i = 0; i < children.length; i++) {
|
||||||
|
const child = ast.content[i];
|
||||||
|
const subCtx: Context = {
|
||||||
|
block: block,
|
||||||
|
index: block!.childNumber,
|
||||||
|
forceNewBlock: false,
|
||||||
|
isLast: ctx.isLast && i === children.length - 1,
|
||||||
|
};
|
||||||
|
this.compileAST(child, subCtx);
|
||||||
|
}
|
||||||
|
block!.currentDom = initialDom;
|
||||||
|
}
|
||||||
|
|
||||||
|
if (isNewBlock) {
|
||||||
|
this.insertBlock(`${block!.blockName}(ddd)`, block!, ctx)!;
|
||||||
|
// may need to rewrite code!
|
||||||
|
if (block!.children.length && block!.hasDynamicChildren) {
|
||||||
|
const code = this.target.code;
|
||||||
|
const children = block!.children.slice();
|
||||||
|
let current = children.shift();
|
||||||
|
for (let i = codeIdx; i < code.length; i++) {
|
||||||
|
if (code[i].trimStart().startsWith(`let ${current!.varName}`)) {
|
||||||
|
code[i] = code[i].replace(`let ${current!.varName}`, current!.varName);
|
||||||
|
current = children.shift();
|
||||||
|
if (!current) break;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
this.target.addLine(`let ${block!.children.map((c) => c.varName)};`, codeIdx);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
compileTEsc(ast: ASTTEsc, ctx: Context) {
|
||||||
|
let { block, forceNewBlock } = ctx;
|
||||||
|
let expr: string;
|
||||||
|
if (ast.expr === "0") {
|
||||||
|
expr = `ctx[zero]`;
|
||||||
|
} else {
|
||||||
|
expr = compileExpr(ast.expr);
|
||||||
|
if (ast.defaultValue) {
|
||||||
|
expr = `withDefault(${expr}, \`${ast.defaultValue}\`)`;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if (!block || forceNewBlock) {
|
||||||
|
block = this.createBlock(block, "text", ctx);
|
||||||
|
this.insertBlock(`text(${expr})`, block, { ...ctx, forceNewBlock: forceNewBlock && !block });
|
||||||
|
} else {
|
||||||
|
const idx = block.insertData(expr);
|
||||||
|
const text = xmlDoc.createElement(`block-text-${idx}`);
|
||||||
|
block.insert(text);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
compileTRaw(ast: ASTTRaw, ctx: Context) {
|
||||||
|
let { block } = ctx;
|
||||||
|
if (block) {
|
||||||
|
this.insertAnchor(block);
|
||||||
|
}
|
||||||
|
block = this.createBlock(block, "html", ctx);
|
||||||
|
let expr = ast.expr === "0" ? "ctx[zero]" : compileExpr(ast.expr);
|
||||||
|
if (ast.body) {
|
||||||
|
const nextId = BlockDescription.nextBlockId;
|
||||||
|
const subCtx: Context = { block: null, index: 0, forceNewBlock: true };
|
||||||
|
this.compileAST({ type: ASTType.Multi, content: ast.body }, subCtx);
|
||||||
|
expr = `withDefault(${expr}, b${nextId})`;
|
||||||
|
}
|
||||||
|
this.insertBlock(`html(${expr})`, block, ctx);
|
||||||
|
}
|
||||||
|
|
||||||
|
compileTIf(ast: ASTTif, ctx: Context, nextNode?: ASTDomNode) {
|
||||||
|
let { block, forceNewBlock, index } = ctx;
|
||||||
|
let currentIndex = index;
|
||||||
|
const codeIdx = this.target.code.length;
|
||||||
|
const isNewBlock = !block || (block.type !== "multi" && forceNewBlock);
|
||||||
|
if (block) {
|
||||||
|
block.hasDynamicChildren = true;
|
||||||
|
}
|
||||||
|
if (!block || (block.type !== "multi" && forceNewBlock)) {
|
||||||
|
block = this.createBlock(block, "multi", ctx);
|
||||||
|
}
|
||||||
|
this.addLine(`if (${compileExpr(ast.condition)}) {`);
|
||||||
|
this.target.indentLevel++;
|
||||||
|
this.insertAnchor(block!);
|
||||||
|
const subCtx: Context = { block: block, index: currentIndex, forceNewBlock: true };
|
||||||
|
this.compileAST(ast.content, subCtx);
|
||||||
|
this.target.indentLevel--;
|
||||||
|
if (ast.tElif) {
|
||||||
|
for (let clause of ast.tElif) {
|
||||||
|
this.addLine(`} else if (${compileExpr(clause.condition)}) {`);
|
||||||
|
this.target.indentLevel++;
|
||||||
|
this.insertAnchor(block);
|
||||||
|
const subCtx: Context = {
|
||||||
|
block: block,
|
||||||
|
index: currentIndex,
|
||||||
|
forceNewBlock: true,
|
||||||
|
};
|
||||||
|
this.compileAST(clause.content, subCtx);
|
||||||
|
this.target.indentLevel--;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if (ast.tElse) {
|
||||||
|
this.addLine(`} else {`);
|
||||||
|
this.target.indentLevel++;
|
||||||
|
this.insertAnchor(block);
|
||||||
|
const subCtx: Context = {
|
||||||
|
block: block,
|
||||||
|
index: currentIndex,
|
||||||
|
forceNewBlock: true,
|
||||||
|
};
|
||||||
|
this.compileAST(ast.tElse, subCtx);
|
||||||
|
this.target.indentLevel--;
|
||||||
|
}
|
||||||
|
this.addLine("}");
|
||||||
|
if (isNewBlock) {
|
||||||
|
// note: this part is duplicated from end of compiledomnode:
|
||||||
|
if (block!.children.length) {
|
||||||
|
const code = this.target.code;
|
||||||
|
const children = block!.children.slice();
|
||||||
|
let current = children.shift();
|
||||||
|
for (let i = codeIdx; i < code.length; i++) {
|
||||||
|
if (code[i].trimStart().startsWith(`let ${current!.varName}`)) {
|
||||||
|
code[i] = code[i].replace(`let ${current!.varName}`, current!.varName);
|
||||||
|
current = children.shift();
|
||||||
|
if (!current) break;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
this.target.addLine(`let ${block!.children.map((c) => c.varName)};`, codeIdx);
|
||||||
|
}
|
||||||
|
|
||||||
|
// note: this part is duplicated from end of compilemulti:
|
||||||
|
const args = block!.children.map((c) => c.varName).join(", ");
|
||||||
|
this.insertBlock(`multi([${args}])`, block!, ctx)!;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
compileTForeach(ast: ASTTForEach, ctx: Context) {
|
||||||
|
let { block } = ctx;
|
||||||
|
if (block) {
|
||||||
|
this.insertAnchor(block);
|
||||||
|
}
|
||||||
|
block = this.createBlock(block, "list", ctx);
|
||||||
|
this.target.loopLevel++;
|
||||||
|
const loopVar = `i${this.target.loopLevel}`;
|
||||||
|
this.addLine(`ctx = Object.create(ctx);`);
|
||||||
|
// const cId = this.generateId();
|
||||||
|
const vals = `v${block.id}`;
|
||||||
|
const keys = `k${block.id}`;
|
||||||
|
const l = `l${block.id}`;
|
||||||
|
const c = `c${block.id}`;
|
||||||
|
this.addLine(
|
||||||
|
`const [${keys}, ${vals}, ${l}, ${c}] = prepareList(${compileExpr(ast.collection)});`
|
||||||
|
);
|
||||||
|
this.addLine(`for (let ${loopVar} = 0; ${loopVar} < ${l}; ${loopVar}++) {`);
|
||||||
|
this.target.indentLevel++;
|
||||||
|
this.addLine(`ctx[\`${ast.elem}\`] = ${vals}[${loopVar}];`);
|
||||||
|
if (!ast.hasNoFirst) {
|
||||||
|
this.addLine(`ctx[\`${ast.elem}_first\`] = ${loopVar} === 0;`);
|
||||||
|
}
|
||||||
|
if (!ast.hasNoLast) {
|
||||||
|
this.addLine(`ctx[\`${ast.elem}_last\`] = ${loopVar} === ${vals}.length - 1;`);
|
||||||
|
}
|
||||||
|
if (!ast.hasNoIndex) {
|
||||||
|
this.addLine(`ctx[\`${ast.elem}_index\`] = ${loopVar};`);
|
||||||
|
}
|
||||||
|
if (!ast.hasNoValue) {
|
||||||
|
this.addLine(`ctx[\`${ast.elem}_value\`] = ${keys}[${loopVar}];`);
|
||||||
|
}
|
||||||
|
this.addLine(`let key${this.target.loopLevel} = ${ast.key ? compileExpr(ast.key) : loopVar};`);
|
||||||
|
let id: string;
|
||||||
|
if (ast.memo) {
|
||||||
|
this.target.hasCache = true;
|
||||||
|
this.shouldDefineAssign = true;
|
||||||
|
id = this.generateId();
|
||||||
|
this.addLine(`let memo${id} = ${compileExpr(ast.memo)}`);
|
||||||
|
this.addLine(`let vnode${id} = cache[key${this.target.loopLevel}];`);
|
||||||
|
this.addLine(`if (vnode${id}) {`);
|
||||||
|
this.target.indentLevel++;
|
||||||
|
this.addLine(`if (shallowEqual(vnode${id}.memo, memo${id})) {`);
|
||||||
|
this.target.indentLevel++;
|
||||||
|
this.addLine(`${c}[${loopVar}] = vnode${id};`);
|
||||||
|
this.addLine(`nextCache[key${this.target.loopLevel}] = vnode${id};`);
|
||||||
|
this.addLine(`continue;`);
|
||||||
|
this.target.indentLevel--;
|
||||||
|
this.addLine("}");
|
||||||
|
this.target.indentLevel--;
|
||||||
|
this.addLine("}");
|
||||||
|
}
|
||||||
|
|
||||||
|
const subCtx: Context = {
|
||||||
|
block: block, //collectionBlock,
|
||||||
|
index: loopVar,
|
||||||
|
forceNewBlock: true,
|
||||||
|
};
|
||||||
|
this.compileAST(ast.body, subCtx);
|
||||||
|
if (!ast.key) {
|
||||||
|
console.warn(
|
||||||
|
`"Directive t-foreach should always be used with a t-key! (in template: '${this.templateName}')"`
|
||||||
|
);
|
||||||
|
}
|
||||||
|
if (ast.memo) {
|
||||||
|
this.addLine(
|
||||||
|
`nextCache[key${this.target.loopLevel}] = assign(${c}[${loopVar}], {memo: memo${id!}});`
|
||||||
|
);
|
||||||
|
}
|
||||||
|
this.target.indentLevel--;
|
||||||
|
this.target.loopLevel--;
|
||||||
|
this.addLine(`}`);
|
||||||
|
if (!ctx.isLast) {
|
||||||
|
this.addLine(`ctx = ctx.__proto__;`);
|
||||||
|
}
|
||||||
|
this.insertBlock("l", block, ctx);
|
||||||
|
}
|
||||||
|
|
||||||
|
compileTKey(ast: ASTTKey, ctx: Context) {
|
||||||
|
this.compileAST(ast.content, ctx);
|
||||||
|
}
|
||||||
|
|
||||||
|
compileMulti(ast: ASTMulti, ctx: Context) {
|
||||||
|
let { block, forceNewBlock } = ctx;
|
||||||
|
const isNewBlock = !block || forceNewBlock;
|
||||||
|
let codeIdx = this.target.code.length;
|
||||||
|
if (isNewBlock) {
|
||||||
|
const n = ast.content.filter((c) => c.type !== ASTType.TSet).length;
|
||||||
|
if (n <= 1) {
|
||||||
|
for (let child of ast.content) {
|
||||||
|
this.compileAST(child, ctx);
|
||||||
|
}
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
block = this.createBlock(block, "multi", ctx);
|
||||||
|
}
|
||||||
|
let index = 0;
|
||||||
|
for (let i = 0, l = ast.content.length; i < l; i++) {
|
||||||
|
const child = ast.content[i];
|
||||||
|
const isTSet = child.type === ASTType.TSet;
|
||||||
|
const subCtx: Context = {
|
||||||
|
block: block,
|
||||||
|
index: index,
|
||||||
|
forceNewBlock: !isTSet,
|
||||||
|
preventRoot: ctx.preventRoot,
|
||||||
|
isLast: ctx.isLast && i === l - 1,
|
||||||
|
};
|
||||||
|
this.compileAST(child, subCtx);
|
||||||
|
if (!isTSet) {
|
||||||
|
index++;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if (isNewBlock) {
|
||||||
|
if (block!.hasDynamicChildren) {
|
||||||
|
if (block!.children.length) {
|
||||||
|
const code = this.target.code;
|
||||||
|
const children = block!.children.slice();
|
||||||
|
let current = children.shift();
|
||||||
|
for (let i = codeIdx; i < code.length; i++) {
|
||||||
|
if (code[i].trimStart().startsWith(`let ${current!.varName}`)) {
|
||||||
|
code[i] = code[i].replace(`let ${current!.varName}`, current!.varName);
|
||||||
|
current = children.shift();
|
||||||
|
if (!current) break;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
this.target.addLine(`let ${block!.children.map((c) => c.varName)};`, codeIdx);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
const args = block!.children.map((c) => c.varName).join(", ");
|
||||||
|
this.insertBlock(`multi([${args}])`, block!, ctx)!;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
compileTCall(ast: ASTTCall, ctx: Context) {
|
||||||
|
let { block, forceNewBlock } = ctx;
|
||||||
|
// this.hasTCall = true;
|
||||||
|
if (ast.body) {
|
||||||
|
this.addLine(`ctx = Object.create(ctx);`);
|
||||||
|
const nextId = BlockDescription.nextBlockId;
|
||||||
|
const subCtx: Context = { block: null, index: 0, forceNewBlock: true, preventRoot: true };
|
||||||
|
this.compileAST({ type: ASTType.Multi, content: ast.body }, subCtx);
|
||||||
|
if (nextId !== BlockDescription.nextBlockId) {
|
||||||
|
this.addLine(`ctx[zero] = b${nextId};`);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
const isDynamic = INTERP_REGEXP.test(ast.name);
|
||||||
|
const subTemplate = isDynamic ? interpolate(ast.name) : "`" + ast.name + "`";
|
||||||
|
if (block) {
|
||||||
|
if (!forceNewBlock) {
|
||||||
|
this.insertAnchor(block);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
const key = `key + \`${this.generateComponentKey()}\``;
|
||||||
|
if (isDynamic) {
|
||||||
|
const templateVar = this.generateId("template");
|
||||||
|
this.addLine(`const ${templateVar} = ${subTemplate};`);
|
||||||
|
block = this.createBlock(block, "multi", ctx);
|
||||||
|
this.insertBlock(`call(${templateVar}, ctx, node, ${key})`, block!, {
|
||||||
|
...ctx,
|
||||||
|
forceNewBlock: !block,
|
||||||
|
});
|
||||||
|
} else {
|
||||||
|
const id = this.generateId(`callTemplate_`);
|
||||||
|
this.staticCalls.push({ id, template: subTemplate });
|
||||||
|
// console.warn('coucoup', this.target.hasRoot)
|
||||||
|
block = this.createBlock(block, "multi", ctx);
|
||||||
|
this.insertBlock(`${id}(ctx, node, ${key})`, block!, { ...ctx, forceNewBlock: !block });
|
||||||
|
}
|
||||||
|
if (ast.body && !ctx.isLast) {
|
||||||
|
this.addLine(`ctx = ctx.__proto__;`);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
compileTCallBlock(ast: ASTTCallBlock, ctx: Context) {
|
||||||
|
let { block, forceNewBlock } = ctx;
|
||||||
|
if (block) {
|
||||||
|
if (!forceNewBlock) {
|
||||||
|
this.insertAnchor(block);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
block = this.createBlock(block, "multi", ctx);
|
||||||
|
this.insertBlock(compileExpr(ast.name), block, { ...ctx, forceNewBlock: !block });
|
||||||
|
}
|
||||||
|
|
||||||
|
compileTSet(ast: ASTTSet, ctx: Context) {
|
||||||
|
this.shouldProtectScope = true;
|
||||||
|
const expr = ast.value ? compileExpr(ast.value || "") : "null";
|
||||||
|
if (ast.body) {
|
||||||
|
const subCtx: Context = { block: null, index: 0, forceNewBlock: true };
|
||||||
|
const nextId = `b${BlockDescription.nextBlockId}`;
|
||||||
|
this.compileAST({ type: ASTType.Multi, content: ast.body }, subCtx);
|
||||||
|
const value = ast.value ? (nextId ? `withDefault(${expr}, ${nextId})` : expr) : nextId;
|
||||||
|
this.addLine(`ctx[\`${ast.name}\`] = ${value};`);
|
||||||
|
} else {
|
||||||
|
let value: string;
|
||||||
|
if (ast.defaultValue) {
|
||||||
|
if (ast.value) {
|
||||||
|
value = `withDefault(${expr}, \`${ast.defaultValue}\`)`;
|
||||||
|
} else {
|
||||||
|
value = `\`${ast.defaultValue}\``;
|
||||||
|
}
|
||||||
|
} else {
|
||||||
|
value = expr;
|
||||||
|
}
|
||||||
|
this.addLine(`ctx[\`${ast.name}\`] = ${value};`);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
generateComponentKey() {
|
||||||
|
const parts = [this.generateId("__")];
|
||||||
|
for (let i = 0; i < this.target.loopLevel; i++) {
|
||||||
|
parts.push(`\${key${i + 1}}`);
|
||||||
|
}
|
||||||
|
return parts.join("__");
|
||||||
|
}
|
||||||
|
|
||||||
|
compileComponent(ast: ASTComponent, ctx: Context) {
|
||||||
|
let { block } = ctx;
|
||||||
|
let extraArgs: { [key: string]: string } = {};
|
||||||
|
|
||||||
|
// props
|
||||||
|
const props: string[] = [];
|
||||||
|
for (let p in ast.props) {
|
||||||
|
props.push(`${p}: ${compileExpr(ast.props[p]) || undefined}`);
|
||||||
|
}
|
||||||
|
const propString = `{${props.join(",")}}`;
|
||||||
|
|
||||||
|
// cmap key
|
||||||
|
const key = this.generateComponentKey();
|
||||||
|
let expr: string;
|
||||||
|
if (ast.isDynamic) {
|
||||||
|
expr = this.generateId("Comp");
|
||||||
|
this.addLine(`let ${expr} = ${compileExpr(ast.name)};`);
|
||||||
|
} else {
|
||||||
|
expr = `\`${ast.name}\``;
|
||||||
|
}
|
||||||
|
let blockArgs = `${expr}, ${propString}, key + \`${key}\`, node, ctx`;
|
||||||
|
|
||||||
|
// slots
|
||||||
|
const hasSlot = !!Object.keys(ast.slots).length;
|
||||||
|
let slotDef: string;
|
||||||
|
if (hasSlot) {
|
||||||
|
if (this.hasSafeContext === null) {
|
||||||
|
this.hasSafeContext = !this.template.includes("t-set") && !this.template.includes("t-call");
|
||||||
|
}
|
||||||
|
let ctxStr = "ctx";
|
||||||
|
if (this.target.loopLevel || !this.hasSafeContext) {
|
||||||
|
ctxStr = this.generateId("ctx");
|
||||||
|
this.addLine(`const ${ctxStr} = capture(ctx);`);
|
||||||
|
}
|
||||||
|
let slotStr: string[] = [];
|
||||||
|
const initialTarget = this.target;
|
||||||
|
for (let slotName in ast.slots) {
|
||||||
|
let name = this.generateId("slot");
|
||||||
|
const slot = new CodeTarget(name);
|
||||||
|
slot.signature = "ctx => (node, key) => {";
|
||||||
|
this.functions.push(slot);
|
||||||
|
this.target = slot;
|
||||||
|
const subCtx: Context = { block: null, index: 0, forceNewBlock: true };
|
||||||
|
this.compileAST(ast.slots[slotName], subCtx);
|
||||||
|
if (this.hasRef) {
|
||||||
|
slot.signature = "ctx => node => {";
|
||||||
|
slot.code.unshift(` const refs = ctx.__owl__.refs`);
|
||||||
|
slotStr.push(`'${slotName}': ${name}(${ctxStr})`);
|
||||||
|
} else {
|
||||||
|
slotStr.push(`'${slotName}': ${name}(${ctxStr})`);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
this.target = initialTarget;
|
||||||
|
slotDef = `{${slotStr.join(", ")}}`;
|
||||||
|
extraArgs.slots = slotDef;
|
||||||
|
}
|
||||||
|
|
||||||
|
// handlers
|
||||||
|
const hasHandlers = Object.keys(ast.handlers).length;
|
||||||
|
if (hasHandlers) {
|
||||||
|
const vars = Object.keys(ast.handlers).map((ev) => {
|
||||||
|
let id = this.generateId("h");
|
||||||
|
this.addLine(`let ${id} = ${this.generateHandlerCode(ast.handlers[ev], ev)};`);
|
||||||
|
return id;
|
||||||
|
});
|
||||||
|
extraArgs.handlers = `[${vars}]`;
|
||||||
|
}
|
||||||
|
|
||||||
|
if (block && ctx.forceNewBlock === false) {
|
||||||
|
// todo: check the forcenewblock condition
|
||||||
|
this.insertAnchor(block);
|
||||||
|
}
|
||||||
|
let blockExpr = `component(${blockArgs})`;
|
||||||
|
if (Object.keys(extraArgs).length) {
|
||||||
|
this.shouldDefineAssign = true;
|
||||||
|
const content = Object.keys(extraArgs).map((k) => `${k}: ${extraArgs[k]}`);
|
||||||
|
blockExpr = `assign(${blockExpr}, {${content.join(", ")}})`;
|
||||||
|
}
|
||||||
|
if (ast.isDynamic) {
|
||||||
|
blockExpr = `toggler(${expr}, ${blockExpr})`;
|
||||||
|
}
|
||||||
|
block = this.createBlock(block, "multi", ctx);
|
||||||
|
this.insertBlock(blockExpr, block, ctx);
|
||||||
|
}
|
||||||
|
|
||||||
|
compileTSlot(ast: ASTSlot, ctx: Context) {
|
||||||
|
let { block } = ctx;
|
||||||
|
let blockString: string;
|
||||||
|
let slotName;
|
||||||
|
let dynamic = false;
|
||||||
|
if (ast.name.match(INTERP_REGEXP)) {
|
||||||
|
dynamic = true;
|
||||||
|
slotName = interpolate(ast.name);
|
||||||
|
} else {
|
||||||
|
slotName = "'" + ast.name + "'";
|
||||||
|
}
|
||||||
|
if (ast.defaultContent) {
|
||||||
|
let name = this.generateId("defaultSlot");
|
||||||
|
const slot = new CodeTarget(name);
|
||||||
|
slot.signature = "ctx => {";
|
||||||
|
this.functions.push(slot);
|
||||||
|
const initialTarget = this.target;
|
||||||
|
const subCtx: Context = { block: null, index: 0, forceNewBlock: true };
|
||||||
|
this.target = slot;
|
||||||
|
this.compileAST(ast.defaultContent, subCtx);
|
||||||
|
this.target = initialTarget;
|
||||||
|
blockString = `callSlot(ctx, node, key, ${slotName}, ${name}, ${dynamic})`;
|
||||||
|
} else {
|
||||||
|
if (dynamic) {
|
||||||
|
let name = this.generateId("slot");
|
||||||
|
this.addLine(`const ${name} = ${slotName};`);
|
||||||
|
blockString = `toggler(${name}, callSlot(ctx, node, key, ${name}))`;
|
||||||
|
} else {
|
||||||
|
blockString = `callSlot(ctx, node, key, ${slotName})`;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if (block) {
|
||||||
|
this.insertAnchor(block);
|
||||||
|
}
|
||||||
|
block = this.createBlock(block, "multi", ctx);
|
||||||
|
this.insertBlock(blockString, block, { ...ctx, forceNewBlock: false });
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -70,7 +70,6 @@ interface Token {
|
|||||||
size?: number;
|
size?: number;
|
||||||
varName?: string;
|
varName?: string;
|
||||||
replace?: Function;
|
replace?: Function;
|
||||||
isLocal?: boolean;
|
|
||||||
}
|
}
|
||||||
|
|
||||||
const STATIC_TOKEN_MAP: { [key: string]: TKind } = Object.assign(Object.create(null), {
|
const STATIC_TOKEN_MAP: { [key: string]: TKind } = Object.assign(Object.create(null), {
|
||||||
@@ -85,9 +84,8 @@ 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
|
// note that the space after typeof is relevant. It makes sure that the formatted
|
||||||
// expression has a space after typeof. Currently we don't support delete and void
|
// expression has a space after typeof
|
||||||
const OPERATORS =
|
const OPERATORS = "...,.,===,==,+,!==,!=,!,||,&&,>=,>,<=,<,?,-,*,/,%,typeof ,=>,=,;,in ".split(",");
|
||||||
"...,.,===,==,+,!==,!=,!,||,&&,>=,>,<=,<,?,-,*,/,%,typeof ,=>,=,;,in ,new ,|,&,^,~".split(",");
|
|
||||||
|
|
||||||
type Tokenizer = (expr: string) => Token | false;
|
type Tokenizer = (expr: string) => Token | false;
|
||||||
|
|
||||||
@@ -200,30 +198,24 @@ const TOKENIZERS = [
|
|||||||
export function tokenize(expr: string): Token[] {
|
export function tokenize(expr: string): Token[] {
|
||||||
const result: Token[] = [];
|
const result: Token[] = [];
|
||||||
let token: boolean | Token = true;
|
let token: boolean | Token = true;
|
||||||
let error: any;
|
|
||||||
let current = expr;
|
|
||||||
|
|
||||||
try {
|
while (token) {
|
||||||
while (token) {
|
expr = expr.trim();
|
||||||
current = current.trim();
|
if (expr) {
|
||||||
if (current) {
|
for (let tokenizer of TOKENIZERS) {
|
||||||
for (let tokenizer of TOKENIZERS) {
|
token = tokenizer(expr);
|
||||||
token = tokenizer(current);
|
if (token) {
|
||||||
if (token) {
|
result.push(token);
|
||||||
result.push(token);
|
expr = expr.slice(token.size || token.value.length);
|
||||||
current = current.slice(token.size || token.value.length);
|
break;
|
||||||
break;
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
} else {
|
|
||||||
token = false;
|
|
||||||
}
|
}
|
||||||
|
} else {
|
||||||
|
token = false;
|
||||||
}
|
}
|
||||||
} catch (e) {
|
|
||||||
error = e; // Silence all errors and throw a generic error below
|
|
||||||
}
|
}
|
||||||
if (current.length || error) {
|
if (expr.length) {
|
||||||
throw new Error(`Tokenizer error: could not tokenize \`${expr}\``);
|
throw new Error(`Tokenizer error: could not tokenize "${expr}"`);
|
||||||
}
|
}
|
||||||
return result;
|
return result;
|
||||||
}
|
}
|
||||||
@@ -333,41 +325,24 @@ export function compileExprToArray(expr: string): Token[] {
|
|||||||
}
|
}
|
||||||
i++;
|
i++;
|
||||||
}
|
}
|
||||||
// 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" && token.varName && localVars.has(token.value)) {
|
|
||||||
token.originalValue = token.value;
|
|
||||||
token.value = `_${token.value}`;
|
|
||||||
token.isLocal = true;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
return tokens;
|
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 {
|
export function compileExpr(expr: string): string {
|
||||||
return compileExprToArray(expr)
|
return compileExprToArray(expr)
|
||||||
.map((t) => paddedValues.get(t.value) || t.value)
|
.map((t) => t.value)
|
||||||
.join("");
|
.join("");
|
||||||
}
|
}
|
||||||
|
|
||||||
export const INTERP_REGEXP = /\{\{.*?\}\}|\#\{.*?\}/g;
|
export const INTERP_REGEXP = /\{\{.*?\}\}/g;
|
||||||
|
const INTERP_GROUP_REGEXP = /\{\{.*?\}\}/g;
|
||||||
|
|
||||||
export function replaceDynamicParts(s: string, replacer: (s: string) => string) {
|
export function interpolate(s: string): string {
|
||||||
let matches = s.match(INTERP_REGEXP);
|
let matches = s.match(INTERP_REGEXP);
|
||||||
if (matches && matches[0].length === s.length) {
|
if (matches && matches[0].length === s.length) {
|
||||||
return `(${replacer(s.slice(2, matches[0][0] === "{" ? -2 : -1))})`;
|
return `(${compileExpr(s.slice(2, -2))})`;
|
||||||
}
|
}
|
||||||
|
|
||||||
let r = s.replace(
|
let r = s.replace(INTERP_GROUP_REGEXP, (s) => "${" + compileExpr(s.slice(2, -2)) + "}");
|
||||||
INTERP_REGEXP,
|
|
||||||
(s) => "${" + replacer(s.slice(2, s[0] === "{" ? -2 : -1)) + "}"
|
|
||||||
);
|
|
||||||
return "`" + r + "`";
|
return "`" + r + "`";
|
||||||
}
|
}
|
||||||
export function interpolate(s: string): string {
|
|
||||||
return replaceDynamicParts(s, compileExpr);
|
|
||||||
}
|
|
||||||
@@ -2,9 +2,6 @@
|
|||||||
// AST Type definition
|
// AST Type definition
|
||||||
// -----------------------------------------------------------------------------
|
// -----------------------------------------------------------------------------
|
||||||
|
|
||||||
export type EventHandlers = { [eventName: string]: string };
|
|
||||||
export type Attrs = { [attrs: string]: string };
|
|
||||||
|
|
||||||
export const enum ASTType {
|
export const enum ASTType {
|
||||||
Text,
|
Text,
|
||||||
Comment,
|
Comment,
|
||||||
@@ -14,7 +11,7 @@ export const enum ASTType {
|
|||||||
TIf,
|
TIf,
|
||||||
TSet,
|
TSet,
|
||||||
TCall,
|
TCall,
|
||||||
TOut,
|
TRaw,
|
||||||
TForEach,
|
TForEach,
|
||||||
TKey,
|
TKey,
|
||||||
TComponent,
|
TComponent,
|
||||||
@@ -22,8 +19,6 @@ export const enum ASTType {
|
|||||||
TLog,
|
TLog,
|
||||||
TSlot,
|
TSlot,
|
||||||
TCallBlock,
|
TCallBlock,
|
||||||
TTranslation,
|
|
||||||
TPortal,
|
|
||||||
}
|
}
|
||||||
|
|
||||||
export interface ASTText {
|
export interface ASTText {
|
||||||
@@ -36,27 +31,13 @@ export interface ASTComment {
|
|||||||
value: string;
|
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 {
|
export interface ASTDomNode {
|
||||||
type: ASTType.DomNode;
|
type: ASTType.DomNode;
|
||||||
tag: string;
|
tag: string;
|
||||||
|
attrs: { [key: string]: string };
|
||||||
content: AST[];
|
content: AST[];
|
||||||
attrs: Attrs | null;
|
|
||||||
ref: string | null;
|
ref: string | null;
|
||||||
on: EventHandlers | null;
|
on: { [key: string]: string };
|
||||||
model: TModelInfo | null;
|
|
||||||
dynamicTag: string | null;
|
|
||||||
ns: string | null;
|
|
||||||
}
|
}
|
||||||
|
|
||||||
export interface ASTMulti {
|
export interface ASTMulti {
|
||||||
@@ -70,8 +51,8 @@ export interface ASTTEsc {
|
|||||||
defaultValue: string;
|
defaultValue: string;
|
||||||
}
|
}
|
||||||
|
|
||||||
export interface ASTTOut {
|
export interface ASTTRaw {
|
||||||
type: ASTType.TOut;
|
type: ASTType.TRaw;
|
||||||
expr: string;
|
expr: string;
|
||||||
body: AST[] | null;
|
body: AST[] | null;
|
||||||
}
|
}
|
||||||
@@ -96,13 +77,15 @@ export interface ASTTForEach {
|
|||||||
type: ASTType.TForEach;
|
type: ASTType.TForEach;
|
||||||
collection: string;
|
collection: string;
|
||||||
elem: string;
|
elem: string;
|
||||||
|
key: string | null;
|
||||||
body: AST;
|
body: AST;
|
||||||
memo: string;
|
memo: string;
|
||||||
|
isOnlyChild: boolean;
|
||||||
|
hasNoComponent: boolean;
|
||||||
hasNoFirst: boolean;
|
hasNoFirst: boolean;
|
||||||
hasNoLast: boolean;
|
hasNoLast: boolean;
|
||||||
hasNoIndex: boolean;
|
hasNoIndex: boolean;
|
||||||
hasNoValue: boolean;
|
hasNoValue: boolean;
|
||||||
key: string | null;
|
|
||||||
}
|
}
|
||||||
|
|
||||||
export interface ASTTKey {
|
export interface ASTTKey {
|
||||||
@@ -115,31 +98,20 @@ export interface ASTTCall {
|
|||||||
type: ASTType.TCall;
|
type: ASTType.TCall;
|
||||||
name: string;
|
name: string;
|
||||||
body: AST[] | null;
|
body: AST[] | null;
|
||||||
context: string | null;
|
|
||||||
}
|
|
||||||
|
|
||||||
interface SlotDefinition {
|
|
||||||
content: AST | null;
|
|
||||||
scope: string | null;
|
|
||||||
on: EventHandlers | null;
|
|
||||||
attrs: Attrs | null;
|
|
||||||
}
|
}
|
||||||
|
|
||||||
export interface ASTComponent {
|
export interface ASTComponent {
|
||||||
type: ASTType.TComponent;
|
type: ASTType.TComponent;
|
||||||
name: string;
|
name: string;
|
||||||
isDynamic: boolean;
|
isDynamic: boolean;
|
||||||
dynamicProps: string | null;
|
props: { [name: string]: string };
|
||||||
on: EventHandlers | null;
|
handlers: { [event: string]: string };
|
||||||
props: { [name: string]: string } | null;
|
slots: { [name: string]: AST };
|
||||||
slots: { [name: string]: SlotDefinition } | null;
|
|
||||||
}
|
}
|
||||||
|
|
||||||
export interface ASTSlot {
|
export interface ASTSlot {
|
||||||
type: ASTType.TSlot;
|
type: ASTType.TSlot;
|
||||||
name: string;
|
name: string;
|
||||||
attrs: Attrs | null;
|
|
||||||
on: EventHandlers | null;
|
|
||||||
defaultContent: AST | null;
|
defaultContent: AST | null;
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -159,17 +131,6 @@ export interface ASTLog {
|
|||||||
content: AST | null;
|
content: AST | null;
|
||||||
}
|
}
|
||||||
|
|
||||||
export interface ASTTranslation {
|
|
||||||
type: ASTType.TTranslation;
|
|
||||||
content: AST | null;
|
|
||||||
}
|
|
||||||
|
|
||||||
export interface ASTTPortal {
|
|
||||||
type: ASTType.TPortal;
|
|
||||||
target: string;
|
|
||||||
content: AST;
|
|
||||||
}
|
|
||||||
|
|
||||||
export type AST =
|
export type AST =
|
||||||
| ASTText
|
| ASTText
|
||||||
| ASTComment
|
| ASTComment
|
||||||
@@ -179,49 +140,34 @@ export type AST =
|
|||||||
| ASTTif
|
| ASTTif
|
||||||
| ASTTSet
|
| ASTTSet
|
||||||
| ASTTCall
|
| ASTTCall
|
||||||
| ASTTOut
|
| ASTTRaw
|
||||||
| ASTTForEach
|
| ASTTForEach
|
||||||
| ASTTKey
|
| ASTTKey
|
||||||
| ASTComponent
|
| ASTComponent
|
||||||
| ASTSlot
|
| ASTSlot
|
||||||
| ASTTCallBlock
|
| ASTTCallBlock
|
||||||
| ASTLog
|
| ASTLog
|
||||||
| ASTDebug
|
| ASTDebug;
|
||||||
| ASTTranslation
|
|
||||||
| ASTTPortal;
|
|
||||||
|
|
||||||
// -----------------------------------------------------------------------------
|
// -----------------------------------------------------------------------------
|
||||||
// Parser
|
// Parser
|
||||||
// -----------------------------------------------------------------------------
|
// -----------------------------------------------------------------------------
|
||||||
const cache: WeakMap<Element, AST> = new WeakMap();
|
interface ParsingContext {
|
||||||
|
inPreTag: boolean;
|
||||||
|
}
|
||||||
|
|
||||||
export function parse(xml: string | Element): AST {
|
export function parse(xml: string): AST {
|
||||||
if (typeof xml === "string") {
|
const template = `<t>${xml}</t>`;
|
||||||
const elem = parseXML(`<t>${xml}</t>`).firstChild as Element;
|
const doc = parseXML(template);
|
||||||
return _parse(elem);
|
const ctx = { inPreTag: false };
|
||||||
}
|
const ast = parseNode(doc.firstChild!, ctx);
|
||||||
let ast = cache.get(xml);
|
|
||||||
if (!ast) {
|
if (!ast) {
|
||||||
// we clone here the xml to prevent modifying it in place
|
return { type: ASTType.Text, value: "" };
|
||||||
ast = _parse(xml.cloneNode(true) as Element);
|
|
||||||
cache.set(xml, ast);
|
|
||||||
}
|
}
|
||||||
return ast;
|
return ast;
|
||||||
}
|
}
|
||||||
|
|
||||||
function _parse(xml: Element): AST {
|
function parseNode(node: ChildNode, ctx: ParsingContext): AST | null {
|
||||||
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)) {
|
if (!(node instanceof Element)) {
|
||||||
return parseTextCommentNode(node, ctx);
|
return parseTextCommentNode(node, ctx);
|
||||||
}
|
}
|
||||||
@@ -229,14 +175,12 @@ function parseNode(node: Node, ctx: ParsingContext): AST | null {
|
|||||||
parseTDebugLog(node, ctx) ||
|
parseTDebugLog(node, ctx) ||
|
||||||
parseTForEach(node, ctx) ||
|
parseTForEach(node, ctx) ||
|
||||||
parseTIf(node, ctx) ||
|
parseTIf(node, ctx) ||
|
||||||
parseTPortal(node, ctx) ||
|
|
||||||
parseTCall(node, ctx) ||
|
parseTCall(node, ctx) ||
|
||||||
parseTCallBlock(node, ctx) ||
|
parseTCallBlock(node, ctx) ||
|
||||||
parseTEscNode(node, ctx) ||
|
parseTEscNode(node, ctx) ||
|
||||||
parseTKey(node, ctx) ||
|
parseTKey(node, ctx) ||
|
||||||
parseTTranslation(node, ctx) ||
|
|
||||||
parseTSlot(node, ctx) ||
|
parseTSlot(node, ctx) ||
|
||||||
parseTOutNode(node, ctx) ||
|
parseTRawNode(node, ctx) ||
|
||||||
parseComponent(node, ctx) ||
|
parseComponent(node, ctx) ||
|
||||||
parseDOMNode(node, ctx) ||
|
parseDOMNode(node, ctx) ||
|
||||||
parseTSetNode(node, ctx) ||
|
parseTSetNode(node, ctx) ||
|
||||||
@@ -252,23 +196,44 @@ function parseTNode(node: Element, ctx: ParsingContext): AST | null {
|
|||||||
if (node.tagName !== "t") {
|
if (node.tagName !== "t") {
|
||||||
return null;
|
return null;
|
||||||
}
|
}
|
||||||
return parseChildNodes(node, ctx);
|
const children: AST[] = [];
|
||||||
|
for (let child of node.childNodes) {
|
||||||
|
const ast = parseNode(child, ctx);
|
||||||
|
if (ast) {
|
||||||
|
children.push(ast);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
switch (children.length) {
|
||||||
|
case 0:
|
||||||
|
return null;
|
||||||
|
case 1:
|
||||||
|
return children[0];
|
||||||
|
default:
|
||||||
|
return {
|
||||||
|
type: ASTType.Multi,
|
||||||
|
content: children,
|
||||||
|
};
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
// -----------------------------------------------------------------------------
|
// -----------------------------------------------------------------------------
|
||||||
// Text and Comment Nodes
|
// Text and Comment Nodes
|
||||||
// -----------------------------------------------------------------------------
|
// -----------------------------------------------------------------------------
|
||||||
const whitespaceRE = /[^\S\r\n]+/g;
|
const lineBreakRE = /[\r\n]/;
|
||||||
|
const whitespaceRE = /\s+/g;
|
||||||
|
|
||||||
function parseTextCommentNode(node: Node, ctx: ParsingContext): AST | null {
|
function parseTextCommentNode(node: ChildNode, ctx: ParsingContext): AST | null {
|
||||||
if (node.nodeType === Node.TEXT_NODE) {
|
if (node.nodeType === 3) {
|
||||||
let value = node.textContent || "";
|
let value = node.textContent || "";
|
||||||
if (!ctx.inPreTag) {
|
if (!ctx.inPreTag) {
|
||||||
|
if (lineBreakRE.test(value) && !value.trim()) {
|
||||||
|
return null;
|
||||||
|
}
|
||||||
value = value.replace(whitespaceRE, " ");
|
value = value.replace(whitespaceRE, " ");
|
||||||
}
|
}
|
||||||
|
|
||||||
return { type: ASTType.Text, value };
|
return { type: ASTType.Text, value };
|
||||||
} else if (node.nodeType === Node.COMMENT_NODE) {
|
} else if (node.nodeType === 8) {
|
||||||
return { type: ASTType.Comment, value: node.textContent || "" };
|
return { type: ASTType.Comment, value: node.textContent || "" };
|
||||||
}
|
}
|
||||||
return null;
|
return null;
|
||||||
@@ -302,115 +267,55 @@ function parseTDebugLog(node: Element, ctx: ParsingContext): AST | null {
|
|||||||
// -----------------------------------------------------------------------------
|
// -----------------------------------------------------------------------------
|
||||||
// Regular dom node
|
// Regular dom node
|
||||||
// -----------------------------------------------------------------------------
|
// -----------------------------------------------------------------------------
|
||||||
const hasDotAtTheEnd = /\.[\w_]+\s*$/;
|
|
||||||
const hasBracketsAtTheEnd = /\[[^\[]+\]\s*$/;
|
|
||||||
|
|
||||||
const ROOT_SVG_TAGS = new Set(["svg", "g", "path"]);
|
|
||||||
|
|
||||||
function parseDOMNode(node: Element, ctx: ParsingContext): AST | null {
|
function parseDOMNode(node: Element, ctx: ParsingContext): AST | null {
|
||||||
const { tagName } = node;
|
if (node.tagName === "t") {
|
||||||
const dynamicTag = node.getAttribute("t-tag");
|
|
||||||
node.removeAttribute("t-tag");
|
|
||||||
if (tagName === "t" && !dynamicTag) {
|
|
||||||
return null;
|
return null;
|
||||||
}
|
}
|
||||||
if (tagName.startsWith("block-")) {
|
const children: AST[] = [];
|
||||||
throw new Error(`Invalid tag name: '${tagName}'`);
|
if (node.tagName === "pre") {
|
||||||
|
ctx = { inPreTag: true };
|
||||||
}
|
}
|
||||||
ctx = Object.assign({}, ctx);
|
let ref = null;
|
||||||
if (tagName === "pre") {
|
if (node.hasAttribute("t-ref")) {
|
||||||
ctx.inPreTag = true;
|
ref = node.getAttribute("t-ref");
|
||||||
|
node.removeAttribute("t-ref");
|
||||||
}
|
}
|
||||||
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 nodeAttrsNames = node.getAttributeNames();
|
for (let child of node.childNodes) {
|
||||||
let attrs: ASTDomNode["attrs"] = null;
|
const ast = parseNode(child, ctx);
|
||||||
let on: EventHandlers | null = null;
|
if (ast) {
|
||||||
let model: TModelInfo | null = null;
|
children.push(ast);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
for (let attr of nodeAttrsNames) {
|
const attrs: ASTDomNode["attrs"] = {};
|
||||||
|
const on: ASTDomNode["on"] = {};
|
||||||
|
|
||||||
|
for (let attr of node.getAttributeNames()) {
|
||||||
const value = node.getAttribute(attr)!;
|
const value = node.getAttribute(attr)!;
|
||||||
if (attr.startsWith("t-on")) {
|
if (attr.startsWith("t-on")) {
|
||||||
if (attr === "t-on") {
|
if (attr === "t-on") {
|
||||||
throw new Error("Missing event name with t-on directive");
|
throw new Error("Missing event name with t-on directive");
|
||||||
}
|
}
|
||||||
on = on || {};
|
|
||||||
on[attr.slice(5)] = value;
|
on[attr.slice(5)] = value;
|
||||||
} else if (attr.startsWith("t-model")) {
|
} else {
|
||||||
if (!["input", "select", "textarea"].includes(tagName)) {
|
|
||||||
throw new Error("The t-model directive only works with <input>, <textarea> and <select>");
|
|
||||||
}
|
|
||||||
|
|
||||||
let baseExpr, expr;
|
|
||||||
if (hasDotAtTheEnd.test(value)) {
|
|
||||||
const index = value.lastIndexOf(".");
|
|
||||||
baseExpr = value.slice(0, index);
|
|
||||||
expr = `'${value.slice(index + 1)}'`;
|
|
||||||
} else if (hasBracketsAtTheEnd.test(value)) {
|
|
||||||
const index = value.lastIndexOf("[");
|
|
||||||
baseExpr = value.slice(0, index);
|
|
||||||
expr = value.slice(index + 1, -1);
|
|
||||||
} else {
|
|
||||||
throw new Error(`Invalid t-model expression: "${value}" (it should be assignable)`);
|
|
||||||
}
|
|
||||||
|
|
||||||
const typeAttr = node.getAttribute("type");
|
|
||||||
const isInput = tagName === "input";
|
|
||||||
const isSelect = tagName === "select";
|
|
||||||
const isTextarea = tagName === "textarea";
|
|
||||||
const isCheckboxInput = isInput && typeAttr === "checkbox";
|
|
||||||
const isRadioInput = isInput && typeAttr === "radio";
|
|
||||||
const isOtherInput = isInput && !isCheckboxInput && !isRadioInput;
|
|
||||||
const hasLazyMod = attr.includes(".lazy");
|
|
||||||
const hasNumberMod = attr.includes(".number");
|
|
||||||
const hasTrimMod = attr.includes(".trim");
|
|
||||||
const eventType = isRadioInput ? "click" : isSelect || hasLazyMod ? "change" : "input";
|
|
||||||
|
|
||||||
model = {
|
|
||||||
baseExpr,
|
|
||||||
expr,
|
|
||||||
targetAttr: isCheckboxInput ? "checked" : "value",
|
|
||||||
specialInitTargetAttr: isRadioInput ? "checked" : null,
|
|
||||||
eventType,
|
|
||||||
hasDynamicChildren: false,
|
|
||||||
shouldTrim: hasTrimMod && (isOtherInput || isTextarea),
|
|
||||||
shouldNumberize: hasNumberMod && (isOtherInput || isTextarea),
|
|
||||||
};
|
|
||||||
if (isSelect) {
|
|
||||||
// don't pollute the original ctx
|
|
||||||
ctx = Object.assign({}, ctx);
|
|
||||||
ctx.tModelInfo = model;
|
|
||||||
}
|
|
||||||
} else if (attr.startsWith("block-")) {
|
|
||||||
throw new Error(`Invalid attribute: '${attr}'`);
|
|
||||||
} else if (attr !== "t-name") {
|
|
||||||
if (attr.startsWith("t-") && !attr.startsWith("t-att")) {
|
if (attr.startsWith("t-") && !attr.startsWith("t-att")) {
|
||||||
throw new Error(`Unknown QWeb directive: '${attr}'`);
|
throw new Error(`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;
|
attrs[attr] = value;
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
if (children.length === 1 && children[0].type === ASTType.TForEach) {
|
||||||
const children = parseChildren(node, ctx);
|
children[0].isOnlyChild = true;
|
||||||
|
}
|
||||||
return {
|
return {
|
||||||
type: ASTType.DomNode,
|
type: ASTType.DomNode,
|
||||||
tag: tagName,
|
tag: node.tagName,
|
||||||
dynamicTag,
|
|
||||||
attrs,
|
attrs,
|
||||||
on,
|
on,
|
||||||
ref,
|
ref,
|
||||||
content: children,
|
content: children,
|
||||||
model,
|
|
||||||
ns,
|
|
||||||
};
|
};
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -435,53 +340,56 @@ function parseTEscNode(node: Element, ctx: ParsingContext): AST | null {
|
|||||||
if (!ast) {
|
if (!ast) {
|
||||||
return tesc;
|
return tesc;
|
||||||
}
|
}
|
||||||
if (ast.type === ASTType.DomNode) {
|
if (ast && ast.type === ASTType.DomNode) {
|
||||||
return {
|
return {
|
||||||
...ast,
|
type: ASTType.DomNode,
|
||||||
|
tag: ast.tag,
|
||||||
|
attrs: ast.attrs,
|
||||||
|
on: ast.on,
|
||||||
ref,
|
ref,
|
||||||
content: [tesc],
|
content: [tesc],
|
||||||
};
|
};
|
||||||
}
|
}
|
||||||
if (ast.type === ASTType.TComponent) {
|
if (ast && ast.type === ASTType.TComponent) {
|
||||||
throw new Error("t-esc is not supported on Component nodes");
|
return {
|
||||||
|
...ast,
|
||||||
|
slots: { default: tesc },
|
||||||
|
};
|
||||||
}
|
}
|
||||||
return tesc;
|
return tesc;
|
||||||
}
|
}
|
||||||
|
|
||||||
// -----------------------------------------------------------------------------
|
// -----------------------------------------------------------------------------
|
||||||
// t-out
|
// t-raw
|
||||||
// -----------------------------------------------------------------------------
|
// -----------------------------------------------------------------------------
|
||||||
|
|
||||||
function parseTOutNode(node: Element, ctx: ParsingContext): AST | null {
|
function parseTRawNode(node: Element, ctx: ParsingContext): AST | null {
|
||||||
if (!node.hasAttribute("t-out") && !node.hasAttribute("t-raw")) {
|
if (!node.hasAttribute("t-raw")) {
|
||||||
return null;
|
return null;
|
||||||
}
|
}
|
||||||
if (node.hasAttribute("t-raw")) {
|
const expr = node.getAttribute("t-raw")!;
|
||||||
console.warn(
|
|
||||||
`t-raw has been deprecated in favor of t-out. If the value to render is not wrapped by the "markup" function, it will be escaped`
|
|
||||||
);
|
|
||||||
}
|
|
||||||
const expr = (node.getAttribute("t-out") || node.getAttribute("t-raw"))!;
|
|
||||||
node.removeAttribute("t-out");
|
|
||||||
node.removeAttribute("t-raw");
|
node.removeAttribute("t-raw");
|
||||||
|
|
||||||
const tOut: AST = { type: ASTType.TOut, expr, body: null };
|
const tRaw: AST = { type: ASTType.TRaw, expr, body: null };
|
||||||
const ref = node.getAttribute("t-ref");
|
const ref = node.getAttribute("t-ref");
|
||||||
node.removeAttribute("t-ref");
|
node.removeAttribute("t-ref");
|
||||||
const ast = parseNode(node, ctx);
|
const ast = parseNode(node, ctx);
|
||||||
if (!ast) {
|
if (!ast) {
|
||||||
return tOut;
|
return tRaw;
|
||||||
}
|
}
|
||||||
if (ast.type === ASTType.DomNode) {
|
if (ast && ast.type === ASTType.DomNode) {
|
||||||
tOut.body = ast.content.length ? ast.content : null;
|
tRaw.body = ast.content.length ? ast.content : null;
|
||||||
return {
|
return {
|
||||||
...ast,
|
type: ASTType.DomNode,
|
||||||
|
tag: ast.tag,
|
||||||
|
attrs: ast.attrs,
|
||||||
|
on: ast.on,
|
||||||
ref,
|
ref,
|
||||||
content: [tOut],
|
content: [tRaw],
|
||||||
};
|
};
|
||||||
}
|
}
|
||||||
|
|
||||||
return tOut;
|
return tRaw;
|
||||||
}
|
}
|
||||||
|
|
||||||
// -----------------------------------------------------------------------------
|
// -----------------------------------------------------------------------------
|
||||||
@@ -498,11 +406,6 @@ function parseTForEach(node: Element, ctx: ParsingContext): AST | null {
|
|||||||
const elem = node.getAttribute("t-as") || "";
|
const elem = node.getAttribute("t-as") || "";
|
||||||
node.removeAttribute("t-as");
|
node.removeAttribute("t-as");
|
||||||
const key = node.getAttribute("t-key");
|
const key = node.getAttribute("t-key");
|
||||||
if (!key) {
|
|
||||||
throw new Error(
|
|
||||||
`"Directive t-foreach should always be used with a t-key!" (expression: t-foreach="${collection}" t-as="${elem}")`
|
|
||||||
);
|
|
||||||
}
|
|
||||||
node.removeAttribute("t-key");
|
node.removeAttribute("t-key");
|
||||||
const memo = node.getAttribute("t-memo") || "";
|
const memo = node.getAttribute("t-memo") || "";
|
||||||
node.removeAttribute("t-memo");
|
node.removeAttribute("t-memo");
|
||||||
@@ -525,6 +428,8 @@ function parseTForEach(node: Element, ctx: ParsingContext): AST | null {
|
|||||||
body,
|
body,
|
||||||
memo,
|
memo,
|
||||||
key,
|
key,
|
||||||
|
isOnlyChild: false,
|
||||||
|
hasNoComponent: hasNoComponent(body),
|
||||||
hasNoFirst,
|
hasNoFirst,
|
||||||
hasNoLast,
|
hasNoLast,
|
||||||
hasNoIndex,
|
hasNoIndex,
|
||||||
@@ -532,6 +437,57 @@ 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.TRaw:
|
||||||
|
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:
|
||||||
|
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 {
|
function parseTKey(node: Element, ctx: ParsingContext): AST | null {
|
||||||
if (!node.hasAttribute("t-key")) {
|
if (!node.hasAttribute("t-key")) {
|
||||||
return null;
|
return null;
|
||||||
@@ -554,13 +510,11 @@ function parseTCall(node: Element, ctx: ParsingContext): AST | null {
|
|||||||
return null;
|
return null;
|
||||||
}
|
}
|
||||||
const subTemplate = node.getAttribute("t-call")!;
|
const subTemplate = node.getAttribute("t-call")!;
|
||||||
const context = node.getAttribute("t-call-context");
|
|
||||||
node.removeAttribute("t-call");
|
|
||||||
node.removeAttribute("t-call-context");
|
|
||||||
|
|
||||||
|
node.removeAttribute("t-call");
|
||||||
if (node.tagName !== "t") {
|
if (node.tagName !== "t") {
|
||||||
const ast = parseNode(node, ctx);
|
const ast = parseNode(node, ctx);
|
||||||
const tcall: AST = { type: ASTType.TCall, name: subTemplate, body: null, context };
|
const tcall: AST = { type: ASTType.TCall, name: subTemplate, body: null };
|
||||||
if (ast && ast.type === ASTType.DomNode) {
|
if (ast && ast.type === ASTType.DomNode) {
|
||||||
ast.content = [tcall];
|
ast.content = [tcall];
|
||||||
return ast;
|
return ast;
|
||||||
@@ -568,17 +522,22 @@ function parseTCall(node: Element, ctx: ParsingContext): AST | null {
|
|||||||
if (ast && ast.type === ASTType.TComponent) {
|
if (ast && ast.type === ASTType.TComponent) {
|
||||||
return {
|
return {
|
||||||
...ast,
|
...ast,
|
||||||
slots: { default: { content: tcall, scope: null, on: null, attrs: null } },
|
slots: { default: tcall },
|
||||||
};
|
};
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
const body = parseChildren(node, ctx);
|
const body: AST[] = [];
|
||||||
|
for (let child of node.childNodes) {
|
||||||
|
const ast = parseNode(child, ctx);
|
||||||
|
if (ast) {
|
||||||
|
body.push(ast);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
return {
|
return {
|
||||||
type: ASTType.TCall,
|
type: ASTType.TCall,
|
||||||
name: subTemplate,
|
name: subTemplate,
|
||||||
body: body.length ? body : null,
|
body: body.length ? body : null,
|
||||||
context,
|
|
||||||
};
|
};
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -607,7 +566,10 @@ function parseTIf(node: Element, ctx: ParsingContext): AST | null {
|
|||||||
}
|
}
|
||||||
const condition = node.getAttribute("t-if")!;
|
const condition = node.getAttribute("t-if")!;
|
||||||
node.removeAttribute("t-if");
|
node.removeAttribute("t-if");
|
||||||
const content = parseNode(node, ctx) || { type: ASTType.Text, value: "" };
|
const content = parseNode(node, ctx);
|
||||||
|
if (!content) {
|
||||||
|
throw new Error("hmmm");
|
||||||
|
}
|
||||||
|
|
||||||
let nextElement = node.nextElementSibling;
|
let nextElement = node.nextElementSibling;
|
||||||
// t-elifs
|
// t-elifs
|
||||||
@@ -654,7 +616,13 @@ function parseTSetNode(node: Element, ctx: ParsingContext): AST | null {
|
|||||||
const defaultValue = node.innerHTML === node.textContent ? node.textContent || null : null;
|
const defaultValue = node.innerHTML === node.textContent ? node.textContent || null : null;
|
||||||
let body: AST[] | null = null;
|
let body: AST[] | null = null;
|
||||||
if (node.textContent !== node.innerHTML) {
|
if (node.textContent !== node.innerHTML) {
|
||||||
body = parseChildren(node, ctx);
|
body = [];
|
||||||
|
for (let child of node.childNodes) {
|
||||||
|
let childAst = parseNode(child, ctx);
|
||||||
|
if (childAst) {
|
||||||
|
body.push(childAst);
|
||||||
|
}
|
||||||
|
}
|
||||||
}
|
}
|
||||||
return { type: ASTType.TSet, name, value, defaultValue, body };
|
return { type: ASTType.TSet, name, value, defaultValue, body };
|
||||||
}
|
}
|
||||||
@@ -663,28 +631,11 @@ function parseTSetNode(node: Element, ctx: ParsingContext): AST | null {
|
|||||||
// Components
|
// Components
|
||||||
// -----------------------------------------------------------------------------
|
// -----------------------------------------------------------------------------
|
||||||
|
|
||||||
// Error messages when trying to use an unsupported directive on a component
|
|
||||||
const directiveErrorMap = new Map([
|
|
||||||
[
|
|
||||||
"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.",
|
|
||||||
],
|
|
||||||
["t-att", "t-att makes no sense on component: props are already treated as expressions"],
|
|
||||||
[
|
|
||||||
"t-attf",
|
|
||||||
"t-attf is not supported on components: use template strings for string interpolation in props",
|
|
||||||
],
|
|
||||||
]);
|
|
||||||
|
|
||||||
function parseComponent(node: Element, ctx: ParsingContext): AST | null {
|
function parseComponent(node: Element, ctx: ParsingContext): AST | null {
|
||||||
let name = node.tagName;
|
let name = node.tagName;
|
||||||
const firstLetter = name[0];
|
const firstLetter = name[0];
|
||||||
let isDynamic = node.hasAttribute("t-component");
|
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}>)`);
|
|
||||||
}
|
|
||||||
|
|
||||||
if (!(firstLetter === firstLetter.toUpperCase() || isDynamic)) {
|
if (!(firstLetter === firstLetter.toUpperCase() || isDynamic)) {
|
||||||
return null;
|
return null;
|
||||||
}
|
}
|
||||||
@@ -693,42 +644,24 @@ function parseComponent(node: Element, ctx: ParsingContext): AST | null {
|
|||||||
node.removeAttribute("t-component");
|
node.removeAttribute("t-component");
|
||||||
}
|
}
|
||||||
|
|
||||||
const dynamicProps = node.getAttribute("t-props");
|
const props: ASTComponent["props"] = {};
|
||||||
node.removeAttribute("t-props");
|
const handlers: ASTComponent["handlers"] = {};
|
||||||
|
|
||||||
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()) {
|
for (let name of node.getAttributeNames()) {
|
||||||
const value = node.getAttribute(name)!;
|
const value = node.getAttribute(name)!;
|
||||||
if (name.startsWith("t-")) {
|
if (name.startsWith("t-on-")) {
|
||||||
if (name.startsWith("t-on-")) {
|
handlers[name.slice(5)] = value;
|
||||||
on = on || {};
|
|
||||||
on[name.slice(5)] = value;
|
|
||||||
} else {
|
|
||||||
const message = directiveErrorMap.get(name.split("-").slice(0, 2).join("-"));
|
|
||||||
throw new Error(message || `unsupported directive on Component: ${name}`);
|
|
||||||
}
|
|
||||||
} else {
|
} else {
|
||||||
props = props || {};
|
|
||||||
props[name] = value;
|
props[name] = value;
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
let slots: ASTComponent["slots"] | null = null;
|
const slots: ASTComponent["slots"] = {};
|
||||||
if (node.hasChildNodes()) {
|
if (node.hasChildNodes()) {
|
||||||
const clone = <Element>node.cloneNode(true);
|
const clone = <Element>node.cloneNode(true);
|
||||||
|
|
||||||
// named slots
|
// named slots
|
||||||
const slotNodes = Array.from(clone.querySelectorAll("[t-set-slot]"));
|
const slotNodes = Array.from(clone.querySelectorAll("[t-set-slot]"));
|
||||||
for (let slotNode of slotNodes) {
|
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")!;
|
const name = slotNode.getAttribute("t-set-slot")!;
|
||||||
|
|
||||||
// check if this is defined in a sub component (in which case it should
|
// check if this is defined in a sub component (in which case it should
|
||||||
@@ -749,34 +682,18 @@ function parseComponent(node: Element, ctx: ParsingContext): AST | null {
|
|||||||
slotNode.removeAttribute("t-set-slot");
|
slotNode.removeAttribute("t-set-slot");
|
||||||
slotNode.remove();
|
slotNode.remove();
|
||||||
const slotAst = parseNode(slotNode, ctx);
|
const slotAst = parseNode(slotNode, ctx);
|
||||||
let on: SlotDefinition["on"] = null;
|
if (slotAst) {
|
||||||
let attrs: Attrs | null = null;
|
slots[name] = slotAst;
|
||||||
let scope: string | null = null;
|
|
||||||
for (let attributeName of slotNode.getAttributeNames()) {
|
|
||||||
const value = slotNode.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 || {};
|
|
||||||
slots[name] = { content: slotAst, on, attrs, scope };
|
|
||||||
}
|
}
|
||||||
|
|
||||||
// default slot
|
// default slot
|
||||||
const defaultContent = parseChildNodes(clone, ctx);
|
const defaultContent = parseChildNodes(clone, ctx);
|
||||||
if (defaultContent) {
|
if (defaultContent) {
|
||||||
slots = slots || {};
|
slots.default = defaultContent;
|
||||||
slots.default = { content: defaultContent, on, attrs: null, scope: defaultSlotScope };
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
return { type: ASTType.TComponent, name, isDynamic, dynamicProps, props, slots, on };
|
return { type: ASTType.TComponent, name, isDynamic, props, handlers, slots };
|
||||||
}
|
}
|
||||||
|
|
||||||
// -----------------------------------------------------------------------------
|
// -----------------------------------------------------------------------------
|
||||||
@@ -787,92 +704,25 @@ function parseTSlot(node: Element, ctx: ParsingContext): AST | null {
|
|||||||
if (!node.hasAttribute("t-slot")) {
|
if (!node.hasAttribute("t-slot")) {
|
||||||
return null;
|
return null;
|
||||||
}
|
}
|
||||||
const name = node.getAttribute("t-slot")!;
|
|
||||||
node.removeAttribute("t-slot");
|
|
||||||
let attrs: Attrs | null = null;
|
|
||||||
let on: ASTComponent["on"] = null;
|
|
||||||
for (let attributeName of node.getAttributeNames()) {
|
|
||||||
const value = node.getAttribute(attributeName)!;
|
|
||||||
if (attributeName.startsWith("t-on-")) {
|
|
||||||
on = on || {};
|
|
||||||
on[attributeName.slice(5)] = value;
|
|
||||||
} else {
|
|
||||||
attrs = attrs || {};
|
|
||||||
attrs[attributeName] = value;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
return {
|
return {
|
||||||
type: ASTType.TSlot,
|
type: ASTType.TSlot,
|
||||||
name,
|
name: node.getAttribute("t-slot")!,
|
||||||
attrs,
|
|
||||||
on,
|
|
||||||
defaultContent: parseChildNodes(node, ctx),
|
defaultContent: parseChildNodes(node, ctx),
|
||||||
};
|
};
|
||||||
}
|
}
|
||||||
|
|
||||||
function parseTTranslation(node: Element, ctx: ParsingContext): AST | null {
|
|
||||||
if (node.getAttribute("t-translation") !== "off") {
|
|
||||||
return null;
|
|
||||||
}
|
|
||||||
node.removeAttribute("t-translation");
|
|
||||||
return {
|
|
||||||
type: ASTType.TTranslation,
|
|
||||||
content: parseNode(node, ctx),
|
|
||||||
};
|
|
||||||
}
|
|
||||||
|
|
||||||
// -----------------------------------------------------------------------------
|
|
||||||
// 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
|
// helpers
|
||||||
// -----------------------------------------------------------------------------
|
// -----------------------------------------------------------------------------
|
||||||
|
|
||||||
/**
|
function parseChildNodes(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: Element, ctx: ParsingContext): AST[] {
|
|
||||||
const children: AST[] = [];
|
const children: AST[] = [];
|
||||||
for (let child of node.childNodes) {
|
for (let child of node.childNodes) {
|
||||||
const childAst = parseNode(child, ctx);
|
const childAst = parseNode(child, ctx);
|
||||||
if (childAst) {
|
if (childAst) {
|
||||||
if (childAst.type === ASTType.Multi) {
|
children.push(childAst);
|
||||||
children.push(...childAst.content);
|
|
||||||
} else {
|
|
||||||
children.push(childAst);
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
return children;
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* 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: Element, ctx: ParsingContext): AST | null {
|
|
||||||
const children = parseChildren(node, ctx);
|
|
||||||
switch (children.length) {
|
switch (children.length) {
|
||||||
case 0:
|
case 0:
|
||||||
return null;
|
return null;
|
||||||
@@ -882,17 +732,34 @@ function parseChildNodes(node: Element, ctx: ParsingContext): AST | null {
|
|||||||
return { type: ASTType.Multi, content: children };
|
return { type: ASTType.Multi, content: children };
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
function parseXML(xml: string): Document {
|
||||||
|
const parser = new DOMParser();
|
||||||
|
|
||||||
/**
|
const doc = parser.parseFromString(xml, "text/xml");
|
||||||
* Normalizes the content of an Element so that t-if/t-elif/t-else directives
|
if (doc.getElementsByTagName("parsererror").length) {
|
||||||
* immediately follow one another (by removing empty text nodes or comments).
|
let msg = "Invalid XML in template.";
|
||||||
* Throws an error when a conditional branching statement is malformed. This
|
const parsererrorText = doc.getElementsByTagName("parsererror")[0].textContent;
|
||||||
* function modifies the Element in place.
|
if (parsererrorText) {
|
||||||
*
|
msg += "\nThe parser has produced the following error message:\n" + parsererrorText;
|
||||||
* @param el the element containing the tree that should be normalized
|
const re = /\d+/g;
|
||||||
*/
|
const firstMatch = re.exec(parsererrorText);
|
||||||
function normalizeTIf(el: Element) {
|
if (firstMatch) {
|
||||||
let tbranch = el.querySelectorAll("[t-elif], [t-else]");
|
const lineNumber = Number(firstMatch[0]);
|
||||||
|
const line = xml.split("\n")[lineNumber - 1];
|
||||||
|
const secondMatch = re.exec(parsererrorText);
|
||||||
|
if (line && secondMatch) {
|
||||||
|
const columnIndex = Number(secondMatch[0]) - 1;
|
||||||
|
if (line[columnIndex]) {
|
||||||
|
msg +=
|
||||||
|
`\nThe error might be located at xml line ${lineNumber} column ${columnIndex}\n` +
|
||||||
|
`${line}\n${"-".repeat(columnIndex - 1)}^`;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
throw new Error(msg);
|
||||||
|
}
|
||||||
|
let tbranch = doc.querySelectorAll("[t-elif], [t-else]");
|
||||||
for (let i = 0, ilen = tbranch.length; i < ilen; i++) {
|
for (let i = 0, ilen = tbranch.length; i < ilen; i++) {
|
||||||
let node = tbranch[i];
|
let node = tbranch[i];
|
||||||
let prevElem = node.previousElementSibling!;
|
let prevElem = node.previousElementSibling!;
|
||||||
@@ -926,78 +793,6 @@ function normalizeTIf(el: Element) {
|
|||||||
);
|
);
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Normalizes the content of an Element so that t-esc directives on components
|
|
||||||
* are removed and instead places a <t t-esc=""> as the default slot of the
|
|
||||||
* component. Also throws if the component already has content. This function
|
|
||||||
* modifies the Element in place.
|
|
||||||
*
|
|
||||||
* @param el the element containing the tree that should be normalized
|
|
||||||
*/
|
|
||||||
function normalizeTEsc(el: Element) {
|
|
||||||
const elements = [...el.querySelectorAll("[t-esc]")].filter(
|
|
||||||
(el) => el.tagName[0] === el.tagName[0].toUpperCase() || el.hasAttribute("t-component")
|
|
||||||
);
|
|
||||||
for (const el of elements) {
|
|
||||||
if (el.childNodes.length) {
|
|
||||||
throw new Error("Cannot have t-esc on a component that already has content");
|
|
||||||
}
|
|
||||||
const value = el.getAttribute("t-esc");
|
|
||||||
el.removeAttribute("t-esc");
|
|
||||||
const t = el.ownerDocument.createElement("t");
|
|
||||||
if (value != null) {
|
|
||||||
t.setAttribute("t-esc", value);
|
|
||||||
}
|
|
||||||
el.appendChild(t);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Normalizes the tree inside a given element and do some preliminary validation
|
|
||||||
* on it. This function modifies the Element in place.
|
|
||||||
*
|
|
||||||
* @param el the element containing the tree that should be normalized
|
|
||||||
*/
|
|
||||||
function normalizeXML(el: Element) {
|
|
||||||
normalizeTIf(el);
|
|
||||||
normalizeTEsc(el);
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Parses an XML string into an XML document, throwing errors on parser errors
|
|
||||||
* instead of returning an XML document containing the parseerror.
|
|
||||||
*
|
|
||||||
* @param xml the string to parse
|
|
||||||
* @returns an XML document corresponding to the content of the string
|
|
||||||
*/
|
|
||||||
function parseXML(xml: string): XMLDocument {
|
|
||||||
const parser = new DOMParser();
|
|
||||||
const doc = parser.parseFromString(xml, "text/xml");
|
|
||||||
if (doc.getElementsByTagName("parsererror").length) {
|
|
||||||
let msg = "Invalid XML in template.";
|
|
||||||
const parsererrorText = doc.getElementsByTagName("parsererror")[0].textContent;
|
|
||||||
if (parsererrorText) {
|
|
||||||
msg += "\nThe parser has produced the following error message:\n" + parsererrorText;
|
|
||||||
const re = /\d+/g;
|
|
||||||
const firstMatch = re.exec(parsererrorText);
|
|
||||||
if (firstMatch) {
|
|
||||||
const lineNumber = Number(firstMatch[0]);
|
|
||||||
const line = xml.split("\n")[lineNumber - 1];
|
|
||||||
const secondMatch = re.exec(parsererrorText);
|
|
||||||
if (line && secondMatch) {
|
|
||||||
const columnIndex = Number(secondMatch[0]) - 1;
|
|
||||||
if (line[columnIndex]) {
|
|
||||||
msg +=
|
|
||||||
`\nThe error might be located at xml line ${lineNumber} column ${columnIndex}\n` +
|
|
||||||
`${line}\n${"-".repeat(columnIndex - 1)}^`;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
throw new Error(msg);
|
|
||||||
}
|
|
||||||
|
|
||||||
return doc;
|
return doc;
|
||||||
}
|
}
|
||||||
@@ -0,0 +1,129 @@
|
|||||||
|
// import { compileTemplate, Template } from "./qweb/index";
|
||||||
|
import { BDom, createBlock, html, list, multi, text, toggler } from "../blockdom";
|
||||||
|
import { component } from "../component/component_node";
|
||||||
|
import { Template, compileTemplate } from "./compiler";
|
||||||
|
|
||||||
|
const bdom = { text, createBlock, list, multi, html, toggler, component };
|
||||||
|
|
||||||
|
export const globalTemplates: { [key: string]: string } = {};
|
||||||
|
|
||||||
|
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,
|
||||||
|
defaultSlot?: (ctx: any, key: string) => BDom,
|
||||||
|
dynamic?: boolean
|
||||||
|
): BDom | null {
|
||||||
|
const slots = ctx.__owl__.slots;
|
||||||
|
const slotFn = slots[name];
|
||||||
|
const slotBDom = slotFn ? slotFn(parent, key) : null;
|
||||||
|
if (defaultSlot) {
|
||||||
|
let child1: BDom | undefined = undefined;
|
||||||
|
let child2: BDom | undefined = undefined;
|
||||||
|
// const result = new BMulti(2);
|
||||||
|
if (slotBDom) {
|
||||||
|
child1 = dynamic ? toggler(name, slotBDom) : slotBDom;
|
||||||
|
} else {
|
||||||
|
child2 = defaultSlot(parent, key);
|
||||||
|
}
|
||||||
|
return multi([child1, child2]);
|
||||||
|
}
|
||||||
|
return slotBDom;
|
||||||
|
}
|
||||||
|
|
||||||
|
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)];
|
||||||
|
}
|
||||||
|
export const UTILS = {
|
||||||
|
// elem,
|
||||||
|
// setText,
|
||||||
|
withDefault,
|
||||||
|
zero: Symbol("zero"),
|
||||||
|
callSlot,
|
||||||
|
capture,
|
||||||
|
// toClassObj,
|
||||||
|
withKey,
|
||||||
|
prepareList,
|
||||||
|
shallowEqual,
|
||||||
|
};
|
||||||
|
|
||||||
|
export class TemplateSet {
|
||||||
|
rawTemplates: { [name: string]: string } = Object.create(globalTemplates);
|
||||||
|
templates: { [name: string]: Template } = {};
|
||||||
|
utils: typeof UTILS;
|
||||||
|
|
||||||
|
constructor() {
|
||||||
|
const call = (subTemplate: string, ctx: any, parent: any) => {
|
||||||
|
const template = this.getTemplate(subTemplate);
|
||||||
|
return toggler(subTemplate, template(ctx, parent));
|
||||||
|
};
|
||||||
|
|
||||||
|
const getTemplate = (name: string) => this.getTemplate(name);
|
||||||
|
this.utils = Object.assign({}, UTILS, { getTemplate, call });
|
||||||
|
}
|
||||||
|
|
||||||
|
addTemplate(name: string, template: string, options: { allowDuplicate?: boolean } = {}) {
|
||||||
|
if (name in this.rawTemplates && !options.allowDuplicate) {
|
||||||
|
throw new Error(`Template ${name} already defined`);
|
||||||
|
}
|
||||||
|
this.rawTemplates[name] = template;
|
||||||
|
}
|
||||||
|
|
||||||
|
getTemplate(name: string): Template {
|
||||||
|
if (!(name in this.templates)) {
|
||||||
|
const rawTemplate = this.rawTemplates[name];
|
||||||
|
if (rawTemplate === undefined) {
|
||||||
|
throw new Error(`Missing template: "${name}"`);
|
||||||
|
}
|
||||||
|
const templateFn = compileTemplate(rawTemplate, name);
|
||||||
|
|
||||||
|
// 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);
|
||||||
|
this.templates[name] = template;
|
||||||
|
}
|
||||||
|
return this.templates[name];
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
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;
|
||||||
|
}
|
||||||
@@ -0,0 +1,144 @@
|
|||||||
|
import { getCurrent } from "./component/component_node";
|
||||||
|
|
||||||
|
export function useState<T>(state: T): T {
|
||||||
|
const node = getCurrent()!;
|
||||||
|
return observe(state, () => node.render());
|
||||||
|
}
|
||||||
|
|
||||||
|
type CB = () => void;
|
||||||
|
const observers: WeakMap<any, PSet<CB>> = new WeakMap();
|
||||||
|
|
||||||
|
/**
|
||||||
|
* PSet (for Prototypal Set) are sets that can lookup in their "parent sets", if
|
||||||
|
* any.
|
||||||
|
*/
|
||||||
|
|
||||||
|
class PSet<T> extends Set<T> {
|
||||||
|
parent?: PSet<T>;
|
||||||
|
|
||||||
|
static createChild<T>(parent: PSet<T>): PSet<T> {
|
||||||
|
const pset: PSet<T> = new PSet();
|
||||||
|
pset.parent = parent;
|
||||||
|
return pset;
|
||||||
|
}
|
||||||
|
|
||||||
|
has(key: T): boolean {
|
||||||
|
if (super.has(key)) {
|
||||||
|
return true;
|
||||||
|
}
|
||||||
|
return this.parent ? this.parent.has(key) : false;
|
||||||
|
}
|
||||||
|
|
||||||
|
*[Symbol.iterator](): Generator<T> {
|
||||||
|
let iterator = super[Symbol.iterator]();
|
||||||
|
for (let elem of iterator) {
|
||||||
|
yield elem;
|
||||||
|
}
|
||||||
|
if (this.parent) {
|
||||||
|
for (let elem of this.parent) {
|
||||||
|
yield elem;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// -----------------------------------------------------------------------------
|
||||||
|
|
||||||
|
export function observe<T>(value: T, cb: CB): T {
|
||||||
|
if (isNotObservable(value)) {
|
||||||
|
return value;
|
||||||
|
}
|
||||||
|
if (observers.has(value)) {
|
||||||
|
const callbacks = observers.get(value)!;
|
||||||
|
callbacks.add(cb);
|
||||||
|
return value;
|
||||||
|
}
|
||||||
|
const callbacks: PSet<CB> = new PSet();
|
||||||
|
callbacks.add(cb);
|
||||||
|
return observeValue(value, callbacks);
|
||||||
|
}
|
||||||
|
|
||||||
|
export function unobserve<T>(value: T, cb: () => void) {
|
||||||
|
if (isNotObservable(value)) {
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
if (observers.has(value)) {
|
||||||
|
const callbacks = observers.get(value)!;
|
||||||
|
callbacks.delete(cb);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
function isNotObservable(value: any): boolean {
|
||||||
|
return (
|
||||||
|
value === null || typeof value !== "object" || value instanceof Date || value instanceof Promise
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* value should
|
||||||
|
* 1. be observable
|
||||||
|
* 2. not yet be observed
|
||||||
|
*/
|
||||||
|
function observeValue(value: any, callbacks: PSet<CB>): any {
|
||||||
|
const proxy = new Proxy(value as any, {
|
||||||
|
get(target: any, key: any): any {
|
||||||
|
const current = target[key];
|
||||||
|
if (isNotObservable(current)) {
|
||||||
|
return current;
|
||||||
|
}
|
||||||
|
if (observers.has(current)) {
|
||||||
|
// this is wrong ?
|
||||||
|
observers.get(current)!.parent = callbacks;
|
||||||
|
return current;
|
||||||
|
}
|
||||||
|
const subCallbacks = PSet.createChild(callbacks);
|
||||||
|
const subValue = observeValue(current, subCallbacks);
|
||||||
|
target[key] = subValue;
|
||||||
|
return subValue;
|
||||||
|
},
|
||||||
|
set(target: any, key: any, value: any): boolean {
|
||||||
|
// TODO: check if current !== target or proxy ??
|
||||||
|
const current = target[key];
|
||||||
|
if (current !== value) {
|
||||||
|
if (isNotObservable(value)) {
|
||||||
|
target[key] = value;
|
||||||
|
} else {
|
||||||
|
// TODO: test following scenario:
|
||||||
|
// 1. obj1 = observer({a:1}, somecb);
|
||||||
|
// 2. unobserve(obj1, somecb)
|
||||||
|
// 3. obj1.a = {b: 2};
|
||||||
|
// check that somecb was not called
|
||||||
|
// obj1.a.b = 3;
|
||||||
|
// check again that somecb was not called
|
||||||
|
if (observers.has(value)) {
|
||||||
|
const pset = observers.get(value)!;
|
||||||
|
pset.parent = callbacks;
|
||||||
|
target[key] = value;
|
||||||
|
} else {
|
||||||
|
const subCallbacks = PSet.createChild(callbacks);
|
||||||
|
target[key] = observeValue(value, subCallbacks);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
notify(target);
|
||||||
|
}
|
||||||
|
return true;
|
||||||
|
},
|
||||||
|
deleteProperty(target: any, key: any) {
|
||||||
|
if (key in target) {
|
||||||
|
delete target[key];
|
||||||
|
notify(target);
|
||||||
|
}
|
||||||
|
return true;
|
||||||
|
},
|
||||||
|
});
|
||||||
|
observers.set(value, callbacks);
|
||||||
|
observers.set(proxy, callbacks);
|
||||||
|
return proxy;
|
||||||
|
}
|
||||||
|
|
||||||
|
function notify(value: any) {
|
||||||
|
const cbs = observers.get(value)!;
|
||||||
|
for (let cb of cbs) {
|
||||||
|
cb();
|
||||||
|
}
|
||||||
|
}
|
||||||
+36
@@ -0,0 +1,36 @@
|
|||||||
|
// -----------------------------------------------------------------------------
|
||||||
|
// useRef
|
||||||
|
// -----------------------------------------------------------------------------
|
||||||
|
|
||||||
|
import type { Component } from "./component/component";
|
||||||
|
import { getCurrent } from "./component/component_node";
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The purpose of this hook is to allow components to get a reference to a sub
|
||||||
|
* html node or component.
|
||||||
|
*/
|
||||||
|
interface Ref<C extends Component = Component> {
|
||||||
|
el: HTMLElement | null;
|
||||||
|
comp: C | null;
|
||||||
|
}
|
||||||
|
|
||||||
|
export function useRef<C extends Component = Component>(name: string): Ref<C> {
|
||||||
|
const node = getCurrent()!;
|
||||||
|
return {
|
||||||
|
get el(): HTMLElement | null {
|
||||||
|
const val = node.refs[name];
|
||||||
|
return val!;
|
||||||
|
// if (val instanceof HTMLElement) {
|
||||||
|
// return val;
|
||||||
|
// } else if (val instanceof Component) {
|
||||||
|
// return val.el;
|
||||||
|
// }
|
||||||
|
// return null;
|
||||||
|
},
|
||||||
|
get comp(): C | null {
|
||||||
|
return null;
|
||||||
|
// const val = node.refs && node.refs[name];
|
||||||
|
// return val instanceof Component ? (val as C) : null;
|
||||||
|
},
|
||||||
|
};
|
||||||
|
}
|
||||||
@@ -1,184 +0,0 @@
|
|||||||
import { Component, ComponentConstructor, Props } from "./component";
|
|
||||||
import { ComponentNode } from "./component_node";
|
|
||||||
import { nodeErrorHandlers } from "./error_handling";
|
|
||||||
import { Fiber, 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.`;
|
|
||||||
};
|
|
||||||
|
|
||||||
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;
|
|
||||||
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) {
|
|
||||||
console.error(e);
|
|
||||||
} else {
|
|
||||||
reject(e);
|
|
||||||
}
|
|
||||||
throw e;
|
|
||||||
});
|
|
||||||
});
|
|
||||||
node.mountComponent(target, options);
|
|
||||||
return promise;
|
|
||||||
}
|
|
||||||
|
|
||||||
destroy() {
|
|
||||||
if (this.root) {
|
|
||||||
this.scheduler.flush();
|
|
||||||
this.root.destroy();
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
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) {
|
|
||||||
C = parent.constructor.components[name as any];
|
|
||||||
if (!C) {
|
|
||||||
throw new Error(`Cannot find the definition of component "${name}"`);
|
|
||||||
} else if (!(C.prototype instanceof Component)) {
|
|
||||||
throw new Error(
|
|
||||||
`"${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;
|
|
||||||
};
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
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);
|
|
||||||
}
|
|
||||||
@@ -1,101 +0,0 @@
|
|||||||
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 !== afterNode) {
|
|
||||||
if (currentNode.contains(target)) {
|
|
||||||
return origFn.call(this, ev);
|
|
||||||
}
|
|
||||||
currentNode = currentNode.nextSibling;
|
|
||||||
}
|
|
||||||
};
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
moveBefore(other: VCatcher | null, afterNode: Node | null) {
|
|
||||||
this.child.moveBefore(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);
|
|
||||||
};
|
|
||||||
}
|
|
||||||
@@ -1,100 +0,0 @@
|
|||||||
import { config } from "./config";
|
|
||||||
|
|
||||||
type EventHandlerSetter = (this: HTMLElement, data: any) => void;
|
|
||||||
|
|
||||||
interface EventHandlerCreator {
|
|
||||||
setup: EventHandlerSetter;
|
|
||||||
update: EventHandlerSetter;
|
|
||||||
remove: (this: HTMLElement) => void;
|
|
||||||
}
|
|
||||||
|
|
||||||
export function createEventHandler(rawEvent: string): EventHandlerCreator {
|
|
||||||
const eventName = rawEvent.split(".")[0];
|
|
||||||
const capture = rawEvent.includes(".capture");
|
|
||||||
if (rawEvent.includes(".synthetic")) {
|
|
||||||
return createSyntheticHandler(eventName, capture);
|
|
||||||
} else {
|
|
||||||
return createElementHandler(eventName, capture);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// Native listener
|
|
||||||
let nextNativeEventId = 1;
|
|
||||||
function createElementHandler(evName: string, capture: boolean = false): EventHandlerCreator {
|
|
||||||
let eventKey = `__event__${evName}_${nextNativeEventId++}`;
|
|
||||||
if (capture) {
|
|
||||||
eventKey = `${eventKey}_capture`;
|
|
||||||
}
|
|
||||||
|
|
||||||
function listener(ev: Event) {
|
|
||||||
const currentTarget = ev.currentTarget;
|
|
||||||
if (!currentTarget || !document.contains(currentTarget as HTMLElement)) return;
|
|
||||||
const data = (currentTarget as any)[eventKey];
|
|
||||||
if (!data) return;
|
|
||||||
config.mainEventHandler(data, ev, currentTarget);
|
|
||||||
}
|
|
||||||
|
|
||||||
function setup(this: HTMLElement, data: any) {
|
|
||||||
(this as any)[eventKey] = data;
|
|
||||||
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, remove };
|
|
||||||
}
|
|
||||||
|
|
||||||
// Synthetic handler: a form of event delegation that allows placing only one
|
|
||||||
// listener per event type.
|
|
||||||
let nextSyntheticEventId = 1;
|
|
||||||
function createSyntheticHandler(evName: string, capture: boolean = false): EventHandlerCreator {
|
|
||||||
let eventKey = `__event__synthetic_${evName}`;
|
|
||||||
if (capture) {
|
|
||||||
eventKey = `${eventKey}_capture`;
|
|
||||||
}
|
|
||||||
setupSyntheticEvent(evName, eventKey, capture);
|
|
||||||
const currentId = nextSyntheticEventId++;
|
|
||||||
function setup(this: HTMLElement, data: any) {
|
|
||||||
const _data = (this as any)[eventKey] || {};
|
|
||||||
_data[currentId] = data;
|
|
||||||
(this as any)[eventKey] = _data;
|
|
||||||
}
|
|
||||||
|
|
||||||
function remove(this: HTMLElement) {
|
|
||||||
delete (this as any)[eventKey];
|
|
||||||
}
|
|
||||||
|
|
||||||
return { setup, update: setup, remove };
|
|
||||||
}
|
|
||||||
|
|
||||||
function nativeToSyntheticEvent(eventKey: string, event: Event) {
|
|
||||||
let dom = event.target;
|
|
||||||
while (dom !== null) {
|
|
||||||
const _data = (dom as any)[eventKey];
|
|
||||||
if (_data) {
|
|
||||||
for (const data of Object.values(_data)) {
|
|
||||||
const stopped = config.mainEventHandler(data, event, dom);
|
|
||||||
if (stopped) return;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
dom = (dom as any).parentNode;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
const CONFIGURED_SYNTHETIC_EVENTS: { [event: string]: boolean } = {};
|
|
||||||
|
|
||||||
function setupSyntheticEvent(evName: string, eventKey: string, capture: boolean = false) {
|
|
||||||
if (CONFIGURED_SYNTHETIC_EVENTS[eventKey]) {
|
|
||||||
return;
|
|
||||||
}
|
|
||||||
document.addEventListener(evName, (event) => nativeToSyntheticEvent(eventKey, event), {
|
|
||||||
capture,
|
|
||||||
});
|
|
||||||
CONFIGURED_SYNTHETIC_EVENTS[eventKey] = true;
|
|
||||||
}
|
|
||||||
@@ -1,44 +0,0 @@
|
|||||||
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);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -1,355 +0,0 @@
|
|||||||
import type { App, Env } from "./app";
|
|
||||||
import { BDom, VNode } from "./blockdom";
|
|
||||||
import { Component, ComponentConstructor, Props } from "./component";
|
|
||||||
import { fibersInError, handleError } from "./error_handling";
|
|
||||||
import { Fiber, makeChildFiber, makeRootFiber, MountFiber, MountOptions } from "./fibers";
|
|
||||||
import {
|
|
||||||
clearReactivesForCallback,
|
|
||||||
getSubscriptions,
|
|
||||||
NonReactive,
|
|
||||||
Reactive,
|
|
||||||
reactive,
|
|
||||||
TARGET,
|
|
||||||
} from "./reactivity";
|
|
||||||
import { STATUS } from "./status";
|
|
||||||
import { batched, Callback } from "./utils";
|
|
||||||
|
|
||||||
let currentNode: ComponentNode | null = null;
|
|
||||||
|
|
||||||
export function getCurrent(): ComponentNode {
|
|
||||||
if (!currentNode) {
|
|
||||||
throw new Error("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): Reactive<T> | NonReactive<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;
|
|
||||||
level: number;
|
|
||||||
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;
|
|
||||||
this.level = parent ? parent.level + 1 : 0;
|
|
||||||
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" && prop[TARGET]) {
|
|
||||||
props[key] = useState(prop);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
this.component = new C(props, env, this);
|
|
||||||
this.renderFn = app.getTemplate(C.template).bind(this.component, this.component, 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) {
|
|
||||||
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) {
|
|
||||||
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" && prop[TARGET]) {
|
|
||||||
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;
|
|
||||||
}
|
|
||||||
|
|
||||||
moveBefore(other: ComponentNode | null, afterNode: Node | null) {
|
|
||||||
this.bdom!.moveBefore(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;
|
|
||||||
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) : [];
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -1,63 +0,0 @@
|
|||||||
import type { ComponentNode } from "./component_node";
|
|
||||||
import type { Fiber } from "./fibers";
|
|
||||||
|
|
||||||
// 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): boolean {
|
|
||||||
if (!node) {
|
|
||||||
return false;
|
|
||||||
}
|
|
||||||
const fiber = node.fiber;
|
|
||||||
if (fiber) {
|
|
||||||
fibersInError.set(fiber, error);
|
|
||||||
}
|
|
||||||
|
|
||||||
const errorHandlers = nodeErrorHandlers.get(node);
|
|
||||||
if (errorHandlers) {
|
|
||||||
let handled = false;
|
|
||||||
// execute in the opposite order
|
|
||||||
for (let i = errorHandlers.length - 1; i >= 0; i--) {
|
|
||||||
try {
|
|
||||||
errorHandlers[i](error);
|
|
||||||
handled = true;
|
|
||||||
break;
|
|
||||||
} catch (e) {
|
|
||||||
error = e;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
if (handled) {
|
|
||||||
return true;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
return _handleError(node.parent, error);
|
|
||||||
}
|
|
||||||
|
|
||||||
type ErrorParams = { error: any } & ({ node: ComponentNode } | { fiber: Fiber });
|
|
||||||
export function handleError(params: ErrorParams) {
|
|
||||||
const error = params.error;
|
|
||||||
const node = "node" in params ? params.node : params.fiber.node;
|
|
||||||
const fiber = "fiber" in params ? params.fiber : node.fiber!;
|
|
||||||
|
|
||||||
// resets the fibers on components if possible. This is important so that
|
|
||||||
// new renderings can be properly included in the initial one, if any.
|
|
||||||
let current: Fiber | null = fiber;
|
|
||||||
do {
|
|
||||||
current.node.fiber = current;
|
|
||||||
current = current.parent;
|
|
||||||
} while (current);
|
|
||||||
|
|
||||||
fibersInError.set(fiber.root!, error);
|
|
||||||
|
|
||||||
const handled = _handleError(node, error);
|
|
||||||
if (!handled) {
|
|
||||||
console.warn(`[Owl] Unhandled error. Destroying the root component`);
|
|
||||||
try {
|
|
||||||
node.app.destroy();
|
|
||||||
} catch (e) {
|
|
||||||
console.error(e);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -1,44 +0,0 @@
|
|||||||
import { filterOutModifiersFromData } from "./blockdom/config";
|
|
||||||
import { STATUS } from "./status";
|
|
||||||
|
|
||||||
export const mainEventHandler = (data: any, ev: Event, currentTarget?: EventTarget | null) => {
|
|
||||||
const { data: _data, modifiers } = filterOutModifiersFromData(data);
|
|
||||||
data = _data;
|
|
||||||
let stopped = false;
|
|
||||||
if (modifiers.length) {
|
|
||||||
let selfMode = false;
|
|
||||||
const isSelf = ev.target === currentTarget;
|
|
||||||
for (const mod of modifiers) {
|
|
||||||
switch (mod) {
|
|
||||||
case "self":
|
|
||||||
selfMode = true;
|
|
||||||
if (isSelf) {
|
|
||||||
continue;
|
|
||||||
} else {
|
|
||||||
return stopped;
|
|
||||||
}
|
|
||||||
case "prevent":
|
|
||||||
if ((selfMode && isSelf) || !selfMode) ev.preventDefault();
|
|
||||||
continue;
|
|
||||||
case "stop":
|
|
||||||
if ((selfMode && isSelf) || !selfMode) ev.stopPropagation();
|
|
||||||
stopped = true;
|
|
||||||
continue;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
// If handler is empty, the array slot 0 will also be empty, and data will not have the property 0
|
|
||||||
// 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)) {
|
|
||||||
const handler = data[0];
|
|
||||||
if (typeof handler !== "function") {
|
|
||||||
throw new Error(`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;
|
|
||||||
};
|
|
||||||
@@ -1,265 +0,0 @@
|
|||||||
import { BDom, mount } from "./blockdom";
|
|
||||||
import type { ComponentNode } from "./component_node";
|
|
||||||
import { fibersInError, handleError } from "./error_handling";
|
|
||||||
import { STATUS } from "./status";
|
|
||||||
|
|
||||||
export function makeChildFiber(node: ComponentNode, parent: Fiber): Fiber {
|
|
||||||
let current = node.fiber;
|
|
||||||
if (current) {
|
|
||||||
cancelFibers(current.children);
|
|
||||||
current.root = null;
|
|
||||||
}
|
|
||||||
return new Fiber(node, parent);
|
|
||||||
}
|
|
||||||
|
|
||||||
export function makeRootFiber(node: ComponentNode): Fiber {
|
|
||||||
let current = node.fiber;
|
|
||||||
if (current) {
|
|
||||||
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 = [];
|
|
||||||
current.childrenMap = {};
|
|
||||||
current.bdom = null;
|
|
||||||
if (fibersInError.has(current)) {
|
|
||||||
fibersInError.delete(current);
|
|
||||||
fibersInError.delete(root);
|
|
||||||
current.appliedToDom = false;
|
|
||||||
}
|
|
||||||
return current;
|
|
||||||
}
|
|
||||||
const fiber = new RootFiber(node, null);
|
|
||||||
if (node.willPatch.length) {
|
|
||||||
fiber.willPatch.push(fiber);
|
|
||||||
}
|
|
||||||
if (node.patched.length) {
|
|
||||||
fiber.patched.push(fiber);
|
|
||||||
}
|
|
||||||
return fiber;
|
|
||||||
}
|
|
||||||
|
|
||||||
function throwOnRender() {
|
|
||||||
throw new Error("Attempted to render cancelled fiber");
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* @returns number of not-yet rendered fibers cancelled
|
|
||||||
*/
|
|
||||||
function cancelFibers(fibers: Fiber[]): number {
|
|
||||||
let result = 0;
|
|
||||||
for (let fiber of fibers) {
|
|
||||||
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(fiber.children);
|
|
||||||
}
|
|
||||||
return result;
|
|
||||||
}
|
|
||||||
|
|
||||||
export class Fiber {
|
|
||||||
node: ComponentNode;
|
|
||||||
bdom: BDom | null = null;
|
|
||||||
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) {
|
|
||||||
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) {
|
|
||||||
handleError({ node, error: e });
|
|
||||||
}
|
|
||||||
root.setCounter(root.counter - 1);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
export class RootFiber extends Fiber {
|
|
||||||
counter: number = 1;
|
|
||||||
|
|
||||||
// only add stuff in this if they have registered some hooks
|
|
||||||
willPatch: Fiber[] = [];
|
|
||||||
patched: Fiber[] = [];
|
|
||||||
mounted: Fiber[] = [];
|
|
||||||
// A fiber is typically locked when it is completing and the patch has not, or is being applied.
|
|
||||||
// i.e.: render triggered in onWillUnmount or in willPatch will be delayed
|
|
||||||
locked: boolean = false;
|
|
||||||
|
|
||||||
complete() {
|
|
||||||
const node = this.node;
|
|
||||||
this.locked = true;
|
|
||||||
let current: Fiber | undefined = undefined;
|
|
||||||
try {
|
|
||||||
// Step 1: calling all willPatch lifecycle hooks
|
|
||||||
for (current of this.willPatch) {
|
|
||||||
// because of the asynchronous nature of the rendering, some parts of the
|
|
||||||
// UI may have been rendered, then deleted in a followup rendering, and we
|
|
||||||
// do not want to call onWillPatch in that case.
|
|
||||||
let node = current.node;
|
|
||||||
if (node.fiber === current) {
|
|
||||||
const component = node.component;
|
|
||||||
for (let cb of node.willPatch) {
|
|
||||||
cb.call(component);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
current = undefined;
|
|
||||||
|
|
||||||
// Step 2: patching the dom
|
|
||||||
node._patch();
|
|
||||||
this.locked = false;
|
|
||||||
|
|
||||||
// Step 4: calling all mounted lifecycle hooks
|
|
||||||
let mountedFibers = this.mounted;
|
|
||||||
while ((current = mountedFibers.pop())) {
|
|
||||||
current = current;
|
|
||||||
if (current.appliedToDom) {
|
|
||||||
for (let cb of current.node.mounted) {
|
|
||||||
cb();
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// Step 5: calling all patched hooks
|
|
||||||
let patchedFibers = this.patched;
|
|
||||||
while ((current = patchedFibers.pop())) {
|
|
||||||
current = current;
|
|
||||||
if (current.appliedToDom) {
|
|
||||||
for (let cb of current.node.patched) {
|
|
||||||
cb();
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
} catch (e) {
|
|
||||||
this.locked = false;
|
|
||||||
handleError({ fiber: current || this, error: e });
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
setCounter(newValue: number) {
|
|
||||||
this.counter = newValue;
|
|
||||||
if (newValue === 0) {
|
|
||||||
this.node.app.scheduler.flush();
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
type Position = "first-child" | "last-child";
|
|
||||||
|
|
||||||
export interface MountOptions {
|
|
||||||
position?: Position;
|
|
||||||
}
|
|
||||||
|
|
||||||
export class MountFiber extends RootFiber {
|
|
||||||
target: HTMLElement;
|
|
||||||
position: Position;
|
|
||||||
|
|
||||||
constructor(node: ComponentNode, target: HTMLElement, options: MountOptions = {}) {
|
|
||||||
super(node, null);
|
|
||||||
this.target = target;
|
|
||||||
this.position = options.position || "last-child";
|
|
||||||
}
|
|
||||||
complete() {
|
|
||||||
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,
|
|
||||||
// but a crash occurred in some mounted hook. Then, it was handled and
|
|
||||||
// the new rendering is being applied.
|
|
||||||
node.updateDom();
|
|
||||||
} else {
|
|
||||||
node.bdom = this.bdom;
|
|
||||||
if (this.position === "last-child" || this.target.childNodes.length === 0) {
|
|
||||||
mount(node.bdom!, this.target);
|
|
||||||
} else {
|
|
||||||
const firstChild = this.target.childNodes[0];
|
|
||||||
mount(node.bdom!, this.target, firstChild);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// unregistering the fiber before mounted since it can do another render
|
|
||||||
// and that the current rendering is obviously completed
|
|
||||||
node.fiber = null;
|
|
||||||
|
|
||||||
node.status = STATUS.MOUNTED;
|
|
||||||
this.appliedToDom = true;
|
|
||||||
let mountedFibers = this.mounted;
|
|
||||||
while ((current = mountedFibers.pop())) {
|
|
||||||
if (current.appliedToDom) {
|
|
||||||
for (let cb of current.node.mounted) {
|
|
||||||
cb();
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
} catch (e) {
|
|
||||||
handleError({ fiber: current as Fiber, error: e });
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -1,129 +0,0 @@
|
|||||||
import type { Env } from "./app";
|
|
||||||
import { getCurrent } from "./component_node";
|
|
||||||
import { onMounted, onPatched, onWillUnmount } from "./lifecycle_hooks";
|
|
||||||
|
|
||||||
// -----------------------------------------------------------------------------
|
|
||||||
// useRef
|
|
||||||
// -----------------------------------------------------------------------------
|
|
||||||
|
|
||||||
/**
|
|
||||||
* The purpose of this hook is to allow components to get a reference to a sub
|
|
||||||
* html node or component.
|
|
||||||
*/
|
|
||||||
export function useRef<T extends HTMLElement = HTMLElement>(name: string): { el: T | null } {
|
|
||||||
const node = getCurrent();
|
|
||||||
const refs = node.refs;
|
|
||||||
return {
|
|
||||||
get el(): T | null {
|
|
||||||
return refs[name] || null;
|
|
||||||
},
|
|
||||||
};
|
|
||||||
}
|
|
||||||
|
|
||||||
// -----------------------------------------------------------------------------
|
|
||||||
// useEnv and useSubEnv
|
|
||||||
// -----------------------------------------------------------------------------
|
|
||||||
|
|
||||||
/**
|
|
||||||
* This hook is useful as a building block for some customized hooks, that may
|
|
||||||
* need a reference to the env of the component calling them.
|
|
||||||
*/
|
|
||||||
export function useEnv<E extends Env>(): E {
|
|
||||||
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));
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* This hook is a simple way to let components use a sub environment. Note that
|
|
||||||
* like for all hooks, it is important that this is only called in the
|
|
||||||
* constructor method.
|
|
||||||
*/
|
|
||||||
export function useSubEnv(envExtension: Env) {
|
|
||||||
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
|
|
||||||
// -----------------------------------------------------------------------------
|
|
||||||
|
|
||||||
/**
|
|
||||||
* @param {...any} dependencies the dependencies computed by computeDependencies
|
|
||||||
* @returns {void|(()=>void)} a cleanup function that reverses the side
|
|
||||||
* effects of the effect callback.
|
|
||||||
*/
|
|
||||||
type Effect = (...dependencies: any[]) => void | (() => void);
|
|
||||||
|
|
||||||
/**
|
|
||||||
* 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.
|
|
||||||
*
|
|
||||||
* @param {Effect} effect the effect to run on component mount and/or patch
|
|
||||||
* @param {()=>any[]} [computeDependencies=()=>[NaN]] a callback to compute
|
|
||||||
* dependencies that will decide if the effect needs to be cleaned up and
|
|
||||||
* run again. If the dependencies did not change, the effect will not run
|
|
||||||
* again. The default value returns an array containing only NaN because
|
|
||||||
* NaN !== NaN, which will cause the effect to rerun on every patch.
|
|
||||||
*/
|
|
||||||
export function useEffect(effect: Effect, computeDependencies: () => any[] = () => [NaN]) {
|
|
||||||
let cleanup: (() => void) | void;
|
|
||||||
let dependencies: any[];
|
|
||||||
onMounted(() => {
|
|
||||||
dependencies = computeDependencies();
|
|
||||||
cleanup = effect(...dependencies);
|
|
||||||
});
|
|
||||||
|
|
||||||
onPatched(() => {
|
|
||||||
const newDeps = computeDependencies();
|
|
||||||
const shouldReapply = newDeps.some((val, i) => val !== dependencies[i]);
|
|
||||||
if (shouldReapply) {
|
|
||||||
dependencies = newDeps;
|
|
||||||
if (cleanup) {
|
|
||||||
cleanup();
|
|
||||||
}
|
|
||||||
cleanup = effect(...dependencies);
|
|
||||||
}
|
|
||||||
});
|
|
||||||
|
|
||||||
onWillUnmount(() => cleanup && cleanup());
|
|
||||||
}
|
|
||||||
|
|
||||||
// -----------------------------------------------------------------------------
|
|
||||||
// useExternalListener
|
|
||||||
// -----------------------------------------------------------------------------
|
|
||||||
|
|
||||||
/**
|
|
||||||
* When a component needs to listen to DOM Events on element(s) that are not
|
|
||||||
* part of his hierarchy, we can use the `useExternalListener` hook.
|
|
||||||
* It will correctly add and remove the event listener, whenever the
|
|
||||||
* component is mounted and unmounted.
|
|
||||||
*
|
|
||||||
* Example:
|
|
||||||
* a menu needs to listen to the click on window to be closed automatically
|
|
||||||
*
|
|
||||||
* Usage:
|
|
||||||
* in the constructor of the OWL component that needs to be notified,
|
|
||||||
* `useExternalListener(window, 'click', this._doSomething);`
|
|
||||||
* */
|
|
||||||
export function useExternalListener(
|
|
||||||
target: HTMLElement | typeof window,
|
|
||||||
eventName: string,
|
|
||||||
handler: EventListener,
|
|
||||||
eventParams?: AddEventListenerOptions
|
|
||||||
) {
|
|
||||||
const node = getCurrent();
|
|
||||||
const boundHandler = handler.bind(node.component);
|
|
||||||
onMounted(() => target.addEventListener(eventName, boundHandler, eventParams));
|
|
||||||
onWillUnmount(() => target.removeEventListener(eventName, boundHandler, eventParams));
|
|
||||||
}
|
|
||||||
@@ -1,58 +0,0 @@
|
|||||||
import {
|
|
||||||
config,
|
|
||||||
createBlock,
|
|
||||||
html,
|
|
||||||
list,
|
|
||||||
mount as blockMount,
|
|
||||||
multi,
|
|
||||||
patch,
|
|
||||||
remove,
|
|
||||||
text,
|
|
||||||
toggler,
|
|
||||||
comment,
|
|
||||||
} from "./blockdom";
|
|
||||||
import { mainEventHandler } from "./event_handling";
|
|
||||||
export type { Reactive } from "./reactivity";
|
|
||||||
|
|
||||||
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 { 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 const __info__ = {};
|
|
||||||
@@ -1,122 +0,0 @@
|
|||||||
import { getCurrent } from "./component_node";
|
|
||||||
import { nodeErrorHandlers } from "./error_handling";
|
|
||||||
|
|
||||||
const TIMEOUT = Symbol("timeout");
|
|
||||||
function wrapError(fn: (...args: any[]) => any, hookName: string) {
|
|
||||||
const error = new Error(`The following error occurred in ${hookName}: `) as Error & {
|
|
||||||
cause: any;
|
|
||||||
};
|
|
||||||
const timeoutError = new Error(`${hookName}'s promise hasn't resolved after 3 seconds`);
|
|
||||||
const node = getCurrent();
|
|
||||||
return (...args: any[]) => {
|
|
||||||
try {
|
|
||||||
const result = fn(...args);
|
|
||||||
if (result instanceof Promise) {
|
|
||||||
if (hookName === "onWillStart" || hookName === "onWillUpdateProps") {
|
|
||||||
const fiber = node.fiber;
|
|
||||||
Promise.race([
|
|
||||||
result,
|
|
||||||
new Promise((resolve) => setTimeout(() => resolve(TIMEOUT), 3000)),
|
|
||||||
]).then((res) => {
|
|
||||||
if (res === TIMEOUT && node.fiber === fiber) {
|
|
||||||
console.warn(timeoutError);
|
|
||||||
}
|
|
||||||
});
|
|
||||||
}
|
|
||||||
return result.catch((cause) => {
|
|
||||||
error.cause = cause;
|
|
||||||
if (cause instanceof Error) {
|
|
||||||
error.message += `"${cause.message}"`;
|
|
||||||
}
|
|
||||||
throw error;
|
|
||||||
});
|
|
||||||
}
|
|
||||||
return result;
|
|
||||||
} catch (cause) {
|
|
||||||
if (cause instanceof Error) {
|
|
||||||
error.message += `"${cause.message}"`;
|
|
||||||
}
|
|
||||||
throw error;
|
|
||||||
}
|
|
||||||
};
|
|
||||||
}
|
|
||||||
|
|
||||||
// -----------------------------------------------------------------------------
|
|
||||||
// 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));
|
|
||||||
}
|
|
||||||
@@ -1,457 +0,0 @@
|
|||||||
import { Callback } from "./utils";
|
|
||||||
|
|
||||||
// Allows to get the target of a Reactive (used for making a new Reactive from the underlying object)
|
|
||||||
export const TARGET = Symbol("Target");
|
|
||||||
// Escape hatch to prevent reactivity system to turn something into a reactive
|
|
||||||
const SKIP = Symbol("Skip");
|
|
||||||
// Special key to subscribe to, to be notified of key creation/deletion
|
|
||||||
const KEYCHANGES = Symbol("Key changes");
|
|
||||||
|
|
||||||
type Target = object;
|
|
||||||
type Collection = Set<any> | Map<any, any> | WeakMap<any, any>;
|
|
||||||
type CollectionRawType = "Set" | "Map" | "WeakMap";
|
|
||||||
|
|
||||||
export type Reactive<T extends Target = Target> = T & {
|
|
||||||
[TARGET]: any;
|
|
||||||
};
|
|
||||||
|
|
||||||
export type NonReactive<T extends Target = Target> = T & {
|
|
||||||
[SKIP]: any;
|
|
||||||
};
|
|
||||||
|
|
||||||
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(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;
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* 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): NonReactive<T> {
|
|
||||||
(value as any)[SKIP] = true;
|
|
||||||
return value as NonReactive<T>;
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* 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 object>(value: Reactive<T>): T {
|
|
||||||
return value[TARGET] || 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 (!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 callbacks of observedKeys.values()) {
|
|
||||||
callbacks.delete(callback);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
targetsToClear.clear();
|
|
||||||
}
|
|
||||||
|
|
||||||
export function getSubscriptions(callback: Callback) {
|
|
||||||
const targets = callbacksToTargets.get(callback) || [];
|
|
||||||
return [...targets].map((target) => {
|
|
||||||
const keysToCallbacks = targetToKeysToCallbacks.get(target);
|
|
||||||
return {
|
|
||||||
target,
|
|
||||||
keys: keysToCallbacks ? [...keysToCallbacks.keys()] : [],
|
|
||||||
};
|
|
||||||
});
|
|
||||||
}
|
|
||||||
|
|
||||||
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> | NonReactive<T> {
|
|
||||||
if (!canBeMadeReactive(target)) {
|
|
||||||
throw new Error(`Cannot make the given value reactive`);
|
|
||||||
}
|
|
||||||
if (SKIP in target) {
|
|
||||||
return target as NonReactive<T>;
|
|
||||||
}
|
|
||||||
const originalTarget = (target as Reactive)[TARGET];
|
|
||||||
if (originalTarget) {
|
|
||||||
return reactive(originalTarget, 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);
|
|
||||||
}
|
|
||||||
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: any, key: PropertyKey, proxy: Reactive<T>) {
|
|
||||||
if (key === TARGET) {
|
|
||||||
return target;
|
|
||||||
}
|
|
||||||
// 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, proxy);
|
|
||||||
}
|
|
||||||
observeTargetKey(target, key, callback);
|
|
||||||
return possiblyReactive(Reflect.get(target, key, proxy), callback);
|
|
||||||
},
|
|
||||||
set(target, key, value, proxy) {
|
|
||||||
const isNewKey = !objectHasOwnProperty.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);
|
|
||||||
// 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), {
|
|
||||||
get(target: any, key: PropertyKey) {
|
|
||||||
if (key === TARGET) {
|
|
||||||
return target;
|
|
||||||
}
|
|
||||||
if (objectHasOwnProperty.call(specialHandlers, key)) {
|
|
||||||
return (specialHandlers as any)[key];
|
|
||||||
}
|
|
||||||
observeTargetKey(target, key, callback);
|
|
||||||
return possiblyReactive(target[key], callback);
|
|
||||||
},
|
|
||||||
}) as ProxyHandler<T>;
|
|
||||||
}
|
|
||||||
@@ -1,76 +0,0 @@
|
|||||||
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);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -1,267 +0,0 @@
|
|||||||
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";
|
|
||||||
|
|
||||||
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.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 = ObjectCreate(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;
|
|
||||||
component: any;
|
|
||||||
node: any;
|
|
||||||
constructor(fn: any, ctx: any, component: any, node: any) {
|
|
||||||
this.fn = fn;
|
|
||||||
this.ctx = capture(ctx);
|
|
||||||
this.component = component;
|
|
||||||
this.node = node;
|
|
||||||
}
|
|
||||||
|
|
||||||
evaluate(): any {
|
|
||||||
return this.fn.call(this.component, 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, 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(ctx: any, fn: Function): Function {
|
|
||||||
let component = ctx.__owl__.component;
|
|
||||||
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 Error("Cannot have 2 elements with same ref name at the same time");
|
|
||||||
}
|
|
||||||
}
|
|
||||||
if (count === 0 || el) {
|
|
||||||
refs[name] = 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, parent?: any) {
|
|
||||||
const ComponentClass =
|
|
||||||
typeof name !== "string"
|
|
||||||
? name
|
|
||||||
: (parent.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 (parent.__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 Error(
|
|
||||||
`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 Error(`Invalid props for component '${ComponentClass.name}': ` + errors.join(", "));
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
export const helpers = {
|
|
||||||
withDefault,
|
|
||||||
zero: Symbol("zero"),
|
|
||||||
isBoundary,
|
|
||||||
callSlot,
|
|
||||||
capture,
|
|
||||||
withKey,
|
|
||||||
prepareList,
|
|
||||||
setContextValue,
|
|
||||||
multiRefSetter,
|
|
||||||
shallowEqual,
|
|
||||||
toNumber,
|
|
||||||
validateProps,
|
|
||||||
LazyValue,
|
|
||||||
safeOutput,
|
|
||||||
bind,
|
|
||||||
createCatcher,
|
|
||||||
markRaw,
|
|
||||||
};
|
|
||||||
@@ -1,145 +0,0 @@
|
|||||||
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";
|
|
||||||
|
|
||||||
const bdom = { text, createBlock, list, multi, html, toggler, comment };
|
|
||||||
|
|
||||||
function parseXML(xml: string): Document {
|
|
||||||
const parser = new DOMParser();
|
|
||||||
|
|
||||||
const doc = parser.parseFromString(xml, "text/xml");
|
|
||||||
if (doc.getElementsByTagName("parsererror").length) {
|
|
||||||
let msg = "Invalid XML in template.";
|
|
||||||
const parsererrorText = doc.getElementsByTagName("parsererror")[0].textContent;
|
|
||||||
if (parsererrorText) {
|
|
||||||
msg += "\nThe parser has produced the following error message:\n" + parsererrorText;
|
|
||||||
const re = /\d+/g;
|
|
||||||
const firstMatch = re.exec(parsererrorText);
|
|
||||||
if (firstMatch) {
|
|
||||||
const lineNumber = Number(firstMatch[0]);
|
|
||||||
const line = xml.split("\n")[lineNumber - 1];
|
|
||||||
const secondMatch = re.exec(parsererrorText);
|
|
||||||
if (line && secondMatch) {
|
|
||||||
const columnIndex = Number(secondMatch[0]) - 1;
|
|
||||||
if (line[columnIndex]) {
|
|
||||||
msg +=
|
|
||||||
`\nThe error might be located at xml line ${lineNumber} column ${columnIndex}\n` +
|
|
||||||
`${line}\n${"-".repeat(columnIndex - 1)}^`;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
throw new Error(msg);
|
|
||||||
}
|
|
||||||
return doc;
|
|
||||||
}
|
|
||||||
|
|
||||||
export interface TemplateSetConfig {
|
|
||||||
dev?: boolean;
|
|
||||||
translatableAttributes?: string[];
|
|
||||||
translateFn?: (s: string) => string;
|
|
||||||
templates?: string | Document;
|
|
||||||
}
|
|
||||||
|
|
||||||
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[];
|
|
||||||
Portal = Portal;
|
|
||||||
|
|
||||||
constructor(config: TemplateSetConfig = {}) {
|
|
||||||
this.dev = config.dev || false;
|
|
||||||
this.translateFn = config.translateFn;
|
|
||||||
this.translatableAttributes = config.translatableAttributes;
|
|
||||||
if (config.templates) {
|
|
||||||
this.addTemplates(config.templates);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
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 Error(`Template ${name} already defined with different content`);
|
|
||||||
}
|
|
||||||
this.rawTemplates[name] = template;
|
|
||||||
}
|
|
||||||
|
|
||||||
addTemplates(xml: string | Document) {
|
|
||||||
if (!xml) {
|
|
||||||
// empty string
|
|
||||||
return;
|
|
||||||
}
|
|
||||||
xml = xml instanceof Document ? xml : parseXML(xml);
|
|
||||||
for (const template of xml.querySelectorAll("[t-name]")) {
|
|
||||||
const name = template.getAttribute("t-name")!;
|
|
||||||
this.addTemplate(name, template);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
getTemplate(name: string): Template {
|
|
||||||
if (!(name in this.templates)) {
|
|
||||||
const rawTemplate = this.rawTemplates[name];
|
|
||||||
if (rawTemplate === undefined) {
|
|
||||||
let extraInfo = "";
|
|
||||||
try {
|
|
||||||
const componentName = getCurrent().component.constructor.name;
|
|
||||||
extraInfo = ` (for component "${componentName}")`;
|
|
||||||
} catch {}
|
|
||||||
throw new Error(`Missing template: "${name}"${extraInfo}`);
|
|
||||||
}
|
|
||||||
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
|
|
||||||
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 | Element): ReturnType<typeof compile> {
|
|
||||||
throw new Error(`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);
|
|
||||||
globalTemplates[name] = value;
|
|
||||||
return name;
|
|
||||||
}
|
|
||||||
|
|
||||||
xml.nextId = 1;
|
|
||||||
|
|
||||||
TemplateSet.registerTemplate("__portal__", portalTemplate);
|
|
||||||
@@ -1,75 +0,0 @@
|
|||||||
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) {
|
|
||||||
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");
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
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);
|
|
||||||
}
|
|
||||||
@@ -1,167 +0,0 @@
|
|||||||
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 Error("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);
|
|
||||||
}
|
|
||||||
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;
|
|
||||||
}
|
|
||||||
+14
@@ -0,0 +1,14 @@
|
|||||||
|
import { globalTemplates } from "./qweb/template_helpers";
|
||||||
|
|
||||||
|
// -----------------------------------------------------------------------------
|
||||||
|
// Global templates
|
||||||
|
// -----------------------------------------------------------------------------
|
||||||
|
|
||||||
|
export function xml(strings: TemplateStringsArray, ...args: any[]) {
|
||||||
|
const name = `__template__${xml.nextId++}`;
|
||||||
|
const value = String.raw(strings, ...args);
|
||||||
|
globalTemplates[name] = value;
|
||||||
|
return name;
|
||||||
|
}
|
||||||
|
|
||||||
|
xml.nextId = 1;
|
||||||
@@ -1,407 +0,0 @@
|
|||||||
// Jest Snapshot v1, https://goo.gl/fbAQLP
|
|
||||||
|
|
||||||
exports[`Reactivity: useState concurrent renderings 1`] = `
|
|
||||||
"function anonymous(bdom, helpers
|
|
||||||
) {
|
|
||||||
let { text, createBlock, list, multi, html, toggler, component } = bdom;
|
|
||||||
let { withDefault, getTemplate, prepareList, withKey, zero, call, callSlot, capture, isBoundary, shallowEqual, setContextValue, toNumber, safeOutput } = helpers;
|
|
||||||
|
|
||||||
let block1 = createBlock(\`<span><block-text-0/><block-text-1/></span>\`);
|
|
||||||
|
|
||||||
return function template(ctx, node, key = \\"\\") {
|
|
||||||
let d1 = ctx['context'][ctx['props'].key].n;
|
|
||||||
let d2 = ctx['state'].x;
|
|
||||||
return block1([d1, d2]);
|
|
||||||
}
|
|
||||||
}"
|
|
||||||
`;
|
|
||||||
|
|
||||||
exports[`Reactivity: useState concurrent renderings 2`] = `
|
|
||||||
"function anonymous(bdom, helpers
|
|
||||||
) {
|
|
||||||
let { text, createBlock, list, multi, html, toggler, component } = bdom;
|
|
||||||
let { withDefault, getTemplate, prepareList, withKey, zero, call, callSlot, capture, isBoundary, shallowEqual, setContextValue, toNumber, safeOutput } = helpers;
|
|
||||||
|
|
||||||
let block1 = createBlock(\`<p><block-child-0/></p>\`);
|
|
||||||
|
|
||||||
return function template(ctx, node, key = \\"\\") {
|
|
||||||
let b2 = component(\`ComponentC\`, {key: ctx['props'].key}, key + \`__1\`, node, ctx);
|
|
||||||
return block1([], [b2]);
|
|
||||||
}
|
|
||||||
}"
|
|
||||||
`;
|
|
||||||
|
|
||||||
exports[`Reactivity: useState concurrent renderings 3`] = `
|
|
||||||
"function anonymous(bdom, helpers
|
|
||||||
) {
|
|
||||||
let { text, createBlock, list, multi, html, toggler, component } = bdom;
|
|
||||||
let { withDefault, getTemplate, prepareList, withKey, zero, call, callSlot, capture, isBoundary, shallowEqual, setContextValue, toNumber, safeOutput } = helpers;
|
|
||||||
|
|
||||||
let block1 = createBlock(\`<div><block-child-0/></div>\`);
|
|
||||||
|
|
||||||
return function template(ctx, node, key = \\"\\") {
|
|
||||||
let b2 = component(\`ComponentB\`, {key: ctx['context'].key}, key + \`__1\`, node, ctx);
|
|
||||||
return block1([], [b2]);
|
|
||||||
}
|
|
||||||
}"
|
|
||||||
`;
|
|
||||||
|
|
||||||
exports[`Reactivity: useState destroyed component before being mounted is inactive 1`] = `
|
|
||||||
"function anonymous(app, bdom, helpers
|
|
||||||
) {
|
|
||||||
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 = comp1({}, key + \`__1\`, node, this, null);
|
|
||||||
}
|
|
||||||
return block1([], [b2]);
|
|
||||||
}
|
|
||||||
}"
|
|
||||||
`;
|
|
||||||
|
|
||||||
exports[`Reactivity: useState destroyed component before being mounted is inactive 2`] = `
|
|
||||||
"function anonymous(app, bdom, helpers
|
|
||||||
) {
|
|
||||||
let { text, createBlock, list, multi, html, toggler, comment } = bdom;
|
|
||||||
|
|
||||||
let block1 = createBlock(\`<span><block-text-0/></span>\`);
|
|
||||||
|
|
||||||
return function template(ctx, node, key = \\"\\") {
|
|
||||||
let txt1 = ctx['contextObj'].a;
|
|
||||||
return block1([txt1]);
|
|
||||||
}
|
|
||||||
}"
|
|
||||||
`;
|
|
||||||
|
|
||||||
exports[`Reactivity: useState destroyed component is inactive 1`] = `
|
|
||||||
"function anonymous(app, bdom, helpers
|
|
||||||
) {
|
|
||||||
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 = comp1({}, key + \`__1\`, node, this, null);
|
|
||||||
}
|
|
||||||
return block1([], [b2]);
|
|
||||||
}
|
|
||||||
}"
|
|
||||||
`;
|
|
||||||
|
|
||||||
exports[`Reactivity: useState destroyed component is inactive 2`] = `
|
|
||||||
"function anonymous(app, bdom, helpers
|
|
||||||
) {
|
|
||||||
let { text, createBlock, list, multi, html, toggler, comment } = bdom;
|
|
||||||
|
|
||||||
let block1 = createBlock(\`<span><block-text-0/></span>\`);
|
|
||||||
|
|
||||||
return function template(ctx, node, key = \\"\\") {
|
|
||||||
let txt1 = ctx['contextObj'].a;
|
|
||||||
return block1([txt1]);
|
|
||||||
}
|
|
||||||
}"
|
|
||||||
`;
|
|
||||||
|
|
||||||
exports[`Reactivity: useState one components can subscribe twice to same context 1`] = `
|
|
||||||
"function anonymous(app, bdom, helpers
|
|
||||||
) {
|
|
||||||
let { text, createBlock, list, multi, html, toggler, comment } = bdom;
|
|
||||||
|
|
||||||
let block1 = createBlock(\`<div><block-text-0/><block-text-1/></div>\`);
|
|
||||||
|
|
||||||
return function template(ctx, node, key = \\"\\") {
|
|
||||||
let txt1 = ctx['contextObj1'].a;
|
|
||||||
let txt2 = ctx['contextObj2'].b;
|
|
||||||
return block1([txt1, txt2]);
|
|
||||||
}
|
|
||||||
}"
|
|
||||||
`;
|
|
||||||
|
|
||||||
exports[`Reactivity: useState parent and children subscribed to same context 1`] = `
|
|
||||||
"function anonymous(app, bdom, helpers
|
|
||||||
) {
|
|
||||||
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 = \\"\\") {
|
|
||||||
const b2 = comp1({}, key + \`__1\`, node, this, null);
|
|
||||||
let txt1 = ctx['contextObj'].b;
|
|
||||||
return block1([txt1], [b2]);
|
|
||||||
}
|
|
||||||
}"
|
|
||||||
`;
|
|
||||||
|
|
||||||
exports[`Reactivity: useState parent and children subscribed to same context 2`] = `
|
|
||||||
"function anonymous(app, bdom, helpers
|
|
||||||
) {
|
|
||||||
let { text, createBlock, list, multi, html, toggler, comment } = bdom;
|
|
||||||
|
|
||||||
let block1 = createBlock(\`<span><block-text-0/></span>\`);
|
|
||||||
|
|
||||||
return function template(ctx, node, key = \\"\\") {
|
|
||||||
let txt1 = ctx['contextObj'].a;
|
|
||||||
return block1([txt1]);
|
|
||||||
}
|
|
||||||
}"
|
|
||||||
`;
|
|
||||||
|
|
||||||
exports[`Reactivity: useState several nodes on different level use same context 1`] = `
|
|
||||||
"function anonymous(bdom, helpers
|
|
||||||
) {
|
|
||||||
let { text, createBlock, list, multi, html, toggler, component } = bdom;
|
|
||||||
let { withDefault, getTemplate, prepareList, withKey, zero, call, callSlot, capture, isBoundary, shallowEqual, setContextValue, toNumber, safeOutput } = helpers;
|
|
||||||
|
|
||||||
let block1 = createBlock(\`<div><block-text-0/> <block-text-1/></div>\`);
|
|
||||||
|
|
||||||
return function template(ctx, node, key = \\"\\") {
|
|
||||||
let d1 = ctx['contextObj'].a;
|
|
||||||
let d2 = ctx['contextObj'].b;
|
|
||||||
return block1([d1, d2]);
|
|
||||||
}
|
|
||||||
}"
|
|
||||||
`;
|
|
||||||
|
|
||||||
exports[`Reactivity: useState several nodes on different level use same context 2`] = `
|
|
||||||
"function anonymous(bdom, helpers
|
|
||||||
) {
|
|
||||||
let { text, createBlock, list, multi, html, toggler, component } = bdom;
|
|
||||||
let { withDefault, getTemplate, prepareList, withKey, zero, call, callSlot, capture, isBoundary, shallowEqual, setContextValue, toNumber, safeOutput } = helpers;
|
|
||||||
|
|
||||||
let block1 = createBlock(\`<div><block-text-0/></div>\`);
|
|
||||||
|
|
||||||
return function template(ctx, node, key = \\"\\") {
|
|
||||||
let d1 = ctx['contextObj'].b;
|
|
||||||
return block1([d1]);
|
|
||||||
}
|
|
||||||
}"
|
|
||||||
`;
|
|
||||||
|
|
||||||
exports[`Reactivity: useState several nodes on different level use same context 3`] = `
|
|
||||||
"function anonymous(bdom, helpers
|
|
||||||
) {
|
|
||||||
let { text, createBlock, list, multi, html, toggler, component } = bdom;
|
|
||||||
let { withDefault, getTemplate, prepareList, withKey, zero, call, callSlot, capture, isBoundary, shallowEqual, setContextValue, toNumber, safeOutput } = helpers;
|
|
||||||
|
|
||||||
let block1 = createBlock(\`<div><block-text-0/><block-child-0/></div>\`);
|
|
||||||
|
|
||||||
return function template(ctx, node, key = \\"\\") {
|
|
||||||
let d1 = ctx['contextObj'].a;
|
|
||||||
let b2 = component(\`L3A\`, {}, key + \`__1\`, node, ctx);
|
|
||||||
return block1([d1], [b2]);
|
|
||||||
}
|
|
||||||
}"
|
|
||||||
`;
|
|
||||||
|
|
||||||
exports[`Reactivity: useState several nodes on different level use same context 4`] = `
|
|
||||||
"function anonymous(bdom, helpers
|
|
||||||
) {
|
|
||||||
let { text, createBlock, list, multi, html, toggler, component } = bdom;
|
|
||||||
let { withDefault, getTemplate, prepareList, withKey, zero, call, callSlot, capture, isBoundary, shallowEqual, setContextValue, toNumber, safeOutput } = helpers;
|
|
||||||
|
|
||||||
let block1 = createBlock(\`<div><block-child-0/><block-child-1/></div>\`);
|
|
||||||
|
|
||||||
return function template(ctx, node, key = \\"\\") {
|
|
||||||
let b2 = component(\`L2A\`, {}, key + \`__1\`, node, ctx);
|
|
||||||
let b3 = component(\`L2B\`, {}, key + \`__2\`, node, ctx);
|
|
||||||
return block1([], [b2, b3]);
|
|
||||||
}
|
|
||||||
}"
|
|
||||||
`;
|
|
||||||
|
|
||||||
exports[`Reactivity: useState two components are updated in parallel 1`] = `
|
|
||||||
"function anonymous(app, bdom, helpers
|
|
||||||
) {
|
|
||||||
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 = \\"\\") {
|
|
||||||
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(app, bdom, helpers
|
|
||||||
) {
|
|
||||||
let { text, createBlock, list, multi, html, toggler, comment } = bdom;
|
|
||||||
|
|
||||||
let block1 = createBlock(\`<span><block-text-0/></span>\`);
|
|
||||||
|
|
||||||
return function template(ctx, node, key = \\"\\") {
|
|
||||||
let txt1 = ctx['contextObj'].value;
|
|
||||||
return block1([txt1]);
|
|
||||||
}
|
|
||||||
}"
|
|
||||||
`;
|
|
||||||
|
|
||||||
exports[`Reactivity: useState two components can subscribe to same context 1`] = `
|
|
||||||
"function anonymous(app, bdom, helpers
|
|
||||||
) {
|
|
||||||
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 = \\"\\") {
|
|
||||||
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(app, bdom, helpers
|
|
||||||
) {
|
|
||||||
let { text, createBlock, list, multi, html, toggler, comment } = bdom;
|
|
||||||
|
|
||||||
let block1 = createBlock(\`<span><block-text-0/></span>\`);
|
|
||||||
|
|
||||||
return function template(ctx, node, key = \\"\\") {
|
|
||||||
let txt1 = ctx['contextObj'].value;
|
|
||||||
return block1([txt1]);
|
|
||||||
}
|
|
||||||
}"
|
|
||||||
`;
|
|
||||||
|
|
||||||
exports[`Reactivity: useState two independent components on different levels are updated in parallel 1`] = `
|
|
||||||
"function anonymous(app, bdom, helpers
|
|
||||||
) {
|
|
||||||
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 = \\"\\") {
|
|
||||||
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(app, bdom, helpers
|
|
||||||
) {
|
|
||||||
let { text, createBlock, list, multi, html, toggler, comment } = bdom;
|
|
||||||
|
|
||||||
let block1 = createBlock(\`<span><block-text-0/></span>\`);
|
|
||||||
|
|
||||||
return function template(ctx, node, key = \\"\\") {
|
|
||||||
let txt1 = ctx['contextObj'].value;
|
|
||||||
return block1([txt1]);
|
|
||||||
}
|
|
||||||
}"
|
|
||||||
`;
|
|
||||||
|
|
||||||
exports[`Reactivity: useState two independent components on different levels are updated in parallel 3`] = `
|
|
||||||
"function anonymous(app, bdom, helpers
|
|
||||||
) {
|
|
||||||
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 = \\"\\") {
|
|
||||||
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(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['contextObj'].value;
|
|
||||||
return block1([txt1]);
|
|
||||||
}
|
|
||||||
}"
|
|
||||||
`;
|
|
||||||
|
|
||||||
exports[`Reactivity: useState useless atoms should be deleted 1`] = `
|
|
||||||
"function anonymous(app, bdom, helpers
|
|
||||||
) {
|
|
||||||
let { text, createBlock, list, multi, html, toggler, comment } = bdom;
|
|
||||||
let { prepareList, withKey } = helpers;
|
|
||||||
const comp1 = app.createComponent(\`Quantity\`, true, false, false, false);
|
|
||||||
|
|
||||||
let block3 = createBlock(\`<div>
|
|
||||||
<block-child-0/>
|
|
||||||
Total: <block-text-0/>
|
|
||||||
Count: <block-text-1/>
|
|
||||||
</div>\`);
|
|
||||||
|
|
||||||
return function template(ctx, node, key = \\"\\") {
|
|
||||||
const b2 = text(\`
|
|
||||||
\`);
|
|
||||||
ctx = Object.create(ctx);
|
|
||||||
const [k_block4, v_block4, l_block4, c_block4] = prepareList(Object.keys(ctx['state']));;
|
|
||||||
for (let i1 = 0; i1 < l_block4; i1++) {
|
|
||||||
ctx[\`id\`] = v_block4[i1];
|
|
||||||
const key1 = ctx['id'];
|
|
||||||
const b6 = text(\`
|
|
||||||
\`);
|
|
||||||
const b7 = comp1({id: ctx['id']}, key + \`__1__\${key1}\`, node, this, null);
|
|
||||||
const b8 = text(\`
|
|
||||||
\`);
|
|
||||||
c_block4[i1] = withKey(multi([b6, b7, b8]), key1);
|
|
||||||
}
|
|
||||||
ctx = ctx.__proto__;
|
|
||||||
const b4 = list(c_block4);
|
|
||||||
let txt1 = ctx['total'];
|
|
||||||
let txt2 = Object.keys(ctx['state']).length;
|
|
||||||
const b3 = block3([txt1, txt2], [b4]);
|
|
||||||
return multi([b2, b3]);
|
|
||||||
}
|
|
||||||
}"
|
|
||||||
`;
|
|
||||||
|
|
||||||
exports[`Reactivity: useState useless atoms should be deleted 2`] = `
|
|
||||||
"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['state'].quantity;
|
|
||||||
return block1([txt1]);
|
|
||||||
}
|
|
||||||
}"
|
|
||||||
`;
|
|
||||||
|
|
||||||
exports[`Reactivity: useState very simple use, with initial value 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['contextObj'].value;
|
|
||||||
return block1([txt1]);
|
|
||||||
}
|
|
||||||
}"
|
|
||||||
`;
|
|
||||||
@@ -1,57 +0,0 @@
|
|||||||
// Jest Snapshot v1, https://goo.gl/fbAQLP
|
|
||||||
|
|
||||||
exports[`app App supports env with getters/setters 1`] = `
|
|
||||||
"function anonymous(app, bdom, helpers
|
|
||||||
) {
|
|
||||||
let { text, createBlock, list, multi, html, toggler, comment } = bdom;
|
|
||||||
|
|
||||||
let block1 = createBlock(\`<div><block-text-0/> <block-text-1/></div>\`);
|
|
||||||
|
|
||||||
return function template(ctx, node, key = \\"\\") {
|
|
||||||
let txt1 = ctx['env'].someVal;
|
|
||||||
let txt2 = Object.keys(ctx['env'].services);
|
|
||||||
return block1([txt1, txt2]);
|
|
||||||
}
|
|
||||||
}"
|
|
||||||
`;
|
|
||||||
|
|
||||||
exports[`app can configure an app with props 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['props'].value;
|
|
||||||
return block1([txt1]);
|
|
||||||
}
|
|
||||||
}"
|
|
||||||
`;
|
|
||||||
|
|
||||||
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/>\`);
|
|
||||||
|
|
||||||
return function template(ctx, node, key = \\"\\") {
|
|
||||||
return block1();
|
|
||||||
}
|
|
||||||
}"
|
|
||||||
`;
|
|
||||||
|
|
||||||
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]);
|
|
||||||
}
|
|
||||||
}"
|
|
||||||
`;
|
|
||||||
@@ -1,79 +0,0 @@
|
|||||||
import { App, Component, mount, xml } from "../../src";
|
|
||||||
import { status } from "../../src/runtime/status";
|
|
||||||
import { makeTestFixture, snapshotEverything, nextTick, elem } from "../helpers";
|
|
||||||
|
|
||||||
let fixture: HTMLElement;
|
|
||||||
|
|
||||||
snapshotEverything();
|
|
||||||
|
|
||||||
beforeEach(() => {
|
|
||||||
fixture = makeTestFixture();
|
|
||||||
});
|
|
||||||
|
|
||||||
describe("app", () => {
|
|
||||||
test("destroy remove the widget from the DOM", async () => {
|
|
||||||
class SomeComponent extends Component {
|
|
||||||
static template = xml`<div/>`;
|
|
||||||
}
|
|
||||||
|
|
||||||
const app = new App(SomeComponent);
|
|
||||||
const comp = await app.mount(fixture);
|
|
||||||
const el = elem(comp);
|
|
||||||
expect(document.contains(el)).toBe(true);
|
|
||||||
app.destroy();
|
|
||||||
expect(document.contains(el)).toBe(false);
|
|
||||||
expect(status(comp)).toBe("destroyed");
|
|
||||||
});
|
|
||||||
|
|
||||||
test("App supports env with getters/setters", async () => {
|
|
||||||
let someVal = "maggot";
|
|
||||||
|
|
||||||
const services: any = { serv1: "" };
|
|
||||||
const env = {
|
|
||||||
get someVal() {
|
|
||||||
return someVal;
|
|
||||||
},
|
|
||||||
services,
|
|
||||||
};
|
|
||||||
|
|
||||||
class SomeComponent extends Component {
|
|
||||||
static template = xml`<div><t t-esc="env.someVal" /> <t t-esc="Object.keys(env.services)" /></div>`;
|
|
||||||
}
|
|
||||||
|
|
||||||
const app = new App(SomeComponent, { env });
|
|
||||||
const comp = await app.mount(fixture);
|
|
||||||
expect(fixture.innerHTML).toBe("<div>maggot serv1</div>");
|
|
||||||
someVal = "brain";
|
|
||||||
services.serv2 = "";
|
|
||||||
comp.render();
|
|
||||||
await nextTick();
|
|
||||||
expect(fixture.innerHTML).toBe("<div>brain serv1,serv2</div>");
|
|
||||||
});
|
|
||||||
|
|
||||||
test("can configure an app with props", async () => {
|
|
||||||
class SomeComponent extends Component {
|
|
||||||
static template = xml`<div t-esc="props.value"/>`;
|
|
||||||
}
|
|
||||||
|
|
||||||
const app = new App(SomeComponent, { props: { value: 333 } });
|
|
||||||
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"
|
|
||||||
);
|
|
||||||
});
|
|
||||||
});
|
|
||||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user