From 9519979199e6724395ba1a9776e243e8b74bffb6 Mon Sep 17 00:00:00 2001
From: Philipp Fritsche <ph.fritsche@gmail.com>
Date: Fri, 15 Oct 2021 12:40:50 +0200
Subject: [PATCH] fix(keyboard): deprecate `specialCharMap` (#738)

---
 src/keyboard/specialCharMap.ts | 5 +++++
 1 file changed, 5 insertions(+)

diff --git a/src/keyboard/specialCharMap.ts b/src/keyboard/specialCharMap.ts
index d9a85eec..d98838e7 100644
--- 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}',