Components: Add types to Shortcut (WordPress#29633)

lephleg · Mar 8, 2021 · 00ae3fc · 00ae3fc
1 parent 398a9e7
commit 00ae3fc
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 0 deletions.
diff --git a/packages/components/src/shortcut/index.js b/packages/components/src/shortcut/index.js
@@ -3,6 +3,17 @@
  */
 import { isString, isObject } from 'lodash';
 
+/** @typedef {string | { display: string, ariaLabel: string }} Shortcut */
+/**
+ * @typedef Props
+ * @property {Shortcut} shortcut Shortcut configuration
+ * @property {string} [className] Classname
+ */
+
+/**
+ * @param {Props} props Props
+ * @return {JSX.Element | null} Element
+ */
 function Shortcut( { shortcut, className } ) {
 	if ( ! shortcut ) {
 		return null;

diff --git a/packages/components/tsconfig.json b/packages/components/tsconfig.json
@@ -19,6 +19,7 @@
 		"src/dashicon/**/*",
 		"src/flex/**/*",
 		"src/form-group/**/*",
+		"src/shortcut/**/*",
 		"src/spinner/**/*",
 		"src/tip/**/*",
 		"src/ui/**/*",