lib/templates/notification_base.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_base
  19
  20     Base Moodle notification template.
  21
  22     The purpose of this template is to render an base template for alert notifications.
  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     {
  38         "message": "<p>Hello <a href=\"#\">World!</a></p><p>Your pants are on fire!</p>",
  39         "closebutton": 1,
  40         "announce": 1,
  41         "extraclasses": "foo bar"
  42     }
  43 }}
  44 <div class="alert {{$alertclass}}alert-secondary{{/alertclass}} alert-block fade in {{ extraclasses }} {{#closebutton}}alert-dismissible{{/closebutton}}" {{!
  45         }}{{# announce }} role="alert" data-aria-autofocus="true"{{/ announce }}>
  46     {{{ message }}}
  47     {{# closebutton }}{{!
  48     }}<button type="button" class="close" data-dismiss="alert">
  49         <span aria-hidden="true">&times;</span>
  50         <span class="sr-only">{{#str}}dismissnotification, core{{/str}}</span>
  51     </button>{{!
  52     }}{{/ closebutton }}
  53 </div>