Skip to content
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
merged 6 commits into from
Mar 8, 2024
Merged
Show file tree
Hide file tree
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions packages/terra-core-docs/CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,9 @@

## Unreleased

* Added
* Added implementation page documentation regarding consumers responsibility to ensure the accessibility of the `terra-signature`.
Copy link
Contributor

Choose a reason for hiding this comment

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

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`.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Updated


## 1.57.0 - (February 15, 2024)

* Added
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Copy link
Contributor

Choose a reason for hiding this comment

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

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.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Updated


- **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.
Copy link
Contributor

Choose a reason for hiding this comment

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

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.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Updated


- **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.
Copy link
Contributor

Choose a reason for hiding this comment

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

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.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Updated


- **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.
Copy link
Contributor

Choose a reason for hiding this comment

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

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.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Updated


- **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.
Copy link
Contributor

Choose a reason for hiding this comment

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

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.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Updated


- **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.
Copy link
Contributor

Choose a reason for hiding this comment

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

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.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Updated


- **Documenting Accessibility Features**: Document the accessibility features of the signature component for end users, including instructions on how to use it with assistive technologies.
Copy link
Contributor

Choose a reason for hiding this comment

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

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.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Updated


By following these guidelines, consumers can ensure that the Terra Signature component is accessible to all users, including those with disabilities.

## Component Features
* [Cross-Browser Support](https://engineering.cerner.com/terra-ui/about/terra-ui/component-standards#cross-browser-support)

Expand Down
Loading