message/templates/message_preferences_component.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_message/message_preferences_component
  19
  20     The message preferences page
  21
  22     Classes required for JS:
  23     * None
  24
  25     Data attibutes required for JS:
  26     * All data attributes are required
  27
  28     Context variables required for this template:
  29     * notifications The list of notifications
  30
  31     Example context (json):
  32     {
  33         "notifications": [
  34             {
  35                 "displayname": "Notices about minor problems",
  36                 "preferencekey": "message_provider_moodle_notices",
  37                 "onlinehelphtml": "<p>some help HTML</p>",
  38                 "offlinehelphtml": "<p>some help HTML</p>",
  39                 "processors": [
  40                     {
  41                         "displayname": "Popup notification",
  42                         "name": "popup",
  43                         "locked": 0,
  44                         "userconfigured": 1,
  45                         "loggedin": {
  46                             "name": "loggedin",
  47                             "displayname": "When I'm logged in",
  48                             "checked": 0,
  49                             "disableall": 0
  50                         },
  51                         "loggedoff": {
  52                             "name": "loggedoff",
  53                             "displayname": "When I'm offline",
  54                             "checked": 0,
  55                             "disableall": 0
  56                         }
  57                     }
  58                 ]
  59             }
  60         ]
  61     }
  62 }}
  63 {{#notifications}}
  64     <tr data-preference-key="{{preferencekey}}">
  65         <th>{{displayname}}</th>
  66         <td class="align-bottom">
  67             <div class="container-fluid">
  68                 <div class="row-fluid">
  69                     <div class="span6 col-6">
  70                         {{#str}} loggedin, message {{/str}}
  71                         {{#onlinehelphtml}}{{{.}}}{{/onlinehelphtml}}
  72                     </div>
  73                     <div class="span6 col-6">
  74                         {{#str}} loggedoff, message {{/str}}
  75                         {{#offlinehelphtml}}{{{.}}}{{/offlinehelphtml}}
  76                     </div>
  77                 </div>
  78             </div>
  79         </td>
  80     </tr>
  81     {{#processors}}
  82         {{> message/message_preferences_notification_processor }}
  83     {{/processors}}
  84 {{/notifications}}