Files
nairobi/app/components/management/menu_component.rb
Javi Martín db25dc13e1 Use buttons to open/close admin navigation submenus
We were using Foundation's accordion menu to open/close nested lists of
links. Unfortunately, Foundation's accordion makes it impossible to
access links in nested links using the keyboard [1] (note the issue is
closed, but in the latest version of Foundation, 6.8.1, it's still
present, and Foundation's development is mostly discontinued).
Furtheremore, it adds the `menuitem` role to links, but ARIA menus are
not ment for navigation but for application behavior and, since it
doesn't add the `menubar` or `menu` roles to the parent elements, it
results in accessibility issues for people using screen readers (also
reported by the Axe accessibility testing engine).

So we need to implement our own solution. We're using the most commonly
used pattern: a buttton with the `aria-expanded` attribute. And, for
people using browsers where JavaScript hasn't loaded, we're keeping the
submenus open at all times (just like we were doing until now), and
we're disabling the buttons (since they do nothing without JavaScript).
This might not be an ideal solution, but it's probably good enough, and
way better than what we had until now.

We've also considered using the <details> and <summary> elements instead
of using buttons to open/close items on the list. However, these
elements still present some accessibility issues [2], and the transition
between open and closed can't be animated unless we overwrite the
`click` event with JavaScript. The pattern of using these elements to
open/close a nested list of links isn't common either, and some people
using screen readers might get confused when entering/leaving the nested
list.

We tried other approaches to get the animation effect, all of them based
on adding `[aria-expanded="false"]:not([disabled]) + * { display: none;
}` to the CSS file.

Unfortunately, animation using CSS isn't feasible right now because
browsers can't animate a change form `height: 0` to `height: auto`.
There are some hacks like animating the `max-height` or the `flex-grow`
property, but the resulting animation is inconsistent. A perfect
animation can be done using the `grid-template-rows` property [3], but
it requires adding a grid container and only works in Firefox and recent
versions of Chrome and similar browsers.

Getting to a solution with JavaScript was also tricky. With the
following approach, `slideToggle()` opened the menu the first time, even
if it was already open (not sure why):

```
toggle_buttons.on("click", function() {
  $(this).attr("aria-expanded", !JSON.parse($(this).attr("aria-expanded")));
  $(this).next().slideToggle();
});
```

This made the arrow turn after the menu had slided instead of doing it
at the same time:

```
toggle_buttons.on("click", function() {
  var button = $(this);

  button.next().slideToggle(function() {
    button.attr("aria-expanded",
    !JSON.parse(button.attr("aria-expanded")));
  });
}
```

With this, everything disappeared quickly:

```
toggle_buttons.on("click", function() {
  var expanded = JSON.parse($(this).attr("aria-expanded"));

  if (expanded) {
    $(this).next().slideUp();
  } else {
    $(this).next().slideDown();
  }

  $(this).attr("aria-expanded", !expanded);
}
```

So, in the end, we're hiding the nested link lists with JavaScript
instead of CSS.

[1] Issue 12046 in https://github.com/foundation/foundation-sites
[2] https://www.scottohara.me/blog/2022/09/12/details-summary.html
[3] https://css-tricks.com/css-grid-can-do-auto-height-transitions
2024-04-18 16:10:58 +02:00

163 lines
4.1 KiB
Ruby

class Management::MenuComponent < ApplicationComponent
use_helpers :managed_user, :link_list
def links
[
user_links,
(print_investments_link if Setting["process.budgets"]),
print_proposals_link,
user_invites_link
]
end
private
def user_links
section(t("management.menu.users"), active: true, class: "users-link") do
link_list(
select_user_link,
(reset_password_email_link if managed_user.email),
reset_password_manually_link,
create_proposal_link,
support_proposals_link,
(create_budget_investment_link if Setting["process.budgets"]),
(support_budget_investments_link if Setting["process.budgets"])
)
end
end
def select_user_link
[
t("management.menu.select_user"),
management_document_verifications_path,
users?
]
end
def reset_password_email_link
[
t("management.account.menu.reset_password_email"),
edit_password_email_management_account_path,
edit_password_email?
]
end
def reset_password_manually_link
[
t("management.account.menu.reset_password_manually"),
edit_password_manually_management_account_path,
edit_password_manually?
]
end
def create_proposal_link
[
t("management.menu.create_proposal"),
new_management_proposal_path,
create_proposal?
]
end
def support_proposals_link
[
t("management.menu.support_proposals"),
management_proposals_path,
support_proposal?
]
end
def create_budget_investment_link
[
t("management.menu.create_budget_investment"),
create_investments_management_budgets_path,
create_investments?
]
end
def support_budget_investments_link
[
t("management.menu.support_budget_investments"),
support_investments_management_budgets_path,
support_investments?
]
end
def print_investments_link
[
t("management.menu.print_budget_investments"),
print_investments_management_budgets_path,
print_investments?,
class: "print-investments-link"
]
end
def print_proposals_link
[
t("management.menu.print_proposals"),
print_management_proposals_path,
print_proposals?,
class: "print-proposals-link"
]
end
def user_invites_link
[
t("management.menu.user_invites"),
new_management_user_invite_path,
user_invites?,
class: "invitations-link"
]
end
def users?
["users", "email_verifications", "document_verifications"].include?(controller_name)
end
def edit_password_email?
controller_name == "account" && action_name == "edit_password_email"
end
def edit_password_manually?
controller_name == "account" && action_name == "edit_password_manually"
end
def create_proposal?
controller_name == "proposals" && action_name == "new"
end
def support_proposal?
controller_name == "proposals" && action_name == "index"
end
def print_proposals?
controller_name == "proposals" && action_name == "print"
end
def create_investments?
(controller_name == "budget_investments" && action_name == "new") ||
(controller_name == "budgets" && action_name == "create_investments")
end
def support_investments?
(controller_name == "budget_investments" && action_name == "index") ||
(controller_name == "budgets" && action_name == "support_investments")
end
def print_investments?
(controller_name == "budget_investments" && action_name == "print") ||
(controller_name == "budgets" && action_name == "print_investments")
end
def user_invites?
controller_name == "user_invites"
end
def section(title, **, &content)
section_opener(title, **) + content.call
end
def section_opener(title, active:, **options)
button_tag(title, { type: "button", disabled: "disabled", "aria-expanded": active }.merge(options))
end
end