@brightspace-ui/core 2.57.0 → 2.58.0

package/components/inputs/docs/input-search.md

@@ -56,6 +56,7 @@ For text searches use `<d2l-input-search>`, which wraps the native `<input type=
 | Property | Type | Description |
 |---|---|---|
 | `label` | String, required | Accessible label for the input |
+| `description` | String | Additional information communicated in the `aria-describedby` on the input |
 | `disabled` | Boolean | Disables the input |
 | `maxlength` | Number | Imposes an upper character limit |
 | `no-clear` | Boolean | Prevents the "clear" button from appearing |
@@ -82,4 +83,5 @@ To make your usage of `d2l-input-search` accessible, use the following property
 
 | Attribute | Description |
 |---|---|
+| `description` | Use when label on input does not provide enough context. |
 | label | **REQUIRED** [Acts as a primary label on the input](https://www.w3.org/WAI/tutorials/forms/labels/). Not visible. |

package/components/inputs/input-search.js

@@ -16,6 +16,11 @@ class InputSearch extends FocusMixin(LocalizeCoreElement(RtlMixin(LitElement)))
 
 	static get properties() {
 		return {
+			/**
+			 * Additional information communicated in the aria-describedby on the input
+			 * @type {string}
+			 */
+			description: { type: String, reflect: true },
 			/**
 			 * Disables the input
 			 * @type {boolean}
@@ -115,6 +120,7 @@ class InputSearch extends FocusMixin(LocalizeCoreElement(RtlMixin(LitElement)))
 			<d2l-input-text
 				label="${ifDefined(this.label)}"
 				label-hidden
+				description="${this.description}"
 				?disabled="${this.disabled}"
 				@input="${this._handleInput}"
 				@keypress="${this._handleInputKeyPress}"

package/custom-elements.json

@@ -5797,6 +5797,11 @@
       "path": "./components/inputs/input-search.js",
       "description": "This component wraps the native \"<input type=\"search\">\"\" element and is for text searching.",
       "attributes": [
+        {
+          "name": "description",
+          "description": "Additional information communicated in the aria-describedby on the input",
+          "type": "string"
+        },
         {
           "name": "label",
           "description": "REQUIRED: Accessible label for the input",
@@ -5832,6 +5837,12 @@
         }
       ],
       "properties": [
+        {
+          "name": "description",
+          "attribute": "description",
+          "description": "Additional information communicated in the aria-describedby on the input",
+          "type": "string"
+        },
         {
           "name": "label",
           "attribute": "label",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@brightspace-ui/core",
-  "version": "2.57.0",
+  "version": "2.58.0",
   "description": "A collection of accessible, free, open-source web components for building Brightspace applications",
   "type": "module",
   "repository": "https://github.com/BrightspaceUI/core.git",