@stihl-design-system/components
Version:
Welcome to the STIHL Design System react component library.
33 lines (32 loc) • 1.33 kB
TypeScript
import { HTMLAttributes } from 'react';
import { SelectedAriaAttributes, Theme } from '../../types';
import { Logo, LogoAriaAttribute, LogoTarget } from './Logo.utils';
export interface LogoProps extends HTMLAttributes<SVGElement | HTMLAnchorElement> {
/** If the DSLogo is used with an href prop, make sure to add a descriptive label to inform screen reader users what the link stands for.
* `{'aria-label'? string;}`
*/
aria?: SelectedAriaAttributes<LogoAriaAttribute>;
/**
* Controls main and sub-brand logo display.
* @default 'main'
*/
logo?: Logo;
/** Defines the URL to link to. If you provide a URL, the component will be rendered as a link. */
href?: string;
/** The target of the link.
* @default '_self'
*/
target?: LogoTarget;
/** Defines the theme. Relevant for the focus border on dark backgrounds.
* @default 'light'
*/
theme?: Theme;
}
/**
* This component is used to display the logo.
*
* It can be also used as a link by providing a `href` and an `aria-label`.
*
* Design in Figma: [Logo](https://www.figma.com/design/qXldpLO6gxHJNLdcXIPxYt/Core-Components-%F0%9F%92%A0?node-id=9050-2)
*/
export declare const DSLogo: import('react').ForwardRefExoticComponent<LogoProps & import('react').RefAttributes<HTMLAnchorElement>>;