oe-message-handler v2.2.0

\<oe-message-handler>

<oe-message-handler> is an element for handling message/warning/error display using <paper-toast>. The component can be placed anywhere on the main application page and all message display will be handled automatically.

    <oe-message-handler duration="2000" persist-on="error"></oe-message-handler>

Show a toast

• Within a polymer element

  this.fire('oe-show-message','Hello World!');

• From javascript

  var event = new CustomEvent('oe-show-message', {detail: "Hello World!"});
  window.dispatchEvent(event);

• For warning and error messages

  this.fire('oe-show-warning','This is a warning message!');
  this.fire('oe-show-error','Oh snap! something went terribly wrong');

• Toast that stays forever

  this.fire('oe-show-message',{
      message:'This message stays until the next toast',
      forever:true
  });

• Toasts to be explicitly dismissed

  When persist-on="error,warning" is provided, all error and warning messages will persist and OK button must be pressed to dismiss the toast. An ok callback can be provided which is invoked when user presses OK.

  this.fire('oe-show-error', {
      message:'You must login before posting data.',
      ok: goToLoginPage
  });

i18n

If passed in message object has a code property, it is transformed for i18n. This means, you can pass the error-codes/message-codes as msgData.code and oe-message-handler will translate them into current language. When a translation is not found, msgData.message is displayed (if present), otherwise msgData.code (i.e. the error-code/message-code) is displayed as it is.

this.fire('oe-show-error', {
    code:'invalid-credentials',
    message: 'Invalid Credentials'
});

Now the oe-message-handler will look for a translation for 'invalid-credentials' and will display if it is found. If the translation is not defined then 'Invalid Credentials' will be displayed.

Confirmation window

Confirmation toast, takes ok and cancel callbacks.

this.fire('oe-show-confirmation', {
    message:'Record will be permanently removed. Are you sure?',
    ok: okCallback,
    cancel:cancelCallback
});

Styling

The following custom properties and mixins are available for styling: