mirror of https://github.com/odoo/owl.git synced 2025-10-06 19:59:41 +07:00

Files

T

Mathieu Duckerts-Antoine a9be149e1e [IMP] translation contexts

A new directive t-tanslation-context and a new family of directives (of the form
t-translation-context-...) are introduced to allow to translate terms in contexts.

Set t-translation-context="fr" on a node makes every call of the translation
function to be done with "fr" as seconde parameter when translating an
attribute/content within that node or its children (if no closer
t-translation-context directive is found).
A directive t-translation-context-attr="fr" can be used on a node to target its
attribute "attr". For example, if a div has an attribute title="a title",
use t-translation-context-title="pt" will make "a title" to be translated
in the context "pt". Note that this takes precedence over any other directive
t-translation-context found on a parent (or the div itself).
The translation function is in charge of the interpretation of the context: OWL
does not associate any meaning with a translation context.

2025-01-15 11:01:53 +01:00

learning

[FIX] t-call-context: make this unavailable in rendering context

2023-01-12 09:38:22 +01:00

miscellaneous

[DOC] add explanation on structure of compiled template

2022-03-01 15:46:09 +01:00

reference

[IMP] translation contexts

2025-01-15 11:01:53 +01:00

tools

[IMP] devtools: update doc

2024-12-05 15:43:39 +01:00

readme.md

[IMP] index: export batched utility function

2024-05-22 12:01:13 +02:00

readme.md

🦉 Owl overview 🦉

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

Main entities:

App: represent an Owl application (mainly a root component,a set of templates, and a config)
Component: the main class to define a concrete Owl component
mount: main entry point for most application: mount a component to a target
xml: helper to define an inline template

Reactivity

useState: create a reactive object (hook, linked to a specific component)
reactive: create a reactive object (not linked to any component)
markRaw: mark an object or array so that it is ignored by the reactivity system
toRaw: given a reactive objet, return the raw (non reactive) underlying object

Lifecycle hooks:

onWillStart: hook to define asynchronous code that should be executed before component is rendered
onMounted: hook to define code that should be executed when component is mounted
onWillPatch: hook to define code that should be executed before component is patched
onWillUpdateProps: hook to define code that should be executed before component is updated
onPatched: hook to define code that should be executed when component is patched
onWillRender: hook to define code that should be executed before component is rendered
onRendered: hook to define code that should be executed after component is rendered
onWillUnmount: hook to define code that should be executed before component is unmounted
onWillDestroy: hook to define code that should be executed before component is destroyed
onError: hook to define a Owl error handler

Other hooks:

useComponent: return a reference to the current component (useful to create derived hooks)
useEffect: define an effect with its dependencies
useEnv: return a reference to the current env
useExternalListener: add a listener outside of a component DOM
useRef: get an object representing a reference (t-ref)
useChildSubEnv: extend the current env with additional information (for child components)
useSubEnv: extend the current env with additional information (for current component and child components)

Utility/helpers:

EventBus: a simple event bus
loadFile: an helper to load a file from the server
markup: utility function to define strings that represent html (should not be escaped)
status: utility function to get the status of a component (new, mounted or destroyed)
validate: validates if an object satisfies a specified schema
whenReady: utility function to execute code when DOM is ready
batched: utility function to batch function calls