@ng-bootstrap/ng-bootstrap
Version:
Angular powered Bootstrap
82 lines (77 loc) • 2.95 kB
TypeScript
import * as i0 from '@angular/core';
import { EventEmitter } from '@angular/core';
import { Observable } from 'rxjs';
/**
* Alert is a component to provide contextual feedback messages for user.
*
* It supports several alert types and can be dismissed.
*/
declare class NgbAlert {
private _config;
private _elementRef;
private _zone;
/**
* If `true`, alert closing will be animated.
*
* Animation is triggered only when clicked on the close button (×)
* or via the `.close()` function
*
* @since 8.0.0
*/
animation: boolean;
/**
* If `true`, alert can be dismissed by the user.
*
* The close button (×) will be displayed and you can be notified
* of the event with the `(closed)` output.
*/
dismissible: boolean;
/**
* Type of the alert.
*
* Bootstrap provides styles for the following types: `'success'`, `'info'`, `'warning'`, `'danger'`, `'primary'`,
* `'secondary'`, `'light'` and `'dark'`.
*/
type: string;
/**
* An event emitted when the close button is clicked. It has no payload and only relevant for dismissible alerts.
*
* @since 8.0.0
*/
closed: EventEmitter<void>;
/**
* Triggers alert closing programmatically (same as clicking on the close button (×)).
*
* The returned observable will emit and be completed once the closing transition has finished.
* If the animations are turned off this happens synchronously.
*
* Alternatively you could listen or subscribe to the `(closed)` output
*
* @since 8.0.0
*/
close(): Observable<void>;
static ɵfac: i0.ɵɵFactoryDeclaration<NgbAlert, never>;
static ɵcmp: i0.ɵɵComponentDeclaration<NgbAlert, "ngb-alert", ["ngbAlert"], { "animation": { "alias": "animation"; "required": false; }; "dismissible": { "alias": "dismissible"; "required": false; }; "type": { "alias": "type"; "required": false; }; }, { "closed": "closed"; }, never, ["*"], true, never>;
}
/**
* A configuration service for the [NgbAlert](#/components/alert/api#NgbAlert) component.
*
* You can inject this service, typically in your root component, and customize its properties
* to provide default values for all alerts used in the application.
*/
declare class NgbAlertConfig {
private _ngbConfig;
private _animation;
dismissible: boolean;
type: string;
get animation(): boolean;
set animation(animation: boolean);
static ɵfac: i0.ɵɵFactoryDeclaration<NgbAlertConfig, never>;
static ɵprov: i0.ɵɵInjectableDeclaration<NgbAlertConfig>;
}
declare class NgbAlertModule {
static ɵfac: i0.ɵɵFactoryDeclaration<NgbAlertModule, never>;
static ɵmod: i0.ɵɵNgModuleDeclaration<NgbAlertModule, never, [typeof NgbAlert], [typeof NgbAlert]>;
static ɵinj: i0.ɵɵInjectorDeclaration<NgbAlertModule>;
}
export { NgbAlert, NgbAlertConfig, NgbAlertModule };