Skip to content

Conversation

@FrancescoMolinaro
Copy link
Contributor

@FrancescoMolinaro FrancescoMolinaro commented Apr 16, 2025

References

Fixes #4198

Description

Following what is described in https://www.deque.com/blog/accessible-forms-the-problem-with-placeholders/ as an issue with placeholder, this PR gives the possibility to disable, via a configuration property, the placeholders in simple fields during submission. (fields where it would just be the replica of the label)

Instructions for Reviewers

If the newly introduced param ignorePlaceholderForSimpleFields is set to true in the default-app.config.ts the placeholders in submission shouldn't be visible unless they are different from the label and bring some additional information.

If set to false all the placeholders should be visible as before.

List of changes in this PR:

Make placeholder presence configurable
Fix wrongly used placeholder in date field

Checklist

This checklist provides a reminder of what we are going to look for when reviewing your PR. You do not need to complete this checklist prior creating your PR (draft PRs are always welcome).
However, reviewers may request that you complete any actions in this list if you have not done so. If you are unsure about an item in the checklist, don't hesitate to ask. We're here to help!

  • My PR is created against the main branch of code (unless it is a backport or is fixing an issue specific to an older branch).
  • My PR is small in size (e.g. less than 1,000 lines of code, not including comments & specs/tests), or I have provided reasons as to why that's not possible.
  • My PR passes ESLint validation using npm run lint
  • My PR doesn't introduce circular dependencies (verified via npm run check-circ-deps)
  • My PR includes TypeDoc comments for all new (or modified) public methods and classes. It also includes TypeDoc for large or complex private methods.
  • My PR passes all specs/tests and includes new/updated specs or tests based on the Code Testing Guide.
  • My PR aligns with Accessibility guidelines if it makes changes to the user interface.
  • My PR uses i18n (internationalization) keys instead of hardcoded English text, to allow for translations.
  • My PR includes details on how to test it. I've provided clear instructions to reviewers on how to successfully test this fix or feature.
  • If my PR includes new libraries/dependencies (in package.json), I've made sure their licenses align with the DSpace BSD License based on the Licensing of Contributions documentation.
  • If my PR includes new features or configurations, I've provided basic technical documentation in the PR itself.
  • If my PR fixes an issue ticket, I've linked them together.

@tdonohue tdonohue changed the title Task/main/duracom 347 Fix accessibility issues with placeholder text in submission forms Apr 16, 2025
@tdonohue tdonohue added accessibility component: submission 1 APPROVAL pull request only requires a single approval to merge labels Apr 16, 2025
@tdonohue tdonohue moved this to 🙋 Needs Reviewers Assigned in DSpace 9.0 Release Apr 16, 2025
@tdonohue
Copy link
Member

Temporarily closing & reopening this PR to trigger tests to run again. The e2e test failures currently in this PR seem unrelated to the PR itself, and I'm hoping reopening this PR will get this to run against latest main.

@tdonohue tdonohue closed this May 14, 2025
@github-project-automation github-project-automation bot moved this from 🙋 Needs Reviewers Assigned to ✅ Done in DSpace 9.0 Release May 14, 2025
@tdonohue tdonohue reopened this May 14, 2025
@tdonohue tdonohue moved this from ✅ Done to 🙋 Needs Reviewers Assigned in DSpace 9.0 Release May 14, 2025
@tdonohue
Copy link
Member

@FrancescoMolinaro : Just a note this PR seems to be failing the automated accessibility scan that is done in e2e tests. The failure is in the Submission Form and it says this:

1 accessibility violation was detected
[
  {
    id: 'label',
    impact: 'critical',
    description: 'Ensure every form element has a label',
    helpUrl: 'https://dequeuniversity.com/rules/axe/4.10/label?application=axeAPI',
    nodes: 4,
    html: [
      '<input class="form-control ng-untouched ng-pristine ng-valid ng-star-inserted" autocomplete="on" id="6_array-0-dc_contributor_author" name="dc.contributor.author" placeholder="" spellcheck="true" tabindex="0" type="text">',
      '<input class="form-control ng-untouched ng-pristine ng-valid ng-star-inserted" autocomplete="on" id="9_array-0-dc_title_alternative" name="dc.title.alternative" placeholder="" spellcheck="true" tabindex="0" type="text">',
      '<input class="form-control ds-form-input-value ng-untouched ng-pristine ng-valid ng-star-inserted" autocomplete="on" id="15_array-0-dc_identifier_QUALDROP_VALUE" name="dc.identifier_QUALDROP_VALUE" placeholder="" spellcheck="false" tabindex="0" type="text">',
      '<input _ngcontent-dspace-angular-c4223387587="" class="form-control scrollable-dropdown-input" id="17_array-0-dc_type" name="dc.type" readonly="" type="text" aria-controls="combobox_17_array-0-dc_type_listbox" autocomplete="off">'
    ]
  }
]
    (Attempt 1 of 3) should create a new submission when using /submit path & pass accessibility

@github-actions
Copy link

Hi @FrancescoMolinaro,
Conflicts have been detected against the base branch.
Please resolve these conflicts as soon as you can. Thanks!

@tdonohue tdonohue moved this to 🙋 Needs Reviewers Assigned in DSpace 10.0 Release May 19, 2025
@FrancescoMolinaro
Copy link
Contributor Author

Hi @tdonohue , sorry for the delay on this one, I have adapted the code to handle also the native components from the form library, the PR should be ready now.

@tdonohue tdonohue moved this from 🙋 Needs Reviewers Assigned to 👀 Under Review in DSpace 10.0 Release Oct 30, 2025
@github-actions
Copy link

Hi @FrancescoMolinaro,
Conflicts have been detected against the base branch.
Please resolve these conflicts as soon as you can. Thanks!

Copy link
Member

@tdonohue tdonohue left a comment

Choose a reason for hiding this comment

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

@FrancescoMolinaro : I'm looking at this after having reviewed #4777 from @AndreaBarbasso , and I feel this two PRs have slight conflicts.

In #4777, we have added labels to fields (like dates) which used the placeholder as a "label". This removes the usefulness of the placeholders on date fields.

So, arguably once those fields have labels, we could just remove their placeholders(which is what is recommended in https://www.deque.com/blog/accessible-forms-the-problem-with-placeholders/). That'd simplify things as we'd no longer need the configuration setting that you are adding in this PR.

If there are some fields where the placeholders are still necessary, then we could look at ways to remove those placeholders or fix the color contrast (if possible). So, I'd rather not introduce this new omitSimpleFieldPlaceholders configuration, because we should discourage people from using placeholders in general.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

1 APPROVAL pull request only requires a single approval to merge accessibility component: submission

Projects

Status: 👀 Under Review

Development

Successfully merging this pull request may close these issues.

Make presence of placeholders in submission configurable and hide placeholders by default; to avoid accessibility issues

2 participants