owl/doc/readme.md

# 🦉 OWL Documentation 🦉

## Reference

- [Animations](reference/animations.md)
- [Component](reference/component.md)
- [Configuration](reference/config.md)
- [Context](reference/context.md)
- [Environment](reference/environment.md)
- [Event Bus](reference/event_bus.md)
- [Hooks](reference/hooks.md)
- [Miscellaneous Components](reference/misc.md)
- [Observer](reference/observer.md)
- [Props](reference/props.md)
- [QWeb Templating Language](reference/qweb_templating_language.md)
- [QWeb Engine](reference/qweb_engine.md)
- [Router](reference/router.md)
- [Store](reference/store.md)
- [Tags](reference/tags.md)
- [Utils](reference/utils.md)

## Learning Resources

- [Quick Start: create an (almost) empty Owl application](learning/quick_start.md)
- [Tutorial: create a TodoList application](learning/tutorial_todoapp.md)

## Miscellaneous

- [Comparison with React/Vue](comparison.md)
- [Tooling](tooling.md)
- [Templates to start Owl applications (external link)](https://github.com/ged-odoo/owl-templates)

## Architecture

This section explains in more detail the inner workings of Owl. It is targeted
for developers working on Owl itself.

- [Virtual DOM](architecture/vdom.md)
- [Rendering](architecture/rendering.md)

## Owl Content

Here is a complete visual representation of everything exported by the `owl`
global object (so, for example, `Component` is available at `owl.Component`,
and `EventBus` is exported as `owl.core.EventBus`):

```
Component                               misc
Context                                     AsyncRoot
QWeb                                    router
Store                                       Link
useState                                    RouteComponent
config                                      Router
    mode                                tags
core                                        xml
    EventBus                            utils
    Observer                                debounce
hooks                                       escape
    onWillStart                             loadJS
    onMounted                               loadFile
    onWillUpdateProps                       shallowEqual
    onWillPatch                             whenReady
    onPatched
    onWillUnmount
    useContext
    useState
    useRef
    useSubEnv
    useStore
    useDispatch
    useGetters
```

Note that for convenience, the `useState` hook is also exported at the root of the `owl` object.