Skip to content
This repository was archived by the owner on Sep 5, 2024. It is now read-only.

Commit 6d17e6e

Browse files
committed
docs(chips): remove deprecation of delete-button-label
- improve documentation for this API
1 parent 1a2e3d0 commit 6d17e6e

File tree

1 file changed

+5
-2
lines changed

1 file changed

+5
-2
lines changed

src/components/chips/js/chipsDirective.js

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -155,8 +155,11 @@
155155
* @param {string=} delete-hint A string read by screen readers instructing users that pressing
156156
* the delete key will remove the chip. You will want to use this to override the default when
157157
* in a non-English locale.
158-
* @param {string=} delete-button-label <strong>Deprecated</strong> A label for the delete button.
159-
* Used to be read by screen readers.
158+
* @param {string=} delete-button-label Text for the `aria-label` of the button with the
159+
* `md-chip-remove` class. If the chip is an Object, then this will be the only text in the
160+
* label. Otherwise, this is prepended to the string representation of the chip. Defaults to
161+
* "Remove", which would be "Remove Apple" for a chip that contained the string "Apple".
162+
* You will want to use this to override the default when in a non-English locale.
160163
* @param {string=} md-removed-message Screen readers will announce this message following the
161164
* chips contents. The default is `"removed"`. If a chip with the content of "Apple" was
162165
* removed, the screen reader would read "Apple removed". You will want to use this to override

0 commit comments

Comments
 (0)