aria-practices

aria-practices copied to clipboard

This is a refactor of the content from #1027 to close issue #78. There is a long comment thread in #1027 with information that may be useful to people working on this content.

Preview of Liver Regions Practice Page

---

WAI Preview Link (Last built on Sat, 14 Sep 2024 22:14:33 GMT).

The ARIA Authoring Practices (APG) Task Force just discussed Adding a Live regions practice page.

The full IRC log of that discussion

<jugglinmike> Topic: Adding a Live regions practice page
<jugglinmike> github: https://github.com/w3c/aria-practices/pull/2989
<Jem> https://github.com/w3c/aria-practices/pull/2989
<jugglinmike> Matt_King: We had a pull request that was originally started by Simon
<jugglinmike> Matt_King: It never got finished for a number of reasons
<jugglinmike> Matt_King: And there has recently been more attention given to live regions in ARIA
<jugglinmike> Matt_King: So now seems like the right time to "wake up" this piece of work that has been dormant for five years (since 2019!)
<jugglinmike> Matt_King: I created this pull request. The preview doesn't work right now, there are broken links, etc.
<jugglinmike> Matt_King: I could continue work on it, but I thought it was a great pull request for someone who wants to get their hands dirty for the first time
<jugglinmike> Matt_King: The first step is to bring the text up to date in terms of linking to the correct places in the APG, fixing the other evident problems in the pull request, and then facilitating a discussion about what SHOULD be on this new page.
<jugglinmike> Jem: It would be helpful if this had more of a description
<jugglinmike> Matt_King: I'd be happy to mentor someone if someone wants to pick this up
<jugglinmike> Matt_King: It includes a link to issue 1027. I don't know if that has a functional preview, but you can at least see the functional content by opening the "files" tab of that pull request
<jugglinmike> dmontalvo: I can make an attempt. No promises about deadlines, though!
<jugglinmike> Matt_King: I thought about raising an issue in ARIA and maybe pulling in one of the people in ARIA
<jugglinmike> dmontalvo: that's a good idea. ARIA is a larger group, to be sure, so we may find someone there
<Jem> Now I see what Matt did. https://github.com/w3c/aria-practices/pull/2989/files
<jugglinmike> Matt_King: I think I wanted to do something like that for ARIA Actions, too
<jugglinmike> Matt_King: But if, in the mean time, we could assign this to you, dmontalvo, just to get your initial impressions
<jugglinmike> dmontalvo: Sure
<jugglinmike> dmontalvo: This is only about live regions, correct? We're not considering ARIA Notify, yet, right?
<jugglinmike> Matt_King: That's right--not yet
<jugglinmike> Matt_King: For now, anything on ARIA Notify would have to be in the "experimental content" area. But this is not about that
<jugglinmike> Matt_King: We're not getting rid of declarative live regions--not at all. There's no movement in ARIA for anything like that
<jugglinmike> Matt_King: I think people will continue to use live regions when content is in the DOM and in a fixed location
<jugglinmike> Matt_King: There are other use cases where the Accessibility Notifications API will come into play
<Jem> content/practices/live-regions/live-regions-practice.html

Assignees, @curtbellew @jugglinmike @howard-e @daniel-montalvo @shirsha

• Please review the draft and share the feedback.
• Please add the known and frequently used live region examples

@mcking65 This is one of the live region talks by @smhigley

@smhigley please let us know if you have more recent talk about live region so that we can consider in creating the live region draft.

We discussed this during today's Task Force meeting. Relevant notes are available in the public meeting minutes.

The ARIA Authoring Practices (APG) Task Force just discussed Live regions practice.

The full IRC log of that discussion

<jugglinmike> Topic: Live regions practice
<jugglinmike> Matt_King: I'm trying to recruit help for a page about live regions
<jugglinmike> Matt_King: Simon Pieters originally drafted a whole bunch of content about practice with live regions
<jugglinmike> Matt_King: ...but it got delayed as we tried to figure out exactly what to recommend
<jugglinmike> Matt_King: I think this is getting resolved as the working group works on actions
<jugglinmike> Matt_King: You can see the pull request here; I essentially refactored Simon's pull request without making any substantial changes
<jugglinmike> github: https://github.com/w3c/aria-practices/pull/2989/files
<jugglinmike> Matt_King: It's ready to go if someone wants to pick it up and become our resident expert in live regions
<jugglinmike> Matt_King: You can consider this a "public service announcement"
<jugglinmike> github: https://github.com/w3c/aria-practices/pull/2989
<jugglinmike> jongund: It looks like the preview failed the build
<jugglinmike> Matt_King: There were definitely some linting errors here
<jugglinmike> Matt_King: Okay, well then it actually needs some clean-up work!
<jugglinmike> jongund: I can take a look at these errors
<jugglinmike> howard-e: It might be an issue with the build repository itself. There's a long-standing issue where if that repository has progressed way beyond the current structure, there could be incompatibilities
<jugglinmike> howard-e: I see here that the work was done in April, so there may have been significant changes to the "build" repository in the time since
<jugglinmike> Matt_King: Thank you jongund and howard-e for agreeing to help get this cleaned up a bit

@jongund @mcking65 the preview link is ready now, Practices > Notifying Users with Live Regions (Automatic Screen Reader Announcements) after re-syncing the built assets.

@mcking65 I fixed the linting errors on the practices page and put a link in the first comment to the preview live region practices page. The link checker errors don't seem to have anything to do with the practices page.

@mcking65 I fixed the linting errors on the practices page and put a link in the first comment to the preview live region practices page. The link checker errors don't seem to have anything to do with the practices page.

Created #3113 to track the link checker issue. I've also responded with a reason why it's happening in https://github.com/w3c/aria-practices/issues/3113#issuecomment-2353154753. @jongund you're also correct that it has nothing to do with with this change.