Refactor: Fix docstring for getCardColors utils function (anuraghazra…

…#3011)
sebastian-coding · Jul 30, 2023 · ffafcf2 · ffafcf2
1 parent d7b534a
commit ffafcf2
Showing 1 changed file with 13 additions and 8 deletions.
diff --git a/src/common/utils.js b/src/common/utils.js
@@ -191,6 +191,18 @@ const flexLayout = ({ items, gap, direction, sizes = [] }) => {
   });
 };
 
+/**
+ * Object containing card colors.
+ * @typedef {{
+ *  titleColor: string | string[];
+ *  iconColor: string | string[];
+ *  textColor: string | string[];
+ *  bgColor: string | string[];
+ *  borderColor: string | string[];
+ *  ringColor: string | string[];
+ * }} CardColors
+ */
+
 /**
  * Returns theme based colors with proper overrides and defaults.
  *
@@ -203,14 +215,7 @@ const flexLayout = ({ items, gap, direction, sizes = [] }) => {
  * @param {string=} args.ring_color Card ring color.
  * @param {string=} args.theme Card theme.
  * @param {string=} args.fallbackTheme Fallback theme.
- * @returns {{
- *  titleColor: string | string[];
- *  iconColor: string | string[];
- *  textColor: string | string[];
- *  bgColor: string | string[];
- *  borderColor: string | string[];
- *  ringColor: string | string[];
- * }} Card colors.
+ * @returns {CardColors} Card colors.
  */
 const getCardColors = ({
   title_color,