7f95b6c292d12f255b718e01810fbc6df848c138
[moodle.git] / lib / templates / pix_icon_fontawesome.mustache
1 {{!
2     This file is part of Moodle - http://moodle.org/
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.
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.
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_fontawesome
20     Moodle pix_icon template.
22     The purpose of this template is to render a pix_icon. If the icon was not mapped we fall back to normal pix_icon markup.
24     Classes required for JS:
25     * none
27     Data attributes required for JS:
28     * none
30     Context variables required for this template:
31     * pix
32     * title
33     * extraclasses
35     Example context (json):
36     {
37         "key": "fa-meh-o",
38         "title": "Meh",
39         "alt": "Meh Meh",
40         "extraclasses": "fa-spin",
41         "unmappedIcon": false
42     }
44 }}
45 {{^unmappedIcon}}
46 <i class="icon fa {{key}} fa-fw {{extraclasses}}" aria-hidden="true" {{#title}}title="{{title}}"{{/title}} aria-label="{{alt}}"></i>
47 {{/unmappedIcon}}
48 {{#unmappedIcon}}
49 {{! We cannot include the pix_icon template directly here because we don't have all the mustache helpers loaded. }}
50 <img class="icon {{extraclasses}}" {{#attributes}}{{name}}="{{value}}" {{/attributes}}/>
51 {{/unmappedIcon}}