fix(keyboard): deprecate specialCharMap (#738)

testing-library · Oct 15, 2021 · 9519979 · 9519979
1 parent 0fb2c87
commit 9519979
Showing 1 changed file with 5 additions and 0 deletions.
diff --git a/src/keyboard/specialCharMap.ts b/src/keyboard/specialCharMap.ts
@@ -1,3 +1,8 @@
+/**
+ * @deprecated This list of strings with special meaning is no longer necessary
+ * as we've introduced a standardized way to describe any keystroke for `userEvent`.
+ * @see https://testing-library.com/docs/ecosystem-user-event#keyboardtext-options
+ */
 export const specialCharMap = {
   arrowLeft: '{arrowleft}',
   arrowRight: '{arrowright}',