@@ -23,16 +23,22 @@ export const ACCESSIBILITY_SETTINGS_METADATA_KEY = 'dspace.accessibility.setting
2323
2424/**
2525 * Enum containing all possible accessibility settings.
26- * When adding new settings, the { @link AccessibilitySettingsService#getInputType} method and the i18n keys for the
27- * accessibility settings page should be updated.
26+ * When adding new settings, make sure to add the new setting to the accessibility-settings component.
27+ * The converter methods to convert from stored format to form format (and vice-versa) need to be updated as well .
2828 */
2929export enum AccessibilitySetting {
3030 NotificationTimeOut = 'notificationTimeOut' ,
3131 LiveRegionTimeOut = 'liveRegionTimeOut' ,
3232}
3333
34+ /**
35+ * Type representing an object that contains accessibility settings values.
36+ */
3437export type AccessibilitySettings = { [ key in AccessibilitySetting ] ?: string } ;
3538
39+ /**
40+ * The accessibility settings object format used by the accessibility-settings component form.
41+ */
3642export interface AccessibilitySettingsFormValues {
3743 disableNotificationTimeOut : boolean ,
3844 notificationTimeOut : string ,
@@ -226,6 +232,10 @@ export class AccessibilitySettingsService {
226232 return this . setSettingsInAuthenticatedUserMetadata ( { } ) ;
227233 }
228234
235+ /**
236+ * Retrieve the placeholder to be used for the provided AccessibilitySetting.
237+ * Returns an empty string when no placeholder is specified for the provided setting.
238+ */
229239 getPlaceholder ( setting : AccessibilitySetting ) : string {
230240 switch ( setting ) {
231241 case AccessibilitySetting . NotificationTimeOut :
0 commit comments