Skip to content

Commit 5f8cbcd

Browse files
Enhance Calendar Date screen reader UX (#2040)
1 parent 0af371c commit 5f8cbcd

File tree

3 files changed

+26
-11
lines changed

3 files changed

+26
-11
lines changed

.changeset/dry-kangaroos-try.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
---
2+
'@cloudfour/patterns': patch
3+
---
4+
5+
Enhance Calendar Date screen reader UX
Lines changed: 20 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,31 @@
1-
{% set datetime = datetime|default('now') %}
2-
{% set days = days|default(1) %}
1+
{% set _datetime = datetime|default('now') %}
32
{% set _note %}{% block note %}{{ note }}{% endblock %}{% endset %}
43

5-
<time class="c-calendar-date c-calendar-date--{{ datetime|date('F')|lower }}{% if class %} {{ class }}{% endif %}"
6-
datetime="{{ datetime|date('Y-m-d') }}"
4+
<div
5+
class="c-calendar-date c-calendar-date--{{ _datetime|date('F')|lower }}{% if class %} {{ class }}{% endif %}"
76
>
8-
<span class="c-calendar-date__header">
9-
{{ datetime|date('M') }}
7+
{# The abbreviated month is aria-hidden as it's only presentational #}
8+
<span class="c-calendar-date__header" aria-hidden="true">
9+
{{ _datetime|date('M') }}
1010
</span>
11+
1112
<span class="c-calendar-date__main">
12-
<span class="c-calendar-date__day">
13-
{{ datetime|date('j') }}
14-
</span>
13+
<time class="c-calendar-date__day" datetime="{{ _datetime|date('Y-m-d') }}">
14+
{# The day of the month is aria-hidden as it's only presentational #}
15+
<span aria-hidden="true">{{ _datetime|date('j') }}</span>
16+
{# The full date is accessible to screen readers to provide full context #}
17+
<span class="u-hidden-visually">{{ _datetime|date('F j, o') }}</span>
18+
</time>
19+
1520
{% if _note %}
1621
<span class="c-calendar-date__note">
1722
{{ _note }}
1823
</span>
24+
{% else %}
25+
{#
26+
A default visually hidden note to provide extra context for screen reader users.
27+
#}
28+
<span class="u-hidden-visually">Single-day event</span>
1929
{% endif %}
2030
</span>
21-
</time>
31+
</div>

src/components/media-summary/demo/event.twig

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
{% embed '@cloudfour/components/media-summary/media-summary.twig' with {
2-
heading: "Smashing Magazine",
2+
heading: "SmashingConf New York",
33
href: "https://cloudfour.com",
44
reverse_markup: true,
55
} only %}

0 commit comments

Comments
 (0)