lib/templates/notification.mustache

   1 {{!
   2     This file is part of Moodle - http://moodle.org/
   3
   4     Moodle is free software: you can redistribute it and/or modify
   5     it under the terms of the GNU General Public License as published by
   6     the Free Software Foundation, either version 3 of the License, or
   7     (at your option) any later version.
   8
   9     Moodle is distributed in the hope that it will be useful,
  10     but WITHOUT ANY WARRANTY; without even the implied warranty of
  11     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12     GNU General Public License for more details.
  13
  14     You should have received a copy of the GNU General Public License
  15     along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
  16 }}
  17 {{!
  18     @template core/notification
  19
  20     Moodle notification template.
  21
  22     The purpose of this template is to render a notification using other notification templates.
  23
  24     Classes required for JS:
  25     * none
  26
  27     Data attributes required for JS:
  28     * none
  29
  30     Context variables required for this template:
  31     * message A cleaned string (use clean_text()) to display.
  32     * extraclasses Additional classes to apply to the notification.
  33     * closebutton Whether a close button should be displayed to dismiss the message.
  34     * announce Whether the notification should be announced to screen readers.
  35
  36     Example context (json):
  37     { "message": "Your pants are on fire!", "closebutton": 1, "announce": 1, "extraclasses": "foo bar", "issuccess": 1}
  38 }}
  39 {{#issuccess}}
  40     {{> core/notification_success}}
  41 {{/issuccess}}
  42 {{#isinfo}}
  43     {{> core/notification_info}}
  44 {{/isinfo}}
  45 {{#iswarning}}
  46     {{> core/notification_warning}}
  47 {{/iswarning}}
  48 {{#iserror}}
  49     {{> core/notification_error}}
  50 {{/iserror}}