core_user/comboboxsearch/user

Allow the user to search for learners.

Source:

user/amd/src/comboboxsearch/user.js, line 16

Copyright:

2023 Mathew May

License:

http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later

Methods

clickHandler(e)

Source:

user/amd/src/comboboxsearch/user.js, line 174

The handler for when a user interacts with the component.

Parameters:

Name	Type	Description
`e`	MouseEvent	The triggering event that we are working with.

componentSelector() → {string}

Source:

user/amd/src/comboboxsearch/user.js, line 69

The overall div that contains the searching widget.

Returns:

Type: string

dropdownSelector() → {string}

Source:

user/amd/src/comboboxsearch/user.js, line 78

The dropdown div that contains the searching widget result space.

Returns:

Type: string

fetchDataset() → {Promise.<*>}

Source:

user/amd/src/comboboxsearch/user.js, line 110

Get the data we will be searching against in this component.

Returns:

Type: Promise.<*>

(async) filterDataset(filterableData) → {Array}

Source:

user/amd/src/comboboxsearch/user.js, line 120

Dictate to the search component how and what we want to match upon.

Parameters:

Name	Type	Description
`filterableData`	Array

Returns:

The users that match the given criteria.

Type: Array

(async) filterMatchDataset() → {Array}

Source:

user/amd/src/comboboxsearch/user.js, line 134

Given we have a subset of the dataset, set the field that we matched upon to inform the end user.

Returns:

The results with the matched fields inserted.

Type: Array

getStringMap() → {Promise.<void>}

Source:

user/amd/src/comboboxsearch/user.js, line 281

Given the set of profile fields we can possibly search, fetch their strings, so we can report to screen readers the field that matched.

Returns:

Type: Promise.<void>

keyHandler(e)

Source:

user/amd/src/comboboxsearch/user.js, line 194

The handler for when a user presses a key within the component.

Parameters:

Name	Type	Description
`e`	KeyboardEvent	The triggering event that we are working with.

(async) renderDropdown()

Source:

user/amd/src/comboboxsearch/user.js, line 94

Build the content then replace the node.

selectAllResultsLink()

Source:

user/amd/src/comboboxsearch/user.js, line 262

Build up the view all link.

selectOneLink(userID)

Source:

user/amd/src/comboboxsearch/user.js, line 271

Build up the view all link that is dedicated to a particular result.

Parameters:

Name	Type	Description
`userID`	Number	The ID of the user selected.

toggleDropdown(on)

Source:

user/amd/src/comboboxsearch/user.js, line 247

When called, hide or show the users dropdown.

Parameters:

Name	Type	Default	Description
`on`	Boolean	`false`	Flag to toggle hiding or showing values.

triggerSelector() → {string}

Source:

user/amd/src/comboboxsearch/user.js, line 87

The triggering div that contains the searching widget.

Returns:

Type: string