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.

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

feat: add property to accessible BrowserWindow window title #19698

Merged
merged 5 commits into from Aug 27, 2019

Conversation

mshoho
Copy link
Contributor

@mshoho mshoho commented Aug 9, 2019

Description of Change

Sometimes it's necessary to convey more information about the window to the screen reader users only (simply putting everything to the window title might be unnecessarily noisy).

For example, Chromium uses that technique to tell the screen reader users that the window is in incognito mode (the incognito window looks differently and doesn't have «incognito» in the title, but for the blind users the screen reader will announce that it's incognito).

Chromium has GetAccessibleWindowTitle() method internally. This PR exposes a way to customize the accessible title via Electron API.

Checklist

Release Notes

Notes: Added win.accessibleTitle property to be able to augment the window title for the screen readers.

@electron-cation electron-cation bot added the new-pr 🌱 PR opened in the last 24 hours label Aug 9, 2019
@welcome
Copy link

welcome bot commented Aug 9, 2019

💖 Thanks for opening this pull request! 💖

We use semantic commit messages to streamline the release process. Before your pull request can be merged, you should update your pull request title to start with a semantic prefix.

Examples of commit messages with semantic prefixes:

  • fix: don't overwrite prevent_default if default wasn't prevented
  • feat: add app.isPackaged() method
  • docs: app.isDefaultProtocolClient is now available on Linux

Things that will help get your PR across the finish line:

  • Follow the JavaScript, C++, and Python coding style.
  • Run npm run lint locally to catch formatting errors earlier.
  • Document any user-facing changes you've made following the documentation styleguide.
  • Include tests when adding/changing behavior.
  • Include screenshots and animated GIFs whenever possible.

We get a lot of pull requests on this repo, so please be patient and we will get back to you as soon as we can.

@alexeykuzmin
Copy link
Contributor

@mshoho please use the PR template for description.

shell/browser/native_window.h Outdated Show resolved Hide resolved
shell/browser/native_window.cc Show resolved Hide resolved
docs/api/browser-window.md Outdated Show resolved Hide resolved
Copy link
Contributor

@miniak miniak left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

approved by mistake, please address those minor issues

@miniak
Copy link
Contributor

miniak commented Aug 9, 2019

please use the correct PR template

@codebytere codebytere changed the title feat: Accessible window title feat: add property to accessible BrowserWindow window title Aug 9, 2019
@electron-cation electron-cation bot removed the new-pr 🌱 PR opened in the last 24 hours label Aug 10, 2019
docs/api/browser-window.md Outdated Show resolved Hide resolved
@miniak
Copy link
Contributor

miniak commented Aug 24, 2019

@MarshallOfSound can you please review the current version?

Copy link
Member

@ckerr ckerr left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks alright. Thanks for the patch!

@alexeykuzmin alexeykuzmin merged commit ae9424d into electron:master Aug 27, 2019
@welcome
Copy link

welcome bot commented Aug 27, 2019

Congrats on merging your first pull request! 🎉🎉🎉

@release-clerk
Copy link

release-clerk bot commented Aug 27, 2019

Release Notes Persisted

Added win.accessibleTitle property to augment a window title for screen readers.

@alexeykuzmin alexeykuzmin mentioned this pull request Aug 28, 2019
4 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

6 participants