MDL-68169 user: Add keyword filter
[moodle.git] / user / amd / src / local / participantsfilter / filtertypes / keyword.js
1 // This file is part of Moodle - http://moodle.org/
2 //
3 // Moodle is free software: you can redistribute it and/or modify
4 // it under the terms of the GNU General Public License as published by
5 // the Free Software Foundation, either version 3 of the License, or
6 // (at your option) any later version.
7 //
8 // Moodle is distributed in the hope that it will be useful,
9 // but WITHOUT ANY WARRANTY; without even the implied warranty of
10 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
11 // GNU General Public License for more details.
12 //
13 // You should have received a copy of the GNU General Public License
14 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
16 /**
17  * Keyword filter.
18  *
19  * @module     core_user/local/participantsfilter/filtertypes/keyword
20  * @package    core_user
21  * @copyright  2020 Andrew Nicols <andrew@nicols.co.uk>
22  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
23  */
24 import Filter from '../filter';
25 import {get_string as getString} from 'core/str';
27 export default class extends Filter {
28     constructor(filterType, filterSet) {
29         super(filterType, filterSet);
30     }
32     /**
33      * For keywords the final value is an Array of strings.
34      *
35      * @returns {Object}
36      */
37     get values() {
38         return this.rawValues;
39     }
41     /**
42      * Get the placeholder to use when showing the value selector.
43      *
44      * @return {Promise} Resolving to a String
45      */
46     get placeholder() {
47         return getString('placeholdertype', 'core_user');
48     }
50     /**
51      * Whether to show suggestions in the autocomplete.
52      *
53      * @return {Boolean}
54      */
55     get showSuggestions() {
56         return false;
57     }
58 }