@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.
58 lines (57 loc) • 2.3 kB
TypeScript
import type { BaseProps } from '../../BaseProps';
import type { DisplayAlign, DisplayColor, BreakpointCustomizable, DisplaySize, DisplayTag } from '../types';
export type PDisplayProps = BaseProps & {
/**
* Sets the horizontal text alignment (`start`, `center`, `end`, or `inherit`).
* @default 'start'
*/
align?: DisplayAlign;
/**
* Sets the text color using PDS color tokens.
* @default 'primary'
*/
color?: DisplayColor;
/**
* Truncates the text with an ellipsis when it overflows the container on a single line.
* @default false
*/
ellipsis?: boolean;
/**
* Sets the visual text size. Supports responsive breakpoint values.
* @default 'large'
*/
size?: BreakpointCustomizable<DisplaySize>;
/**
* Sets the HTML heading tag (h1–h6) for correct document outline placement. When omitted, the tag is inferred from `size`.
*/
tag?: DisplayTag;
};
/** @deprecated since v4.0.0, will be removed with next major release. Please use `p-heading` instead. */
export declare const PDisplay: 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 the horizontal text alignment (`start`, `center`, `end`, or `inherit`).
* @default 'start'
*/
align?: DisplayAlign;
/**
* Sets the text color using PDS color tokens.
* @default 'primary'
*/
color?: DisplayColor;
/**
* Truncates the text with an ellipsis when it overflows the container on a single line.
* @default false
*/
ellipsis?: boolean;
/**
* Sets the visual text size. Supports responsive breakpoint values.
* @default 'large'
*/
size?: BreakpointCustomizable<DisplaySize>;
/**
* Sets the HTML heading tag (h1–h6) for correct document outline placement. When omitted, the tag is inferred from `size`.
*/
tag?: DisplayTag;
} & {
children?: import("react").ReactNode | undefined;
} & import("react").RefAttributes<HTMLElement>>;