@agnos-ui/core/components/alert/alert.d.ts

Framework-agnostic headless component library.

import type { CommonAlertApi, CommonAlertDirectives, CommonAlertProps, CommonAlertState } from './common';
import type { Widget, WidgetFactory } from '../../types';
/**
 * Represents the state of an alert component.
 */
export interface AlertState extends CommonAlertState {
}
/**
 * Represents the properties for the alert component.
 */
export interface AlertProps extends CommonAlertProps {
}
/**
 * Represents the API for an alert component.
 */
export interface AlertApi extends CommonAlertApi {
}
/**
 * Represents the directives for an alert component.
 */
export interface AlertDirectives extends CommonAlertDirectives {
}
/**
 * Represents an alert widget with specific properties, state, API, and directives.
 */
export type AlertWidget = Widget<AlertProps, AlertState, AlertApi, AlertDirectives>;
/**
 * Retrieve a shallow copy of the default alert config
 * @returns the default alert config
 */
export declare function getAlertDefaultConfig(): AlertProps;
/**
 * Create an AlertWidget with given config props
 * @param config - an optional alert config
 * @returns an AlertWidget
 */
export declare const createAlert: WidgetFactory<AlertWidget>;