README.rst

Client side message boxes

This module allows to show a message popup on the client side as result of a button.

Table of contents

• Usage
• Known issues / Roadmap
• Bug Tracker
• Credits
  • Authors
  • Contributors
  • Maintainers

Usage

Depend on this module and return

{
    'type': 'ir.actions.act_window.message',
    'title': _('My title'),
    'message': _('My message'),
    # optional title of the close button, if not set, will be _('Close')
    # if set False, no close button will be shown
    # you can create your own close button with an action of type
    # ir.actions.act_window_close
    'close_button_title': 'Make this window go away',
    # Use HTML instead of text
    'is_html_message': True,
    # this is an optional list of buttons to show
    'buttons': [
        # a button can be any action (also ir.actions.report.xml et al)
        {
            'type': 'ir.actions.act_window',
            'name': 'All customers',
            'res_model': 'res.partner',
            'view_mode': 'form',
            'views': [[False, 'list'], [False, 'form']],
            'domain': [('customer', '=', True)],
        },
        # or if type == method, you need to pass a model, a method name and
        # parameters
        {
            'type': 'method',
            'name': _('Yes, do it'),
            'model': self._name,
            'method': 'myfunction',
            # list of arguments to pass positionally
            'args': [self.ids],
            # dictionary of keyword arguments
            'kwargs': {'force': True},
            # button style
            'classes': 'btn-primary',
        }
    ]
}

You are responsible for translating the messages.

Known issues / Roadmap

• add message_type to differenciate between warnings, errors, etc.
• have one message_type to show a nonmodal warning on top right

Bug Tracker

Bugs are tracked on GitHub Issues. In case of trouble, please check there if your issue has already been reported. If you spotted it first, help us smashing it by providing a detailed and welcomed feedback.

Do not contact contributors directly about support or help with technical issues.

Credits

Authors

• Therp BV
• ACSONE SA/NV

Contributors

• Holger Brunn <[email protected]>
• Zakaria Makrelouf (ACSONE SA/NV) <[email protected]>
• Benjamin Willig (ACSONE SA/NV) <[email protected]>
• Ioan Galan (Studio73) <[email protected]>
• Abraham Anes (Studio73) <[email protected]>

Maintainers

This module is maintained by the OCA.

OCA, or the Odoo Community Association, is a nonprofit organization whose mission is to support the collaborative development of Odoo features and promote its widespread use.

This module is part of the OCA/web project on GitHub.

You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.