@porsche-design-system/components-vue 3.16.0-rc.1 → 3.16.0

package/esm/lib/components/TextFieldWrapperWrapper.vue.d.ts

@@ -0,0 +1,123 @@
+import type { TextFieldWrapperActionIcon, BreakpointCustomizable, TextFieldWrapperState, Theme, TextFieldWrapperUnitPosition } from '../types';
+type PTextFieldWrapperProps = {
+    /**
+     * Action icon can be set to `locate` for `input type="search"` in order to display an action button.
+     */
+    actionIcon?: TextFieldWrapperActionIcon;
+    /**
+     * Disables the action button and shows a loading indicator. No events will be triggered while loading state is active.
+     */
+    actionLoading?: boolean;
+    /**
+     * The description text.
+     */
+    description?: string;
+    /**
+     * Show or hide label and description text. For better accessibility it is recommended to show the label.
+     */
+    hideLabel?: BreakpointCustomizable<boolean>;
+    /**
+     * The label text.
+     */
+    label?: string;
+    /**
+     * The message styled depending on validation state.
+     */
+    message?: string;
+    /**
+     * @deprecated since v3.0.0, will be removed with next major release, use `showCounter` instead. Show or hide max character count.
+     */
+    showCharacterCount?: boolean;
+    /**
+     * Show or hide max character count.
+     */
+    showCounter?: boolean;
+    /**
+     * @experimental Show or hide password toggle for `input type="password"`.
+     */
+    showPasswordToggle?: boolean;
+    /**
+     * The validation state.
+     */
+    state?: TextFieldWrapperState;
+    /**
+     * Show search button if wrapped inside a form.
+     */
+    submitButton?: boolean;
+    /**
+     * Adapts the color depending on the theme.
+     */
+    theme?: Theme;
+    /**
+     * The unit text.
+     */
+    unit?: string;
+    /**
+     * The unit position.
+     */
+    unitPosition?: TextFieldWrapperUnitPosition;
+};
+declare const _default: __VLS_WithTemplateSlots<import("vue").DefineComponent<__VLS_WithDefaults<__VLS_TypePropsToOption<PTextFieldWrapperProps>, {
+    actionLoading: boolean;
+    description: string;
+    hideLabel: boolean;
+    label: string;
+    message: string;
+    showCounter: boolean;
+    showPasswordToggle: boolean;
+    state: string;
+    submitButton: boolean;
+    unit: string;
+    unitPosition: string;
+}>, {}, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {
+    [x: string]: (...args: unknown[]) => void;
+}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<__VLS_WithDefaults<__VLS_TypePropsToOption<PTextFieldWrapperProps>, {
+    actionLoading: boolean;
+    description: string;
+    hideLabel: boolean;
+    label: string;
+    message: string;
+    showCounter: boolean;
+    showPasswordToggle: boolean;
+    state: string;
+    submitButton: boolean;
+    unit: string;
+    unitPosition: string;
+}>>>, {
+    label: string;
+    description: string;
+    state: "none" | "success" | "error";
+    hideLabel: BreakpointCustomizable<boolean>;
+    message: string;
+    actionLoading: boolean;
+    showCounter: boolean;
+    showPasswordToggle: boolean;
+    submitButton: boolean;
+    unit: string;
+    unitPosition: "prefix" | "suffix";
+}, {}>, {
+    default?(_: {}): any;
+}>;
+export default _default;
+type __VLS_WithDefaults<P, D> = {
+    [K in keyof Pick<P, keyof P>]: K extends keyof D ? __VLS_Prettify<P[K] & {
+        default: D[K];
+    }> : P[K];
+};
+type __VLS_Prettify<T> = {
+    [K in keyof T]: T[K];
+} & {};
+type __VLS_WithTemplateSlots<T, S> = T & {
+    new (): {
+        $slots: S;
+    };
+};
+type __VLS_NonUndefinedable<T> = T extends undefined ? never : T;
+type __VLS_TypePropsToOption<T> = {
+    [K in keyof T]-?: {} extends Pick<T, K> ? {
+        type: import('vue').PropType<__VLS_NonUndefinedable<T[K]>>;
+    } : {
+        type: import('vue').PropType<T[K]>;
+        required: true;
+    };
+};

