@porsche-design-system/components-react 4.0.0-beta.2 → 4.0.0-beta.3

package/esm/lib/components/tag-dismissible.wrapper.d.ts

@@ -2,29 +2,29 @@ import type { BaseProps } from '../../BaseProps';
 import type { SelectedAriaAttributes, TagDismissibleAriaAttribute } from '../types';
 export type PTagDismissibleProps = BaseProps & {
     /**
-     * Add ARIA attributes.
+     * Sets ARIA attributes.
      */
     aria?: SelectedAriaAttributes<TagDismissibleAriaAttribute>;
     /**
-     * A boolean value that, if present, renders the tag dismissible as a compact version.
+     * Displays the dismissible tag in compact mode.
      */
     compact?: boolean;
     /**
-     * The label text.
+     * Text content for a user-facing label.
      */
     label?: string;
 };
 export declare const PTagDismissible: import("react").ForwardRefExoticComponent<Omit<import("react").DOMAttributes<{}>, "onChange" | "onInput" | "onToggle"> & Pick<import("react").HTMLAttributes<{}>, "suppressHydrationWarning" | "autoFocus" | "className" | "dir" | "hidden" | "id" | "inert" | "lang" | "slot" | "style" | "tabIndex" | "title" | "translate" | "role"> & {
     /**
-     * Add ARIA attributes.
+     * Sets ARIA attributes.
      */
     aria?: SelectedAriaAttributes<TagDismissibleAriaAttribute>;
     /**
-     * A boolean value that, if present, renders the tag dismissible as a compact version.
+     * Displays the dismissible tag in compact mode.
      */
     compact?: boolean;
     /**
-     * The label text.
+     * Text content for a user-facing label.
      */
     label?: string;
 } & {

package/esm/lib/components/tag.wrapper.d.ts

@@ -2,7 +2,7 @@ import type { BaseProps } from '../../BaseProps';
 import type { TagIcon, TagVariant } from '../types';
 export type PTagProps = BaseProps & {
     /**
-     * Displays as compact version.
+     * Displays the tag in compact mode.
      */
     compact?: boolean;
     /**
@@ -20,7 +20,7 @@ export type PTagProps = BaseProps & {
 };
 export declare const PTag: import("react").ForwardRefExoticComponent<Omit<import("react").DOMAttributes<{}>, "onChange" | "onInput" | "onToggle"> & Pick<import("react").HTMLAttributes<{}>, "suppressHydrationWarning" | "autoFocus" | "className" | "dir" | "hidden" | "id" | "inert" | "lang" | "slot" | "style" | "tabIndex" | "title" | "translate" | "role"> & {
     /**
-     * Displays as compact version.
+     * Displays the tag in compact mode.
      */
     compact?: boolean;
     /**

package/esm/lib/components/text.wrapper.d.ts

@@ -2,53 +2,53 @@ import type { BaseProps } from '../../BaseProps';
 import type { TextAlign, TextColor, BreakpointCustomizable, TextSize, TextTag, TextWeight } from '../types';
 export type PTextProps = BaseProps & {
     /**
-     * Text alignment of the component.
+     * Text alignment of the text.
      */
     align?: TextAlign;
     /**
-     * Basic text color variations.
+     * Text color of the text. Use 'primary' for default, 'contrast-high' / 'contrast-medium' for alternative emphasis, 'success' / 'warning' / 'error' / 'info' for status messages, or 'inherit' to adopt the parent's color.
      */
     color?: TextColor;
     /**
-     * Adds an ellipsis to a single line of text if it overflows.
+     * Adds an ellipsis to a single line of text if it overflows the container width.
      */
     ellipsis?: boolean;
     /**
-     * Size of the text. Also defines the size for specific breakpoints, like {base: "small", l: "medium"}. You always need to provide a base value when doing this.
+     * Size of the text. Also defines the size for specific breakpoints, like {base: "sm", l: "md"}.
      */
     size?: BreakpointCustomizable<TextSize>;
     /**
-     * Sets a custom HTML tag depending on the usage of the text component.
+     * Sets the HTML tag of the rendered element to ensure correct semantic meaning (e.g. 'p' for paragraphs, 'blockquote' for quotes).
      */
     tag?: TextTag;
     /**
-     * The weight of the text.
+     * The font weight of the text.
      */
     weight?: TextWeight;
 };
 export declare const PText: import("react").ForwardRefExoticComponent<Omit<import("react").DOMAttributes<{}>, "onChange" | "onInput" | "onToggle"> & Pick<import("react").HTMLAttributes<{}>, "suppressHydrationWarning" | "autoFocus" | "className" | "dir" | "hidden" | "id" | "inert" | "lang" | "slot" | "style" | "tabIndex" | "title" | "translate" | "role"> & {
     /**
-     * Text alignment of the component.
+     * Text alignment of the text.
      */
     align?: TextAlign;
     /**
-     * Basic text color variations.
+     * Text color of the text. Use 'primary' for default, 'contrast-high' / 'contrast-medium' for alternative emphasis, 'success' / 'warning' / 'error' / 'info' for status messages, or 'inherit' to adopt the parent's color.
      */
     color?: TextColor;
     /**
-     * Adds an ellipsis to a single line of text if it overflows.
+     * Adds an ellipsis to a single line of text if it overflows the container width.
      */
     ellipsis?: boolean;
     /**
-     * Size of the text. Also defines the size for specific breakpoints, like {base: "small", l: "medium"}. You always need to provide a base value when doing this.
+     * Size of the text. Also defines the size for specific breakpoints, like {base: "sm", l: "md"}.
      */
     size?: BreakpointCustomizable<TextSize>;
     /**
-     * Sets a custom HTML tag depending on the usage of the text component.
+     * Sets the HTML tag of the rendered element to ensure correct semantic meaning (e.g. 'p' for paragraphs, 'blockquote' for quotes).
      */
     tag?: TextTag;
     /**
-     * The weight of the text.
+     * The font weight of the text.
      */
     weight?: TextWeight;
 } & {

package/esm/lib/components/text.wrapper.mjs

@@ -4,7 +4,7 @@ import { forwardRef, useRef } from 'react';
 import { usePrefix, useBrowserLayoutEffect, useMergedClass } from '../../hooks.mjs';
 import { syncRef } from '../../utils.mjs';
 
-const PText = /*#__PURE__*/ forwardRef(({ align = 'start', color = 'primary', ellipsis = false, size = 'small', tag = 'p', weight = 'regular', className, ...rest }, ref) => {
+const PText = /*#__PURE__*/ forwardRef(({ align = 'start', color = 'primary', ellipsis = false, size = 'sm', tag = 'p', weight = 'normal', className, ...rest }, ref) => {
     const elementRef = useRef(undefined);
     const WebComponentTag = usePrefix('p-text');
     const propsToSync = [align, color, ellipsis, size, tag, weight];

package/esm/lib/components/textarea.wrapper.d.ts

@@ -6,7 +6,7 @@ export type PTextareaProps = BaseProps & {
      */
     autoComplete?: string;
     /**
-     * A boolean value that, if present, renders the textarea as a compact version.
+     * Displays the textarea in compact mode.
      */
     compact?: boolean;
     /**
@@ -18,7 +18,7 @@ export type PTextareaProps = BaseProps & {
      */
     description?: string;
     /**
-     * A boolean value that, if present, makes the textarea unusable and unclickable. The value will not be submitted with the form.
+     * Disables the textarea. The value will not be submitted with the form.
      */
     disabled?: boolean;
     /**
@@ -26,7 +26,7 @@ export type PTextareaProps = BaseProps & {
      */
     form?: string;
     /**
-     * Controls the visibility of the label.
+     * Shows or hides the label. For better accessibility, it is recommended to show the label.
      */
     hideLabel?: BreakpointCustomizable<boolean>;
     /**
@@ -104,7 +104,7 @@ export declare const PTextarea: import("react").ForwardRefExoticComponent<Omit<i
      */
     autoComplete?: string;
     /**
-     * A boolean value that, if present, renders the textarea as a compact version.
+     * Displays the textarea in compact mode.
      */
     compact?: boolean;
     /**
@@ -116,7 +116,7 @@ export declare const PTextarea: import("react").ForwardRefExoticComponent<Omit<i
      */
     description?: string;
     /**
-     * A boolean value that, if present, makes the textarea unusable and unclickable. The value will not be submitted with the form.
+     * Disables the textarea. The value will not be submitted with the form.
      */
     disabled?: boolean;
     /**
@@ -124,7 +124,7 @@ export declare const PTextarea: import("react").ForwardRefExoticComponent<Omit<i
      */
     form?: string;
     /**
-     * Controls the visibility of the label.
+     * Shows or hides the label. For better accessibility, it is recommended to show the label.
      */
     hideLabel?: BreakpointCustomizable<boolean>;
     /**

package/esm/lib/components/wordmark.wrapper.d.ts

@@ -2,37 +2,37 @@ import type { BaseProps } from '../../BaseProps';
 import type { SelectedAriaAttributes, WordmarkAriaAttribute, WordmarkSize, WordmarkTarget } from '../types';
 export type PWordmarkProps = BaseProps & {
     /**
-     * Add ARIA attributes.
+     * Sets ARIA attributes.
      */
     aria?: SelectedAriaAttributes<WordmarkAriaAttribute>;
     /**
-     * When providing an url then the component will be rendered as `<a>`.
+     * When `href` is provided, the component renders as an `<a>` element.
      */
     href?: string;
     /**
-     * Adapts sizing of wordmark.
+     * Controls the size of the wordmark.
      */
     size?: WordmarkSize;
     /**
-     * Target attribute where the link should be opened.
+     * Specifies where to open the linked document.
      */
     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" | "lang" | "slot" | "style" | "tabIndex" | "title" | "translate" | "role"> & {
     /**
-     * Add ARIA attributes.
+     * Sets ARIA attributes.
      */
     aria?: SelectedAriaAttributes<WordmarkAriaAttribute>;
     /**
-     * When providing an url then the component will be rendered as `<a>`.
+     * When `href` is provided, the component renders as an `<a>` element.
      */
     href?: string;
     /**
-     * Adapts sizing of wordmark.
+     * Controls the size of the wordmark.
      */
     size?: WordmarkSize;
     /**
-     * Target attribute where the link should be opened.
+     * Specifies where to open the linked document.
      */
     target?: WordmarkTarget;
 } & import("react").RefAttributes<HTMLElement>>;