web/web_ir_actions_act_window_m.../README.rst

141 lines
4.9 KiB
ReStructuredText

=========================
Client side message boxes
=========================
..
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
!! This file is generated by oca-gen-addon-readme !!
!! changes will be overwritten. !!
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
!! source digest: sha256:c6ab6322d92b7ec73af6324032ed00e8a974d28ad30f78d025febc67e5976bf7
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
.. |badge1| image:: https://img.shields.io/badge/maturity-Beta-yellow.png
:target: https://odoo-community.org/page/development-status
:alt: Beta
.. |badge2| image:: https://img.shields.io/badge/licence-AGPL--3-blue.png
:target: http://www.gnu.org/licenses/agpl-3.0-standalone.html
:alt: License: AGPL-3
.. |badge3| image:: https://img.shields.io/badge/github-OCA%2Fweb-lightgray.png?logo=github
:target: https://github.com/OCA/web/tree/16.0/web_ir_actions_act_window_message
:alt: OCA/web
.. |badge4| image:: https://img.shields.io/badge/weblate-Translate%20me-F47D42.png
:target: https://translation.odoo-community.org/projects/web-16-0/web-16-0-web_ir_actions_act_window_message
:alt: Translate me on Weblate
.. |badge5| image:: https://img.shields.io/badge/runboat-Try%20me-875A7B.png
:target: https://runboat.odoo-community.org/builds?repo=OCA/web&target_branch=16.0
:alt: Try me on Runboat
|badge1| |badge2| |badge3| |badge4| |badge5|
This module allows to show a message popup on the client side as result of a button.
**Table of contents**
.. contents::
:local:
Usage
=====
Depend on this module and return
.. code:: python
{
'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 <https://github.com/OCA/web/issues>`_.
In case of trouble, please check there if your issue has already been reported.
If you spotted it first, help us to smash it by providing a detailed and welcomed
`feedback <https://github.com/OCA/web/issues/new?body=module:%20web_ir_actions_act_window_message%0Aversion:%2016.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**>`_.
Do not contact contributors directly about support or help with technical issues.
Credits
=======
Authors
~~~~~~~
* Therp BV
* ACSONE SA/NV
Contributors
~~~~~~~~~~~~
* Holger Brunn <hbrunn@therp.nl>
* Zakaria Makrelouf (ACSONE SA/NV) <z.makrelouf@gmail.com>
* Benjamin Willig (ACSONE SA/NV) <benjamin.willig@acsone.eu>
* Ioan Galan (Studio73) <ioan@studio73.es>
* Abraham Anes (Studio73) <abraham@studio73.es>
* Miguel Gandia (Studio73) <miguel@studio73.es>
* `DynApps NV <https://www.dynapps.be>`_:
* Koen Loodts
* Raf Ven
Maintainers
~~~~~~~~~~~
This module is maintained by the OCA.
.. image:: https://odoo-community.org/logo.png
:alt: Odoo Community Association
:target: https://odoo-community.org
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 <https://github.com/OCA/web/tree/16.0/web_ir_actions_act_window_message>`_ project on GitHub.
You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.