Announce sort state on a column header when changed with an inner button by michaelDCurran · Pull Request #14234 · nvaccess/nvda

michaelDCurran · 2022-10-11T01:04:11Z

Link to issue number:

Summary of the issue:

A recommended UI pattern for sortable columns in HTML tables is to embed a button inside each table column header which when pressed sorts the rows by that column and updates aria-sort on the column header.
Although it is possible to have the sorting state of the column reported manually in NVDA, NVDA does not automatically announce the sorting state when it changes.
this is because NVDA currently only announces state changes for the focused object, which in this case is the bembedded button. Where as the column header is an ancestor of the focus.

Description of user facing changes

NVDA will announce the sort state as it changes.
More broadly, NVDA will now announce any state change on a focus ancestor, not just the focus itself. For example, this could be announcing the expand collapse state on a parent when an inner focused button is pressed.

Description of development approach

Base NVDAObject's event_stateChange method: announce the new state not only if this object is the focused object, but also if this object is one of the focus ancestors.

Testing strategy:

Performed steps in #10890.
Added specific w3c datagrid ARIA example as a system test.

Known issues with pull request:

None known.

Change log entries:

New features
Changes
Bug fixes

NVDA will automatically announce the sort state on an HTML table column header when changed by pressing an inner button. (aria-sort changes not announced when the change is not on the focused element #10890)
- More broadly, NVDA will now announce state changes to any object in the focus ancestry.
  For Developers

Code Review Checklist:

Pull Request description:
- description is up to date
- change log entries
Testing:
- Unit tests
- System (end to end) tests
- Manual testing
API is compatible with existing add-ons.
Documentation:
- User Documentation
- Developer / Technical Documentation
- Context sensitive help for GUI changes
UX of all users considered:
- Speech
- Braille
- Low Vision
- Different web browsers
- Localization in other languages / culture than English
Security precautions taken.

…t only for the focus, but also the focus ancestors. this allows supporting scenarios such as a button inside a column header that changes the sort state.

AppVeyorBot · 2022-10-11T01:41:25Z

PASS: Translation comments check.
PASS: Unit tests.
PASS: Lint check.
FAIL: System tests (tags: installer NVDA). See test results for more information.
Build (for testing PR): https://ci.appveyor.com/api/buildjobs/tkw04teqac8abxjj/artifacts/output/nvda_snapshot_pr14234-26774,0037c02e.exe
CI timing (mins):
INIT 0.0,
INSTALL_START 0.8,
INSTALL_END 0.8,
BUILD_START 0.0,
BUILD_END 22.1,
TESTSETUP_START 0.0,
TESTSETUP_END 0.2,
TEST_START 0.0,
TEST_END 12.9,
FINISH_END 0.1

See test results for failed build of commit 0037c02edd

AppVeyorBot · 2022-10-11T04:19:39Z

PASS: Translation comments check.
PASS: Unit tests.
PASS: Lint check.
FAIL: System tests (tags: installer NVDA). See test results for more information.
Build (for testing PR): https://ci.appveyor.com/api/buildjobs/0sma5y3f05ctvbtu/artifacts/output/nvda_snapshot_pr14234-26778,b4c86b79.exe
CI timing (mins):
INIT 0.0,
INSTALL_START 0.8,
INSTALL_END 0.8,
BUILD_START 0.0,
BUILD_END 21.1,
TESTSETUP_START 0.0,
TESTSETUP_END 0.2,
TEST_START 0.0,
TEST_END 12.8,
FINISH_END 0.2

See test results for failed build of commit b4c86b790b

michaelDCurran · 2022-10-11T07:08:13Z

System test currently fails every time not being able to locate the start marker. Possibly due to timing. May be fixed by #14054
Holding this back until this can be sorted.

AppVeyorBot · 2022-10-14T08:06:40Z

PASS: Translation comments check.
PASS: Unit tests.
PASS: Lint check.
FAIL: System tests (tags: installer NVDA). See test results for more information.
Build (for testing PR): https://ci.appveyor.com/api/buildjobs/x9k9enh90gdam29g/artifacts/output/nvda_snapshot_pr14234-26802,82a6a30c.exe
CI timing (mins):
INIT 0.0,
INSTALL_START 0.7,
INSTALL_END 0.8,
BUILD_START 0.0,
BUILD_END 20.9,
TESTSETUP_START 0.0,
TESTSETUP_END 0.2,
TEST_START 0.0,
TEST_END 13.4,
FINISH_END 0.1

See test results for failed build of commit 82a6a30ce0

AppVeyorBot · 2022-10-20T23:20:41Z

PASS: Translation comments check.
PASS: Unit tests.
PASS: Lint check.
FAIL: System tests (tags: installer NVDA). See test results for more information.
Build (for testing PR): https://ci.appveyor.com/api/buildjobs/6kxuqbh0plv60xuf/artifacts/output/nvda_snapshot_pr14234-26880,3495f4dd.exe
CI timing (mins):
INIT 0.0,
INSTALL_START 0.8,
INSTALL_END 0.9,
BUILD_START 0.0,
BUILD_END 21.8,
TESTSETUP_START 0.0,
TESTSETUP_END 0.2,
TEST_START 0.0,
TEST_END 13.5,
FINISH_END 0.1

See test results for failed build of commit 3495f4ddc1

AppVeyorBot · 2022-10-23T01:21:28Z

PASS: Translation comments check.
PASS: Unit tests.
PASS: Lint check.
FAIL: System tests (tags: installer NVDA). See test results for more information.
Build (for testing PR): https://ci.appveyor.com/api/buildjobs/7ir01gapslnu93q9/artifacts/output/nvda_snapshot_pr14234-26897,fcd4d6f7.exe
CI timing (mins):
INIT 0.0,
INSTALL_START 0.8,
INSTALL_END 0.8,
BUILD_START 0.0,
BUILD_END 21.5,
TESTSETUP_START 0.0,
TESTSETUP_END 0.3,
TEST_START 0.0,
TEST_END 13.9,
FINISH_END 0.2

See test results for failed build of commit fcd4d6f714

AppVeyorBot · 2022-10-23T02:35:31Z

PASS: Translation comments check.
PASS: Unit tests.
PASS: Lint check.
FAIL: System tests (tags: installer NVDA). See test results for more information.
Build (for testing PR): https://ci.appveyor.com/api/buildjobs/qjhpel0ax70c597i/artifacts/output/nvda_snapshot_pr14234-26899,fcd4d6f7.exe
CI timing (mins):
INIT 0.0,
INSTALL_START 0.8,
INSTALL_END 0.8,
BUILD_START 0.0,
BUILD_END 21.1,
TESTSETUP_START 0.0,
TESTSETUP_END 0.3,
TEST_START 0.0,
TEST_END 13.7,
FINISH_END 0.1

See test results for failed build of commit fcd4d6f714

AppVeyorBot · 2022-10-26T14:55:12Z

PASS: Translation comments check.
PASS: Unit tests.
PASS: Lint check.
FAIL: System tests (tags: installer NVDA). See test results for more information.
Build (for testing PR): https://ci.appveyor.com/api/buildjobs/0pg382amuu6wddjo/artifacts/output/nvda_snapshot_pr14234-26992,bcc6ac84.exe
CI timing (mins):
INIT 0.0,
INSTALL_START 0.8,
INSTALL_END 0.9,
BUILD_START 0.0,
BUILD_END 24.0,
TESTSETUP_START 0.0,
TESTSETUP_END 0.3,
TEST_START 0.0,
TEST_END 22.1,
FINISH_END 0.1

See test results for failed build of commit bcc6ac8423

Co-authored-by: Leonard de Ruijter <[email protected]>

brunoprietog · 2022-10-27T14:12:12Z

I think this could also potentially fix #13316

michaelDCurran added 3 commits October 10, 2022 20:23

base NVDAObject's event_statechange method: speak the state change no…

cfe9b41

…t only for the focus, but also the focus ancestors. this allows supporting scenarios such as a button inside a column header that changes the sort state.

Add system test

f51faca

Linting

879c03e

michaelDCurran requested a review from a team as a code owner October 11, 2022 01:04

michaelDCurran requested a review from seanbudd October 11, 2022 01:04

seanbudd approved these changes Oct 11, 2022

View reviewed changes

LeonarddeR reviewed Oct 12, 2022

View reviewed changes

Comment thread source/NVDAObjects/__init__.py Outdated

seanbudd added blocked blocked/needs-internal-fix labels Oct 14, 2022

Merge branch 'master' into i10890

e850725

seanbudd removed blocked blocked/needs-internal-fix labels Oct 23, 2022

michaelDCurran added 2 commits October 26, 2022 19:04

Merge branch 'master' into i10890

c1378d0

Update what's new

d33c7c8

michaelDCurran and others added 3 commits October 27, 2022 03:13

Remove conflict marker

7320386

Correct test w3c ARIA example path

969a926

Apply suggestions from code review

713e0b0

Co-authored-by: Leonard de Ruijter <[email protected]>

michaelDCurran merged commit 93fc1ed into master Oct 26, 2022

michaelDCurran deleted the i10890 branch October 26, 2022 19:00

nvaccessAuto added this to the 2023.1 milestone Oct 26, 2022

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

Announce sort state on a column header when changed with an inner button#14234

Announce sort state on a column header when changed with an inner button#14234
michaelDCurran merged 9 commits into
masterfrom
i10890

michaelDCurran commented Oct 11, 2022

Uh oh!

AppVeyorBot commented Oct 11, 2022

Uh oh!

AppVeyorBot commented Oct 11, 2022

Uh oh!

michaelDCurran commented Oct 11, 2022

Uh oh!

Uh oh!

AppVeyorBot commented Oct 14, 2022

Uh oh!

AppVeyorBot commented Oct 20, 2022

Uh oh!

AppVeyorBot commented Oct 23, 2022

Uh oh!

AppVeyorBot commented Oct 23, 2022

Uh oh!

AppVeyorBot commented Oct 26, 2022

Uh oh!

brunoprietog commented Oct 27, 2022

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

Uh oh!

Uh oh!

Conversation

michaelDCurran commented Oct 11, 2022

Link to issue number:

Summary of the issue:

Description of user facing changes

Description of development approach

Testing strategy:

Known issues with pull request:

Change log entries:

Code Review Checklist:

Uh oh!

AppVeyorBot commented Oct 11, 2022

Uh oh!

AppVeyorBot commented Oct 11, 2022

Uh oh!

michaelDCurran commented Oct 11, 2022

Uh oh!

Uh oh!

AppVeyorBot commented Oct 14, 2022

Uh oh!

AppVeyorBot commented Oct 20, 2022

Uh oh!

AppVeyorBot commented Oct 23, 2022

Uh oh!

AppVeyorBot commented Oct 23, 2022

Uh oh!

AppVeyorBot commented Oct 26, 2022

Uh oh!

brunoprietog commented Oct 27, 2022

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants