Files
owl/doc/readme.md
T

69 lines
1.3 KiB
Markdown
Raw Normal View History

2019-04-25 15:57:13 +02:00
# 🦉 OWL Documentation 🦉
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
Context
2019-07-14 22:18:00 +02:00
QWeb
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
onMounted
onWillUnmount
onWillPatch
onPatched
useContext
2019-09-24 14:06:53 +02:00
useState
2019-09-26 21:56:01 +02:00
useRef
useSubEnv
2019-08-26 15:33:38 +02:00
router
Link
RouteComponent
2019-08-26 15:33:38 +02:00
Router
2019-07-14 22:18:00 +02:00
store
Store
ConnectedComponent
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
loadTemplates
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.
## Reference
2019-06-11 08:58:37 +02:00
- [Animations](animations.md)
- [Component](component.md)
- [Context](context.md)
2019-06-11 08:58:37 +02:00
- [Event Bus](event_bus.md)
2019-09-24 14:06:53 +02:00
- [Hooks](hooks.md)
2019-06-11 08:58:37 +02:00
- [Observer](observer.md)
- [QWeb](qweb.md)
2019-08-26 15:33:38 +02:00
- [Router](router.md)
- [Store](store.md)
2019-09-12 09:45:32 +02:00
- [Tags](tags.md)
- [Utils](utils.md)
2019-06-11 08:58:37 +02:00
- [Virtual DOM](vdom.md)
2019-06-14 15:24:04 +02:00
## Learning Resources
- [Quick Start](quick_start.md)
2019-06-11 08:58:37 +02:00
## Miscellaneous
- [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)