Skip to content
This repository has been archived by the owner on May 24, 2024. It is now read-only.

Commit

Permalink
[terra-signature] Doc Update (#4077)
Browse files Browse the repository at this point in the history
  • Loading branch information
MadanKumarGovindaswamy authored Apr 3, 2024
1 parent ab57d92 commit 6c96489
Show file tree
Hide file tree
Showing 3 changed files with 8 additions and 11 deletions.
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

* Changed
* Updated documentation for `terra-signature`.

## 1.69.0 - (March 27, 2024)

* Added
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,11 @@ import SignaturePropsTable from 'terra-signature/lib/Signature?dev-site-props-ta

# Terra Signature

The terra-signature component provides users a way to define a signature with a series of line segments.
The component can define line width, line color, and optionally display a signature if the line segments have
already been recorded. Exiting the canvas then re-entering continues the drawing, as long as the pointer does not exit the confines of the browser. For mouse usage, only left click drawing is enabled.
The terra-signature component is used to digitally validate or acknowledge files or documents such as PDF documents, online forms, or specialized e-signature software.
- For mouse usage, only left-click drawing is enabled, and can continue the drawing with a series of line segments as long as the pointer does not exit the confines of the browser.
- The Terra Signature component has the ability to define line width, and line color, and optionally display a signature if the line segments used in the signature have already been recorded.
- For keyboard usage, consumers can provide their signature by typing, drawing, or inserting an image file with their name. Ensuring the keyboard navigation follows a logical tab order, and provides the instructions and cues necessary to complete the same action.
- The Terra Signature component supports resizing to 400% and supports reflow when the viewport is resized to 320x256 px without loss of information or function.

## Getting Started

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -71,14 +71,6 @@ class SignatureExample extends React.Component {
<ImageSignature onClearSignature={this.handleLiveRegion} />
</Tabs.Pane>
</Tabs>
<p>
<strong>Note: </strong>
<br />
<ul>
<li>This example Terra Signature currently supports only Draw Functionality.</li>
<li>Signature Text and Signature Upload Image functionalities will be part of future enhancement.</li>
</ul>
</p>
<VisuallyHiddenText aria-live="polite" text={this.state.message} />
</div>
);
Expand Down

0 comments on commit 6c96489

Please sign in to comment.