Skip to main content

Basic status messages for your CMS system

Project description

License: LGPL-3

CMS status message

A “status message” is an important message that you want to show to users.

For instance: a user submit a form or does a specific action and you want to report the status of this action like “your profile has been updated” or “Your upgrade has been successful.”.

This module allows to easily display this kind of messages to your users.

Messages are displayed using Twitter bootstrap alerts.

You can add several messages: they will be displayed one after another.

Usage

Python code

Set a message:

msg = _('My important message.')
if request.website:
    request.website.add_status_message(msg)

By default the message type is info. The title (the label at the beginning of the message) matches the message type:

  • ‘info’: ‘Info’
  • ‘success’: ‘Success’
  • ‘danger’: ‘Error’
  • ‘warning’: ‘Warning’

You can change message parameters:

msg = _('Watch out!')
if request.website:
    request.website.add_status_message(msg, type_='warning', title='Oh no')

Messages will be displayed like this:

./images/preview.png

Javascript code

Dependencies:

var msg_tool = require('cms_status_message.tool');
var core = require('web.core');
var _t = core._t;

Inject a custom message on the fly:

msg = {
    'msg': _t('Item unpublished.'),
    'title': _t('Warning'),
    'type': 'warning'
}
msg_tool.render_messages(msg).then(function(html) {
    // wipe existing
    $('.status_message').remove();
    // inject new
    $(html).hide().prependTo('#wrap').fadeIn('slow');
});

Add a status message to the session, useful if you want to show the message only after a redirect:

var msg =  _t('Contratulations! You made it!.');
var options = {'title': _('My title'), 'dismissible': false};
msg_tool.add_message(msg, options);

Customize appereance

By default the alert box is added on top of <main /> content. If you want to customize this behavior just override or disable cms_status_message.add_status_message template.

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.

Credits

Contributors

Maintainer

Odoo Community Association

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.

To contribute to this module, please visit https://odoo-community.org.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for odoo10-addon-cms-status-message, version 10.0.1.1.0.99.dev3
Filename, size File type Python version Upload date Hashes
Filename, size odoo10_addon_cms_status_message-10.0.1.1.0.99.dev3-py2-none-any.whl (78.7 kB) File type Wheel Python version py2 Upload date Hashes View hashes

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page