146 lines
4.3 KiB
TypeScript
146 lines
4.3 KiB
TypeScript
|
|
import { Injector } from '@angular/core';
|
||
|
|
import { NgbConfig } from '../ngb-config';
|
||
|
|
import * as i0 from "@angular/core";
|
||
|
|
/**
|
||
|
|
* Options available when opening new modal windows with `NgbModal.open()` method.
|
||
|
|
*/
|
||
|
|
export interface NgbModalOptions {
|
||
|
|
/**
|
||
|
|
* If `true`, modal opening and closing will be animated.
|
||
|
|
*
|
||
|
|
* @since 8.0.0
|
||
|
|
*/
|
||
|
|
animation?: boolean;
|
||
|
|
/**
|
||
|
|
* `aria-labelledby` attribute value to set on the modal window.
|
||
|
|
*
|
||
|
|
* @since 2.2.0
|
||
|
|
*/
|
||
|
|
ariaLabelledBy?: string;
|
||
|
|
/**
|
||
|
|
* `aria-describedby` attribute value to set on the modal window.
|
||
|
|
*
|
||
|
|
* @since 6.1.0
|
||
|
|
*/
|
||
|
|
ariaDescribedBy?: string;
|
||
|
|
/**
|
||
|
|
* If `true`, the backdrop element will be created for a given modal.
|
||
|
|
*
|
||
|
|
* Alternatively, specify `'static'` for a backdrop which doesn't close the modal on click.
|
||
|
|
*
|
||
|
|
* Default value is `true`.
|
||
|
|
*/
|
||
|
|
backdrop?: boolean | 'static';
|
||
|
|
/**
|
||
|
|
* Callback right before the modal will be dismissed.
|
||
|
|
*
|
||
|
|
* If this function returns:
|
||
|
|
* * `false`
|
||
|
|
* * a promise resolved with `false`
|
||
|
|
* * a promise that is rejected
|
||
|
|
*
|
||
|
|
* then the modal won't be dismissed.
|
||
|
|
*/
|
||
|
|
beforeDismiss?: () => boolean | Promise<boolean>;
|
||
|
|
/**
|
||
|
|
* If `true`, the modal will be centered vertically.
|
||
|
|
*
|
||
|
|
* Default value is `false`.
|
||
|
|
*
|
||
|
|
* @since 1.1.0
|
||
|
|
*/
|
||
|
|
centered?: boolean;
|
||
|
|
/**
|
||
|
|
* A selector specifying the element all new modal windows should be appended to.
|
||
|
|
* Since v5.3.0 it is also possible to pass the reference to an `HTMLElement`.
|
||
|
|
*
|
||
|
|
* If not specified, will be `body`.
|
||
|
|
*/
|
||
|
|
container?: string | HTMLElement;
|
||
|
|
/**
|
||
|
|
* If `true` modal will always be displayed in fullscreen mode.
|
||
|
|
*
|
||
|
|
* For values like `'md'` it means that modal will be displayed in fullscreen mode
|
||
|
|
* only if the viewport width is below `'md'`. For custom strings (ex. when passing `'mysize'`)
|
||
|
|
* it will add a `'modal-fullscreen-mysize-down'` class.
|
||
|
|
*
|
||
|
|
* If not specified will be `false`.
|
||
|
|
*
|
||
|
|
* @since 12.1.0
|
||
|
|
*/
|
||
|
|
fullscreen?: 'sm' | 'md' | 'lg' | 'xl' | 'xxl' | boolean | string;
|
||
|
|
/**
|
||
|
|
* The `Injector` to use for modal content.
|
||
|
|
*/
|
||
|
|
injector?: Injector;
|
||
|
|
/**
|
||
|
|
* If `true`, the modal will be closed when `Escape` key is pressed
|
||
|
|
*
|
||
|
|
* Default value is `true`.
|
||
|
|
*/
|
||
|
|
keyboard?: boolean;
|
||
|
|
/**
|
||
|
|
* Scrollable modal content (false by default).
|
||
|
|
*
|
||
|
|
* @since 5.0.0
|
||
|
|
*/
|
||
|
|
scrollable?: boolean;
|
||
|
|
/**
|
||
|
|
* Size of a new modal window.
|
||
|
|
*/
|
||
|
|
size?: 'sm' | 'lg' | 'xl' | string;
|
||
|
|
/**
|
||
|
|
* A custom class to append to the modal window.
|
||
|
|
*/
|
||
|
|
windowClass?: string;
|
||
|
|
/**
|
||
|
|
* A custom class to append to the modal dialog.
|
||
|
|
*
|
||
|
|
* @since 9.1.0
|
||
|
|
*/
|
||
|
|
modalDialogClass?: string;
|
||
|
|
/**
|
||
|
|
* A custom class to append to the modal backdrop.
|
||
|
|
*
|
||
|
|
* @since 1.1.0
|
||
|
|
*/
|
||
|
|
backdropClass?: string;
|
||
|
|
}
|
||
|
|
/**
|
||
|
|
* Options that can be changed on an opened modal with `NgbModalRef.update()` and `NgbActiveModal.update()` methods.
|
||
|
|
*
|
||
|
|
* @since 14.2.0
|
||
|
|
*/
|
||
|
|
export declare type NgbModalUpdatableOptions = Pick<NgbModalOptions, 'ariaLabelledBy' | 'ariaDescribedBy' | 'centered' | 'fullscreen' | 'backdropClass' | 'size' | 'windowClass' | 'modalDialogClass'>;
|
||
|
|
/**
|
||
|
|
* A configuration service for the [`NgbModal`](#/components/modal/api#NgbModal) service.
|
||
|
|
*
|
||
|
|
* You can inject this service, typically in your root component, and customize the values of its properties in
|
||
|
|
* order to provide default values for all modals used in the application.
|
||
|
|
*
|
||
|
|
* @since 3.1.0
|
||
|
|
*/
|
||
|
|
export declare class NgbModalConfig implements Required<NgbModalOptions> {
|
||
|
|
private _ngbConfig;
|
||
|
|
ariaLabelledBy: string;
|
||
|
|
ariaDescribedBy: string;
|
||
|
|
backdrop: boolean | 'static';
|
||
|
|
beforeDismiss: () => boolean | Promise<boolean>;
|
||
|
|
centered: boolean;
|
||
|
|
container: string | HTMLElement;
|
||
|
|
fullscreen: 'sm' | 'md' | 'lg' | 'xl' | 'xxl' | boolean | string;
|
||
|
|
injector: Injector;
|
||
|
|
keyboard: boolean;
|
||
|
|
scrollable: boolean;
|
||
|
|
size: 'sm' | 'lg' | 'xl' | string;
|
||
|
|
windowClass: string;
|
||
|
|
modalDialogClass: string;
|
||
|
|
backdropClass: string;
|
||
|
|
private _animation;
|
||
|
|
constructor(_ngbConfig: NgbConfig);
|
||
|
|
get animation(): boolean;
|
||
|
|
set animation(animation: boolean);
|
||
|
|
static ɵfac: i0.ɵɵFactoryDeclaration<NgbModalConfig, never>;
|
||
|
|
static ɵprov: i0.ɵɵInjectableDeclaration<NgbModalConfig>;
|
||
|
|
}
|