OWL
data_display
Form Renderer
Odoo 19 OWL component — Form Renderer (views)
Related requirements
- List, form, header, tabs, full DB code Odoo 19 list + form with workflow header, notebook tabs, and ace/code fields for full Text from DB.
Live preview
Interactive
Source excerpt
web/static/src/views/form/form_renderer.js
import { evaluateBooleanExpr } from "@web/core/py_js/py";
import { Notebook } from "@web/core/notebook/notebook";
import { Setting } from "./setting/setting";
import { Field } from "@web/views/fields/field";
import { browser } from "@web/core/browser/browser";
import { hasTouch } from "@web/core/browser/feature_detection";
import { useService } from "@web/core/utils/hooks";
import { useDebounced, useThrottleForAnimation } from "@web/core/utils/timing";
import { ButtonBox } from "@web/views/form/button_box/button_box";
import { InnerGroup, OuterGroup } from "@web/views/form/form_group/form_group";
import { ViewButton } from "@web/views/view_button/view_button";
import { useViewCompiler } from "@web/views/view_compiler";
import { Widget } from "@web/views/widgets/widget";
import { FormCompiler } from "./form_compiler";
import { FormLabel } from "./form_label";
import { StatusBarButtons } from "./status_bar_buttons/status_bar_buttons";
import {
Component,
onMounted,
onWillUnmount,
useEffect,
useSubEnv,
useRef,
useState,
xml,
} from "@odoo/owl";
export class FormRenderer extends Component {
static template = xml`<t t-call="{{ templates.FormRenderer }}" t-call-context="{ __comp__: Object.assign(Object.create(this), { this: this }) }" />`;
static components = {
Field,
FormLabel,
ButtonBox,
ViewButton,
Widget,
Notebook,
Setting,
OuterGroup,
InnerGroup,
StatusBarButtons,
};
static props = {
archInfo: Object,
Compiler: { type: Function, optional: true },
record: Object,
// Template props : added by the FormCompiler
class: { type: String, optional: 1 },
translateAlert: { type: [Object, { value: null }], optional: true },
onNotebookPageChange: { type: Function, optional: true },
activeNotebookPages: { type: Object, optional: true },
readonly: { type: Boolean, optional: true },
saveRecord: { type: Function, optional: true },
setFieldAsDirty: { type: Function, optional: true },
slots: { type: Object, optional: true },
};
static defaultProps = {
activeNotebookPages: {},
onNotebookPageChange: () => {},
};
setup() {
this.evaluateBooleanExpr = evaluateBooleanExpr;
const { archInfo, Compiler, record } = this.props;
const templates = { FormRenderer: archInfo.xmlDoc };
this.state = useState({}); // Used by Form Compiler
this.templates = useViewCompiler(Compiler || FormCompiler, templates);
useSubEnv({ model: record.model });
this.uiService = useService("ui");
this.onResize = useDebounced(this.render, 200);
this.onScrollThrottled = useThrottleForAnimation(this.onScroll);
onMounted(() => browser.addEventListener("resize", this.onResize));
onWillUnmount(() => browser.removeEventListener("resize", this.onResize));
const { autofocusFieldIds } = archInfo;
const rootRef = useRef("compiled_view_root");
if (this.shouldAutoFocus) {
useEffect(
(isNew, rootEl) => {
if (!rootEl) {
return;
}
let elementToFocus;
if (isNew) {
const focusableSelectors = [
'input[type="text"]',
"textarea",
"[contenteditable]",
];
for (const id of autofocusFieldIds) {
elementToFocus = rootEl.querySelector(`#${id}`);
if (elementToFocus) {
break;
}
}
elementToFocus =
elementToFocus ||
rootEl.querySelector(
focusableSelectors
.map((sel) => `.o_content .o_field_widget ${sel}`)
.join(", ")
);
}
if (elementToFocus) {
elementToFocus.focus();
}
},
() => [this.props.record.isNew, rootRef.el]
);
}
if (this.env.inDialog) {
// try to ensure ids unicity by temporarily removing similar ids that could already
// exist in the DOM (e.g. in a form view displayed below this dialog which contains
// same field names as this form view)
const fieldNodeIds = Object.keys(this.props.archInfo.fieldNodes);
const elementsByNodeIds = {};
onMounted(() => {
if (!rootRef.el) {
// t-ref is sometimes set on a <t> node, resulting in a null ref (e.g. footer case)
Registry / API
- Registry name
FormRenderer- Category
—- Module
web- Slug
form-renderer- Nav group
data_display