Skip to content

Commit 0337d1a

Browse files
qwerty541setdebarr
authored andcommitted
Refactor: Fix docstring for getCardColors utils function (anuraghazra#3011)
1 parent f0f39fa commit 0337d1a

File tree

1 file changed

+13
-8
lines changed

1 file changed

+13
-8
lines changed

src/common/utils.js

Lines changed: 13 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -191,6 +191,18 @@ const flexLayout = ({ items, gap, direction, sizes = [] }) => {
191191
});
192192
};
193193

194+
/**
195+
* Object containing card colors.
196+
* @typedef {{
197+
* titleColor: string | string[];
198+
* iconColor: string | string[];
199+
* textColor: string | string[];
200+
* bgColor: string | string[];
201+
* borderColor: string | string[];
202+
* ringColor: string | string[];
203+
* }} CardColors
204+
*/
205+
194206
/**
195207
* Returns theme based colors with proper overrides and defaults.
196208
*
@@ -203,14 +215,7 @@ const flexLayout = ({ items, gap, direction, sizes = [] }) => {
203215
* @param {string=} args.ring_color Card ring color.
204216
* @param {string=} args.theme Card theme.
205217
* @param {string=} args.fallbackTheme Fallback theme.
206-
* @returns {{
207-
* titleColor: string | string[];
208-
* iconColor: string | string[];
209-
* textColor: string | string[];
210-
* bgColor: string | string[];
211-
* borderColor: string | string[];
212-
* ringColor: string | string[];
213-
* }} Card colors.
218+
* @returns {CardColors} Card colors.
214219
*/
215220
const getCardColors = ({
216221
title_color,

0 commit comments

Comments
 (0)