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.

Sign up for GitHub

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

Add detailed status information to the badge for screen readers. #4088

Merged
merged 10 commits into from
Dec 17, 2024
Merged

Add detailed status information to the badge for screen readers. #4088

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
50b48e6
Add detailed status information to the badge for screen readers.
pasitiis Nov 19, 2024
81a7057
Use aria-label.
pasitiis Nov 20, 2024
b6ef29b
Use separate field for screen readers.
pasitiis Dec 4, 2024
df4ff34
Fix
pasitiis Dec 4, 2024
94875da
Merge dev into fix-account-status-sr
pasitiis Dec 4, 2024
55ed8b2
Fix, compile stylesheets
pasitiis Dec 4, 2024
0275a9c
Add support function.
pasitiis Dec 17, 2024
d323614
Merge dev into fix-account-status-sr
pasitiis Dec 17, 2024
a0de949
Build css.
pasitiis Dec 17, 2024
c27de29
Fix bad merge.
pasitiis Dec 17, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion themes/bootprint3/css/compiled.css
View file
Open in desktop

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion themes/bootstrap3/css/compiled.css
View file
Open in desktop

Large diffs are not rendered by default.

31 changes: 19 additions & 12 deletions themes/bootstrap3/js/account_ajax.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -201,6 +201,13 @@ VuFind.register('account', function Account() {

$(function registerAccountAjax() {

var renderStatusBadge = (titleKey, count, className = "") => {
return count > 0
? `<span aria-hidden="true" class="badge ${className}" data-toggle="tooltip" title="${VuFind.translate(titleKey)}">${count}</span>
<span class="sr-only">${VuFind.translate(titleKey)}: ${count} , </span>`
: "";
};

VuFind.account.register("fines", {
selector: ".fines-status",
ajaxMethod: "getUserFines",
Expand All @@ -224,14 +231,14 @@ $(function registerAccountAjax() {
var html = '';
var level = ICON_LEVELS.NONE;
if (status.ok > 0) {
html += '<span class="badge account-info" data-toggle="tooltip" title="' + VuFind.translate('account_normal_checkouts') + '">' + status.ok + '</span>';
html += renderStatusBadge('account_normal_checkouts', status.ok, 'account-info');
}
if (status.warn > 0) {
html += '<span class="badge account-warning" data-toggle="tooltip" title="' + VuFind.translate('account_checkouts_due') + '">' + status.warn + '</span>';
html += renderStatusBadge('account_checkouts_due', status.warn, 'account-warning');
level = ICON_LEVELS.WARNING;
}
if (status.overdue > 0) {
html += '<span class="badge account-alert" data-toggle="tooltip" title="' + VuFind.translate('account_checkouts_overdue') + '">' + status.overdue + '</span>';
html += renderStatusBadge('account_checkouts_overdue', status.overdue, 'account-alert');
level = ICON_LEVELS.DANGER;
}
$element.html(html);
Expand All @@ -250,14 +257,14 @@ $(function registerAccountAjax() {
var html = '';
var level = ICON_LEVELS.NONE;
if (status.available > 0) {
html += '<span class="badge account-info" data-toggle="tooltip" title="' + VuFind.translate('account_requests_available') + '">' + status.available + '</span>';
html += renderStatusBadge('account_requests_available', status.available, 'account-info');
level = ICON_LEVELS.GOOD;
}
if (status.in_transit > 0) {
html += '<span class="badge account-warning" data-toggle="tooltip" title="' + VuFind.translate('account_requests_in_transit') + '">' + status.in_transit + '</span>';
html += renderStatusBadge('account_requests_in_transit', status.in_transit, 'account-warning');
}
if (status.other > 0) {
html += '<span class="badge account-none" data-toggle="tooltip" title="' + VuFind.translate('account_requests_other') + '">' + status.other + '</span>';
html += renderStatusBadge('account_requests_other', status.other, 'account-none');
}
if (html !== '') {
$element.html(html);
Expand All @@ -279,14 +286,14 @@ $(function registerAccountAjax() {
var html = '';
var level = ICON_LEVELS.NONE;
if (status.available > 0) {
html += '<span class="badge account-info" data-toggle="tooltip" title="' + VuFind.translate('account_requests_available') + '">' + status.available + '</span>';
html += renderStatusBadge('account_requests_available', status.available, 'account-info');
level = ICON_LEVELS.GOOD;
}
if (status.in_transit > 0) {
html += '<span class="badge account-warning" data-toggle="tooltip" title="' + VuFind.translate('account_requests_in_transit') + '">' + status.in_transit + '</span>';
html += renderStatusBadge('account_requests_in_transit', status.in_transit, 'account-warning');
}
if (status.other > 0) {
html += '<span class="badge account-none" data-toggle="tooltip" title="' + VuFind.translate('account_requests_other') + '">' + status.other + '</span>';
html += renderStatusBadge('account_requests_other', status.other, 'account-none');
}
if (html !== '') {
$element.html(html);
Expand All @@ -308,14 +315,14 @@ $(function registerAccountAjax() {
var html = '';
var level = ICON_LEVELS.NONE;
if (status.available > 0) {
html += '<span class="badge account-info" data-toggle="tooltip" title="' + VuFind.translate('account_requests_available') + '">' + status.available + '</span>';
html += renderStatusBadge('account_requests_available', status.available, 'account-info');
level = ICON_LEVELS.GOOD;
}
if (status.in_transit > 0) {
html += '<span class="badge account-warning" data-toggle="tooltip" title="' + VuFind.translate('account_requests_in_transit') + '">' + status.in_transit + '</span>';
html += renderStatusBadge('account_requests_in_transit', status.in_transit, 'account-warning');
}
if (status.other > 0) {
html += '<span class="badge account-none" data-toggle="tooltip" title="' + VuFind.translate('account_requests_other') + '">' + status.other + '</span>';
html += renderStatusBadge('account_requests_other', status.other, 'account-none');
}
if (html !== '') {
$element.html(html);
Expand Down
3 changes: 2 additions & 1 deletion themes/bootstrap3/less/bootstrap.less
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -403,12 +403,13 @@ footer {
}

.icon-link__label {
display: inline-flex;
flex: 1 1 0%;
}
}

.status {
display: flex;
display: inline-flex;
gap: 2px;
flex: none;
.badge {
Expand Down
3 changes: 2 additions & 1 deletion themes/bootstrap3/scss/bootstrap.scss
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -403,12 +403,13 @@ footer {
}

.icon-link__label {
display: inline-flex;
flex: 1 1 0%;
}
}

.status {
display: flex;
display: inline-flex;
gap: 2px;
flex: none;
.badge {
Expand Down
2 changes: 1 addition & 1 deletion themes/bootstrap5/css/compiled.css
View file
Open in desktop

Large diffs are not rendered by default.

31 changes: 19 additions & 12 deletions themes/bootstrap5/js/account_ajax.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -202,6 +202,13 @@ VuFind.register('account', function Account() {

$(function registerAccountAjax() {

var renderStatusBadge = (titleKey, count, className = "") => {
return count > 0
? `<span aria-hidden="true" class="badge ${className}" data-toggle="tooltip" title="${VuFind.translate(titleKey)}">${count}</span>
<span class="visually-hidden">${VuFind.translate(titleKey)}: ${count} , </span>`
: "";
};

VuFind.account.register("fines", {
selector: ".fines-status",
ajaxMethod: "getUserFines",
Expand All @@ -225,14 +232,14 @@ $(function registerAccountAjax() {
var html = '';
var level = ICON_LEVELS.NONE;
if (status.ok > 0) {
html += '<span class="badge account-info" data-toggle="tooltip" title="' + VuFind.translate('account_normal_checkouts') + '">' + status.ok + '</span>';
html += renderStatusBadge('account_normal_checkouts', status.ok, 'account-info');
}
if (status.warn > 0) {
html += '<span class="badge account-warning" data-toggle="tooltip" title="' + VuFind.translate('account_checkouts_due') + '">' + status.warn + '</span>';
html += renderStatusBadge('account_checkouts_due', status.warn, 'account-warning');
level = ICON_LEVELS.WARNING;
}
if (status.overdue > 0) {
html += '<span class="badge account-alert" data-toggle="tooltip" title="' + VuFind.translate('account_checkouts_overdue') + '">' + status.overdue + '</span>';
html += renderStatusBadge('account_checkouts_overdue', status.overdue, 'account-alert');
level = ICON_LEVELS.DANGER;
}
$element.html(html);
Expand All @@ -251,14 +258,14 @@ $(function registerAccountAjax() {
var html = '';
var level = ICON_LEVELS.NONE;
if (status.available > 0) {
html += '<span class="badge account-info" data-toggle="tooltip" title="' + VuFind.translate('account_requests_available') + '">' + status.available + '</span>';
html += renderStatusBadge('account_requests_available', status.available, 'account-info');
level = ICON_LEVELS.GOOD;
}
if (status.in_transit > 0) {
html += '<span class="badge account-warning" data-toggle="tooltip" title="' + VuFind.translate('account_requests_in_transit') + '">' + status.in_transit + '</span>';
html += renderStatusBadge('account_requests_in_transit', status.in_transit, 'account-warning');
}
if (status.other > 0) {
html += '<span class="badge account-none" data-toggle="tooltip" title="' + VuFind.translate('account_requests_other') + '">' + status.other + '</span>';
html += renderStatusBadge('account_requests_other', status.other, 'account-none');
}
if (html !== '') {
$element.html(html);
Expand All @@ -280,14 +287,14 @@ $(function registerAccountAjax() {
var html = '';
var level = ICON_LEVELS.NONE;
if (status.available > 0) {
html += '<span class="badge account-info" data-toggle="tooltip" title="' + VuFind.translate('account_requests_available') + '">' + status.available + '</span>';
html += renderStatusBadge('account_requests_available', status.available, 'account-info');
level = ICON_LEVELS.GOOD;
}
if (status.in_transit > 0) {
html += '<span class="badge account-warning" data-toggle="tooltip" title="' + VuFind.translate('account_requests_in_transit') + '">' + status.in_transit + '</span>';
html += renderStatusBadge('account_requests_in_transit', status.in_transit, 'account-warning');
}
if (status.other > 0) {
html += '<span class="badge account-none" data-toggle="tooltip" title="' + VuFind.translate('account_requests_other') + '">' + status.other + '</span>';
html += renderStatusBadge('account_requests_other', status.other, 'account-none');
}
if (html !== '') {
$element.html(html);
Expand All @@ -309,14 +316,14 @@ $(function registerAccountAjax() {
var html = '';
var level = ICON_LEVELS.NONE;
if (status.available > 0) {
html += '<span class="badge account-info" data-toggle="tooltip" title="' + VuFind.translate('account_requests_available') + '">' + status.available + '</span>';
html += renderStatusBadge('account_requests_available', status.available, 'account-info');
level = ICON_LEVELS.GOOD;
}
if (status.in_transit > 0) {
html += '<span class="badge account-warning" data-toggle="tooltip" title="' + VuFind.translate('account_requests_in_transit') + '">' + status.in_transit + '</span>';
html += renderStatusBadge('account_requests_in_transit', status.in_transit, 'account-warning');
}
if (status.other > 0) {
html += '<span class="badge account-none" data-toggle="tooltip" title="' + VuFind.translate('account_requests_other') + '">' + status.other + '</span>';
html += renderStatusBadge('account_requests_other', status.other, 'account-none');
}
if (html !== '') {
$element.html(html);
Expand Down
3 changes: 2 additions & 1 deletion themes/bootstrap5/scss/bootstrap.scss
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -442,12 +442,13 @@ footer {
}

.icon-link__label {
display: inline-flex;
flex: 1 1 0%;
}
}

.status {
display: flex;
display: inline-flex;
gap: 2px;
flex: none;
.badge {
Expand Down
2 changes: 1 addition & 1 deletion themes/local_theme_example/css/compiled.css
View file
Open in desktop

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion themes/sandal/css/compiled.css
View file
Open in desktop

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion themes/sandal5/css/compiled.css
View file
Open in desktop

Large diffs are not rendered by default.

Loading