@porsche-design-system/components-react
Version:
Porsche Design System is a component library designed to help developers create the best experience for software or services distributed by Dr. Ing. h.c. F. Porsche AG.
43 lines (42 loc) • 1.98 kB
TypeScript
import type { BaseProps } from '../../BaseProps';
import type { SelectedAriaAttributes, WordmarkAriaAttribute, WordmarkSize, WordmarkTarget } from '../types';
export type PWordmarkProps = BaseProps & {
/**
* Sets ARIA attributes on the anchor element to improve accessibility when the wordmark is used as a link.
*/
aria?: SelectedAriaAttributes<WordmarkAriaAttribute>;
/**
* When set, wraps the wordmark in an anchor element that navigates to the given URL on click.
*/
href?: string;
/**
* Sets the display size of the Porsche wordmark SVG using predefined PDS size tokens (`small`, `medium`, `large`, `inherit`).
* @default 'small'
*/
size?: WordmarkSize;
/**
* Specifies where to open the linked URL when `href` is set (e.g. `_self`, `_blank`).
* @default '_self'
*/
target?: WordmarkTarget;
};
export declare const PWordmark: import("react").ForwardRefExoticComponent<Omit<import("react").DOMAttributes<{}>, "onChange" | "onInput" | "onToggle"> & Pick<import("react").HTMLAttributes<{}>, "suppressHydrationWarning" | "autoFocus" | "className" | "dir" | "hidden" | "id" | "inert" | "inputMode" | "lang" | "slot" | "style" | "tabIndex" | "title" | "translate" | "role"> & {
/**
* Sets ARIA attributes on the anchor element to improve accessibility when the wordmark is used as a link.
*/
aria?: SelectedAriaAttributes<WordmarkAriaAttribute>;
/**
* When set, wraps the wordmark in an anchor element that navigates to the given URL on click.
*/
href?: string;
/**
* Sets the display size of the Porsche wordmark SVG using predefined PDS size tokens (`small`, `medium`, `large`, `inherit`).
* @default 'small'
*/
size?: WordmarkSize;
/**
* Specifies where to open the linked URL when `href` is set (e.g. `_self`, `_blank`).
* @default '_self'
*/
target?: WordmarkTarget;
} & import("react").RefAttributes<HTMLElement>>;