package/esm/lib/components/TextListItemWrapper.vue.d.ts

@@ -0,0 +1,9 @@
+declare const _default: __VLS_WithTemplateSlots<import("vue").DefineComponent<{}, {}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{}>>, {}, {}>, {
+    default?(_: {}): any;
+}>;
+export default _default;
+type __VLS_WithTemplateSlots<T, S> = T & {
+    new (): {
+        $slots: S;
+    };
+};

package/esm/lib/components/TextListWrapper.vue.d.ts

@@ -0,0 +1,51 @@
+import type { TextListListType, TextListOrderType, Theme, TextListType } from '../types';
+type PTextListProps = {
+    /**
+     * @deprecated since v3.0.0, will be removed with next major release, use `type` instead. The type of the list.
+     */
+    listType?: TextListListType;
+    /**
+     * @deprecated since v3.0.0, will be removed with next major release, use `type` instead. The list style type of ordered list. Only has effect when list type is set to 'ordered'.
+     */
+    orderType?: TextListOrderType;
+    /**
+     * Adapts the text color depending on the theme.
+     */
+    theme?: Theme;
+    /**
+     * The list style type.
+     */
+    type?: TextListType;
+};
+declare const _default: __VLS_WithTemplateSlots<import("vue").DefineComponent<__VLS_WithDefaults<__VLS_TypePropsToOption<PTextListProps>, {
+    type: string;
+}>, {}, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<__VLS_WithDefaults<__VLS_TypePropsToOption<PTextListProps>, {
+    type: string;
+}>>>, {
+    type: "unordered" | "numbered" | "alphabetically";
+}, {}>, {
+    default?(_: {}): any;
+}>;
+export default _default;
+type __VLS_WithDefaults<P, D> = {
+    [K in keyof Pick<P, keyof P>]: K extends keyof D ? __VLS_Prettify<P[K] & {
+        default: D[K];
+    }> : P[K];
+};
+type __VLS_Prettify<T> = {
+    [K in keyof T]: T[K];
+} & {};
+type __VLS_WithTemplateSlots<T, S> = T & {
+    new (): {
+        $slots: S;
+    };
+};
+type __VLS_NonUndefinedable<T> = T extends undefined ? never : T;
+type __VLS_TypePropsToOption<T> = {
+    [K in keyof T]-?: {} extends Pick<T, K> ? {
+        type: import('vue').PropType<__VLS_NonUndefinedable<T[K]>>;
+    } : {
+        type: import('vue').PropType<T[K]>;
+        required: true;
+    };
+};

package/esm/lib/components/TextWrapper.vue.d.ts

