Skip to content
Merged
Show file tree
Hide file tree
Changes from all 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
76 changes: 76 additions & 0 deletions packages/main/cypress/specs/TextArea.cy.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -133,6 +133,82 @@ describe("TextArea general interaction", () => {
.find("textarea")
.should("have.attr", "aria-label", attributeValue);
});

it("Tests accessibleDescription property", () => {
const descriptionValue = "This is a direct description";

cy.mount(<TextArea accessibleDescription={descriptionValue}></TextArea>);

cy.get("[ui5-textarea]")
.shadow()
.find("#accessibleDescription")
.should("contain.text", descriptionValue);

cy.get("[ui5-textarea]")
.shadow()
.find("textarea")
.should("have.attr", "aria-describedby")
.and("include", "accessibleDescription");
});

it("Tests accessibleDescriptionRef property", () => {
const descriptionValue = "External description text";

cy.mount(
<>
<div id="external-desc">{descriptionValue}</div>
<TextArea accessibleDescriptionRef="external-desc"></TextArea>
</>
);

cy.get("[ui5-textarea]")
.shadow()
.find("#accessibleDescription")
.should("contain.text", descriptionValue);

cy.get("[ui5-textarea]")
.shadow()
.find("textarea")
.should("have.attr", "aria-describedby")
.and("include", "accessibleDescription");
});

it("Tests accessibleDescriptionRef with multiple references", () => {
const desc1 = "First description";
const desc2 = "Second description";

cy.mount(
<>
<div id="desc1">{desc1}</div>
<div id="desc2">{desc2}</div>
<TextArea accessibleDescriptionRef="desc1 desc2"></TextArea>
</>
);

cy.get("[ui5-textarea]")
.shadow()
.find("#accessibleDescription")
.should("contain.text", desc1)
.and("contain.text", desc2);
});

it("Tests accessibleDescriptionRef takes precedence over accessibleDescription", () => {
const directDesc = "Direct description";
const refDesc = "Referenced description";

cy.mount(
<>
<div id="ref-desc">{refDesc}</div>
<TextArea accessibleDescription={directDesc} accessibleDescriptionRef="ref-desc"></TextArea>
</>
);

cy.get("[ui5-textarea]")
.shadow()
.find("#accessibleDescription")
.should("contain.text", refDesc)
.and("not.contain.text", directDesc);
});
});

describe("disabled and readonly textarea", () => {
Expand Down
39 changes: 37 additions & 2 deletions packages/main/src/TextArea.ts
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,11 @@ import customElement from "@ui5/webcomponents-base/dist/decorators/customElement
import jsxRenderer from "@ui5/webcomponents-base/dist/renderer/JsxRenderer.js";
import ResizeHandler from "@ui5/webcomponents-base/dist/delegate/ResizeHandler.js";
import type { ResizeObserverCallback } from "@ui5/webcomponents-base/dist/delegate/ResizeHandler.js";
import { getEffectiveAriaLabelText, getAssociatedLabelForTexts } from "@ui5/webcomponents-base/dist/util/AccessibilityTextsHelper.js";
import {
getEffectiveAriaLabelText,
getAssociatedLabelForTexts,
getEffectiveAriaDescriptionText,
} from "@ui5/webcomponents-base/dist/util/AccessibilityTextsHelper.js";
import i18n from "@ui5/webcomponents-base/dist/decorators/i18n.js";
import type I18nBundle from "@ui5/webcomponents-base/dist/i18nBundle.js";
import { isEscape } from "@ui5/webcomponents-base/dist/Keys.js";
Expand Down Expand Up @@ -273,6 +277,24 @@ class TextArea extends UI5Element implements IFormInputElement {
@property()
accessibleNameRef?: string;

/**
* Defines the accessible description of the component.
* @default undefined
* @public
* @since 2.16.0
*/
@property()
accessibleDescription?: string;

/**
* Receives id(or many ids) of the elements that describe the textarea.
* @default undefined
* @public
* @since 2.16.0
*/
@property()
accessibleDescriptionRef?: string;

/**
* @private
*/
Expand Down Expand Up @@ -575,8 +597,21 @@ class TextArea extends UI5Element implements IFormInputElement {
return effectiveAriaLabelText;
}

get ariaDescriptionText() {
return getEffectiveAriaDescriptionText(this);
}

get ariaDescriptionTextId() {
return this.ariaDescriptionText ? "accessibleDescription" : "";
}

get ariaDescribedBy() {
return this.hasValueState ? `${this._id}-valueStateDesc` : undefined;
const ids = [
this.hasValueState ? `${this._id}-valueStateDesc` : "",
this.ariaDescriptionTextId,
].filter(Boolean).join(" ");

return ids || undefined;
}

get ariaValueStateHiddenText() {
Expand Down
4 changes: 4 additions & 0 deletions packages/main/src/TextAreaTemplate.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,10 @@ export default function TextAreaTemplate(this: TextArea) {
<span class="ui5-textarea-exceeded-text">{this._exceededTextProps.exceededText}</span>
}

{this.ariaDescriptionText &&
<span id="accessibleDescription" class="ui5-hidden-text">{this.ariaDescriptionText}</span>
}

{this.hasValueState &&
<span id={`${this._id}-valueStateDesc`} class="ui5-hidden-text">{this.ariaValueStateHiddenText}</span>
}
Expand Down
10 changes: 10 additions & 0 deletions packages/main/test/pages/TextArea.html
Original file line number Diff line number Diff line change
Expand Up @@ -215,6 +215,16 @@
<ui5-textarea id="textarea-prevent-escape" class="textarea-width" placeholder="Escape prevention test"></ui5-textarea>
</section>

<section class="group">
<ui5-title>Text Area: Accessible Description</ui5-title>
<div id="external-desc">This is an external description element</div>
<div id="another-desc">Additional description text</div>
<ui5-textarea id="textarea-accessible-description" class="textarea-width" accessible-description="Direct accessible description" placeholder="TextArea with direct accessible description"></ui5-textarea>
<ui5-textarea id="textarea-accessible-description-ref" class="textarea-width" accessible-description-ref="external-desc" placeholder="TextArea with referenced accessible description"></ui5-textarea>
<ui5-textarea id="textarea-accessible-description-multiple-refs" class="textarea-width" accessible-description-ref="external-desc another-desc" placeholder="TextArea with multiple referenced descriptions"></ui5-textarea>
<ui5-textarea id="textarea-accessible-description-both" class="textarea-width" accessible-description="Direct description" accessible-description-ref="external-desc" placeholder="TextArea with both direct and referenced descriptions"></ui5-textarea>
</section>

<script>
var changeCounter = 0;
var inputCounter = 0;
Expand Down
Loading