Interface AlertComponentOptions

Interface defining the options for the AlertComponent.

AlertComponentOptions

Display Control:

interface AlertComponentOptions {
    visible: boolean;
    message: string;
    type?: "success" | "danger";
    duration?: number;
    onHide?: (() => void);
    textColor?: string;
    style?: object;
    renderContent?: ((options: {
        defaultContent: ReactNode;
        dimensions: {
            width: number;
            height: number;
        };
    }) => ReactNode);
    renderContainer?: ((options: {
        defaultContainer: ReactNode;
        dimensions: {
            width: number;
            height: number;
        };
    }) => ReactNode);
}

Properties

visible message type? duration? onHide? textColor? style? renderContent? renderContainer?

Properties

visible

visible: boolean

Whether the alert is currently visible

message

message: string

Alert message text to display

Optionaltype

type?: "success" | "danger"

Alert type determining background color (green/red)

Optionalduration

duration?: number

Auto-hide duration in milliseconds (0 = no auto-hide)

OptionalonHide

onHide?: (() => void)

Callback when alert is hidden (manually or auto)

Styling:

OptionaltextColor

textColor?: string

Color of the message text

Optionalstyle

style?: object

Custom styles for the alert container

Advanced Render Overrides:

OptionalrenderContent

renderContent?: ((options: {
    defaultContent: ReactNode;
    dimensions: {
        width: number;
        height: number;
    };
}) => ReactNode)

Function to wrap or replace the default alert content

OptionalrenderContainer

renderContainer?: ((options: {
    defaultContainer: ReactNode;
    dimensions: {
        width: number;
        height: number;
    };
}) => ReactNode)

Function to wrap or replace the entire alert container

Settings

Member Visibility

On This Page

Properties