@@ -0,0 +1,78 @@
+import type { TextAlign, TextColor, BreakpointCustomizable, TextSize, TextTag, Theme, TextWeight } from '../types';
+type PTextProps = {
+    /**
+     * Text alignment of the component.
+     */
+    align?: TextAlign;
+    /**
+     * Basic text color variations depending on theme property.
+     */
+    color?: TextColor;
+    /**
+     * Adds an ellipsis to a single line of text if it overflows.
+     */
+    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?: BreakpointCustomizable<TextSize>;
+    /**
+     * Sets a custom HTML tag depending on the usage of the text component.
+     */
+    tag?: TextTag;
+    /**
+     * Adapts the text color depending on the theme. Has no effect when "inherit" is set as color prop.
+     */
+    theme?: Theme;
+    /**
+     * The weight of the text.
+     */
+    weight?: TextWeight;
+};
+declare const _default: __VLS_WithTemplateSlots<import("vue").DefineComponent<__VLS_WithDefaults<__VLS_TypePropsToOption<PTextProps>, {
+    align: string;
+    color: string;
+    ellipsis: boolean;
+    size: string;
+    tag: string;
+    weight: string;
+}>, {}, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<__VLS_WithDefaults<__VLS_TypePropsToOption<PTextProps>, {
+    align: string;
+    color: string;
+    ellipsis: boolean;
+    size: string;
+    tag: string;
+    weight: string;
+}>>>, {
+    weight: "regular" | "semi-bold" | "bold" | "thin" | "semibold";
+    size: BreakpointCustomizable<"inherit" | "small" | "medium" | "large" | "x-large" | "xx-small" | "x-small">;
+    tag: "time" | "p" | "span" | "div" | "address" | "blockquote" | "figcaption" | "cite" | "legend";
+    align: "center" | "start" | "end" | "left" | "right";
+    color: "default" | "inherit" | "primary" | "contrast-low" | "contrast-medium" | "contrast-high" | "notification-success" | "notification-warning" | "notification-error" | "notification-info" | "brand" | "neutral-contrast-low" | "neutral-contrast-medium" | "neutral-contrast-high" | "notification-neutral";
+    ellipsis: boolean;
+}, {}>, {
+    default?(_: {}): any;
+}>;
+export default _default;
+type __VLS_WithDefaults<P, D> = {
+    [K in keyof Pick<P, keyof P>]: K extends keyof D ? __VLS_Prettify<P[K] & {
+        default: D[K];
+    }> : P[K];
+};
+type __VLS_Prettify<T> = {
+    [K in keyof T]: T[K];
+} & {};
+type __VLS_WithTemplateSlots<T, S> = T & {
+    new (): {
+        $slots: S;
+    };
+};
+type __VLS_NonUndefinedable<T> = T extends undefined ? never : T;
+type __VLS_TypePropsToOption<T> = {
+    [K in keyof T]-?: {} extends Pick<T, K> ? {
+        type: import('vue').PropType<__VLS_NonUndefinedable<T[K]>>;
+    } : {
+        type: import('vue').PropType<T[K]>;
+        required: true;
+    };
+};

package/esm/lib/components/TextareaWrapperWrapper.vue.d.ts

@@ -0,0 +1,82 @@
+import type { BreakpointCustomizable, TextareaWrapperState, Theme } from '../types';
+type PTextareaWrapperProps = {
+    /**
+     * The description text.
+     */
+    description?: string;
+    /**
+     * Show or hide label. For better accessibility it is recommended to show the label.
+     */
+    hideLabel?: BreakpointCustomizable<boolean>;
+    /**
+     * The label text.
+     */
+    label?: string;
+    /**
+     * The message styled depending on validation state.
+     */
+    message?: string;
+    /**
+     * @deprecated since v3.0.0, will be removed with next major release, use `showCounter` instead. Show or hide max character count.
+     */
+    showCharacterCount?: boolean;
+    /**
+     * Show or hide max character count.
+     */
+    showCounter?: boolean;
+    /**
+     * The validation state.
+     */
+    state?: TextareaWrapperState;
+    /**
+     * Adapts the color depending on the theme.
+     */
+    theme?: Theme;
+};
+declare const _default: __VLS_WithTemplateSlots<import("vue").DefineComponent<__VLS_WithDefaults<__VLS_TypePropsToOption<PTextareaWrapperProps>, {
+    description: string;
+    hideLabel: boolean;
+    label: string;
+    message: string;
+    showCounter: boolean;
+    state: string;
+}>, {}, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<__VLS_WithDefaults<__VLS_TypePropsToOption<PTextareaWrapperProps>, {
+    description: string;
+    hideLabel: boolean;
+    label: string;
+    message: string;
+    showCounter: boolean;
+    state: string;
+}>>>, {
+    label: string;
+    description: string;
+    state: "none" | "success" | "error";
+    hideLabel: BreakpointCustomizable<boolean>;
+    message: string;
+    showCounter: boolean;
+}, {}>, {
+    default?(_: {}): any;
+}>;
+export default _default;
+type __VLS_WithDefaults<P, D> = {
+    [K in keyof Pick<P, keyof P>]: K extends keyof D ? __VLS_Prettify<P[K] & {
+        default: D[K];
+    }> : P[K];
+};
+type __VLS_Prettify<T> = {
+    [K in keyof T]: T[K];
+} & {};
+type __VLS_WithTemplateSlots<T, S> = T & {
+    new (): {
+        $slots: S;
+    };
+};
+type __VLS_NonUndefinedable<T> = T extends undefined ? never : T;
+type __VLS_TypePropsToOption<T> = {
+    [K in keyof T]-?: {} extends Pick<T, K> ? {
+        type: import('vue').PropType<__VLS_NonUndefinedable<T[K]>>;
+    } : {
+        type: import('vue').PropType<T[K]>;
+        required: true;
+    };
+};

