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.

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

Accessibility settings page #3613

Open
wants to merge 28 commits into
base: main
Choose a base branch
from

Conversation

AAwouters
Copy link
Contributor

@AAwouters AAwouters commented Nov 6, 2024

References

REST PR: Accessibility settings metadata field 9964
8_x backport: #3614
7_x backport: #3615

Fixes point 3 of #1191: "Content visually appears and disappears with no ability to adjust timing."

Description

This PR adds the 'Accessibility settings' page where a user can configure accessibility settings. This page can be found either through the 'Accessibility settings' link in the footer, or through the link on the profile page. The settings are stored in a cookie when the user is not authorized and are stored in a metadata field (see backend PR) when the user is authenticated.

Instructions for Reviewers

Access the page through one of the mentioned links, or directly at /info/accessibility. Currently only two settings are available: notification time-out and live region time-out. Functionality of the notification time-out is the easiest to verify. Set a new value and click the 'Save accessibility settings` button. A notification will appear mentioning whether the changes are saved locally (cookie) or on the user profile (metadata) and this notification will stay as long as configured.
Live region time-out can be verified by making the live region visible. (see #3337)

List of changes in this PR:

  • Adds the accessibility-settings component and service
  • Adds links to the 'Accessibility settings' page to the footer and profile page.
  • Notifications added to the notifications-board will have the user-configured time-out (if set by the user).
  • Messages added to the live-region will have the user-configured time-out (if set by the user).

Checklist

  • 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.

…-main

# Conflicts:
#	src/app/core/auth/auth.service.ts
#	src/app/info/info-routing-paths.ts
#	src/app/info/info-routing.module.ts
#	src/app/info/info.module.ts
#	src/app/shared/live-region/live-region.service.spec.ts
#	src/app/shared/live-region/live-region.service.ts
#	src/app/shared/notifications/notifications-board/notifications-board.component.spec.ts
#	src/app/shared/notifications/notifications-board/notifications-board.component.ts
#	src/config/app-config.interface.ts
#	src/config/default-app-config.ts
@AAwouters AAwouters force-pushed the accessibility-settings-main branch from 12fa618 to 3422ec7 Compare November 25, 2024 11:10
@AAwouters AAwouters force-pushed the accessibility-settings-main branch from 3422ec7 to 923d0ff Compare November 29, 2024 10:25
…-main

# Conflicts:
#	src/app/accessibility/accessibility-settings.service.spec.ts
#	src/app/accessibility/accessibility-settings.service.ts
#	src/app/info/accessibility-settings/accessibility-settings.component.spec.ts
#	src/app/info/accessibility-settings/accessibility-settings.component.ts
#	src/app/info/info.module.ts
#	src/app/shared/live-region/live-region.service.ts
#	src/app/shared/notifications/notifications-board/notifications-board.component.ts
@AAwouters AAwouters force-pushed the accessibility-settings-main branch from 923d0ff to ff7c9ba Compare December 11, 2024 10:05
@AAwouters AAwouters marked this pull request as ready for review December 11, 2024 10:34
@tdonohue tdonohue added this to the 9.0 milestone Dec 11, 2024
@tdonohue tdonohue self-requested a review December 12, 2024 15:59
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Status: 🙋 Needs Reviewers Assigned
Development

Successfully merging this pull request may close these issues.

2 participants