Allow the user to search for groups.
- Source:
- Copyright:
- 2023 Mathew May
- 2023 Mathew May
- License:
- http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
Methods
(async) clickHandler(e)
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}
The overall div that contains the searching widget.
Returns:
- Type
- string
dropdownSelector() → {string}
The dropdown div that contains the searching widget result space.
Returns:
- Type
- string
(async) fetchDataset() → {Promise.<*>}
Get the data we will be searching against in this component.
Returns:
- Type
- Promise.<*>
(async) filterDataset(filterableData) → {Array}
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
filterMatchDataset()
Given we have a subset of the dataset, set the field that we matched upon to inform the end user.
keyHandler(e)
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. |
registerInputEvents()
Handle any keyboard inputs.
registerInputHandlers()
Override the input event listener for the text input area.
(async) renderDefault()
Build the content then replace the node by default we want our form to exist.
(async) renderDropdown()
Build the content then replace the node.
selectOneLink(groupID)
Build up the view all link that is dedicated to a particular result.
Parameters:
| Name | Type | Description |
|---|---|---|
groupID |
Number | The ID of the group selected. |
triggerSelector() → {string}
The triggering div that contains the searching widget.
Returns:
- Type
- string