@limetech/lime-elements
Version:
103 lines (100 loc) • 3.69 kB
JavaScript
;
/**
* Get the icon name.
* This helps in setting the right icon, both if the consumer only types `icon: string`,
* and if they use the `Icon` interface for writing the icon name.
*
* @param icon - The icon to retrieve the name from.
* @returns - The icon name or the provided string, or `undefined` if `icon` is falsy.
*/
function getIconName(
// eslint-disable-next-line sonarjs/use-type-alias
icon) {
if (!!icon && typeof icon === 'object' && 'name' in icon) {
return icon.name;
}
if (typeof icon === 'string') {
return icon;
}
return undefined;
}
/**
* Get the icon color.
* This is added because the old way of specifying `iconColor`
* deprecated in our components. So consumers should now use the new
* `Icon` interface instead. But our components must still support the
* old way of writing `iconColor: string`.
*
* @param icon - The icon to retrieve the color from.
* @param iconColor - The color to use when the deprecated `iconColor` is used.
* @returns - The icon color or the provided color string, or `undefined` if `iconColor` is falsy.
*/
function getIconColor(icon, iconColor) {
if (!!icon && typeof icon === 'object' && 'color' in icon) {
return icon.color;
}
if (typeof icon === 'string') {
return iconColor;
}
return undefined;
}
/**
* Get the icon color.
* This is added because the old way of specifying `iconFillColor` is
* deprecated in our components. So consumers should now use the new
* `Icon` interface instead. But our components must still support the
* old way of writing `iconFillColor: string`.
*
* @param icon - The icon to retrieve the color from.
* @param iconFillColor - The color to use when `iconFillColor` is used.
* @returns - The icon color or the provided color string, or `undefined` if `iconColor` is falsy.
*/
function getIconFillColor(icon, iconFillColor) {
if (!!icon && typeof icon === 'object' && 'color' in icon) {
return icon.color;
}
if (typeof icon === 'string') {
return iconFillColor;
}
return undefined;
}
/**
* Get the icon background color.
* This function is used to retrieve the background color associated with an icon,
* whether provided as a string or using the `Icon` interface.
*
* @param icon - The icon to retrieve the background color from.
* @param iconBackgroundColor - The background color to use when provided explicitly.
* @returns - The icon background color or the provided background color string, or `undefined` if `iconBackgroundColor` is falsy.
*/
function getIconBackgroundColor(icon, iconBackgroundColor) {
if (!!icon && typeof icon === 'object' && 'backgroundColor' in icon) {
return icon.backgroundColor;
}
if (typeof icon === 'string') {
return iconBackgroundColor;
}
return undefined;
}
/**
* Get the icon title.
* This function is used to retrieve the title associated with an icon, whether provided as a string or using the `Icon` interface.
*
* @param icon - The icon to retrieve the title from.
* @param iconTitle - The title to use when provided explicitly.
* @returns - The icon title or the provided title string, or `undefined` if `iconTitle` is falsy.
*/
function getIconTitle(icon, iconTitle) {
if (!!icon && typeof icon === 'object' && 'title' in icon) {
return icon.title;
}
if (typeof icon === 'string') {
return iconTitle;
}
return undefined;
}
exports.getIconBackgroundColor = getIconBackgroundColor;
exports.getIconColor = getIconColor;
exports.getIconFillColor = getIconFillColor;
exports.getIconName = getIconName;
exports.getIconTitle = getIconTitle;