From ffafcf29ed11d252eb9d6a00e61fc02ec8332a47 Mon Sep 17 00:00:00 2001 From: Alexandr Garbuzov Date: Sun, 30 Jul 2023 13:08:44 +0300 Subject: [PATCH] Refactor: Fix docstring for getCardColors utils function (#3011) --- src/common/utils.js | 21 +++++++++++++-------- 1 file changed, 13 insertions(+), 8 deletions(-) diff --git a/src/common/utils.js b/src/common/utils.js index d756e2e..59aa111 100644 --- 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,