docbrown/app/javascript/packs/admin/users/memberIndex.js
Suzanne Aitchison 76c7932b09
Member index: Filter by joining date (#17975)
* add the date picker into view

* allow date picker to overflow modal

* allow aria labels to be passed to inputs

* filter records

* add missing comment

* set earliest date

* specs and a small fix

* cypress spec

* fix typo

* tidying up

* fetch date_format

* commit code review suggestion to params

* Revert "commit code review suggestion to params"

This reverts commit 84fb0e0d3acc13257a362eb41c17b2bb8089606a.

* show added filter pill

* add cypress specs for applied filters

* woops! fix unintended change to filter code
2022-07-14 14:52:42 +01:00

187 lines
5.8 KiB
JavaScript

import { showUserModal } from './editUserModals';
import { openDropdown, closeDropdown } from '@utilities/dropdownUtils';
import { copyToClipboard } from '@utilities/runtime';
import { showWindowModal, closeWindowModal } from '@utilities/showModal';
/**
* Adds a single event listener to the "applied filters" section, allowing the user to remove a given filter.
*
* Note: We use buttons instead of links, since the redirection to a new URL is more of an implementation detail than something
* that makes sense semantically to users - e.g. a link to "remove filter: admin" is slightly less clear than understanding an
* in-page action of the same name.
*/
const initializeFilterPills = () => {
// Add the listener to the "Clear all" button
document
.querySelector('.js-clear-filters-btn')
?.addEventListener('click', () => {
const { search, href } = document.location;
const newUrl = href.replace(search, '');
document.location = newUrl;
});
const filtersArea = document.querySelector('.js-applied-filters');
filtersArea?.addEventListener('click', ({ target }) => {
// We target closest data-filter-type to account for SVGs inside the button being the click target
const relevantElement = target.closest('[data-filter-key]');
if (!relevantElement) {
// Nothing to do here
return;
}
const {
dataset: { filterKey, filterValue },
} = relevantElement;
const urlParams = new URLSearchParams(document.location.search);
if (filterKey === 'joining_date') {
urlParams.delete('joining_start');
urlParams.delete('joining_end');
} else {
// In all other cases, we may have filters with a matching key that we want to keep
const allFiltersMatchingKey = urlParams.getAll(filterKey);
// Remove the clicked filter name from the array
allFiltersMatchingKey.splice(
allFiltersMatchingKey.indexOf(filterValue),
1,
);
// Delete _all_ filters with given key
urlParams.delete(filterKey);
// Re-attach any filters with given key that we want to keep
allFiltersMatchingKey.forEach((filterVal) =>
urlParams.append(filterKey, filterVal),
);
}
// Redirect the page
document.location.search = urlParams;
});
};
initializeFilterPills();
// We present up to 50 users in the UI at once, and for performance reasons we don't want to add individual click listeners to each dropdown menu or inner menu item
// Instead we listen for click events anywhere in the table, and identify required actions based on data attributes of the target
document
.getElementById('member-index-content')
?.addEventListener('click', ({ target }) => {
const {
dataset: { copyEmail, toggleDropdown },
} = target;
if (copyEmail) {
handleEmailCopy(copyEmail);
return;
}
if (toggleDropdown) {
handleDropdownToggle({
triggerElementId: target.getAttribute('id'),
dropdownContentId: toggleDropdown,
});
return;
}
});
// We keep track of the currently opened dropdown to make sure we only ever have one open at a time
let currentlyOpenDropdownId;
const handleDropdownToggle = ({ triggerElementId, dropdownContentId }) => {
const triggerButton = document.getElementById(triggerElementId);
const isCurrentlyOpen =
triggerButton.getAttribute('aria-expanded') === 'true';
if (isCurrentlyOpen) {
closeDropdown({ triggerElementId, dropdownContentId });
triggerButton.focus();
currentlyOpenDropdownId = null;
} else {
closeCurrentlyOpenDropdown();
openDropdown({ triggerElementId, dropdownContentId });
currentlyOpenDropdownId = dropdownContentId;
}
};
/**
* Make sure any currently opened dropdown is closed
*/
const closeCurrentlyOpenDropdown = (focusTrigger = false) => {
if (!currentlyOpenDropdownId) {
return;
}
const triggerButton = document.querySelector(
`[aria-controls='${currentlyOpenDropdownId}']`,
);
closeDropdown({
dropdownContentId: currentlyOpenDropdownId,
triggerElementId: triggerButton?.getAttribute('id'),
});
if (focusTrigger) {
triggerButton.focus();
}
};
// We listen for key up events on this page to make sure users can close the dropdowns via keyboard
document.addEventListener('keyup', ({ key }) => {
if (key === 'Escape') {
closeCurrentlyOpenDropdown(true);
return;
}
if (key === 'Tab') {
// If we're not inside a dropdown any more, let's close it
const closestDropdown = document.activeElement.closest('.crayons-dropdown');
if (!closestDropdown) {
closeCurrentlyOpenDropdown();
}
}
});
/**
* Helper function to copy the given text to the clipboard and display a snackbar confirmation.
*
* @param {string} copyEmail The email to copy
*/
const handleEmailCopy = (copyEmail) => {
copyToClipboard(copyEmail)
.then(() => {
document.dispatchEvent(
new CustomEvent('snackbar:add', {
detail: { message: 'Copied to clipboard' },
}),
);
closeCurrentlyOpenDropdown(true);
})
.catch(() => {
document.dispatchEvent(
new CustomEvent('snackbar:add', {
detail: {
message: 'Unable to copy the text. Try reloading the page',
},
}),
);
});
};
// The reason that we loop through the elements is because we have alternate layouts
// for different screen sizes
document.querySelectorAll('.js-export-csv-modal-trigger').forEach((item) => {
item.addEventListener('click', () => {
showWindowModal({
title: 'Download Member Data',
contentSelector: item.dataset.modalContentSelector,
overlay: true,
onOpen: () => {
document
.querySelector('#window-modal .js-export-csv-modal-cancel')
?.addEventListener('click', closeWindowModal);
},
});
});
});
document.body.addEventListener('click', showUserModal);