Skip to content

Commit 241f5e4

Browse files
authored
Merge pull request #375 from alphagov/add-edited-changelog
Add edited v2.0.0 (unreleased) changelog
2 parents 11caaa7 + 1977f36 commit 241f5e4

File tree

1 file changed

+27
-12
lines changed

1 file changed

+27
-12
lines changed

CHANGELOG.md

Lines changed: 27 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -2,29 +2,44 @@
22

33
## [Unreleased]
44

5-
## Breaking changes
6-
You must make the following changes when you migrate to this release, or your service may break.
5+
We recommend you update to the latest release using npm:
76

8-
### Update your focus styles
7+
`npm install accessible-autocomplete@latest`
98

10-
We have updated the focus style of this component to meet the new WCAG 2.1 guidelines around non-text contrast.
9+
### Breaking changes
1110

12-
You can read about this [focus style strategy in the GOV.UK Design System](https://design-system.service.gov.uk/get-started/focus-states/).
11+
You must make the following change when you migrate to this release, or your service may break.
1312

14-
#### If you have copied CSS from this repository
13+
#### Migrate to the new accessible focus state
1514

16-
You can [copy the CSS from the dist folder](https://github.com/alphagov/accessible-autocomplete/blob/master/dist/accessible-autocomplete.min.css).
15+
The focus state [now meets the new WCAG 2.1 level AA requirements](https://designnotes.blog.gov.uk/2019/07/29/weve-made-the-gov-uk-design-system-more-accessible/).
1716

18-
#### If you're using Sass imports
17+
You do not need to do anything if youre using Sass.
1918

20-
This will be updated automatically
19+
If you’ve previously copied CSS from our code into your project, you must copy all the CSS from our [`accessible-autocomplete.min.css` file](https://github.com/alphagov/accessible-autocomplete/blob/master/dist/accessible-autocomplete.min.css) into your CSS file.
2120

22-
#### If you have custom additional CSS
21+
If you’ve created custom CSS, you should check that your component meets WCAG 2.1 level AA requirements. You can [read how we made the GOV.UK Design System focus states accessible](https://design-system.service.gov.uk/get-started/focus-states/).
2322

24-
You should check that your custom CSS does not remove the improvements to the focus state, if you do need to change the appearance keep in mind the WCAG 2.1 level AA requirements.
23+
[Pull request #360: Update focus styles to meet WCAG 2.1 level AA non-text contrast requirements](https://github.com/alphagov/accessible-autocomplete/pull/360).
2524

25+
### Fixes
2626

27-
- [Pull request #360: Update focus styles to meet WCAG 2.1 level AA non-text contrast requirements](https://github.com/alphagov/accessible-autocomplete/pull/360).
27+
#### Better compatibility with screen readers
28+
29+
The input field is now visible to all screen readers, because the input field now meets the Accessible Rich Internet Applications (ARIA) 1.0 standard instead of ARIA 1.1. ARIA 1.0 is better supported by the current versions of most screen readers.
30+
31+
Screen readers will now consistently tell users:
32+
33+
- when users have entered too few characters in the input field
34+
- the correct number of search results, and what the results are
35+
- which result users have highlighted
36+
- how to use autocomplete in different screen readers - by reading hidden hint text
37+
38+
Screen readers will also now avoid telling users information they do not need to know after they highlight an option.
39+
40+
Thanks to [Mark Hunter](https://github.com/markhunter27), Chris Moore and everyone at HMRC who worked on these improvements.
41+
42+
[Pull request #355: Refinements to address accessibility issues](https://github.com/alphagov/accessible-autocomplete/pull/355)
2843

2944
## 1.6.2 - 2018-11-13
3045

0 commit comments

Comments
 (0)