Zulip server and web application. Open-source team chat that helps teams stay productive and focused.
import {$} from "jquery";
import _ from "lodash";
import * as drafts from "./drafts.ts";
import type {Filter} from "./filter.ts";
import {localstorage} from "./localstorage.ts";
import * as message_reminder from "./message_reminder.ts";
import * as navigation_views from "./navigation_views.ts";
import {page_params} from "./page_params.ts";
import * as people from "./people.ts";
import * as resize from "./resize.ts";
import * as scheduled_messages from "./scheduled_messages.ts";
import * as settings_config from "./settings_config.ts";
import type {NarrowTerm} from "./state_data.ts";
import * as ui_util from "./ui_util.ts";
import * as unread from "./unread.ts";
let last_mention_count = 0;
const ls_key = "left_sidebar_views_state";
const ls = localstorage();
const STATES = {
EXPANDED: "expanded",
CONDENSED: "condensed",
};
export function restore_views_state(): void {
if (page_params.is_spectator) {
// Spectators should always see the expanded view.
return;
}
const views_state = ls.get(ls_key);
// Expanded state is default, so we only need to toggle if the state is condensed.
if (views_state === STATES.CONDENSED) {
toggle_condensed_navigation_area();
}
}
function save_state(state: string): void {
ls.set(ls_key, state);
}
export function update_starred_count(count: number, hidden: boolean): void {
const $starred_li = $(".top_left_starred_messages");
ui_util.update_unread_count_in_dom($starred_li, count);
if (hidden) {
$starred_li.addClass("hide_starred_message_count");
return;
}
$starred_li.removeClass("hide_starred_message_count");
}
export function update_scheduled_messages_row(): void {
const $scheduled_li = $(".top_left_scheduled_messages");
const count = scheduled_messages.get_count();
$scheduled_li.toggleClass("hidden-by-filters", count === 0);
ui_util.update_unread_count_in_dom($scheduled_li, count);
}
export function update_reminders_row(): void {
const $reminders_li = $(".top_left_reminders");
const count = message_reminder.get_count();
$reminders_li.toggleClass("hidden-by-filters", count === 0);
ui_util.update_unread_count_in_dom($reminders_li, count);
}
export let update_dom_with_unread_counts = function (
counts: unread.FullUnreadCountsData,
skip_animations: boolean,
): void {
// Note that direct message counts are handled in pm_list.ts.
// mentioned/home views have simple integer counts
const $mentioned_li = $(".top_left_mentions");
const $home_view_li = $(".selected-home-view");
const $condensed_view_li = $(".top_left_condensed_unread_marker");
ui_util.update_unread_count_in_dom($mentioned_li, counts.mentioned_message_count);
ui_util.update_unread_count_in_dom($home_view_li, counts.home_unread_messages);
ui_util.update_unread_count_in_dom($condensed_view_li, counts.home_unread_messages);
if (!skip_animations) {
animate_unread_changes($mentioned_li, counts.mentioned_message_count, last_mention_count);
}
last_mention_count = counts.mentioned_message_count;
};
export function rewire_update_dom_with_unread_counts(
value: typeof update_dom_with_unread_counts,
): void {
update_dom_with_unread_counts = value;
}
export let select_top_left_corner_item = function (narrow_to_activate: string): void {
$(".top-left-active-filter").removeClass("top-left-active-filter");
if (narrow_to_activate !== "") {
$(narrow_to_activate).addClass("top-left-active-filter");
}
};
export function rewire_select_top_left_corner_item(
func: (narrow_to_activate: string) => void,
): void {
select_top_left_corner_item = func;
}
export function handle_narrow_activated(filter: Filter): void {
let terms: NarrowTerm[];
let filter_name: NarrowTerm["operand"];
// TODO: handle confused filters like "in:all stream:foo"
terms = filter.terms_with_operator("in");
if (terms[0] !== undefined) {
filter_name = terms[0].operand;
if (filter_name === "home") {
highlight_all_messages_view();
return;
}
}
terms = filter.terms_with_operator("is");
if (terms[0] !== undefined) {
filter_name = terms[0].operand;
if (filter_name === "starred") {
select_top_left_corner_item(".top_left_starred_messages");
return;
}
if (filter_name === "mentioned") {
select_top_left_corner_item(".top_left_mentions");
return;
}
}
const term_types = filter.sorted_term_types();
if (
_.isEqual(term_types, ["sender", "has-reaction"]) &&
filter.terms_with_operator("sender")[0]!.operand === people.my_current_user_id()
) {
select_top_left_corner_item(".top_left_my_reactions");
return;
}
// If we don't have a specific handler for this narrow, we just clear all.
select_top_left_corner_item("");
}
export function expand_views($views_label_container: JQuery, $views_label_icon: JQuery): void {
$views_label_container.addClass("showing-expanded-navigation");
$views_label_container.removeClass("showing-condensed-navigation");
$views_label_icon.addClass("rotate-icon-down");
$views_label_icon.removeClass("rotate-icon-right");
}
export function collapse_views($views_label_container: JQuery, $views_label_icon: JQuery): void {
$views_label_container.addClass("showing-condensed-navigation");
$views_label_container.removeClass("showing-expanded-navigation");
$views_label_icon.addClass("rotate-icon-right");
$views_label_icon.removeClass("rotate-icon-down");
}
export function force_expand_views(): void {
if (page_params.is_spectator) {
// We don't support collapsing VIEWS for spectators, so exit early.
return;
}
const $views_label_container = $("#views-label-container");
const $views_label_icon = $("#toggle-top-left-navigation-area-icon");
if ($views_label_container.hasClass("showing-condensed-navigation")) {
expand_views($views_label_container, $views_label_icon);
save_state(STATES.EXPANDED);
resize.resize_stream_filters_container();
}
}
export function force_collapse_views(): void {
if (page_params.is_spectator) {
// We don't support collapsing VIEWS for spectators, so exit early.
return;
}
const $views_label_container = $("#views-label-container");
const $views_label_icon = $("#toggle-top-left-navigation-area-icon");
if ($views_label_container.hasClass("showing-expanded-navigation")) {
collapse_views($views_label_container, $views_label_icon);
save_state(STATES.CONDENSED);
resize.resize_stream_filters_container();
}
}
function toggle_condensed_navigation_area(): void {
const $views_label_container = $("#views-label-container");
if (page_params.is_spectator) {
// We don't support collapsing VIEWS for spectators, so exit early.
return;
}
if ($views_label_container.hasClass("showing-expanded-navigation")) {
force_collapse_views();
} else {
force_expand_views();
}
}
export function animate_unread_changes(
$li: JQuery,
new_count: number,
previous_count: number,
): void {
if (new_count > previous_count) {
ui_util.do_new_unread_animation($li);
}
}
export function highlight_inbox_view(): void {
select_top_left_corner_item(".top_left_inbox");
setTimeout(() => {
resize.resize_stream_filters_container();
}, 0);
}
export function highlight_recent_view(): void {
select_top_left_corner_item(".top_left_recent_view");
setTimeout(() => {
resize.resize_stream_filters_container();
}, 0);
}
export function highlight_all_messages_view(): void {
select_top_left_corner_item(".top_left_all_messages");
setTimeout(() => {
resize.resize_stream_filters_container();
}, 0);
}
export function get_view_rows_by_view_name(view: string): JQuery {
if (view === settings_config.web_home_view_values.all_messages.code) {
return $(".top_left_all_messages");
}
if (view === settings_config.web_home_view_values.recent.code) {
return $(".top_left_recent_view");
}
return $(".top_left_inbox");
}
// Reorder <li> views elements in the DOM based on the current home_view.
// Called twice: on initial page load and when home_view changes.
export function reorder_left_sidebar_navigation_list(home_view: string): void {
const $left_sidebar = $("#left-sidebar-navigation-list");
const $left_sidebar_condensed = $("#left-sidebar-navigation-list-condensed");
// First, re-order the views back to the original default order, to preserve the relative order.
for (const key of Object.keys(settings_config.web_home_view_values).toReversed()) {
if (key !== home_view) {
const $view = get_view_rows_by_view_name(key);
$view.eq(1).prependTo($left_sidebar);
$view.eq(0).prependTo($left_sidebar_condensed);
}
}
// Detach the selected home_view and inserts it at the beginning of the navigation list.
const $selected_home_view = get_view_rows_by_view_name(home_view);
$selected_home_view.eq(1).prependTo($left_sidebar);
$selected_home_view.eq(0).prependTo($left_sidebar_condensed);
}
export function handle_home_view_changed(new_home_view: string): void {
const $current_home_view = $(".selected-home-view");
const $new_home_view = get_view_rows_by_view_name(new_home_view);
const res = unread.get_counts();
// Remove class from current home view
$current_home_view.removeClass("selected-home-view");
// Add the class to the matching home view
$new_home_view.addClass("selected-home-view");
reorder_left_sidebar_navigation_list(new_home_view);
update_dom_with_unread_counts(res, true);
}
export function get_built_in_primary_condensed_views(): navigation_views.BuiltInViewMetadata[] {
function score(view: navigation_views.BuiltInViewMetadata): number {
if (view.prioritize_in_condensed_view) {
return 1;
}
return 0;
}
// Get the top 5 prioritized views.
return navigation_views
.get_built_in_views()
.toSorted((view1, view2) => score(view2) - score(view1))
.slice(0, 5);
// TODO: Think about filtering out scheduled message and reminders views with UI to support less than 5 views.
}
export function get_built_in_popover_condensed_views(): navigation_views.BuiltInViewMetadata[] {
const visible_condensed_views = get_built_in_primary_condensed_views();
const all_views = navigation_views.get_built_in_views();
return all_views.filter((view) => {
if (view.fragment === "scheduled") {
const scheduled_message_count = scheduled_messages.get_count();
if (scheduled_message_count === 0) {
return false;
}
view.unread_count = scheduled_message_count;
return true;
}
if (view.fragment === "reminders") {
const reminders_count = message_reminder.get_count();
if (reminders_count === 0) {
return false;
}
view.unread_count = reminders_count;
return true;
}
if (view.fragment === "drafts") {
view.unread_count = drafts.draft_model.getDraftCount();
}
// Remove views that are already visible.
return visible_condensed_views.every(
(visible_view) => visible_view.fragment !== view.fragment,
);
});
}
export function get_built_in_views(): navigation_views.BuiltInViewMetadata[] {
return navigation_views.get_built_in_views();
}
export function initialize(): void {
update_reminders_row();
update_scheduled_messages_row();
restore_views_state();
$("body").on(
"click",
"#toggle-top-left-navigation-area-icon, #views-label-container .left-sidebar-title",
(e) => {
e.stopPropagation();
toggle_condensed_navigation_area();
},
);
}