@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.
105 lines (104 loc) • 3.56 kB
TypeScript
import type { BaseProps } from '../../BaseProps';
import type { InlineNotificationActionIcon, InlineNotificationHeadingTag, InlineNotificationState, Theme } from '../types';
export type PInlineNotificationProps = BaseProps & {
/**
* Action icon of the inline-notification.
*/
actionIcon?: InlineNotificationActionIcon;
/**
* Action label of the inline-notification.
*/
actionLabel?: string;
/**
* Disables the action button and shows a loading indicator. No events will be triggered while loading state is active.
*/
actionLoading?: boolean;
/**
* Description of the inline-notification.
*/
description?: string;
/**
* If false, the inline-notification will not have a dismiss button.
*/
dismissButton?: boolean;
/**
* Heading of the inline-notification.
*/
heading?: string;
/**
* Sets a heading tag, so it fits correctly within the outline of the page.
*/
headingTag?: InlineNotificationHeadingTag;
/**
* Emitted when the action button is clicked.
*/
onAction?: (event: CustomEvent<void>) => void;
/**
* Emitted when the close button is clicked.
*/
onDismiss?: (event: CustomEvent<void>) => void;
/**
* @deprecated since v3.0.0, will be removed with next major release, use `dismissButton` instead. Defines if the inline-notification can be closed/removed by the user.
*/
persistent?: boolean;
/**
* State of the inline-notification.
*/
state?: InlineNotificationState;
/**
* Adapts the inline-notification color depending on the theme.
*/
theme?: Theme;
};
export declare const PInlineNotification: import("react").ForwardRefExoticComponent<import("react").DOMAttributes<{}> & Pick<import("react").HTMLAttributes<{}>, "suppressHydrationWarning" | "autoFocus" | "className" | "dir" | "hidden" | "id" | "inert" | "lang" | "slot" | "style" | "tabIndex" | "title" | "translate" | "role"> & {
/**
* Action icon of the inline-notification.
*/
actionIcon?: InlineNotificationActionIcon;
/**
* Action label of the inline-notification.
*/
actionLabel?: string;
/**
* Disables the action button and shows a loading indicator. No events will be triggered while loading state is active.
*/
actionLoading?: boolean;
/**
* Description of the inline-notification.
*/
description?: string;
/**
* If false, the inline-notification will not have a dismiss button.
*/
dismissButton?: boolean;
/**
* Heading of the inline-notification.
*/
heading?: string;
/**
* Sets a heading tag, so it fits correctly within the outline of the page.
*/
headingTag?: InlineNotificationHeadingTag;
/**
* Emitted when the action button is clicked.
*/
onAction?: (event: CustomEvent<void>) => void;
/**
* Emitted when the close button is clicked.
*/
onDismiss?: (event: CustomEvent<void>) => void;
/**
* @deprecated since v3.0.0, will be removed with next major release, use `dismissButton` instead. Defines if the inline-notification can be closed/removed by the user.
*/
persistent?: boolean;
/**
* State of the inline-notification.
*/
state?: InlineNotificationState;
/**
* Adapts the inline-notification color depending on the theme.
*/
theme?: Theme;
} & {
children?: import("react").ReactNode | undefined;
} & import("react").RefAttributes<HTMLElement>>;