feat: Export isInaccessible

[eps1lon]

Looking for better names of this function.

What:

• Export helper method that is used in byRoles queries to exclude inaccessible elements

Why:

• To implement a custom test matcher like expect(element).toBeInaccessible()
  This is useful if you want to test relationships between elements which are established via aria-controls. We want to test that the value of aria-controls is valid by checking that expect(document.getElementById(control.getAttribute('aria-controls'))).toBeInTheDocument() but we want to make sure that at that point the element is still excluded from the a11y tree.

  Another use case might be if you queried the element with something other than byRole and you want to make sure the element is (in)accessible.

How:

• "just" export it

Checklist:

• Documentation added to the
  docs site
• I've prepared a PR for types targetting https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/testing-library__dom
• Tests
• Ready to be merged
  

[kentcdodds]

I'm not sure of the best name either. Maybe simply isHidden?

[eps1lon]

I'm not sure of the best name either. Maybe simply isHidden

What do you think about isInaccessible? (Although I'd be fine with the current name since it is currently coupled to the spec and I'm not sure we'll ever want to expand what it does).

isHidden has a visual implication which does not apply to aria-hidden or "visually hidden" (i.e. content with zero-width, zero-opacity etc).

[alexkrolick]

🤔 Could include the word ARIA in the name to indicate its relationship to that spec: isAriaHidden, isAriaVisible, ...?

[eps1lon]

🤔 Could include the word ARIA in the name to indicate its relationship to that spec: isAriaHidden, isAriaVisible, ...?

isAriaHidden may be confused with aria-hidden and isAriaVisible might be even more confusing since aria-visible doesn't exist.

It's really just an implementation of "Excluding Elements from the Accessibility Tree". I thought about the name for a bit but I would just punt the name towards spec folks.

[kentcdodds]

I'm fine with this. I don't really mind the name all that much 🤷‍♂️ I don't expect many people will use this API.

[kentcdodds]

lol, actually, I think I like isInaccessible better.

[eps1lon]

lol, actually, I think I like isInaccessible better.

Ok let's go with that.

[kentcdodds]

super. thanks!

[kentcdodds]

🎉 This PR is included in version 6.8.0 🎉

The release is available on:

• npm package (@latest dist-tag)
• GitHub release

Your semantic-release bot 📦🚀