Accessibility #4: Make alerts accessible, Added new setting under misc. #12158

agilewarealok · 2018-05-18T13:56:13Z

Overview

A problem for low vision users is alerts, their AT software doesn't recognise them, so they miss warnings and end up adding duplicates. It would be great to have some sort of per user control for setting how alerts display, perhaps even adding audio cues.

Before

The CiviCRM alerts were not accessible for AT software and there was no setting to disable the dismiss of the info alerts.

After

Now the alerts are accessible which means screen reader software can be set to provide audible alerts, and we have a setting under civicrm/admin/setting/misc to disable the dismissal of all alerts.

Comments

Agileware Ref: CIVICRM-856

jusfreeman · 2018-05-24T06:45:13Z

This PR relates to this work https://lab.civicrm.org/dev/accessibility/issues/4

JoeMurray · 2018-05-24T15:23:18Z

settings/Core.setting.php

+    'title' => 'Dismiss info alerts',
+    'is_domain' => 1,
+    'is_contact' => 0,
+    'description' => 'If disabled, CiviCRM will stop dismissing the information alerts.',


Maybe instead, 'If disabled, CiviCRM will not automatically dismiss information alerts after 10 seconds.'

JoeMurray · 2018-05-24T15:24:01Z

settings/Core.setting.php

+    'is_domain' => 1,
+    'is_contact' => 0,
+    'description' => 'If disabled, CiviCRM will stop dismissing the information alerts.',
+    'help_text' => NULL,


Could you put description in here so there is some on-screen explanation of what the setting does? Thx.

agilewarealok · 2018-05-25T08:19:14Z

@JoeMurray We've updated the PR accordingly. To add on-screen explanation we had to put the description directly on templates/CRM/Admin/Form/Setting/Miscellaneous.tpl as Help and Description text are not accessible on Template page.

JoeMurray · 2018-05-29T11:41:16Z

js/Common.js

@@ -1246,7 +1246,7 @@ if (!CRM.vars) CRM.vars = {};
        unique: true
      };
      options = $.extend(extra, options);
-      options.expires = options.expires === false ? 0 : parseInt(options.expires, 10);
+      options.expires = (options.expires === false || (!CRM.config.dismissInfoAlerts && type == "info")) ? 0 : parseInt(options.expires, 10);


There seems to be a logic error here. Automatic dismissal should be prevented for all errors, not just Info errors. I think you need to remove
&& type == "info"

Also, change name as per https://github.com/civicrm/civicrm-core/pull/12158/files#r191394619

JoeMurray · 2018-05-29T11:50:10Z

settings/Core.setting.php

+    'default' => TRUE,
+    'html_type' => 'radio',
+    'add' => '4.7',
+    'title' => 'Dismiss info alerts',


I think success alerts expire at the moment too. What about saying 'Allow alerts to auto-dismiss?'.

Since we are affecting more than just info alerts, the name of the setting should change too. How about changing from dismiss_info_alerts to allow_alert_autodismissal ?

JoeMurray · 2018-05-29T11:50:47Z

settings/Core.setting.php

+    'title' => 'Dismiss info alerts',
+    'is_domain' => 1,
+    'is_contact' => 0,
+    'description' => 'If disabled, CiviCRM will not automatically dismiss information alerts after 10 seconds.',


change 'information' to 'any'

JoeMurray · 2018-05-29T11:51:09Z

settings/Core.setting.php

