@agnos-ui/core-bootstrap/components/toast/toast.d.ts

Styles and component interface extensions necessary to use AgnosUI with Bootstrap.

import type { ToastDirectives, ToastState as CoreState, ToastProps as CoreProps, ToastApi } from '@agnos-ui/core/components/toast';
import type { SlotContent, Widget, WidgetFactory, WidgetSlotContext } from '@agnos-ui/core/types';
import type { TransitionFn } from '@agnos-ui/core/services/transitions/baseTransitions';
import type { ToastPositions } from '@agnos-ui/core/components/toast';
export * from '@agnos-ui/core/components/toast';
/**
 * Represents the context for a Toast widget.
 * This interface is an alias for `WidgetSlotContext<ToastWidget>`.
 */
export interface ToastContext extends WidgetSlotContext<ToastWidget> {
}
/**
 * Interface representing additional properties for the Toast component.
 */
export interface ToastExtraProps {
    /**
     * Global template for the toast component
     */
    structure: SlotContent<ToastContext>;
    /**
     * Template for the toast content
     */
    children: SlotContent<ToastContext>;
    /**
     * Header template for the toast component
     */
    header: SlotContent<ToastContext>;
}
/**
 * Represents the state of a Toast component.
 */
export interface ToastState extends CoreState, ToastExtraProps {
}
/**
 * Interface representing the properties for the Toast component.
 */
export interface ToastProps extends CoreProps, ToastExtraProps {
    /**
     * The transition function will be executed when the alert is displayed or hidden.
     *
     * Depending on the value of `animatedOnInit`, the animation can be optionally skipped during the showing process.
     *
     * @defaultValue `fadeTransition`
     */
    transition: TransitionFn;
}
/**
 * Represents a Toast widget component.
 */
export type ToastWidget = Widget<ToastProps, ToastState, ToastApi, ToastDirectives>;
/**
 * Retrieve a shallow copy of the default Toast config
 * @returns the default Toast config
 */
export declare function getToastDefaultConfig(): ToastProps;
/**
 * Create an ToastWidget with given config props
 * @param config - an optional alert config
 * @returns an ToastWidget
 */
export declare const createToast: WidgetFactory<ToastWidget>;
/**
 * A mapping of toast position keys to their corresponding CSS class strings of bootstrap.
 * These classes define the positioning of toast notifications on the screen.
 *
 * The keys represent various positions on the screen, such as top-left, top-center,
 * middle-right, etc., and the values are the CSS classes of bootstrap that apply the respective
 * positioning styles.
 *
 * Example usage:
 * ```typescript
 * const positionClass = toastPositions.topLeft; // "top-0 start-0"
 * ```
 */
export declare const toastPositions: Record<ToastPositions, string>;