Files
grecia/spec/system/admin/site_customization/pages_spec.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

104 lines
3.3 KiB
Ruby

require "rails_helper"
describe "Admin custom pages", :admin do
context "Index" do
scenario "lists all created custom pages" do
custom_page = create(:site_customization_page)
visit admin_site_customization_pages_path
expect(page).to have_content(custom_page.title)
expect(page).to have_content(custom_page.slug)
end
scenario "should contain all default custom pages published populated by db:seeds" do
slugs = %w[accessibility census_terms conditions faq privacy welcome_not_verified
welcome_level_two_verified welcome_level_three_verified]
expect(SiteCustomization::Page.count).to be 8
slugs.each do |slug|
expect(SiteCustomization::Page.find_by(slug: slug).status).to eq "published"
end
visit admin_site_customization_pages_path
expect(all("[id^='site_customization_page_']").count).to be 8
slugs.each do |slug|
expect(page).to have_content slug
end
end
end
context "Create" do
scenario "Valid custom page" do
visit admin_root_path
within("#side_menu") do
click_button "Site content"
click_link "Custom pages"
end
expect(page).not_to have_content "An example custom page"
expect(page).not_to have_content "example-page"
click_link "Create new page"
fill_in "Title", with: "An example custom page"
fill_in "Subtitle", with: "Page subtitle"
fill_in "site_customization_page_slug", with: "example-page"
fill_in_ckeditor "Content", with: "This page is about..."
click_button "Create Custom page"
expect(page).to have_content "An example custom page"
expect(page).to have_content "example-page"
end
end
context "Update" do
let!(:custom_page) do
create(:site_customization_page, title: "An example custom page", slug: "custom-example-page")
end
scenario "Valid custom page" do
visit admin_root_path
within("#side_menu") do
click_button "Site content"
click_link "Custom pages"
end
within("tr", text: "An example custom page") { click_link "Edit" }
expect(page).to have_css "h2", text: "An example custom page"
expect(page).to have_css "input[value='custom-example-page']"
fill_in "Title", with: "Another example custom page"
fill_in "site_customization_page_slug", with: "another-custom-example-page"
click_button "Update Custom page"
expect(page).to have_content "Page updated successfully"
expect(page).to have_content "Another example custom page"
expect(page).to have_content "another-custom-example-page"
end
scenario "Allows images in CKEditor" do
visit edit_admin_site_customization_page_path(custom_page)
fill_in_ckeditor "Content", with: "Will add an image"
expect(page).to have_css(".cke_toolbar .cke_button__image_icon")
end
end
scenario "Delete" do
custom_page = create(:site_customization_page, title: "An example custom page")
visit edit_admin_site_customization_page_path(custom_page)
accept_confirm "Are you sure? This action will delete \"An example custom page\" and can't be undone." do
click_button "Delete page"
end
expect(page).not_to have_content "An example custom page"
expect(page).not_to have_content "example-page"
end
end