Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Table of Contents

Description

A text area is a multi-line text input control. It is used where the user is expected to enter a lot of text.

...

Table of Contents

Description

A text area is a multi-line text input control. It is used where the user is expected to enter a lot of text.

...

Usage & Behavior

General guidelines

Structure

The text area consists of:

  • Preceding label - meaningful a meaningful label describing the information the user needs to provide.

  • Input Field.

  • (Optional) Guiding/hint text - a short description of the expected input text, shown within the input field.

  • (Optional) A character count, where there is a limit to the amount of text which can be entered. The count shows:

    • the number of characters currently entered in the text field, and

    • the maximum number of characters allowed.

...

States

State

Default

Filled

Regular

Image RemovedText Area hint.pngImage AddedImage RemovedText Area filled.pngImage Added

Hover

Image RemovedText Area hint hover.pngImage AddedImage RemovedText Area filled hover.pngImage Added

Active

Image RemovedText Area hint active.pngImage AddedImage RemovedText Area filled active.pngImage Added

Disabled

Image RemovedText Area hint disabled.pngImage AddedImage RemovedText Area filled disabled.pngImage Added

Read-Only

Text Area.pngImage RemovedText Area hint read-only.pngImage AddedImage RemovedText Area filled read-only.pngImage Added

Error

Image RemovedText Area hint error.pngImage AddedImage RemovedText Area filled error.pngImage Added

Warning

Image RemovedText Area hint warning.pngImage AddedImage RemovedText Area filled warning.pngImage Added

Focused

Image RemovedText Area hint focused.pngImage AddedImage RemovedText Area filled focused.pngImage Added

Focused, Hover

Image RemovedText Area hint focused hover.pngImage AddedImage RemovedText Area filled focus hover.pngImage Added

Focused, Active

Image RemovedText Area hint focused active.pngImage AddedImage RemovedText Area filled focus active.pngImage Added

Interaction

  • On hover over the text area, the mouse cursor will change to a text cursor.

  • On click:

    • Where where no text has been added to the text area:

      • a text cursor will appear at the beginning of the text area.

      • the hint text will disappear.

    • Where where text already exists in the text area:

      • a text cursor will appear in the position where the user clicks.

      • double-clicking a word inside the text area will select that word.

      • triple-clicking the text area will select all of the text.

  • When the text area becomes inactive (user clicks away) the hint text will reappear, if no other text has been added the hint text will reappear.If a character limit has been set, reaching the limit will prevent the user from entering any more characters

  • The character count will increase as text is entered. (See Validations and errors below for when the character limit is reached).

  • In special cases, the height of the text area will increase automatically in response to the amount of entered text.

  • A vertical scrollbar may be used where the user enters more lines of text than the text area can show.

...

Validations and errors

Please refer to the Field Validation page for more information.

A text area with a warning will have an orange border and a warning icon, as shown below:

...

The orange or red border will be removed when the content is updated and becomes valid.

Character count

When the character count is reached, the count of the characters currently entered in the text area will become red and bold.

The user should not be stopped from entering more characters when the limit is reached.

...

Best practices

Use:

  • where the user only needs to enter a large amount of text

...

  • where the user only needs to enter a short amount of text → use a Text Field.

  • Horizontal scroll should not be used within text areas.

...

Unless otherwise specified, see our general compliance information in Fundamentals - Accessibility.

Focus management

Keyboard

Description

Tab

Navigates to the next component.

Shift + Tab

Navigates to the previous component.

Space

Acts as within a text input.

Enter

Acts as within a text input.

Esc

N/A

Arrows

Acts as within a text input.

...

Verint products should support all devices down to the common tablet size (960px width). For general guidelines, see Fundamentals - Responsive design.

  • Where the available space is narrow:

    • the width of the text area should dynamically respond to its container, taking up 100% of the available space.

    • the label for the text area should be shown above the field, rather than to the left.

...

Zeplin link

Screen thumbnail

https://zpl.io/2v4yY7a

Image RemovedVerint LUX Text Area.pngImage Added

Code

