MDL-66074 core_toast: Documentation
authorMathew May <mathewm@hotmail.co.nz>
Mon, 28 Oct 2019 05:00:25 +0000 (13:00 +0800)
committerMathew May <mathewm@hotmail.co.nz>
Wed, 30 Oct 2019 05:03:59 +0000 (13:03 +0800)
lib/templates/local/toast/message.mustache

index a1a0d5e..4e00ed1 100644 (file)
@@ -1,3 +1,38 @@
+{{!
+    This file is part of Moodle - http://moodle.org/
+
+    Moodle is free software: you can redistribute it and/or modify
+    it under the terms of the GNU General Public License as published by
+    the Free Software Foundation, either version 3 of the License, or
+    (at your option) any later version.
+
+    Moodle is distributed in the hope that it will be useful,
+    but WITHOUT ANY WARRANTY; without even the implied warranty of
+    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+    GNU General Public License for more details.
+
+    You should have received a copy of the GNU General Public License
+    along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
+}}
+{{!
+    @template core/local/toast/message
+
+    Template to render a Toast notification.
+
+    Classes required for JS:
+    * none
+
+    Data attributes required for JS:
+    * none
+
+    Example context (json):
+    {
+        "data": 200,
+        "autohide": true,
+        "Message": "Cubing negative numbers is tough",
+        "closebutton": true
+    }
+}}
 <div id="toast-{{uniqid}}" class="toast bg-dark text-white rounded mx-auto" data-delay="{{delay}}" {{^autohide}}data-autohide="false"{{/autohide}}>
   <div class="toast-body">
     <span>{{{message}}}</span>