@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.
131 lines (130 loc) • 4.07 kB
TypeScript
import type { BaseProps } from '../../BaseProps';
import type { BreakpointCustomizable, LinkPureAlignLabel, SelectedAriaAttributes, LinkPureAriaAttribute, LinkPureIcon, LinkPureSize, LinkPureTarget, Theme, LinkPureWeight } from '../types';
export type PLinkPureProps = BaseProps & {
/**
* Display link in active state.
*/
active?: boolean;
/**
* Aligns the label.
*/
alignLabel?: BreakpointCustomizable<LinkPureAlignLabel>;
/**
* Add ARIA attributes.
*/
aria?: SelectedAriaAttributes<LinkPureAriaAttribute>;
/**
* Special download attribute to open native browser download dialog if target url points to a downloadable file.
*/
download?: string;
/**
* Show or hide label. For better accessibility it is recommended to show the label.
*/
hideLabel?: BreakpointCustomizable<boolean>;
/**
* When providing an url then the component will be rendered as `<a>`.
*/
href?: string;
/**
* The icon shown. By choosing 'none', no icon is displayed
*/
icon?: LinkPureIcon;
/**
* A URL path to a custom icon.
*/
iconSource?: string;
/**
* Specifies the relationship of the target object to the link object.
*/
rel?: string;
/**
* Size of the link.
*/
size?: BreakpointCustomizable<LinkPureSize>;
/**
* Stretches the area between icon and label to max available space.
*/
stretch?: BreakpointCustomizable<boolean>;
/**
* Target attribute where the link should be opened.
*/
target?: LinkPureTarget;
/**
* Adapts the button color depending on the theme.
*/
theme?: Theme;
/**
* Shows an underline under the label.
*/
underline?: boolean;
/**
* The weight of the text (only has effect with visible label).
* @deprecated since v3.0.0, will be removed with next major release
*/
weight?: LinkPureWeight;
};
export declare const PLinkPure: import("react").ForwardRefExoticComponent<import("react").DOMAttributes<{}> & Pick<import("react").HTMLAttributes<{}>, "suppressHydrationWarning" | "autoFocus" | "className" | "dir" | "hidden" | "id" | "inert" | "lang" | "slot" | "style" | "tabIndex" | "title" | "translate" | "role"> & {
/**
* Display link in active state.
*/
active?: boolean;
/**
* Aligns the label.
*/
alignLabel?: BreakpointCustomizable<LinkPureAlignLabel>;
/**
* Add ARIA attributes.
*/
aria?: SelectedAriaAttributes<LinkPureAriaAttribute>;
/**
* Special download attribute to open native browser download dialog if target url points to a downloadable file.
*/
download?: string;
/**
* Show or hide label. For better accessibility it is recommended to show the label.
*/
hideLabel?: BreakpointCustomizable<boolean>;
/**
* When providing an url then the component will be rendered as `<a>`.
*/
href?: string;
/**
* The icon shown. By choosing 'none', no icon is displayed
*/
icon?: LinkPureIcon;
/**
* A URL path to a custom icon.
*/
iconSource?: string;
/**
* Specifies the relationship of the target object to the link object.
*/
rel?: string;
/**
* Size of the link.
*/
size?: BreakpointCustomizable<LinkPureSize>;
/**
* Stretches the area between icon and label to max available space.
*/
stretch?: BreakpointCustomizable<boolean>;
/**
* Target attribute where the link should be opened.
*/
target?: LinkPureTarget;
/**
* Adapts the button color depending on the theme.
*/
theme?: Theme;
/**
* Shows an underline under the label.
*/
underline?: boolean;
/**
* The weight of the text (only has effect with visible label).
* @deprecated since v3.0.0, will be removed with next major release
*/
weight?: LinkPureWeight;
} & {
children?: import("react").ReactNode | undefined;
} & import("react").RefAttributes<HTMLElement>>;