Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Accessibility improvements for submission report pdf #5099

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open

Accessibility improvements for submission report pdf #5099

wants to merge 3 commits into from

Conversation

robinmolen
Copy link
Contributor

Closes #5047

Changes

  • Added semantic relationships between field label and field content.
  • When a field is left empty by the user, the submission report will display 'No information provided' in place of the missing field content.
  • Removed leading and trailing whitespace in pdf metadata title

Checklist

Check off the items that are completed or not relevant.

  • Impact on features

    • Checked copying a form
    • Checked import/export of a form
    • Config checks in the configuration overview admin page
    • Problem detection in the admin email digest is handled

  • Release management

    • I have labelled the PR as "needs-backport" accordingly

  • I have updated the translations assets (you do NOT need to provide translations)

    • Ran ./bin/makemessages_js.sh
    • Ran ./bin/compilemessages_js.sh

  • Dockerfile/scripts

    • Updated the Dockerfile with the necessary scripts from the ./bin folder

  • Commit hygiene

    • Commit messages refer to the relevant Github issue
    • Commit messages explain the "why" of change, not the how

@robinmolen robinmolen requested a review from vaszig February 11, 2025 11:19
@robinmolen robinmolen linked an issue Feb 11, 2025 that may be closed by this pull request
Accessibility improvements - PDF #5047
Open
4 tasks
@robinmolen robinmolen mentioned this pull request Feb 11, 2025
Open
4 tasks
vaszig
vaszig reviewed Feb 13, 2025
View reviewed changes
Copy link
Contributor

@vaszig vaszig left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I am not sure if we should have the translations in this PR. I remember we do it in the release flow (let me know if something has changed).

@robinmolen
Copy link
Contributor Author

I am not sure if we should have the translations in this PR. I remember we do it in the release flow (let me know if something has changed).

Ah yeah, you're right.. I'll remove them from the PR 👍

@robinmolen robinmolen force-pushed the feature/5047-pdf-a11y-improvements branch from ead9eb0 to fef4e04 Compare February 20, 2025 11:18
sergei-maertens
sergei-maertens reviewed Feb 20, 2025
View reviewed changes
src/openforms/submissions/templates/report/submission_report.html Outdated
@@ -76,19 +78,23 @@ <h2 class="subtitle">{{ submission_step_node.render }}</h2>
{% if component_node.component.type == "fieldset" %}
<span class="submission-step-row__fieldset-label">{{ component_node.label }}</span>
{% else %}
<div class="submission-step-row__label">
<span id="{{ component_node.key }}" class="submission-step-row__label">
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not sure if these are sufficiently unique if you use repeating groups, have you tested that?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah, this wasn't enough for repeating groups... I've added the component_node.configuration_path as prefix, to ensure unique ids. I'm not entirely sure configuration_path is the best fit in this situation, but it creates the right result.

I've tried using the component_node.path and component_node.json_renderer_path, but couldn't get those to render properly...

If you have another solution in mind for this, i would love to hear it

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

let's stick to that then - @viktorvanwijk this further complicates the data structures cleanup 😬

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Excellent 🙃

@robinmolen
♿ [#5047] Providing relationships in submission report PDF
eaf228c 
Added aria tags that showcase that field label and field value are related
@robinmolen
♿ [#5047] Show "not filled in" when a field is empty in the submissio…
ea4b733 
…n report pdf

To indicate when a field has been left empty by the user, show "No information provided" in the place where the filled in information would have been.
This also helps screen reader users identify which fields aren't filled in.
@robinmolen
♿ [#5047] Removing whitespace from pdf title
c2c4ddb 
Without the `spaceless` tags the pdf will be generated with leading and trailing whitespace. This whitespace only visible/noticeable when you look at the title in the pdf metadata.
@robinmolen robinmolen force-pushed the feature/5047-pdf-a11y-improvements branch from fef4e04 to c2c4ddb Compare February 24, 2025 10:57
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@sergei-maertens sergei-maertens sergei-maertens left review comments

@viktorvanwijk viktorvanwijk viktorvanwijk left review comments

@vaszig vaszig vaszig left review comments

At least 1 approving review is required to merge this pull request.

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Accessibility improvements - PDF
4 participants
@robinmolen @sergei-maertens @viktorvanwijk @vaszig