core_group/comboboxsearch/group

Description:

  • Allow the user to search for groups.

Source:
Copyright:
  • 2023 Mathew May
License:
  • http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later

Allow the user to search for groups.

Methods

(async) clickHandler(e)

Description:

  • The handler for when a user interacts with the component.

Source:
Parameters:
Name Type Description
e MouseEvent

The triggering event that we are working with.

componentSelector() → {string}

Description:

  • The overall div that contains the searching widget.

Source:
Returns:
Type
string
Description:

  • The dropdown div that contains the searching widget result space.

Source:
Returns:
Type
string

(async) fetchDataset() → {Promise.<*>}

Description:

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

Source:
Returns:
Type
Promise.<*>

(async) filterDataset(filterableData) → {Array}

Description:

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

Source:
Parameters:
Name Type Description
filterableData Array
Returns:

The users that match the given criteria.

Type
Array

filterMatchDataset()

Description:

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

Source:

keyHandler(e)

Description:

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

Source:
Parameters:
Name Type Description
e KeyboardEvent

The triggering event that we are working with.

registerInputEvents()

Description:

  • Handle any keyboard inputs.

Source:

registerInputHandlers()

Description:

  • Override the input event listener for the text input area.

Source:

(async) renderDefault()

Description:

  • Build the content then replace the node by default we want our form to exist.

Source:

(async) renderDropdown()

Description:

  • Build the content then replace the node.

Source:
Description:

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

Source:
Parameters:
Name Type Description
groupID Number

The ID of the group selected.

triggerSelector() → {string}

Description:

  • The triggering div that contains the searching widget.

Source:
Returns:
Type
string