This repository has been archived by the owner on May 24, 2024. It is now read-only.
[terra-signature] Implementation page doc updates #4033
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
sdadn
reviewed
Feb 15, 2024
| ## Consuming teams are responsible for | ||
| - **Providing Descriptive Labels**: Ensure that the signature component is labeled clearly and descriptively for screen reader users. This includes providing labels for form fields and instructions for signing. | ||
|
|
||
| - **Implementing Keyboard Accessibility**: Ensure that all functionality of the signature component can be accessed and operated using a keyboard alone, without relying on mouse interactions. |
There was a problem hiding this comment.
Suggested change
| - **Implementing Keyboard Accessibility**: Ensure that all functionality of the signature component can be accessed and operated using a keyboard alone, without relying on mouse interactions. | |
| - **Implementing Keyboard Accessibility**: Ensure that all functionality of terra-signature can be accessed and operated using only a keyboard, without any mouse interactions. |
|
|
||
| - **Implementing Keyboard Accessibility**: Ensure that all functionality of the signature component can be accessed and operated using a keyboard alone, without relying on mouse interactions. | ||
|
|
||
| - **Using ARIA Attributes**: Use ARIA (Accessible Rich Internet Applications) attributes to enhance the accessibility of the signature component, such as aria-label and aria-describedby, to provide additional context for screen reader users. |
There was a problem hiding this comment.
Suggested change
| - **Using ARIA Attributes**: Use ARIA (Accessible Rich Internet Applications) attributes to enhance the accessibility of the signature component, such as aria-label and aria-describedby, to provide additional context for screen reader users. | |
| - **Using ARIA Attributes**: Use ARIA (Accessible Rich Internet Applications) [attributes](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA) to enhance the accessibility of terra-signature, such as [aria-label](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Attributes/aria-label) and [aria-describedby](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Attributes/aria-describedby), to provide additional context for screen reader users. |
| @@ -2,6 +2,9 @@ | |||
|
|
|||
| ## Unreleased | |||
|
|
|||
| * Added | |||
| * Added implementation page documentation regarding consumers responsibility to ensure the accessibility of the `terra-signature`. | |||
There was a problem hiding this comment.
Suggested change
| * Added implementation page documentation regarding consumers responsibility to ensure the accessibility of the `terra-signature`. | |
| * Added implementation page documentation regarding consumers responsibility to ensure the accessibility for `terra-signature`. |
| @@ -35,6 +35,23 @@ This component requires the following peer dependencies be installed in your app | |||
| import Signature from 'terra-signature'; | |||
| ``` | |||
|
|
|||
| ## Consuming teams are responsible for | |||
| - **Providing Descriptive Labels**: Ensure that the signature component is labeled clearly and descriptively for screen reader users. This includes providing labels for form fields and instructions for signing. | |||
There was a problem hiding this comment.
Suggested change
| - **Providing Descriptive Labels**: Ensure that the signature component is labeled clearly and descriptively for screen reader users. This includes providing labels for form fields and instructions for signing. | |
| - **Providing Descriptive Labels**: Ensure that the terra-signature component is labeled clearly and descriptively for screen reader users. This includes providing labels for form fields and instructions for signing. |
|
|
||
| - **Using ARIA Attributes**: Use ARIA (Accessible Rich Internet Applications) attributes to enhance the accessibility of the signature component, such as aria-label and aria-describedby, to provide additional context for screen reader users. | ||
|
|
||
| - **Testing with Assistive Technologies**: Test the signature component with a variety of assistive technologies, such as screen readers, to ensure that it is fully accessible and usable by all users. |
There was a problem hiding this comment.
Suggested change
| - **Testing with Assistive Technologies**: Test the signature component with a variety of assistive technologies, such as screen readers, to ensure that it is fully accessible and usable by all users. | |
| - **Testing with Assistive Technologies**: Test terra-signature with a variety of assistive technologies, such as screen readers, to ensure that it is fully accessible and usable by all users. |
|
|
||
| - **Testing with Assistive Technologies**: Test the signature component with a variety of assistive technologies, such as screen readers, to ensure that it is fully accessible and usable by all users. | ||
|
|
||
| - **Providing Alternative Text for Images**: If the signature component includes any images or icons, provide alternative text that describes the content or function of the image for users who cannot see it. |
There was a problem hiding this comment.
Suggested change
| - **Providing Alternative Text for Images**: If the signature component includes any images or icons, provide alternative text that describes the content or function of the image for users who cannot see it. | |
| - **Providing Alternative Text for Images**: If terra-signature includes any images or icons, provide alternative text that describes the content or function of the image for users who cannot see it. |
|
|
||
| - **Providing Alternative Text for Images**: If the signature component includes any images or icons, provide alternative text that describes the content or function of the image for users who cannot see it. | ||
|
|
||
| - **Ensuring Sufficient Color Contrast**: Ensure that there is sufficient color contrast between text and background colors to make the signature component readable for users with low vision or color blindness. |
There was a problem hiding this comment.
Suggested change
| - **Ensuring Sufficient Color Contrast**: Ensure that there is sufficient color contrast between text and background colors to make the signature component readable for users with low vision or color blindness. | |
| - **Ensuring Sufficient Color Contrast**: Ensure that there is sufficient color contrast between text and background colors to make terra-signature readable for users with low vision or color blindness. |
|
|
||
| - **Ensuring Sufficient Color Contrast**: Ensure that there is sufficient color contrast between text and background colors to make the signature component readable for users with low vision or color blindness. | ||
|
|
||
| - **Documenting Accessibility Features**: Document the accessibility features of the signature component for end users, including instructions on how to use it with assistive technologies. |
There was a problem hiding this comment.
Suggested change
| - **Documenting Accessibility Features**: Document the accessibility features of the signature component for end users, including instructions on how to use it with assistive technologies. | |
| - **Documenting Accessibility Features**: Document the accessibility features of terra-signature for end users, including instructions on how to use it with assistive technologies. |
sdadn
approved these changes
Feb 20, 2024
sugan2416
approved these changes
Mar 8, 2024
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
Updated implementation page documentation regarding consumers' responsibility to ensure the accessibility of the Terra Signature control.
What was changed:
Why it was changed:
Testing
This change was tested using:
Reviews
In addition to engineering reviews, this PR needs:
Additional Details
This PR resolves:
UXPLATFORM-9215
Thank you for contributing to Terra.
@cerner/terra