@stihl-design-system/components
Version:
Welcome to the STIHL Design System react component library.
28 lines (27 loc) • 1.44 kB
TypeScript
import { HTMLAttributes, JSX } from 'react';
import { Theme } from '../../types/common-types';
import { SystemFeedbackVariant } from './SystemFeedback.utils';
export interface SystemFeedbackProps extends HTMLAttributes<HTMLDivElement> {
/** Unique id for connecting the system feedback with aria attributes like aria-describedby. */
id: string;
/** Defines the message. */
message: string;
/** Defines the variant (e.g. "error", "success" or "warning"). */
variant: SystemFeedbackVariant;
}
/** @internal Props including theme — not exported to consumers. */
export interface SystemFeedbackPropsWithTheme extends SystemFeedbackProps {
/** Defines the theme.
* @default 'light'
*/
theme?: Theme;
}
/**
* Use the SystemFeedback component to provide clear and immediate feedback to the user
* about the status of a system process or validation state.
*
* Design in Figma: [SystemFeedback](https://www.figma.com/design/qXldpLO6gxHJNLdcXIPxYt/Core-Components-%F0%9F%92%A0?node-id=14690-32&t=qoxy54r8T2z3eW8T-4)
*
* <div className="ds-info">For more information on the different types of notifications and to determine which is best suited for your needs, please refer to our [Notification Guidelines](/docs/templates-notification-guidelines--documentation) and explore the decision trees provided.</div>
*/
export declare const DSSystemFeedback: (props: SystemFeedbackProps) => JSX.Element;