Skip to Content
Odoo Menu
  • Sign in
  • Try it free
  • Apps
    Finance
    • Accounting
    • Invoicing
    • Expenses
    • Spreadsheet (BI)
    • Documents
    • Sign
    Sales
    • CRM
    • Sales
    • POS Shop
    • POS Restaurant
    • Subscriptions
    • Rental
    Websites
    • Website Builder
    • eCommerce
    • Blog
    • Forum
    • Live Chat
    • eLearning
    Supply Chain
    • Inventory
    • Manufacturing
    • PLM
    • Purchase
    • Maintenance
    • Quality
    Human Resources
    • Employees
    • Recruitment
    • Time Off
    • Appraisals
    • Referrals
    • Fleet
    Marketing
    • Social Marketing
    • Email Marketing
    • SMS Marketing
    • Events
    • Marketing Automation
    • Surveys
    Services
    • Project
    • Timesheets
    • Field Service
    • Helpdesk
    • Planning
    • Appointments
    Productivity
    • Discuss
    • Approvals
    • IoT
    • VoIP
    • Knowledge
    • WhatsApp
    Third party apps Odoo Studio Odoo Cloud Platform
  • Industries
    Retail
    • Book Store
    • Clothing Store
    • Furniture Store
    • Grocery Store
    • Hardware Store
    • Toy Store
    Food & Hospitality
    • Bar and Pub
    • Restaurant
    • Fast Food
    • Guest House
    • Beverage Distributor
    • Hotel
    Real Estate
    • Real Estate Agency
    • Architecture Firm
    • Construction
    • Estate Management
    • Gardening
    • Property Owner Association
    Consulting
    • Accounting Firm
    • Odoo Partner
    • Marketing Agency
    • Law firm
    • Talent Acquisition
    • Audit & Certification
    Manufacturing
    • Textile
    • Metal
    • Furnitures
    • Food
    • Brewery
    • Corporate Gifts
    Health & Fitness
    • Sports Club
    • Eyewear Store
    • Fitness Center
    • Wellness Practitioners
    • Pharmacy
    • Hair Salon
    Trades
    • Handyman
    • IT Hardware & Support
    • Solar Energy Systems
    • Shoe Maker
    • Cleaning Services
    • HVAC Services
    Others
    • Nonprofit Organization
    • Environmental Agency
    • Billboard Rental
    • Photography
    • Bike Leasing
    • Software Reseller
    Browse all Industries
  • Community
    Learn
    • Tutorials
    • Documentation
    • Certifications
    • Training
    • Blog
    • Podcast
    Empower Education
    • Education Program
    • Scale Up! Business Game
    • Visit Odoo
    Get the Software
    • Download
    • Compare Editions
    • Releases
    Collaborate
    • Github
    • Forum
    • Events
    • Translations
    • Become a Partner
    • Services for Partners
    • Register your Accounting Firm
    Get Services
    • Find a Partner
    • Find an Accountant
    • Meet an advisor
    • Implementation Services
    • Customer References
    • Support
    • Upgrades
    Github Youtube Twitter Linkedin Instagram Facebook Spotify
    +1 (650) 691-3277
    Get a demo
  • Pricing
  • Help

Odoo is the world's easiest all-in-one management software.
It includes hundreds of business apps:

  • CRM
  • e-Commerce
  • Accounting
  • Inventory
  • PoS
  • Project
  • MRP
All apps
You need to be registered to interact with the community.
All Posts People Badges
Tags (View all)
odoo accounting v14 pos v15
About this forum
You need to be registered to interact with the community.
All Posts People Badges
Tags (View all)
odoo accounting v14 pos v15
About this forum
Help

owl component: render to qweb templates via json, possible?

Subscribe

Get notified when there's activity on this post

This question has been flagged
portalon-premise18.0
3 Replies
1015 Views
Avatar
start@adjunto.fr

I have a small sample app that correctly renders an owl component.  I'm trying to incorporate the component into a larger app made with qweb templates and widgets.