package/esm/lib/components/ToastWrapper.vue.d.ts

@@ -0,0 +1,18 @@
+import type { Theme } from '../types';
+type PToastProps = {
+    /**
+     * Adapts the toast color depending on the theme.
+     */
+    theme?: Theme;
+};
+declare const _default: import("vue").DefineComponent<__VLS_TypePropsToOption<PToastProps>, {}, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<__VLS_TypePropsToOption<PToastProps>>>, {}, {}>;
+export default _default;
+type __VLS_NonUndefinedable<T> = T extends undefined ? never : T;
+type __VLS_TypePropsToOption<T> = {
+    [K in keyof T]-?: {} extends Pick<T, K> ? {
+        type: import('vue').PropType<__VLS_NonUndefinedable<T[K]>>;
+    } : {
+        type: import('vue').PropType<T[K]>;
+        required: true;
+    };
+};

package/esm/lib/components/WordmarkWrapper.vue.d.ts

@@ -0,0 +1,51 @@
+import type { SelectedAriaAttributes, WordmarkAriaAttribute, WordmarkSize, WordmarkTarget, Theme } from '../types';
+type PWordmarkProps = {
+    /**
+     * Add ARIA attributes.
+     */
+    aria?: SelectedAriaAttributes<WordmarkAriaAttribute>;
+    /**
+     * When providing an url then the component will be rendered as `<a>`.
+     */
+    href?: string;
+    /**
+     * Adapts sizing of wordmark.
+     */
+    size?: WordmarkSize;
+    /**
+     * Target attribute where the link should be opened.
+     */
+    target?: WordmarkTarget;
+    /**
+     * Adapts color depending on theme.
+     */
+    theme?: Theme;
+};
+declare const _default: import("vue").DefineComponent<__VLS_WithDefaults<__VLS_TypePropsToOption<PWordmarkProps>, {
+    size: string;
+    target: string;
+}>, {}, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<__VLS_WithDefaults<__VLS_TypePropsToOption<PWordmarkProps>, {
+    size: string;
+    target: string;
+}>>>, {
+    size: "inherit" | "small";
+    target: string;
+}, {}>;
+export default _default;
+type __VLS_WithDefaults<P, D> = {
+    [K in keyof Pick<P, keyof P>]: K extends keyof D ? __VLS_Prettify<P[K] & {
+        default: D[K];
+    }> : P[K];
+};
+type __VLS_Prettify<T> = {
+    [K in keyof T]: T[K];
+} & {};
+type __VLS_NonUndefinedable<T> = T extends undefined ? never : T;
+type __VLS_TypePropsToOption<T> = {
+    [K in keyof T]-?: {} extends Pick<T, K> ? {
+        type: import('vue').PropType<__VLS_NonUndefinedable<T[K]>>;
+    } : {
+        type: import('vue').PropType<T[K]>;
+        required: true;
+    };
+};

package/esm/lib/components/index.d.ts

