feat: DAYL-114 Update a11y docn for the numeric input components

[ChrisLabattD2L]

Context for DAYL-114: Numeric Inputs > Improve a11y doc'n

The purpose of this PR is to update the documentation d2l-input-number and d2l-input-percent components to include more a11y-based information. Fortunately a bit of the work was already done for both of these components in this PR, when the labelled-mixin was changed to include the same a11y documentation that was needed here.

[github-actions]

Thanks for the PR! 🎉

We've deployed an automatic preview for this PR - you can see your changes here:

URL	https://live.d2l.dev/prs/BrightspaceUI/core/pr-5028/

Note

The build needs to finish before your changes are deployed.
Changes to the PR will automatically update the instance.

[margaree]

Both input-number and input-percent have labelHidden which mentions aria-label. We likely want their description to be more along the lines of the date inputs ("Hides the label visually. Hidden labels are still read by screen readers so make sure to set an appropriate label.")

Other than the few comments LGTM!

[ChrisLabattD2L]

Both input-number and input-percent have labelHidden which mentions aria-label. We likely want their description to be more along the lines of the date inputs ("Hides the label visually. Hidden labels are still read by screen readers so make sure to set an appropriate label.")

Sounds good and makes sense! I'm wondering if labelHidden might be a good thing to move into the LabelledMixin, it appears in all the components that use it with the exception of d2l-selection-input. But that would be a change made outside the scope of this PR.

[margaree]

Definitely out of scope for this PR. It's an interesting thought. Basically the only reason labelHidden would be in LabelledMixin would be for having it defined in one place. However, it wouldn't really actually get used in there, since it's generally used for rendering and can be handled differently depending on the component, whereas LabelledMixin looks to be more used for finding/enforcing that a label is present but not actually handling how the label is rendered. Something to think about.

[geurts]

Looks good to me Chris, thanks!

The first bullet in the Accessibility section made me want to know more about why it was setup that way, or how it affects the screen reader experience. Maybe we could add more context? Something like this:

When using unit make sure to also set unit-label since the unit itself is hidden from screen reader users; the unit-label is appended to the label off-screen so that it's announced by screen readers and hidden from sighted users.

[d2l-github-release-tokens]

🎉 This PR is included in version 3.51.0 🎉

The release is available on:

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

Your semantic-release bot 📦🚀