@dnb/eufemia
Version:
DNB Eufemia Design System UI Library
52 lines (51 loc) • 1.72 kB
TypeScript
/**
* Web Logo Component
*/
import React from 'react';
import type { IconColor } from '../Icon';
import type { SpacingProps } from '../space/types';
export type LogoWidth = number | string;
export type LogoHeight = number | string;
export type LogoVariant = 'default' | 'compact' | 'compactHorizontal';
export type LogoProps = {
/**
* Define the width of the logo.
*/
width?: LogoWidth;
/**
* Define the height of the logo.
*/
height?: LogoHeight;
/**
* Define the color of the logo.
*/
color?: IconColor;
/**
* Define which brands logo to show. `ui` (DNB) or `sbanken`. Defaults to `ui`.
*/
brand?: string;
/**
* Define the logo variant, if there is more than one variant of a brands logo. Currently the only option other than default is a `compact` variant of the Sbanken logo. Defaults to `default`.
*/
variant?: LogoVariant;
/**
* Set to `true` if you do not want to inherit the color by `currentColor`. Defaults to `false`.
*/
inheritColor?: boolean;
/**
* Set to `true` if you want the logo to inherit the parent size
*/
inheritSize?: boolean;
} & SpacingProps & Omit<React.HTMLProps<HTMLElement>, 'ref' | 'size'> & DeprecatedLogoProps;
type DeprecatedLogoProps = {
/** @deprecated Will be removed in eufemia v11 */
alt?: string;
/** @deprecated Will be removed in eufemia v11 */
ratio?: number | string;
/** @deprecated Use 'inheritColor' */
inherit_color?: boolean;
/** @deprecated Will be removed in eufemia v11 */
size?: string | number;
};
declare function Logo(localProps: LogoProps): import("react/jsx-runtime").JSX.Element;
export default Logo;