Html macro
sanitizefalse
<link rel="stylesheet" href="https://ux.verint.com/bootstrap-4.0.0/dist/fonts/css/verint_lux.css">
<link rel="stylesheet" href="https://ux.verint.com/bootstrap-4.0.0/dist/css/bootstrap.css">
<script src="https://ajax.googleapis.com/ajax/libs/jquery/3.3.1/jquery.min.js"></script>
<script src="https://ux.verint.com/bootstrap-4.0.0/dist/js/bootstrap.bundle.js"></script>
<script src="https://ux.verint.com/bootstrap-4.0.0/dist/other/bootstrap-tooltip-custom-class.js"></script>
<script src="https://ux.verint.com/bootstrap-4.0.0/dist/other/accessibility.js"></script>
<script src="https://ux.verint.com/bootstrap-4.0.0/dist/other/prism.min.js"></script>
<link rel="stylesheet" href="https://ux.verint.com/bootstrap-4.0.0/dist/other/prism-coy.min.css">

<script>
$(function () {
		  $('[data-toggle="tooltip"]').tooltip({trigger: 'hover', delay: { "show": 100, "hide": 0 }});
		  
		  $('.is-invalid, .is-warning').on('shown.bs.tooltip', function () {
			  var x = $(this).offset().left + $(this).width();
			  var y = $(this).offset().top;
			  
			  $('.bs-tooltip-right').css('transform', 'translate3d('+x+'px, '+y+'px, 0px)');
		  });
		})
	</script>

