2019-04-25 15:57:13 +02:00
|
|
|
# 🦉 OWL Documentation 🦉
|
2019-03-27 17:02:35 +01:00
|
|
|
|
2019-07-14 22:18:00 +02:00
|
|
|
## Owl Content
|
|
|
|
|
|
|
|
|
|
Owl is a javascript library that contains some core classes and function to help
|
2019-09-11 14:01:49 +02:00
|
|
|
build applications. Here is a complete representation of its content:
|
2019-07-14 22:18:00 +02:00
|
|
|
|
|
|
|
|
```
|
|
|
|
|
owl
|
|
|
|
|
Component
|
2019-10-08 09:00:06 +02:00
|
|
|
Context
|
2019-07-14 22:18:00 +02:00
|
|
|
QWeb
|
2019-10-08 09:14:41 +02:00
|
|
|
Store
|
2019-09-24 14:06:53 +02:00
|
|
|
useState
|
2019-07-14 22:18:00 +02:00
|
|
|
core
|
|
|
|
|
EventBus
|
|
|
|
|
Observer
|
2019-09-24 14:06:53 +02:00
|
|
|
hooks
|
2019-10-14 13:07:44 +02:00
|
|
|
onWillStart
|
2019-09-24 14:06:53 +02:00
|
|
|
onMounted
|
2019-10-14 13:07:44 +02:00
|
|
|
onWillUpdateProps
|
2019-10-03 11:56:29 +02:00
|
|
|
onWillPatch
|
|
|
|
|
onPatched
|
2019-10-14 13:07:44 +02:00
|
|
|
onWillUnmount
|
2019-10-08 09:00:06 +02:00
|
|
|
useContext
|
2019-09-24 14:06:53 +02:00
|
|
|
useState
|
2019-09-26 21:56:01 +02:00
|
|
|
useRef
|
2019-10-04 22:00:05 +02:00
|
|
|
useSubEnv
|
2019-10-08 09:14:41 +02:00
|
|
|
useStore
|
|
|
|
|
useDispatch
|
|
|
|
|
useGetters
|
2019-10-25 15:35:10 +02:00
|
|
|
misc
|
|
|
|
|
AsyncRoot
|
2019-08-26 15:33:38 +02:00
|
|
|
router
|
|
|
|
|
Link
|
2019-09-11 13:34:29 +02:00
|
|
|
RouteComponent
|
2019-08-26 15:33:38 +02:00
|
|
|
Router
|
2019-09-12 09:45:32 +02:00
|
|
|
tags
|
|
|
|
|
xml
|
2019-07-14 22:18:00 +02:00
|
|
|
utils
|
2019-08-26 15:33:38 +02:00
|
|
|
debounce
|
|
|
|
|
escape
|
2019-07-14 22:18:00 +02:00
|
|
|
loadJS
|
2019-10-17 12:20:22 +02:00
|
|
|
loadFile
|
|
|
|
|
shallowEqual
|
2019-08-26 15:33:38 +02:00
|
|
|
whenReady
|
2019-07-14 22:18:00 +02:00
|
|
|
```
|
|
|
|
|
|
2019-09-24 14:06:53 +02:00
|
|
|
Note that for convenience, the `useState` hook is also exported at the root of the `owl` object.
|
|
|
|
|
|
2019-04-23 15:26:00 +02:00
|
|
|
## Reference
|
2019-03-28 09:49:19 +01:00
|
|
|
|
2019-10-28 09:03:55 +01:00
|
|
|
- [Animations](reference/animations.md)
|
|
|
|
|
- [Component](reference/component.md)
|
|
|
|
|
- [Context](reference/context.md)
|
|
|
|
|
- [Event Bus](reference/event_bus.md)
|
|
|
|
|
- [Hooks](reference/hooks.md)
|
|
|
|
|
- [Misc](reference/misc.md)
|
|
|
|
|
- [Observer](reference/observer.md)
|
|
|
|
|
- [QWeb](reference/qweb.md)
|
|
|
|
|
- [Router](reference/router.md)
|
|
|
|
|
- [Store](reference/store.md)
|
|
|
|
|
- [Tags](reference/tags.md)
|
|
|
|
|
- [Utils](reference/utils.md)
|
2019-06-11 08:58:37 +02:00
|
|
|
|
2019-06-14 15:24:04 +02:00
|
|
|
## Learning Resources
|
2019-04-23 15:26:00 +02:00
|
|
|
|
2019-10-30 09:54:24 +01:00
|
|
|
- [Quick Start: create an (almost) empty Owl application](learning/quick_start.md)
|
2019-06-11 08:58:37 +02:00
|
|
|
|
|
|
|
|
## Miscellaneous
|
|
|
|
|
|
2019-04-23 15:26:00 +02:00
|
|
|
- [Comparison with React/Vue](comparison.md)
|
2019-06-11 08:58:37 +02:00
|
|
|
- [Tooling](tooling.md)
|
2019-09-11 14:01:49 +02:00
|
|
|
- [Templates to start Owl applications (external link)](https://github.com/ged-odoo/owl-templates)
|
2019-10-28 13:35:55 +01:00
|
|
|
|
|
|
|
|
## Architecture
|
|
|
|
|
|
|
|
|
|
This section explains in more detail the inner workings of Owl. It is more
|
|
|
|
|
useful for people working on Owl code.
|
|
|
|
|
|
|
|
|
|
- [Virtual DOM](architecture/vdom.md)
|
|
|
|
|
- [Rendering](architecture/rendering.md)
|
