paulmataruso/zulip
1
0
Fork 0
mirror of https://github.com/zulip/zulip.git synced 2025-11-04 22:13:26 +00:00
Code Issues Packages Projects Releases Wiki Activity

recent_topics: Improve code level documentation.

Browse Source 
Improved documentation of set_filter and show_selected_filters
functions.
This commit is contained in:
Aman Agrawal
2020-06-12 16:37:10 +05:30
committed by Tim Abbott
parent 2d6ada4360
commit 347c0dc80f
1 changed files with 12 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

13
static/js/recent_topics.js
View File

@@ -227,19 +227,30 @@ exports.update_topic_unread_count = function (message) {
}; };
exports.set_filter = function (filter) { exports.set_filter = function (filter) {
// This function updates the `filters` variable
// after user clicks on one of the filter buttons
// based on `btn-recent-selected` class and current
// set `filters`.
// Get the button which was clicked.
const filter_elem = $('#recent_topics_filter_buttons') const filter_elem = $('#recent_topics_filter_buttons')
.find('[data-filter="' + filter + '"]'); .find('[data-filter="' + filter + '"]');
// If user clicks `All`, we clear all filters.
if (filter === 'all' && filters.size !== 0) { if (filter === 'all' && filters.size !== 0) {
filters = new Set(); filters = new Set();
// If the button was already selected, remove the filter.
} else if (filter_elem.hasClass('btn-recent-selected')) { } else if (filter_elem.hasClass('btn-recent-selected')) {
filters.delete(filter); filters.delete(filter);
// If the button was not selected, we add the filter.
} else { } else {
filters.add(filter); filters.add(filter);
} }
}; };
function show_selected_filters() { function show_selected_filters() {
// Add `btn-selected-filter` to the buttons to show
// which filters are applied.
if (filters.size === 0) { if (filters.size === 0) {
$('#recent_topics_filter_buttons') $('#recent_topics_filter_buttons')
.find('[data-filter="all"]') .find('[data-filter="all"]')
@@ -292,7 +303,7 @@ exports.complete_rerender = function () {
if (!overlays.recent_topics_open()) { if (!overlays.recent_topics_open()) {
return false; return false;
} }
// Prepare Header // Prepare header
const rendered_body = render_recent_topics_body({ const rendered_body = render_recent_topics_body({
filter_participated: filters.has('participated'), filter_participated: filters.has('participated'),
filter_unread: filters.has('unread'), filter_unread: filters.has('unread'),