lib/templates/form_autocomplete_suggestions.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/form_autocomplete_suggestions
  19
  20     Moodle template for the list of valid options in an autocomplate form element.
  21
  22     Classes required for JS:
  23     * none
  24
  25     Data attributes required for JS:
  26     * none
  27
  28     Context variables required for this template:
  29     * suggestionsId The dom id of the current suggestions list.
  30     * options List of options with label and value fields.
  31
  32     Example context (json):
  33     { "suggestionsId": 1, "options": [
  34         { "label": "Item label with <strong>tags</strong>", "value": "5" },
  35         { "label": "Another item label with <strong>tags</strong>", "value": "4" }
  36     ]}
  37 }}
  38 <ul class="form-autocomplete-suggestions" id="{{suggestionsId}}" role="listbox" aria-hidden="true">
  39     {{#options}}
  40         <li role="option" data-value="{{value}}">{{{label}}}</li>
  41     {{/options}}
  42 </ul>