diff --git a/src/app/accessibility/accessibility-settings.service.ts b/src/app/accessibility/accessibility-settings.service.ts index e86742d76d..f215167539 100644 --- a/src/app/accessibility/accessibility-settings.service.ts +++ b/src/app/accessibility/accessibility-settings.service.ts @@ -23,16 +23,22 @@ export const ACCESSIBILITY_SETTINGS_METADATA_KEY = 'dspace.accessibility.setting /** * Enum containing all possible accessibility settings. - * When adding new settings, the {@link AccessibilitySettingsService#getInputType} method and the i18n keys for the - * accessibility settings page should be updated. + * When adding new settings, make sure to add the new setting to the accessibility-settings component. + * The converter methods to convert from stored format to form format (and vice-versa) need to be updated as well. */ export enum AccessibilitySetting { NotificationTimeOut = 'notificationTimeOut', LiveRegionTimeOut = 'liveRegionTimeOut', } +/** + * Type representing an object that contains accessibility settings values. + */ export type AccessibilitySettings = { [key in AccessibilitySetting]?: string }; +/** + * The accessibility settings object format used by the accessibility-settings component form. + */ export interface AccessibilitySettingsFormValues { disableNotificationTimeOut: boolean, notificationTimeOut: string, @@ -226,6 +232,10 @@ export class AccessibilitySettingsService { return this.setSettingsInAuthenticatedUserMetadata({}); } + /** + * Retrieve the placeholder to be used for the provided AccessibilitySetting. + * Returns an empty string when no placeholder is specified for the provided setting. + */ getPlaceholder(setting: AccessibilitySetting): string { switch (setting) { case AccessibilitySetting.NotificationTimeOut: diff --git a/src/app/info/accessibility-settings/accessibility-settings.component.ts b/src/app/info/accessibility-settings/accessibility-settings.component.ts index 0de18152ee..cd417393d4 100644 --- a/src/app/info/accessibility-settings/accessibility-settings.component.ts +++ b/src/app/info/accessibility-settings/accessibility-settings.component.ts @@ -9,6 +9,9 @@ import { take } from 'rxjs'; import { NotificationsService } from '../../shared/notifications/notifications.service'; import { TranslateService } from '@ngx-translate/core'; +/** + * Component providing the form where users can update accessibility settings. + */ @Component({ selector: 'ds-accessibility-settings', templateUrl: './accessibility-settings.component.html'