Use a button for non-GET table actions

Links acting like buttons have a few disadvantages.

First, screen readers will announce them as "links". Screen reader users
usually associate links with "things that get you somewhere" and buttons
with "things that perform an action". So when something like "Delete,
link" is announced, they'll probably think this is a link which will
take them to another page where they can delete a record.

Furthermore, the URL of the link for the "destroy" action might be the
same as the URL for the "show" action (only one is accessed with a
DELETE request and the other one with a GET request). That means screen
readers could announce the link like "Delete, visited link", which is
very confusing.

They also won't work when opening links in a new tab, since opening
links in a new tab always results in a GET request to the URL the link
points to.

Finally, submit buttons work without JavaScript enabled, so they'll work
even if the JavaScript in the page hasn't loaded (for whatever reason).

For all these reasons (and probably many more), using a button to send
forms is IMHO superior to using links.

There's one disadvantage, though. Using `button_to` we create a <form>
tag, which means we'll generate invalid HTML if the table is inside
another form. If we run into this issue, we need to use `button_tag`
with a `form` attribute and then generate a form somewhere else inside
the HTML (with `content_for`).

Note we're using `button_to` with a block so it generates a <button>
tag. Using it in a different way the text would result in an <input />
tag, and input elements can't have pseudocontent added via CSS.

The following code could be a starting point to use the `button_tag`
with a `form` attribute. One advantage of this approach is screen
readers wouldn't announce "leaving form" while navigating through these
buttons. However, it doesn't work in Internet Explorer.

```
ERB:

<% content_for(:hidden_content, form_tag(path, form_options) {}) %>
<%= button_tag text, button_options %>

Ruby:

def form_id
  path.gsub("/", "_")
end

def form_options
  { id: form_id, method: options[:method] }
end

def button_options
  html_options.except(:method).merge(form: form_id)
end

Layout:

<%= content_for :hidden_content %> # Right before the `</body>`
```
This commit is contained in:
Javi Martín
2021-08-18 13:30:02 +02:00
parent 6510cb9615
commit 5311daadfe
50 changed files with 193 additions and 166 deletions

View File

@@ -4,35 +4,36 @@ describe Admin::Organizations::TableActionsComponent, controller: Admin::Organiz
let(:organization) { create(:organization) }
let(:component) { Admin::Organizations::TableActionsComponent.new(organization) }
it "renders links to verify and reject when it can" do
it "renders buttons to verify and reject when it can" do
allow(component).to receive(:can_verify?).and_return(true)
allow(component).to receive(:can_reject?).and_return(true)
render_inline component
expect(page).to have_css "a", count: 2
expect(page).to have_css "a[href*='verify'][data-method='put']", text: "Verify"
expect(page).to have_css "a[href*='reject'][data-method='put']", text: "Reject"
expect(page).to have_button count: 2
expect(page).to have_css "form[action*='verify']", exact_text: "Verify"
expect(page).to have_css "form[action*='reject']", exact_text: "Reject"
expect(page).to have_css "input[name='_method'][value='put']", visible: :hidden, count: 2
end
it "renders link to verify when it cannot reject" do
it "renders button to verify when it cannot reject" do
allow(component).to receive(:can_verify?).and_return(true)
allow(component).to receive(:can_reject?).and_return(false)
render_inline component
expect(page).to have_css "a", count: 1
expect(page).to have_link "Verify"
expect(page).to have_button count: 1
expect(page).to have_button "Verify"
end
it "renders link to reject when it cannot verify" do
it "renders button to reject when it cannot verify" do
allow(component).to receive(:can_verify?).and_return(false)
allow(component).to receive(:can_reject?).and_return(true)
render_inline component
expect(page).to have_css "a", count: 1
expect(page).to have_link "Reject"
expect(page).to have_button count: 1
expect(page).to have_button "Reject"
end
it "does not render any actions when it cannot verify nor reject" do
@@ -41,6 +42,6 @@ describe Admin::Organizations::TableActionsComponent, controller: Admin::Organiz
render_inline component
expect(page).not_to have_css "a"
expect(page).not_to have_button
end
end