Reference

Here is a list of everything exported by the Owl library.

Core

• App: an Owl application (root components, templates, and config)
• Component: base class for Owl components
• mount: mount a component to a DOM target
• xml: define an inline template
• props: declare and validate component props
• status: get the status of a component (new, mounted, destroyed)

Reactivity

• signal: create a reactive value
• computed: create a lazily-evaluated derived value
• proxy: create a reactive proxy for an object
• effect: create a side effect that re-runs when dependencies change
• markRaw: mark an object so it is ignored by the reactivity system
• toRaw: given a proxy, return the underlying non-reactive object
• untrack: execute a function without tracking reactive dependencies

Lifecycle Hooks

• onWillStart: async, before first rendering
• onMounted: after component is rendered and added to the DOM
• onWillPatch: before the DOM is patched
• onPatched: after the DOM is patched
• onWillUnmount: before removing component from DOM
• onWillDestroy: before component is destroyed
• onError: catch and handle errors

Other Hooks

• useEffect: create a reactive effect, cleaned up on destroy
• useListener: add a listener to a target, removed on destroy
• useApp: get the current App instance

Plugins

• Plugin: base class for plugins
• plugin: import a plugin dependency
• providePlugins: make plugins available to a component subtree

Type Validation

• types: built-in type validators
• validateType: check a value against a type validator
• assertType: like validateType, but throws on failure

Utilities

• EventBus: a simple event bus
• markup: mark a string as safe HTML (not escaped by t-out)
• batched: batch function calls into a single microtask execution
• whenReady: execute code when the DOM is ready
• Registry: ordered key-value collection with reactivity
• Resource: ordered set collection with reactivity