Enable Dark Mode!
how-to-add-subcomponents-to-main-components-in-owl.jpg
By: Muhammed Rishad

How to Add Subcomponents to Main Components in OWL

Technical

Introduction:

Odoo, the powerful open-source business application platform, offers developers the ability to create modular and reusable components to build intricate user interfaces. A fundamental feature of Odoo is the capability to incorporate subcomponents into main components. This empowers developers to break down their application's functionality into manageable parts, resulting in easier code maintenance and extensibility. In this comprehensive blog post, we will delve into the process of adding subcomponents to the main components in Odoo, illustrating the concept through a practical example.

Understanding Subcomponents:

Let's begin by examining the code structure of a subcomponent in Odoo. In our example, we will explore a subcomponent called `NoteComponent` that represents a note-taking feature. To define the subcomponent, we start by creating a template. The template specifies the component name, where "subcomponent" refers to the module name, and "NoteComponent" denotes the name of the component itself. Within the template, we establish the body of the subcomponent, which, in our case, is a text area for taking notes. This subcomponent will subsequently be added to the main component.

XML:
```
<?xml version="1.0" encoding="UTF-8"?>
<templates id="template" xml:space="preserve">
    <t t-name="subcomponent.NoteComponent" owl="1">
       <textarea placeholder="Enter Something..." class="notes_text"></textarea>
    </t>
</templates>
```
After defining the body of the subcomponent, we proceed to create the component with the same name specified in the template and export it. Additionally, we can define any necessary functions within the component.
JavaScript:
```
/** @odoo-module */
const { Component } = owl;
export class NoteComponent extends Component {
   function_name(){
        // Enter your functionality...
   }
}
NoteComponent.template = 'subcomponent.NoteComponent';
```
Here, the `NoteComponent` is defined as an `owl. Component`, representing a subcomponent that can be utilized within a main component.

Main Component Integration:

Now, let's explore the code for the main component, which includes the `NoteComponent` as a subcomponent and demonstrates how to utilize it effectively.
JavaScript:
```
/** @odoo-module **/
import { NoteComponent } from "./notecomponent";
import { registry } from "@web/core/registry";
import { Component } from "@odoo/owl";
export class Noteitem extends Component {
   _toggle_note() {
       $(this.__owl__.bdom.el.querySelectorAll('.notes_text')).toggle();
   }
}
Noteitem.template = "subcomponent.Noteitem";
Noteitem.components = { NoteComponent };
export const systrayItem = {
   Component: Noteitem,
};
registry.category("systray").add("Noteitem", systrayItem, { sequence: 1 });
```
We import the required subcomponent from its corresponding directory to integrate the main component. Then, we define the main component, `Noteitem,` as an `owl. Component`. The `_toggleNote` method within the `Noteitem` component is responsible for toggling the visibility of the subcomponent elements. After defining the component class, we assign the subcomponent to the main component using the syntax: `Note item. components = { NoteComponent };`. Here, we establish `NoteComponent` as a subcomponent that will be rendered within the `Noteitem` component.

Adding Subcomponents to the Main Component:

To add the `NoteComponent` subcomponent to the main component, we must define the component hierarchy within the XML template.
XML:
```
<?xml version="1.0" encoding="UTF-8"?>
<templates id="template
" xml:space="preserve">
    <t t-name="subcomponent.NoteItem" owl="1">
        <div>
            <div class="note_item_icon" t-on-click="_toggleNote">
                <span><i class="fa fa-file-text"></i></span>
            </div>
            <NoteComponent position="'bottom-end'"/>
        </div>
    </t>
</templates>
```
In the XML template, we structure the `NoteItem` component. It contains a div element with a CSS class for the note item icon. Upon clicking the icon, the `_toggleNote` method of the main component is invoked. The `NoteComponent` is then rendered within the main component, facilitating its seamless integration.

Conclusion:

In conclusion, this blog post has elucidated the process of incorporating subcomponents into the main components in Odoo. You can enhance code maintainability and extensibility by breaking down your application's functionality into smaller, reusable parts. We examined the code structure of a subcomponent, `NoteComponent,` as well as a main component, `NoteItem,` that encompasses the subcomponent. Furthermore, we discussed the XML template structure necessary for rendering the subcomponent within the main component. By following these guidelines, you can elevate your Odoo application development, creating more modular and flexible user interfaces.


If you need any assistance in odoo, we are online, please chat with us.



0
Comments



Leave a comment

 


whatsapp
location

Calicut

Cybrosys Technologies Pvt. Ltd.
Neospace, Kinfra Techno Park
Kakkancherry, Calicut
Kerala, India - 673635

location

Kochi

Cybrosys Technologies Pvt. Ltd.
1st Floor, Thapasya Building,
Infopark, Kakkanad,
Kochi, India - 682030.

location

Bangalore

Cybrosys Techno Solutions
The Estate, 8th Floor,
Dickenson Road,
Bangalore, India - 560042

Send Us A Message