For the small program that works... the controller:

class MyController(http.Controller):

    @http.route('/owlg1/portal_page', type='http', auth='public', website=True)

    def render_portal_page(self):

        _logger.info ("render_portal_page(self), start...")

        html_content = request.render('owlg1.portal_page')

        _logger.info("render_portal_page : Rendered HTML content: %s", html_content)

        return html_content

...the template

<template id="portal_page" name="My Portal Page">
<t t-call="portal.frontend_layout">
        <div id="wrap">
                <div class="container">
                    <h4>My Portal</h4>
                    <owl-component name="owlg1.ChatComponent"/>
                </div>
        </div>
    </t>
</template>

and last, part of the manifest:

    'depends': ['web', 'website', 'im_livechat', 'mail'],
    'assets': {
        'web.assets_frontend': [ ... widget, owl component, owl component template ],
    },
    'data': [
        'views/portal_page.xml',
    ],


The owl component, the main widget and the owl template are all small, generic pieces. (I can post them if you wish)


In my larger app I would like to incorporate the same component into a page controlled by widgets and templates.  The template holding the owl component is not immediately on the page when the user goes there.  The user has to click on a few links to drill down to the template with the owl component is.  The source code is like this:

The widget that renders various part of the page, and the method in question:

const PortalDashboardWidget = publicWidget.Widget.extend({
    selector...
    events... (but nothing related to the button in the own component)
    ... methods...

_setupSubjectDetail: async function(in_userSubjectId) {
    const userSubjectResult = await rpc(
     urlBase + '/dashboard/usersubject/chatbutton',   
                    { userSubject_id: in_userSubjectId }
      );
    $('#chat-block').html(chatButtonResult.html);

});

publicWidget.registry.PortalDashboardWidget = PortalDashboardWidget;
export default PortalDashboardWidget;
The controller:

@http.route(WebsiteController._routes['base'] + '/dashboard/usersubject/chatbutton', type='json', auth='user')

def getChatButton(self, userSubject_id=None, **_kw):
    ... get the chat id from the db, livechat_channel_session.id  (this part works)
    html_content = request.env['ir.ui.view']._render_template(
      "myapp.chat-button-content", { 'chat_session_id': livechat_channel_session.id
    })
    html_content = str(html_content)
    return {'html': html_content}

... and finally part of the manifest:

   'depends': ['base_setup',
        'base',
        'web',
        'portal',
        'project',
        'mail',
        'website',
        'im_livechat',
    ],
    'installable': True,
    'application': True,
    'data': [
        'security/ir.model.access.csv',
...templates... except the owl-component template
        'data/website_data.xml',
...
    ],
'assets': {
    'web.assets_frontend': [
        'myapp/static/src/js/chat/chat_service.js', #owl service, component, template     
'myapp/static/src/js/chat/chat_component.js',
        'myapp/static/src/xml/chat/chat_template.xml',
        ... scss, images, widget javascript
    ],
},


chat-block is a template that is not immediately rendered when the user goes to the page.  The user has to click to "drill-down" to the template where the chat button is.

The above code works well for all of my other templates and widgets, but in this case, when the teamplate is rendered by the controller, <owl-component>... is in the rendered html, and it is inserted into the web page and sits there, inert.


If I move the owl component to a higher level template, one rendered as shown in my sample code, with a controller using type='http',  and "render(...)", it works.  So I believe the component itself is ok. 


I belive I have to alter the widget javascript and the python controller, but have no idea how.  I've modified both files in various ways but have not succeeded.  One idea I had was to make the controller method type='http' so get the rendering correct, and then somehow change it's http response into a json response to work with the widget.  Mostly I either get <owl-component> in my rendered html, and it does not activate, or I get empty json.


Any help/examples would be greatly appreciated.  If you could provide the "import... " lines in your answer that would help.  Thanks!






0
Avatar
Discard
Avatar
Samad Alimadadi
Best Answer

.

0
Avatar
Discard
Avatar
start@adjunto.fr
Author Best Answer

Hello CTS, definitely better... but not quite working.

I'm getting this error message:


OwlError: Missing template: "adjuntohub.ChatContentTemplate" (for component "ChatComponent")


Which I find strange, because when I put <owl-component> on the main page it finds the template.  So I'm pretty sure the manifest is ok


here is the component:

/** @odoo-module **/

import { useService } from "@web/core/utils/hooks";

import { Component } from "@odoo/owl";  

import { registry } from "@web/core/registry";


export class ChatComponent extends Component {


    static template = 'adjuntohub.ChatContentTemplate';

    static props = {

        sessionId: { type: String, optional: true },  // chat session id as string

    };


    setup() {

        console.info("ChatComponent(), setup(), start...");

        this.mail_store_service = useService("adjuntohub.ChatService");

        this.chat_id = parseInt(this.props.sessionId);

        console.info("ChatComponent(), setup(), chat_id is %d.  End.", this.chat_id);

    }


    async onClickChat(ev) {

        ev.preventDefault();

        if (!this.props.sessionId) {

            console.warn("ChatComponent.onClickChat(): sessionId not provided as prop, hard coding to 20 (subject 1336-sv) for testing");

            this.props.sessionId = "20";

        }

        const chat_id = parseInt(this.props.sessionId);

        console.info("ChatComponent.onClickChat(chat_id=%d) start...", chat_id);  // chat_id -> channel_id


        if (chat_id) {

            console.info("  chat_id present, try to open the chat");

            await this.mail_store_service.open_specific_chat(chat_id);

        } else {

            console.warn("chat_id not present");

        }

        console.info("ChatComponent.onClickChat(chat_id=%d) end", chat_id);


    }

}


registry.category("public_components").add("adjuntohub.ChatComponent", ChatComponent);



Here is the component template:


<?xml version="1.0" encoding="UTF-8"?>

<templates xml:space="preserve" >


    <t t-name="adjuntohub.ChatContentTemplate" >  <!-- owl="1" didn't change anything -->

        <p> OWL component adjunto_hub.ChatContent</p>

        <button t-on-click="onClickChat"

            id="chat-button"

            t-att-data-chat-id="chat_id"

            class="btn btn-primary">

            Open Chat

        </button>

        <p>chat_session_id=<t t-esc="chat_session_id"/> </p>

    </t>

</templates>



Here is the crucial part I didn't have in my widget, mounting the component:

// Dynamically mount the OWL component
// Find the <owl-component> element inside the inserted HTML
const owlEl = $chatBlock[0].querySelector('owl-component');
if (owlEl) {
  const cc = registry.category("public_components").get("adjuntohub.ChatComponent");
    mount(cc, { target: owlEl }); 
}

So the controller renders the html and the javascript correctly places it.  And then this code tries to mount it.

What I don't see is any sign of the component being initialized.  I did see that when I had the component on my main page (the page rendered with http).  But I removed the component from that page. 

Things I've tried:
adding owl="1" attribute to the template
using components instead of public_components
I tried a few variations of mountComponent but still got the same error.

And, I don't know if this makes a difference, but I couldn't find this._rpc(...) so I used just rpc(...)

Any ideas?  Maybe look at cc, see if is has a template?
Thank for your help, much obliged.







0
Avatar
Discard
Avatar
Cybrosys Techno Solutions Pvt.Ltd
Best Answer

Hi,


You need to:


    Return the template HTML via JSON as you do.

    After inserting the HTML, manually mount the OWL component using @web/owl utilities.

Step 1: Import necessary OWL modules in your widget JS


/** chat_widget.js **/

import { registry } from "@web/core/registry";

import { Component } from "@odoo/owl";

import { mount } from "@odoo/owl";

import { publicWidget } from "web.public.widget";


Step 2: Update your widget _setupSubjectDetail method


_setupSubjectDetail: async function(in_userSubjectId) {

    // Fetch the template HTML via RPC

    const chatButtonResult = await this._rpc({

        route: "/dashboard/usersubject/chatbutton",

        params: { userSubject_id: in_userSubjectId },

    });


    // Insert HTML into the DOM

    const $chatBlock = $('#chat-block');

    $chatBlock.html(chatButtonResult.html);


    // Dynamically mount the OWL component

    // Find the <owl-component> element inside the inserted HTML

    const owlEl = $chatBlock[0].querySelector('owl-component');


    if (owlEl) {

        const ChatComponent = registry.category("components").get("myapp.ChatComponent");

        mount(ChatComponent, { target: owlEl });

    }

}


Step 3: Ensure your OWL component is registered


/** chat_component.js **/

import { Component } from "@odoo/owl";

import { registry } from "@web/core/registry";


export class ChatComponent extends Component {

    static template = "myapp.ChatComponentTemplate";

}


registry.category("components").add("myapp.ChatComponent", ChatComponent);


* ChatComponentTemplate is your OWL template ID in XML (chat_template.xml).

* Ensure the template is loaded via assets (web.assets_frontend).


Step 4: Controller remains type='json'


No need to change the Python controller. Your current setup works:


@http.route('/dashboard/usersubject/chatbutton', type='json', auth='user')

def getChatButton(self, userSubject_id=None, **_kw):

    # Prepare the template HTML

    html_content = request.env['ir.ui.view']._render_template(

        "myapp.chat-button-content",

        {'chat_session_id': livechat_channel_session.id}

    )

    return {'html': str(html_content)}


- OWL does not auto-initialize components inserted via AJAX/JSON.

- After inserting the HTML, you must mount the OWL component manually.

- Use registry to fetch the component and mount from @odoo/owl.

- Keep controller type='json' for AJAX loading — no need to convert to http.


Hope it helps

0
Avatar
Discard
start@adjunto.fr
Author

Yes, I got closer, thanks! But it's still not working. I put the details in another reply, yesterday. I didn't see the comment button.

Enjoying the discussion? Don't just read, join in!

Create an account today to enjoy exclusive features and engage with our awesome community!

Sign up
Related Posts Replies Views Activity
Adding Front-end/Website Theme to Odoo 18 Not Working
theme website on-premise 18.0
Avatar
1
Jan 25
3430
Trying to replace default “Invoices & Bills” breadcrumb in Odoo portal
portal
Avatar
Avatar
1
Nov 25
393
How To Hide Action Report By Picking Type Code ?
18.0
Avatar
Avatar
Avatar
3
Nov 25
597
Dynamically update cart icon after adding products from a reorder popup in Custom Odoo portal
portal
Avatar
Avatar
1
Nov 25
304
How do I set up budget management / planning Solved
18.0
Avatar
Avatar
2
Aug 25
1091
Community
  • Tutorials
  • Documentation
  • Forum
Open Source
  • Download
  • Github
  • Runbot
  • Translations
Services
  • Odoo.sh Hosting
  • Support
  • Upgrade
  • Custom Developments
  • Education
  • Find an Accountant
  • Find a Partner
  • Become a Partner
About us
  • Our company
  • Brand Assets
  • Contact us
  • Jobs
  • Events
  • Podcast
  • Blog
  • Customers
  • Legal • Privacy
  • Security
الْعَرَبيّة Català 简体中文 繁體中文 (台灣) Čeština Dansk Nederlands English Suomi Français Deutsch हिंदी Bahasa Indonesia Italiano 日本語 한국어 (KR) Lietuvių kalba Język polski Português (BR) română русский язык Slovenský jazyk slovenščina Español (América Latina) Español ภาษาไทย Türkçe українська Tiếng Việt

Odoo is a suite of open source business apps that cover all your company needs: CRM, eCommerce, accounting, inventory, point of sale, project management, etc.

Odoo's unique value proposition is to be at the same time very easy to use and fully integrated.

Website made with

Odoo Experience on YouTube

1. Use the live chat to ask your questions.
2. The operator answers within a few minutes.

Live support on Youtube
Watch now