Skip to Content

Flowchart Builder & Mermaid Diagram

by
Odoo

$ 412.76

v 19.0 Third Party
Availability
Odoo Online
Odoo.sh
On Premise
Odoo Apps Dependencies • Invoicing (account)
• Discuss (mail)
Lines of code 146
Technical Name sm_mermaid_widget
LicenseOPL-1
Websitehttps://apps.odoo.com/apps/browse?repo_maintainer_id=512936
You bought this module and need support? Click here!
Availability
Odoo Online
Odoo.sh
On Premise
Odoo Apps Dependencies • Invoicing (account)
• Discuss (mail)
Lines of code 146
Technical Name sm_mermaid_widget
LicenseOPL-1
Websitehttps://apps.odoo.com/apps/browse?repo_maintainer_id=512936
Module Icon

Flowchart Builder & Mermaid Diagram

Real-time Mermaid.js Diagram, Flowchart, and Gantt Chart widget for any Odoo field

✓ Real-time Rendering ✓ Diagram Support ✓ Easy Integration ✓ No External API Required

Module Video Overview

Features

1 Mermaid.js diagrams rendering

Visualize complex processes directly in Odoo. Support for flowcharts, sequence diagrams, Gantt charts, class diagrams, state diagrams, pie charts, and everything included in the native Mermaid library.

2 Real-time rendering

The Mermaid code is evaluated instantly, and the diagram form visualizer is built seamlessly right away into the interface using the Javascript rendering engine, without refreshing or calling external services.

3 Easy XML integration

With a simple widget="mermaid" attribute added to a text or char field in your XML views, your stored markup immediately transforms from text code into a stunning and easy-to-read diagram visualization!

Flowchart Builder & Mermaid Diagram — Documentation

1. Getting Started

Prerequisites

Before installing, make sure your environment meets these requirements:

Requirement Description
Odoo Version 19.0 (Community or Enterprise)
Dependencies web, sale (Sale Order dependency is for demo views)

Installation

  1. Upload the sm_mermaid_widget module folder to your server's custom addons directory.
  2. Restart the Odoo service to detect the new module.
  3. Navigate to Apps menu, click Update Apps List.
  4. Search for "Flowchart Builder & Mermaid Diagram" and click Install.

Note

After installation, the mermaid widget becomes available for any Text or Char field in Odoo backend views to render Mermaid.js markup. No additional configuration is required.

2. Usage

Adding Mermaid Widget to a Field

To render a text field containing Mermaid.js syntax as a diagram, add widget="mermaid" in your XML view definition:

<field name="mermaid_code" widget="mermaid"/>

Inheriting an existing view

You can also use xpath to add the widget to existing views where you store your Mermaid markup:

<record id="view_order_form_mermaid" model="ir.ui.view">
    <field name="name">sale.order.form.mermaid</field>
    <field name="model">sale.order</field>
    <field name="inherit_id" ref="sale.view_order_form"/>
    <field name="arch" type="xml">
        <xpath expr="//field[@name='note']" position="attributes">
            <attribute name="widget">mermaid</attribute>
        </xpath>
    </field>
</record>

Tip

This module already includes a demonstration on how to use it within the Sale Order views.

3. Features

Mermaid.js Integration

Seamlessly renders standard Mermaid.js syntax directly inside Odoo views.

Supported Diagram Types

  • Flowcharts: Visualize processes and workflows.
  • Sequence Diagrams: Show interactions between processes over time.
  • Gantt Charts: Display project schedules and timelines.
  • Class Diagrams, State Diagrams, Pie Charts, and more supported by the native Mermaid library.

Real-time Rendering

The widget evaluates the text/character content as Mermaid markup and renders the visual diagram when the form is loaded.

4. Technical Support

If you find any bugs or have feature requests, please contact the author or leave a review on the Odoo Apps Store.

Odoo Proprietary License v1.0

This software and associated files (the "Software") may only be used (executed,
modified, executed after modifications) if you have purchased a valid license
from the authors, typically via Odoo Apps, or if you have received a written
agreement from the authors of the Software (see the COPYRIGHT file).

You may develop Odoo modules that use the Software as a library (typically
by depending on it, importing it and using its resources), but without copying
any source code or material from the Software. You may distribute those
modules under the license of your choice, provided that this license is
compatible with the terms of the Odoo Proprietary License (For example:
LGPL, MIT, or proprietary licenses similar to this one).

It is forbidden to publish, distribute, sublicense, or sell copies of the Software
or modified copies of the Software.

The above copyright notice and this permission notice must be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
DEALINGS IN THE SOFTWARE.

Please log in to comment on this module

  • The author can leave a single reply to each comment.
  • This section is meant to ask simple questions or leave a rating. Every report of a problem experienced while using the module should be addressed to the author directly (refer to the following point).
  • If you want to start a discussion with the author or have a question related to your purchase, please use the support page.