+  'dismiss_info_alerts' => array(
+    'group_name' => 'CiviCRM Preferences',
+    'group' => 'core',
+    'name' => 'dismiss_info_alerts',


change name as per https://github.com/civicrm/civicrm-core/pull/12158/files#r191394619

JoeMurray · 2018-05-29T11:52:40Z

templates/CRM/Admin/Form/Setting/Miscellaneous.tpl

+        <tr class="crm-miscellaneous-form-block-dismiss_info_alerts">
+            <td class="label">{$form.dismiss_info_alerts.label}</td>
+            <td>{$form.dismiss_info_alerts.html}<br />
+                <p class="description">{ts}If disabled, CiviCRM will not automatically dismiss information alerts after 10 seconds.{/ts}</p>


change 'information' to 'any'.

JoeMurray · 2018-05-29T11:53:47Z

api/v3/examples/Setting/GetFields.php

@@ -479,6 +479,21 @@ function setting_getfields_expectedresult() {
        'description' => 'If enabled, CiviCRM will permit submissions from external sites to profiles. This is disabled by default to limit abuse.',
        'help_text' => '',
      ),
+      'dismiss_info_alerts' => array(


change name as per https://github.com/civicrm/civicrm-core/pull/12158/files#r191394619

JoeMurray · 2018-05-29T11:54:36Z

CRM/Admin/Form/Setting/Miscellaneous.php

@@ -54,6 +54,7 @@ class CRM_Admin_Form_Setting_Miscellaneous extends CRM_Admin_Form_Setting {
    'recentItemsProviders' => CRM_Core_BAO_Setting::SYSTEM_PREFERENCES_NAME,
    'dedupe_default_limit' => CRM_Core_BAO_Setting::SYSTEM_PREFERENCES_NAME,
    'remote_profile_submissions' => CRM_Core_BAO_Setting::SYSTEM_PREFERENCES_NAME,
+    'dismiss_info_alerts' => CRM_Core_BAO_Setting::SYSTEM_PREFERENCES_NAME,


change name as per https://github.com/civicrm/civicrm-core/pull/12158/files#r191394619

JoeMurray · 2018-05-29T11:54:51Z

CRM/Core/Resources.php

@@ -690,6 +690,7 @@ public static function outputLocalizationJS() {
        'filters' => self::getEntityRefFilters(),
      ),
      'ajaxPopupsEnabled' => self::singleton()->ajaxPopupsEnabled,
+      'dismissInfoAlerts' => Civi::settings()->get('dismiss_info_alerts'),


change name as per https://github.com/civicrm/civicrm-core/pull/12158/files#r191394619

JoeMurray · 2018-05-29T11:55:09Z

api/v3/examples/Setting/GetFields.php

+      'dismiss_info_alerts' => array(
+        'group_name' => 'CiviCRM Preferences',
+        'group' => 'core',
+        'name' => 'dismiss_info_alerts',


change name as per https://github.com/civicrm/civicrm-core/pull/12158/files#r191394619

JoeMurray · 2018-05-29T11:55:20Z

api/v3/examples/Setting/GetFields.php

+        'default' => '1',
+        'html_type' => 'radio',
+        'add' => '4.7',
+        'title' => 'Dismiss info alerts',


change name as per https://github.com/civicrm/civicrm-core/pull/12158/files#r191394619

JoeMurray · 2018-05-29T11:58:53Z

api/v3/examples/Setting/GetFields.php

+        'title' => 'Dismiss info alerts',
+        'is_domain' => 1,
+        'is_contact' => 0,
+        'description' => 'If disabled, CiviCRM will stop dismissing the information alerts.',


How about, 'If disabled, alert messages in CiviCRM will never be automatically dismissed after 10 seconds.'

JoeMurray · 2018-05-29T11:59:08Z

settings/Core.setting.php

@@ -192,6 +192,21 @@
    'description' => 'If enabled, CiviCRM will permit submissions from external sites to profiles. This is disabled by default to limit abuse.',
    'help_text' => NULL,
  ),
+  'dismiss_info_alerts' => array(


change name as per https://github.com/civicrm/civicrm-core/pull/12158/files#r191394619

JoeMurray · 2018-05-29T11:59:37Z

templates/CRM/Admin/Form/Setting/Miscellaneous.tpl

@@ -85,6 +85,12 @@
            <p class="description">{ts}If enabled, CiviCRM will allow users to submit profiles from external sites. This is disabled by default to limit abuse.{/ts}</p>
          </td>
        </tr>
+        <tr class="crm-miscellaneous-form-block-dismiss_info_alerts">


change name as per https://github.com/civicrm/civicrm-core/pull/12158/files#r191394619

JoeMurray · 2018-05-29T11:59:50Z

templates/CRM/Admin/Form/Setting/Miscellaneous.tpl

@@ -85,6 +85,12 @@
            <p class="description">{ts}If enabled, CiviCRM will allow users to submit profiles from external sites. This is disabled by default to limit abuse.{/ts}</p>
          </td>
        </tr>
+        <tr class="crm-miscellaneous-form-block-dismiss_info_alerts">
+            <td class="label">{$form.dismiss_info_alerts.label}</td>


change name as per https://github.com/civicrm/civicrm-core/pull/12158/files#r191394619

JoeMurray · 2018-05-29T12:00:03Z

templates/CRM/common/l10n.js.tpl

@@ -33,6 +33,7 @@
  $.datepicker._defaults.dateFormat = CRM.config.dateInputFormat = {$config->dateInputFormat|@json_encode};
  CRM.config.timeIs24Hr = {if $config->timeInputFormat eq 2}true{else}false{/if};
  CRM.config.ajaxPopupsEnabled = {$ajaxPopupsEnabled|@json_encode};
+  CRM.config.dismissInfoAlerts = {$dismissInfoAlerts};


change name as per https://github.com/civicrm/civicrm-core/pull/12158/files#r191394619

JoeMurray · 2018-05-29T12:01:02Z

Sorry for the verbose messages due to request for change in name.

agilewarealok · 2018-05-31T12:45:52Z

@JoeMurray We've updated the PR accordingly.

JoeMurray · 2018-05-31T15:25:20Z

I've tested and alert messages are being properly dismissed when new setting is enabled, and not dismissed when disabled.

@colemanw I think this is ready for merging.

colemanw · 2018-05-31T18:17:25Z

Code looks great. Merging based on joe's testing.

civicrm-builder added the master label May 18, 2018

JoeMurray reviewed May 24, 2018

View reviewed changes

agilewarealok force-pushed the Accessibility-Issue-4 branch from 0bd7637 to eaa1cd7 Compare May 25, 2018 06:16

JoeMurray reviewed May 29, 2018

View reviewed changes

Accessibility #4: Make alerts accessible, Added new setting under misc.

d19abfd

agilewarealok force-pushed the Accessibility-Issue-4 branch from eaa1cd7 to d19abfd Compare May 31, 2018 12:44

colemanw merged commit e5b6e02 into civicrm:master May 31, 2018

agilewarealok mentioned this pull request Jun 5, 2018

Accessibility #9: Regression - js error due to alertDismissal setting fixed. #12265

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Accessibility #4: Make alerts accessible, Added new setting under misc. #12158

Accessibility #4: Make alerts accessible, Added new setting under misc. #12158

agilewarealok commented May 18, 2018 •

edited by JoeMurray

Loading

jusfreeman commented May 24, 2018

JoeMurray May 24, 2018

JoeMurray May 24, 2018

agilewarealok commented May 25, 2018

JoeMurray May 29, 2018 •

edited

Loading

JoeMurray May 29, 2018

JoeMurray May 29, 2018

JoeMurray May 29, 2018

JoeMurray May 29, 2018

JoeMurray May 29, 2018

JoeMurray May 29, 2018

JoeMurray May 29, 2018

JoeMurray May 29, 2018

JoeMurray May 29, 2018

JoeMurray May 29, 2018

JoeMurray May 29, 2018

JoeMurray May 29, 2018

JoeMurray May 29, 2018

JoeMurray May 29, 2018

JoeMurray commented May 29, 2018

agilewarealok commented May 31, 2018

JoeMurray commented May 31, 2018

colemanw commented May 31, 2018

Accessibility #4: Make alerts accessible, Added new setting under misc. #12158

Accessibility #4: Make alerts accessible, Added new setting under misc. #12158

Conversation

agilewarealok commented May 18, 2018 • edited by JoeMurray Loading

Overview

Before

After

Comments

jusfreeman commented May 24, 2018

Choose a reason for hiding this comment

Choose a reason for hiding this comment

agilewarealok commented May 25, 2018

JoeMurray May 29, 2018 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

JoeMurray commented May 29, 2018

agilewarealok commented May 31, 2018

JoeMurray commented May 31, 2018

colemanw commented May 31, 2018

agilewarealok commented May 18, 2018 •

edited by JoeMurray

Loading

JoeMurray May 29, 2018 •

edited

Loading