@@ -0,0 +1,70 @@
+export { default as PAccordion } from './AccordionWrapper.vue';
+export { default as PBanner } from './BannerWrapper.vue';
+export { default as PButton } from './ButtonWrapper.vue';
+export { default as PButtonGroup } from './ButtonGroupWrapper.vue';
+export { default as PButtonPure } from './ButtonPureWrapper.vue';
+export { default as PButtonTile } from './ButtonTileWrapper.vue';
+export { default as PCanvas } from './CanvasWrapper.vue';
+export { default as PCarousel } from './CarouselWrapper.vue';
+export { default as PCheckboxWrapper } from './CheckboxWrapperWrapper.vue';
+export { default as PContentWrapper } from './ContentWrapperWrapper.vue';
+export { default as PCrest } from './CrestWrapper.vue';
+export { default as PDisplay } from './DisplayWrapper.vue';
+export { default as PDivider } from './DividerWrapper.vue';
+export { default as PFieldset } from './FieldsetWrapper.vue';
+export { default as PFieldsetWrapper } from './FieldsetWrapperWrapper.vue';
+export { default as PFlex } from './FlexWrapper.vue';
+export { default as PFlexItem } from './FlexItemWrapper.vue';
+export { default as PFlyout } from './FlyoutWrapper.vue';
+export { default as PFlyoutMultilevel } from './FlyoutMultilevelWrapper.vue';
+export { default as PFlyoutMultilevelItem } from './FlyoutMultilevelItemWrapper.vue';
+export { default as PGrid } from './GridWrapper.vue';
+export { default as PGridItem } from './GridItemWrapper.vue';
+export { default as PHeading } from './HeadingWrapper.vue';
+export { default as PHeadline } from './HeadlineWrapper.vue';
+export { default as PIcon } from './IconWrapper.vue';
+export { default as PInlineNotification } from './InlineNotificationWrapper.vue';
+export { default as PLink } from './LinkWrapper.vue';
+export { default as PLinkPure } from './LinkPureWrapper.vue';
+export { default as PLinkSocial } from './LinkSocialWrapper.vue';
+export { default as PLinkTile } from './LinkTileWrapper.vue';
+export { default as PLinkTileModelSignature } from './LinkTileModelSignatureWrapper.vue';
+export { default as PLinkTileProduct } from './LinkTileProductWrapper.vue';
+export { default as PMarque } from './MarqueWrapper.vue';
+export { default as PModal } from './ModalWrapper.vue';
+export { default as PModelSignature } from './ModelSignatureWrapper.vue';
+export { default as PMultiSelect } from './MultiSelectWrapper.vue';
+export { default as PMultiSelectOption } from './MultiSelectOptionWrapper.vue';
+export { default as PPagination } from './PaginationWrapper.vue';
+export { default as PPinCode } from './PinCodeWrapper.vue';
+export { default as PPopover } from './PopoverWrapper.vue';
+export { default as PRadioButtonWrapper } from './RadioButtonWrapperWrapper.vue';
+export { default as PScroller } from './ScrollerWrapper.vue';
+export { default as PSegmentedControl } from './SegmentedControlWrapper.vue';
+export { default as PSegmentedControlItem } from './SegmentedControlItemWrapper.vue';
+export { default as PSelect } from './SelectWrapper.vue';
+export { default as PSelectOption } from './SelectOptionWrapper.vue';
+export { default as PSelectWrapper } from './SelectWrapperWrapper.vue';
+export { default as PSpinner } from './SpinnerWrapper.vue';
+export { default as PStepperHorizontal } from './StepperHorizontalWrapper.vue';
+export { default as PStepperHorizontalItem } from './StepperHorizontalItemWrapper.vue';
+export { default as PSwitch } from './SwitchWrapper.vue';
+export { default as PTable } from './TableWrapper.vue';
+export { default as PTableBody } from './TableBodyWrapper.vue';
+export { default as PTableCell } from './TableCellWrapper.vue';
+export { default as PTableHead } from './TableHeadWrapper.vue';
+export { default as PTableHeadCell } from './TableHeadCellWrapper.vue';
+export { default as PTableHeadRow } from './TableHeadRowWrapper.vue';
+export { default as PTableRow } from './TableRowWrapper.vue';
+export { default as PTabs } from './TabsWrapper.vue';
+export { default as PTabsBar } from './TabsBarWrapper.vue';
+export { default as PTabsItem } from './TabsItemWrapper.vue';
+export { default as PTag } from './TagWrapper.vue';
+export { default as PTagDismissible } from './TagDismissibleWrapper.vue';
+export { default as PText } from './TextWrapper.vue';
+export { default as PTextFieldWrapper } from './TextFieldWrapperWrapper.vue';
+export { default as PTextList } from './TextListWrapper.vue';
+export { default as PTextListItem } from './TextListItemWrapper.vue';
+export { default as PTextareaWrapper } from './TextareaWrapperWrapper.vue';
+export { default as PToast } from './ToastWrapper.vue';
+export { default as PWordmark } from './WordmarkWrapper.vue';