@limetech/lime-elements
Version:
54 lines • 2.93 kB
TypeScript
import { Icon } from '../../global/shared-types/icon.types';
/**
* 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.
*/
export declare function getIconName(icon: string | Icon | undefined): string | 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.
*/
export declare function getIconColor(icon: string | Icon | undefined, iconColor?: string | undefined): string | 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.
*/
export declare function getIconFillColor(icon: string | Icon | undefined, iconFillColor?: string | undefined): string | 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.
*/
export declare function getIconBackgroundColor(icon: string | Icon | undefined, iconBackgroundColor?: string | undefined): string | 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.
*/
export declare function getIconTitle(icon: string | Icon | undefined, iconTitle?: string | undefined): string | undefined;
//# sourceMappingURL=get-icon-props.d.ts.map