<div class="card">
			<div class="card-header">Text Area <button id="toggleMarkup" type="button" class="btn btn-sm btn-outline-primary btn btn-fixed-width float-right m-0" onclick="$('pre' ).toggle()">Toggle Markup</button></div>
			<div class="card-body">
				<form>
					<div class="form-group row">
						<label for="inputKey" class="col-lg-2 col-form-label col-form-label-sm">Regular</label>
						<div class="col-lg-4">
							<textarea class="form-control form-control-sm" placeholder="Guiding Text"></textarea>
						</div>
						<div class="col-lg-6">
							<pre class="language-html"><code><script type="prism-html-markup"><textarea class="form-control form-control-sm" placeholder="Guiding Text"></textarea></script></code></pre>
						</div>
					</div>
					<div class="form-group row">
						<label for="inputKey" class="col-lg-2 col-form-label col-form-label-sm"></label>
						<div class="col-lg-4">
							<textarea class="form-control form-control-sm" placeholder="Guiding Text">Lorem ipsum dolor sit amet, id vis ubique cotidieque, ex malis commune mea.</textarea>
						</div>
						<div class="col-lg-6">
							<pre class="language-html"><code><script type="prism-html-markup"><textarea class="form-control form-control-sm" placeholder="Guiding Text">Lorem ipsum dolor sit amet, id vis ubique cotidieque, ex malis commune mea.</textarea></script></code></pre>
						</div>
					</div>
					<div class="form-group row">
						<label for="inputKey" class="col-lg-2 col-form-label col-form-label-sm">Disabled</label>
						<div class="col-lg-4">
							<textarea class="form-control form-control-sm" placeholder="Guiding Text" disabled></textarea>
						</div>
						<div class="col-lg-6">
							<pre class="language-html"><code><script type="prism-html-markup"><textarea class="form-control form-control-sm" placeholder="Guiding Text" disabled></textarea></script></code></pre>
						</div>
					</div>
					<div class="form-group row">
						<label for="inputKey" class="col-lg-2 col-form-label col-form-label-sm"></label>
						<div class="col-lg-4">
							<textarea class="form-control form-control-sm" placeholder="Guiding Text" disabled>Lorem ipsum dolor sit amet, id vis ubique cotidieque, ex malis commune mea.</textarea>
						</div>
						<div class="col-lg-6">
							<pre class="language-html"><code><script type="prism-html-markup"><textarea class="form-control form-control-sm" placeholder="Guiding Text" disabled>Lorem ipsum dolor sit amet, id vis ubique cotidieque, ex malis commune mea.</textarea></script></code></pre>
						</div>
					</div>
					<div class="form-group row">
						<label for="inputKey" class="col-lg-2 col-form-label col-form-label-sm">Read-Only</label>
						<div class="col-lg-4">
							<textarea class="form-control form-control-sm" placeholder="Guiding Text" readonly></textarea>
						</div>
						<div class="col-lg-6">
							<pre class="language-html"><code><script type="prism-html-markup"><textarea class="form-control form-control-sm" placeholder="Guiding Text" readonly></textarea></script></code></pre>
						</div>
					</div>
					<div class="form-group row">
						<label for="inputKey" class="col-lg-2 col-form-label col-form-label-sm"></label>
						<div class="col-lg-4">
							<textarea class="form-control form-control-sm" placeholder="Guiding Text" readonly>Lorem ipsum dolor sit amet, id vis ubique cotidieque, ex malis commune mea.</textarea>
						</div>
						<div class="col-lg-6">
							<pre class="language-html"><code><script type="prism-html-markup"><textarea class="form-control form-control-sm" placeholder="Guiding Text" readonly>Lorem ipsum dolor sit amet, id vis ubique cotidieque, ex malis commune mea.</textarea></script></code></pre>
						</div>
					</div>
					<div class="form-group row">
						<label for="inputKey" class="col-lg-2 col-form-label col-form-label-sm">Error</label>
						<div class="col-lg-4">
							<textarea class="form-control form-control-sm is-invalid" placeholder="Guiding Text" value="Filled Text" data-toggle="tooltip" data-custom-class="input-error" data-placement="right" title="There is an Error on the Text Area"></textarea>
						</div>
						<div class="col-lg-6">
							<pre class="language-html"><code><script type="prism-html-markup"><textarea class="form-control form-control-sm is-invalid" placeholder="Guiding Text"></textarea></script></code></pre>
						</div>
					</div>
					<div class="form-group row">
						<label for="inputKey" class="col-lg-2 col-form-label col-form-label-sm"></label>
						<div class="col-lg-4">
							<textarea class="form-control form-control-sm is-invalid" placeholder="Guiding Text" value="Filled Text" data-toggle="tooltip" data-custom-class="input-error" data-placement="right" title="There is an Error on the Text Area">Lorem ipsum dolor sit amet, id vis ubique cotidieque, ex malis commune mea.</textarea>
						</div>
						<div class="col-lg-6">
							<pre class="language-html"><code><script type="prism-html-markup"><textarea class="form-control form-control-sm is-invalid" placeholder="Guiding Text">Lorem ipsum dolor sit amet, id vis ubique cotidieque, ex malis commune mea.</textarea></script></code></pre>
						</div>
					</div>
					<div class="form-group row">
						<label for="inputKey" class="col-lg-2 col-form-label col-form-label-sm">Warning</label>
						<div class="col-lg-4">
							<textarea class="form-control form-control-sm is-warning" placeholder="Guiding Text" value="Filled Text" data-toggle="tooltip" data-custom-class="input-warning" data-placement="right" title="There is a Warning on the Text Area"></textarea>
						</div>
						<div class="col-lg-6">
							<pre class="language-html"><code><script type="prism-html-markup"><textarea class="form-control form-control-sm is-warning" placeholder="Guiding Text" value="Filled Text" data-toggle="tooltip" data-custom-class="input-warning" data-placement="right" title="There is a Warning on the Text Area"></textarea></script></code></pre>
						</div>
					</div>
					<div class="form-group row">
						<label for="inputKey" class="col-lg-2 col-form-label col-form-label-sm"></label>
						<div class="col-lg-4">
							<textarea class="form-control form-control-sm is-warning" placeholder="Guiding Text" value="Filled Text" data-toggle="tooltip" data-custom-class="input-warning" data-placement="right" title="There is a Warning on the Text Area">Lorem ipsum dolor sit amet, id vis ubique cotidieque, ex malis commune mea.</textarea>
						</div>
						<div class="col-lg-6">
							<pre class="language-html"><code><script type="prism-html-markup"><textarea class="form-control form-control-sm is-warning" placeholder="Guiding Text" value="Filled Text" data-toggle="tooltip" data-custom-class="input-warning" data-placement="right" title="There is a Warning on the Text Area">Lorem ipsum dolor sit amet, id vis ubique cotidieque, ex malis commune mea.</textarea></script></code></pre>
						</div>
					</div>
				</form>
			</div>

...