lib/templates/pix_icon.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/pix_icon
  19
  20     Moodle pix_icon template.
  21
  22     The purpose of this template is to render a pix_icon.
  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     * attributes Array of name / value pairs. Includes title, alt, src.
  32     * extraclasses List of extra classes to append.
  33
  34     Example context (json):
  35     {
  36         "attributes": [
  37             { "name": "src", "value": "https://moodle.org/logo/moodle-logo.svg" },
  38             { "name": "extraclasses", "value": "iconsmall" },
  39             {"name": "alt", "value": "Alt text for icon"}
  40         ]
  41     }
  42
  43 }}
  44 <img class="icon {{extraclasses}}" {{#attributes}}{{name}}="{{value}}" {{/attributes}}/>