owl/doc/readme.md

🦉 OWL Documentation 🦉

Reference

• Animations
• Component
• Configuration
• Context
• Environment
• Event Bus
• Hooks
• Misc
• Observer
• QWeb
• Router
• Store
• Tags
• Utils

Learning Resources

• Quick Start: create an (almost) empty Owl application
• Environment: what it is and what it should contain

Miscellaneous

• Comparison with React/Vue
• Tooling
• Templates to start Owl applications (external link)

Architecture

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

• Virtual DOM
• Rendering

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
    env                                     xml
core                                    utils
    EventBus                                debounce
    Observer                                escape
hooks                                       loadJS
    onWillStart                             loadFile
    onMounted                               shallowEqual
    onWillUpdateProps                       whenReady
    onWillPatch
    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.