paulmataruso/zulip
1
0
Fork 0
mirror of https://github.com/zulip/zulip.git synced 2025-11-16 11:52:01 +00:00
Code Issues Packages Projects Releases Wiki Activity

help: Stop collapsing sidebar sections.

Browse Source 
Three reasons:

1. The sliding was disorienting.
2. The collapsing disallowed searching for other pages with Ctrl+F.
3. The collapsing mechanism wasn't accessible (not usable with the
   keyboard / no ARIA tags).

Tweaked by tabbott to center the left sidebar on the selected page.

Part of #15948.
This commit is contained in:
Gittenburg
2020-07-28 22:48:50 +02:00
committed by Tim Abbott
parent 49d0d7f3cc
commit 87d8a54b91
3 changed files with 3 additions and 16 deletions
Download Patch File Download Diff File Expand all files Collapse all files

13
static/js/portico/help.js
View File

@@ -100,17 +100,6 @@ const update_page = function (html_map, path) {
new SimpleBar($(".sidebar")[0]); new SimpleBar($(".sidebar")[0]);
$(".sidebar.slide h2").on("click", (e) => {
const $next = $(e.target).next();
if ($next.is("ul")) {
// Close other article's headings first
$(".sidebar ul").not($next).hide();
// Toggle the heading
$next.slideToggle("fast", "swing");
}
});
$(".sidebar a").on("click", function (e) { $(".sidebar a").on("click", function (e) {
const path = $(this).attr("href"); const path = $(this).attr("href");
const path_dir = path.split("/")[1]; const path_dir = path.split("/")[1];
@@ -173,3 +162,5 @@ window.addEventListener("popstate", () => {
}); });
$("body").addClass("noscroll"); $("body").addClass("noscroll");
$(".highlighted")[0].scrollIntoView({block: "center"});

2
templates/zerver/documentation_main.html
View File

@@ -5,7 +5,7 @@
{% block portico_content %} {% block portico_content %}
<div class="app help terms-page inline-block{% if page_is_help_center %} help-center{% endif %}{% if page_is_api_center %} api-center{% endif %}"> <div class="app help terms-page inline-block{% if page_is_help_center %} help-center{% endif %}{% if page_is_api_center %} api-center{% endif %}">
<div class="{{ sidebar_class }}"> <div class="sidebar">
<div class="content"> <div class="content">
<h1><a href="{{ doc_root }}" class="no-underline">Home</a></h1> <h1><a href="{{ doc_root }}" class="no-underline">Home</a></h1>
{{ render_markdown_path(sidebar_index, api_uri_context) }} {{ render_markdown_path(sidebar_index, api_uri_context) }}

4
zerver/views/documentation.py
View File

@@ -91,14 +91,11 @@ class MarkdownDirectoryView(ApiURLView):
context["page_is_help_center"] = True context["page_is_help_center"] = True
context["doc_root"] = "/help/" context["doc_root"] = "/help/"
(sidebar_index, http_status_ignored) = self.get_path("include/sidebar_index") (sidebar_index, http_status_ignored) = self.get_path("include/sidebar_index")
# We want the sliding/collapsing behavior for /help pages only
sidebar_class = "sidebar slide"
title_base = "Zulip Help Center" title_base = "Zulip Help Center"
else: else:
context["page_is_api_center"] = True context["page_is_api_center"] = True
context["doc_root"] = "/api/" context["doc_root"] = "/api/"
(sidebar_index, http_status_ignored) = self.get_path("sidebar_index") (sidebar_index, http_status_ignored) = self.get_path("sidebar_index")
sidebar_class = "sidebar"
title_base = "Zulip API Documentation" title_base = "Zulip API Documentation"
# The following is a somewhat hacky approach to extract titles from articles. # The following is a somewhat hacky approach to extract titles from articles.
@@ -118,7 +115,6 @@ class MarkdownDirectoryView(ApiURLView):
context["OPEN_GRAPH_DESCRIPTION"] = self.request.placeholder_open_graph_description context["OPEN_GRAPH_DESCRIPTION"] = self.request.placeholder_open_graph_description
context["sidebar_index"] = sidebar_index context["sidebar_index"] = sidebar_index
context["sidebar_class"] = sidebar_class
# An "article" might require the api_uri_context to be rendered # An "article" might require the api_uri_context to be rendered
api_uri_context: Dict[str, Any] = {} api_uri_context: Dict[str, Any] = {}
add_api_uri_context(api_uri_context, self.request) add_api_uri_context(api_uri_context, self.request)