@skyux/modals 12.23.0 → 13.0.0-alpha.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/fesm2022/skyux-modals-testing.mjs +11 -11
- package/fesm2022/skyux-modals-testing.mjs.map +1 -1
- package/fesm2022/skyux-modals.mjs +60 -60
- package/fesm2022/skyux-modals.mjs.map +1 -1
- package/index.d.ts +647 -27
- package/package.json +11 -11
- package/testing/index.d.ts +283 -3
- package/lib/modules/confirm/confirm-button-action.d.ts +0 -4
- package/lib/modules/confirm/confirm-button-config.d.ts +0 -24
- package/lib/modules/confirm/confirm-button-style-type.d.ts +0 -1
- package/lib/modules/confirm/confirm-button.d.ts +0 -12
- package/lib/modules/confirm/confirm-closed-event-args.d.ts +0 -6
- package/lib/modules/confirm/confirm-config-token.d.ts +0 -6
- package/lib/modules/confirm/confirm-config.d.ts +0 -26
- package/lib/modules/confirm/confirm-instance.d.ts +0 -17
- package/lib/modules/confirm/confirm-service-interface.d.ts +0 -8
- package/lib/modules/confirm/confirm-type.d.ts +0 -22
- package/lib/modules/confirm/confirm.component.d.ts +0 -20
- package/lib/modules/confirm/confirm.module.d.ts +0 -10
- package/lib/modules/confirm/confirm.service.d.ts +0 -19
- package/lib/modules/modal/modal-adapter.service.d.ts +0 -30
- package/lib/modules/modal/modal-before-close-handler.d.ts +0 -18
- package/lib/modules/modal/modal-close-args.d.ts +0 -15
- package/lib/modules/modal/modal-component-adapter.service.d.ts +0 -17
- package/lib/modules/modal/modal-configuration.d.ts +0 -29
- package/lib/modules/modal/modal-content.component.d.ts +0 -9
- package/lib/modules/modal/modal-error.d.ts +0 -9
- package/lib/modules/modal/modal-errors.service.d.ts +0 -14
- package/lib/modules/modal/modal-footer.component.d.ts +0 -11
- package/lib/modules/modal/modal-header.component.d.ts +0 -8
- package/lib/modules/modal/modal-host-context-args.d.ts +0 -7
- package/lib/modules/modal/modal-host-context.d.ts +0 -13
- package/lib/modules/modal/modal-host.component.d.ts +0 -17
- package/lib/modules/modal/modal-host.service.d.ts +0 -37
- package/lib/modules/modal/modal-instance.d.ts +0 -81
- package/lib/modules/modal/modal-is-dirty.directive.d.ts +0 -18
- package/lib/modules/modal/modal-service-interface.d.ts +0 -8
- package/lib/modules/modal/modal.component.d.ts +0 -90
- package/lib/modules/modal/modal.interface.d.ts +0 -75
- package/lib/modules/modal/modal.module.d.ts +0 -11
- package/lib/modules/modal/modal.service.d.ts +0 -36
- package/lib/modules/shared/sky-modals-resources.module.d.ts +0 -10
- package/testing/legacy/modal-fixture.d.ts +0 -57
- package/testing/modules/confirm/confirm-button-harness-filters.d.ts +0 -14
- package/testing/modules/confirm/confirm-button-harness.d.ts +0 -29
- package/testing/modules/confirm/confirm-harness.d.ts +0 -42
- package/testing/modules/confirm/confirm-testing.controller.d.ts +0 -28
- package/testing/modules/confirm/confirm-testing.module.d.ts +0 -9
- package/testing/modules/confirm/confirm-testing.service.d.ts +0 -14
- package/testing/modules/confirm/provide-confirm-testing.d.ts +0 -5
- package/testing/modules/modal/controller/modal-testing.controller.d.ts +0 -26
- package/testing/modules/modal/controller/modal-testing.module.d.ts +0 -9
- package/testing/modules/modal/controller/modal-testing.service.d.ts +0 -18
- package/testing/modules/modal/controller/provide-modal-testing.d.ts +0 -5
- package/testing/modules/modal/modal-harness-filters.d.ts +0 -6
- package/testing/modules/modal/modal-harness.d.ts +0 -64
- package/testing/public-api.d.ts +0 -10
|
@@ -1,11 +0,0 @@
|
|
|
1
|
-
import { SkyModalErrorsService } from './modal-errors.service';
|
|
2
|
-
import * as i0 from "@angular/core";
|
|
3
|
-
import * as i1 from "@skyux/core";
|
|
4
|
-
/**
|
|
5
|
-
* Specifies content to display in the modal's footer.
|
|
6
|
-
*/
|
|
7
|
-
export declare class SkyModalFooterComponent {
|
|
8
|
-
protected readonly errorsSvc: SkyModalErrorsService;
|
|
9
|
-
static ɵfac: i0.ɵɵFactoryDeclaration<SkyModalFooterComponent, never>;
|
|
10
|
-
static ɵcmp: i0.ɵɵComponentDeclaration<SkyModalFooterComponent, "sky-modal-footer", never, {}, {}, never, ["*"], true, [{ directive: typeof i1.SkyResponsiveHostDirective; inputs: {}; outputs: {}; }]>;
|
|
11
|
-
}
|
|
@@ -1,8 +0,0 @@
|
|
|
1
|
-
import * as i0 from "@angular/core";
|
|
2
|
-
/**
|
|
3
|
-
* Specifies a header for the modal.
|
|
4
|
-
*/
|
|
5
|
-
export declare class SkyModalHeaderComponent {
|
|
6
|
-
static ɵfac: i0.ɵɵFactoryDeclaration<SkyModalHeaderComponent, never>;
|
|
7
|
-
static ɵcmp: i0.ɵɵComponentDeclaration<SkyModalHeaderComponent, "sky-modal-header", never, {}, {}, never, ["*", ".sky-control-help"], true, never>;
|
|
8
|
-
}
|
|
@@ -1,13 +0,0 @@
|
|
|
1
|
-
import { SkyModalHostContextArgs } from './modal-host-context-args';
|
|
2
|
-
import * as i0 from "@angular/core";
|
|
3
|
-
/**
|
|
4
|
-
* Provided by the modal service to give the modal host
|
|
5
|
-
* component additional context and features.
|
|
6
|
-
* @internal
|
|
7
|
-
*/
|
|
8
|
-
export declare class SkyModalHostContext {
|
|
9
|
-
args: SkyModalHostContextArgs;
|
|
10
|
-
constructor(args: SkyModalHostContextArgs);
|
|
11
|
-
static ɵfac: i0.ɵɵFactoryDeclaration<SkyModalHostContext, never>;
|
|
12
|
-
static ɵprov: i0.ɵɵInjectableDeclaration<SkyModalHostContext>;
|
|
13
|
-
}
|
|
@@ -1,17 +0,0 @@
|
|
|
1
|
-
import { EnvironmentInjector, OnDestroy, Type, ViewContainerRef } from '@angular/core';
|
|
2
|
-
import { SkyModalInstance } from './modal-instance';
|
|
3
|
-
import { SkyModalConfigurationInterface } from './modal.interface';
|
|
4
|
-
import * as i0 from "@angular/core";
|
|
5
|
-
/**
|
|
6
|
-
* @internal
|
|
7
|
-
*/
|
|
8
|
-
export declare class SkyModalHostComponent implements OnDestroy {
|
|
9
|
-
#private;
|
|
10
|
-
protected backdropZIndex: import("@angular/core").Signal<number | undefined>;
|
|
11
|
-
protected modalCount: import("@angular/core").Signal<number | undefined>;
|
|
12
|
-
target: ViewContainerRef | undefined;
|
|
13
|
-
ngOnDestroy(): void;
|
|
14
|
-
open<T>(modalInstance: SkyModalInstance, component: Type<T>, config?: SkyModalConfigurationInterface, environmentInjector?: EnvironmentInjector): void;
|
|
15
|
-
static ɵfac: i0.ɵɵFactoryDeclaration<SkyModalHostComponent, never>;
|
|
16
|
-
static ɵcmp: i0.ɵɵComponentDeclaration<SkyModalHostComponent, "sky-modal-host", never, {}, {}, never, never, true, never>;
|
|
17
|
-
}
|
|
@@ -1,37 +0,0 @@
|
|
|
1
|
-
import { Observable, Subject } from 'rxjs';
|
|
2
|
-
import * as i0 from "@angular/core";
|
|
3
|
-
/**
|
|
4
|
-
* @internal
|
|
5
|
-
*/
|
|
6
|
-
export declare class SkyModalHostService {
|
|
7
|
-
#private;
|
|
8
|
-
static get openModalCountChange(): Observable<number>;
|
|
9
|
-
static get backdropZIndexChange(): Observable<number>;
|
|
10
|
-
/**
|
|
11
|
-
* @deprecated Subscribe to `openModalCountChange` instead.
|
|
12
|
-
*/
|
|
13
|
-
static get openModalCount(): number;
|
|
14
|
-
static get fullPageModalCount(): number;
|
|
15
|
-
/**
|
|
16
|
-
* @deprecated Subscribe to `backdropZIndexChange` instead.
|
|
17
|
-
*/
|
|
18
|
-
static get backdropZIndex(): number;
|
|
19
|
-
static get topModal(): SkyModalHostService;
|
|
20
|
-
close: Subject<void>;
|
|
21
|
-
fullPage: boolean;
|
|
22
|
-
/**
|
|
23
|
-
* @deprecated
|
|
24
|
-
*/
|
|
25
|
-
openHelp: Subject<string>;
|
|
26
|
-
zIndex: number;
|
|
27
|
-
constructor();
|
|
28
|
-
getModalZIndex(): number;
|
|
29
|
-
onClose(): void;
|
|
30
|
-
/**
|
|
31
|
-
* @deprecated
|
|
32
|
-
*/
|
|
33
|
-
onOpenHelp(helpKey: string): void;
|
|
34
|
-
destroy(): void;
|
|
35
|
-
static ɵfac: i0.ɵɵFactoryDeclaration<SkyModalHostService, never>;
|
|
36
|
-
static ɵprov: i0.ɵɵInjectableDeclaration<SkyModalHostService>;
|
|
37
|
-
}
|
|
@@ -1,81 +0,0 @@
|
|
|
1
|
-
import { ComponentRef } from '@angular/core';
|
|
2
|
-
import { Observable } from 'rxjs';
|
|
3
|
-
import { SkyModalAdapterService } from './modal-adapter.service';
|
|
4
|
-
import { SkyModalBeforeCloseHandler } from './modal-before-close-handler';
|
|
5
|
-
import { SkyModalCloseArgs } from './modal-close-args';
|
|
6
|
-
export declare class SkyModalInstance {
|
|
7
|
-
#private;
|
|
8
|
-
/**
|
|
9
|
-
* An event that the modal instance emits when it is about to close.
|
|
10
|
-
* It emits a `SkyModalBeforeCloseHandler` object with a `closeModal` method
|
|
11
|
-
* that closes the modal. If a subscription exists for this event,
|
|
12
|
-
* the modal does not close until the subscriber calls the `closeModal` method.
|
|
13
|
-
*/
|
|
14
|
-
get beforeClose(): Observable<SkyModalBeforeCloseHandler>;
|
|
15
|
-
/**
|
|
16
|
-
* An event that the modal instance emits when it closes.
|
|
17
|
-
* It emits a `SkyModalCloseArgs` object with a `data` property that includes
|
|
18
|
-
* data passed from users on close or save and a `reason` property that indicates
|
|
19
|
-
* whether the modal was saved or closed without saving.
|
|
20
|
-
* The `reason` property accepts any string value.
|
|
21
|
-
* Common examples include `"cancel"`, `"close"`, and `"save"`.
|
|
22
|
-
*/
|
|
23
|
-
get closed(): Observable<SkyModalCloseArgs>;
|
|
24
|
-
/**
|
|
25
|
-
* An event that the modal instance emits when users click
|
|
26
|
-
* the <i class="fa fa-question-circle" aria-hidden="true"></i> button.
|
|
27
|
-
* If a `helpKey` parameter was specified, the `helpOpened` event broadcasts the `helpKey`.
|
|
28
|
-
* @deprecated
|
|
29
|
-
*/
|
|
30
|
-
get helpOpened(): Observable<string>;
|
|
31
|
-
/**
|
|
32
|
-
* A direct reference to the provided component's class.
|
|
33
|
-
*/
|
|
34
|
-
componentInstance: any;
|
|
35
|
-
/**
|
|
36
|
-
* Sets the component adapter for the instance. This is used internally for actions such as scrolling the content.
|
|
37
|
-
* @internal
|
|
38
|
-
*/
|
|
39
|
-
set adapter(value: SkyModalAdapterService);
|
|
40
|
-
/**
|
|
41
|
-
* Sets the component ref for the instance. This is used to extract the component instance for the public API and the element ref for internal use.
|
|
42
|
-
* @internal
|
|
43
|
-
*/
|
|
44
|
-
set componentRef(value: ComponentRef<any>);
|
|
45
|
-
/**
|
|
46
|
-
* Closes the modal instance.
|
|
47
|
-
* @param result Specifies an object to emit to subscribers of the `closed` event of the
|
|
48
|
-
* modal instance. The `SkyModalInstance` provider can be injected into a component's constructor
|
|
49
|
-
* so that this `close` function can be called from a button in the `sky-modal-footer`.
|
|
50
|
-
* @param reason Specifies the reason for the modal closing, with the default reason of `"close"`.
|
|
51
|
-
* @param ignoreBeforeClose Indicates whether to ignore the modal instance's `beforeClose` event.
|
|
52
|
-
*/
|
|
53
|
-
close(result?: any, reason?: string, ignoreBeforeClose?: boolean): void;
|
|
54
|
-
/**
|
|
55
|
-
* Closes the modal instance with `reason="cancel"`.
|
|
56
|
-
* @param result Specifies an object to emit to subscribers of the `closed` event of the modal
|
|
57
|
-
* instance. The `SkyModalInstance` provider can be injected into a component's constructor so
|
|
58
|
-
* that this cancel function can be called from a button in the `sky-modal-footer`.
|
|
59
|
-
*/
|
|
60
|
-
cancel(result?: any): void;
|
|
61
|
-
/**
|
|
62
|
-
* Closes the modal instance with `reason="save"`.
|
|
63
|
-
* @param result Specifies an object to emit to subscribers of the `closed` event of the modal
|
|
64
|
-
* instance. The `SkyModalInstance` provider can be injected into a component's constructor so
|
|
65
|
-
* that this `save` function can be called from a button in `the sky-modal-footer`.
|
|
66
|
-
*/
|
|
67
|
-
save(result?: any): void;
|
|
68
|
-
/**
|
|
69
|
-
* Scrolls the modal content area to the top of its scrollable area.
|
|
70
|
-
*/
|
|
71
|
-
scrollContentToTop(): void;
|
|
72
|
-
/**
|
|
73
|
-
* Triggers the `helpOpened` event that broadcasts a `helpKey` parameter to open
|
|
74
|
-
* when users click the <i class="fa fa-question-circle" aria-hidden="true"></i> button.
|
|
75
|
-
* @param helpKey Specifies a string to emit to subscribers of
|
|
76
|
-
* the modal instance's `helpOpened` event. Consumers can inject the `SkyModalInstance` provider
|
|
77
|
-
* into a component's constructor to call the `openHelp` function in the modal template.
|
|
78
|
-
* @deprecated
|
|
79
|
-
*/
|
|
80
|
-
openHelp(helpKey: string): void;
|
|
81
|
-
}
|
|
@@ -1,18 +0,0 @@
|
|
|
1
|
-
import { OnDestroy, OnInit } from '@angular/core';
|
|
2
|
-
import * as i0 from "@angular/core";
|
|
3
|
-
/**
|
|
4
|
-
* Provides a way to mark a modal as "dirty" and displays a confirmation
|
|
5
|
-
* message when a user closes the modal without saving.
|
|
6
|
-
*/
|
|
7
|
-
export declare class SkyModalIsDirtyDirective implements OnInit, OnDestroy {
|
|
8
|
-
#private;
|
|
9
|
-
/**
|
|
10
|
-
* Whether the user edited an input on the modal.
|
|
11
|
-
* @required
|
|
12
|
-
*/
|
|
13
|
-
isDirty: boolean;
|
|
14
|
-
ngOnInit(): void;
|
|
15
|
-
ngOnDestroy(): void;
|
|
16
|
-
static ɵfac: i0.ɵɵFactoryDeclaration<SkyModalIsDirtyDirective, never>;
|
|
17
|
-
static ɵdir: i0.ɵɵDirectiveDeclaration<SkyModalIsDirtyDirective, "sky-modal[isDirty]", never, { "isDirty": { "alias": "isDirty"; "required": false; }; }, {}, never, never, true, never>;
|
|
18
|
-
}
|
|
@@ -1,8 +0,0 @@
|
|
|
1
|
-
import { SkyModalInstance } from './modal-instance';
|
|
2
|
-
import { SkyModalConfigurationInterface } from './modal.interface';
|
|
3
|
-
/**
|
|
4
|
-
* @internal
|
|
5
|
-
*/
|
|
6
|
-
export interface SkyModalServiceInterface {
|
|
7
|
-
open(component: any, config?: SkyModalConfigurationInterface | any[]): SkyModalInstance;
|
|
8
|
-
}
|
|
@@ -1,90 +0,0 @@
|
|
|
1
|
-
import { AfterViewInit, ElementRef, OnDestroy, OnInit, TemplateRef } from '@angular/core';
|
|
2
|
-
import { SkyScrollShadowEventArgs } from '@skyux/core';
|
|
3
|
-
import { SkyModalError } from './modal-error';
|
|
4
|
-
import * as i0 from "@angular/core";
|
|
5
|
-
/**
|
|
6
|
-
* Provides a common look-and-feel for modal content with options to display
|
|
7
|
-
* a common modal header, specify body content, and display a common modal footer
|
|
8
|
-
* and buttons.
|
|
9
|
-
*/
|
|
10
|
-
export declare class SkyModalComponent implements AfterViewInit, OnDestroy, OnInit {
|
|
11
|
-
#private;
|
|
12
|
-
wrapperClass: string | undefined;
|
|
13
|
-
/**
|
|
14
|
-
* A list of form-level errors to display to the user.
|
|
15
|
-
*/
|
|
16
|
-
set formErrors(value: SkyModalError[] | undefined);
|
|
17
|
-
/**
|
|
18
|
-
* The text to display as the modal's heading.
|
|
19
|
-
*/
|
|
20
|
-
headingText: string | undefined;
|
|
21
|
-
/**
|
|
22
|
-
* A help key that identifies the global help content to display. When specified along with `headingText`, a [help inline](https://developer.blackbaud.com/skyux/components/help-inline) button is
|
|
23
|
-
* added to the modal header. Clicking the button invokes global help as configured by the application. This property only applies when `headingText` is also specified.
|
|
24
|
-
*/
|
|
25
|
-
helpKey: string | undefined;
|
|
26
|
-
/**
|
|
27
|
-
* The content of the help popover. When specified along with `headingText`, a [help inline](https://developer.blackbaud.com/skyux/components/help-inline)
|
|
28
|
-
* button is added to the modal header. The help inline button displays a [popover](https://developer.blackbaud.com/skyux/components/popover)
|
|
29
|
-
* when clicked using the specified content and optional title. This property only applies when `headingText` is also specified.
|
|
30
|
-
*/
|
|
31
|
-
helpPopoverContent: string | TemplateRef<unknown> | undefined;
|
|
32
|
-
/**
|
|
33
|
-
* The title of the help popover. This property only applies when `helpPopoverContent` is
|
|
34
|
-
* also specified.
|
|
35
|
-
*/
|
|
36
|
-
helpPopoverTitle: string | undefined;
|
|
37
|
-
/**
|
|
38
|
-
* Used by the confirm component to set a different role for the modal.
|
|
39
|
-
* @internal
|
|
40
|
-
*/
|
|
41
|
-
set ariaRole(value: string | undefined);
|
|
42
|
-
ariaRoleOrDefault: string;
|
|
43
|
-
/**
|
|
44
|
-
* @internal
|
|
45
|
-
* @deprecated
|
|
46
|
-
*/
|
|
47
|
-
tiledBody: boolean | undefined;
|
|
48
|
-
/**
|
|
49
|
-
* Used by the confirm component to set descriptive text without using a
|
|
50
|
-
* modal header.
|
|
51
|
-
* @internal
|
|
52
|
-
*/
|
|
53
|
-
set ariaDescribedBy(id: string | undefined);
|
|
54
|
-
get ariaDescribedBy(): string | undefined;
|
|
55
|
-
/**
|
|
56
|
-
* Used by the confirm component to set descriptive text without using a
|
|
57
|
-
* modal header.
|
|
58
|
-
* @internal
|
|
59
|
-
*/
|
|
60
|
-
set ariaLabelledBy(id: string | undefined);
|
|
61
|
-
get ariaLabelledBy(): string | undefined;
|
|
62
|
-
readonly layout: import("@angular/core").InputSignal<"none" | "fit">;
|
|
63
|
-
ariaOwns: string | null;
|
|
64
|
-
/**
|
|
65
|
-
* @deprecated
|
|
66
|
-
*/
|
|
67
|
-
legacyHelpKey: string | undefined;
|
|
68
|
-
modalState: string;
|
|
69
|
-
modalZIndex: number | undefined;
|
|
70
|
-
scrollShadow: SkyScrollShadowEventArgs;
|
|
71
|
-
size: string;
|
|
72
|
-
modalContentWrapperElement: ElementRef | undefined;
|
|
73
|
-
protected scrollShadowEnabled: boolean;
|
|
74
|
-
constructor();
|
|
75
|
-
onDocumentKeyUp(event: KeyboardEvent): void;
|
|
76
|
-
onDocumentKeyDown(event: KeyboardEvent): void;
|
|
77
|
-
ngOnInit(): void;
|
|
78
|
-
ngAfterViewInit(): void;
|
|
79
|
-
ngOnDestroy(): void;
|
|
80
|
-
/**
|
|
81
|
-
* @deprecated
|
|
82
|
-
*/
|
|
83
|
-
helpButtonClick(): void;
|
|
84
|
-
closeButtonClick(): void;
|
|
85
|
-
windowResize(): void;
|
|
86
|
-
scrollShadowChange(args: SkyScrollShadowEventArgs): void;
|
|
87
|
-
viewkeeperEnabled(): boolean;
|
|
88
|
-
static ɵfac: i0.ɵɵFactoryDeclaration<SkyModalComponent, never>;
|
|
89
|
-
static ɵcmp: i0.ɵɵComponentDeclaration<SkyModalComponent, "sky-modal", never, { "formErrors": { "alias": "formErrors"; "required": false; }; "headingText": { "alias": "headingText"; "required": false; }; "helpKey": { "alias": "helpKey"; "required": false; }; "helpPopoverContent": { "alias": "helpPopoverContent"; "required": false; }; "helpPopoverTitle": { "alias": "helpPopoverTitle"; "required": false; }; "ariaRole": { "alias": "ariaRole"; "required": false; }; "tiledBody": { "alias": "tiledBody"; "required": false; }; "ariaDescribedBy": { "alias": "ariaDescribedBy"; "required": false; }; "ariaLabelledBy": { "alias": "ariaLabelledBy"; "required": false; }; "layout": { "alias": "layout"; "required": false; "isSignal": true; }; }, {}, never, ["sky-modal-header", "sky-modal-content", "sky-modal-footer"], true, never>;
|
|
90
|
-
}
|
|
@@ -1,75 +0,0 @@
|
|
|
1
|
-
import { StaticProvider } from '@angular/core';
|
|
2
|
-
/**
|
|
3
|
-
* Specifies configuration options for creating a modal.
|
|
4
|
-
*/
|
|
5
|
-
export interface SkyModalConfigurationInterface {
|
|
6
|
-
/**
|
|
7
|
-
* Whether to display the modal full screen.
|
|
8
|
-
* This property defaults to `false`.
|
|
9
|
-
*/
|
|
10
|
-
fullPage?: boolean;
|
|
11
|
-
/**
|
|
12
|
-
* The size for the modal. The valid options are `small`, `medium`, and `large`.
|
|
13
|
-
* This property defaults to `medium`.
|
|
14
|
-
*/
|
|
15
|
-
size?: string;
|
|
16
|
-
/**
|
|
17
|
-
* An array property of `providers`.
|
|
18
|
-
* In Angular, a provider is something that can create or deliver a service.
|
|
19
|
-
* This property can be used to pass context values from the component that launches the modal to the modal component.
|
|
20
|
-
*/
|
|
21
|
-
providers?: StaticProvider[];
|
|
22
|
-
/**
|
|
23
|
-
* The HTML element ID of the element that describes
|
|
24
|
-
* the modal. This sets the modal's `aria-describedby` attribute to provide a text equivalent for
|
|
25
|
-
* [to support accessibility](https://developer.blackbaud.com/skyux/learn/accessibility).
|
|
26
|
-
* The description typically includes text on the modal but not on items that users interact
|
|
27
|
-
* with, such as buttons and forms. If you do not specify an ID, the default description is
|
|
28
|
-
* the content of the `sky-modal-content` component.
|
|
29
|
-
* For more information about the `aria-describedby` attribute, see the [WAI-ARIA definition](https://www.w3.org/TR/wai-aria/#aria-describedby).
|
|
30
|
-
* @deprecated Set `headingText` on the modal component instead.
|
|
31
|
-
*/
|
|
32
|
-
ariaDescribedBy?: string;
|
|
33
|
-
/**
|
|
34
|
-
* The HTML element ID of the element that labels
|
|
35
|
-
* the modal. This sets the `aria-labelledby` attribute for the modal to provide a text equivalent for
|
|
36
|
-
* [to support accessibility](https://developer.blackbaud.com/skyux/learn/accessibility).
|
|
37
|
-
* This is typically a header element, and if you do not specify an ID, the default value
|
|
38
|
-
* is the content of the `sky-modal-header` component.
|
|
39
|
-
* For more information about the `aria-labelledby` attribute, see the [WAI-ARIA definition](https://www.w3.org/TR/wai-aria/#aria-labelledby).
|
|
40
|
-
* @deprecated Set `headingText` on the modal component instead.
|
|
41
|
-
*/
|
|
42
|
-
ariaLabelledBy?: string;
|
|
43
|
-
/**
|
|
44
|
-
* The ARIA role for the modal
|
|
45
|
-
* [to support accessibility](https://developer.blackbaud.com/skyux/learn/accessibility)
|
|
46
|
-
* by indicating how the modal functions and what it controls. For information about
|
|
47
|
-
* how an ARIA role indicates what an item represents on a web page, see the
|
|
48
|
-
* [WAI-ARIA roles model](http://www.w3.org/WAI/PF/aria/#roles). By default, modals set
|
|
49
|
-
* the ARIA role to `dialog`.
|
|
50
|
-
* @default "dialog"
|
|
51
|
-
*/
|
|
52
|
-
ariaRole?: string;
|
|
53
|
-
/**
|
|
54
|
-
* Whether the modal uses tiles. When set to `true`, the modal's background switches
|
|
55
|
-
* to `$sky-background-color-neutral-light` and tile headings are styled as subsection headings.
|
|
56
|
-
* This property defaults to `false`.
|
|
57
|
-
* @deprecated Tiles inside modals are no longer a recommended design pattern. For complex forms, use [sectioned forms](https://developer.blackbaud.com/skyux/components/sectioned-form) or [other form containers](https://developer.blackbaud.com/skyux/design/guidelines/form-design) instead.
|
|
58
|
-
*/
|
|
59
|
-
tiledBody?: boolean;
|
|
60
|
-
/**
|
|
61
|
-
* The `helpKey` string. This property displays
|
|
62
|
-
* the <i class="fa fa-question-circle" aria-hidden="true"></i> button in the modal header.
|
|
63
|
-
* When users click this button, the `helpOpened` event broadcasts the `helpKey` parameter.
|
|
64
|
-
* Blackbaud developers can use the Help Widget, which is for internal Blackbaud use only, to
|
|
65
|
-
* [display help content in a flyout panel](https://docs.blackbaud.com/bb-help-docs/components/modal-header).
|
|
66
|
-
* @deprecated To display a help button in the modal header, set either the
|
|
67
|
-
* `helpKey` or `helpPopoverContent` inputs on the modal component.
|
|
68
|
-
*/
|
|
69
|
-
helpKey?: string;
|
|
70
|
-
/**
|
|
71
|
-
* The CSS class to add to the modal, such as `ag-custom-component-popup` for
|
|
72
|
-
* using a modal as part of a cell editor in Data Entry Grid.
|
|
73
|
-
*/
|
|
74
|
-
wrapperClass?: string;
|
|
75
|
-
}
|
|
@@ -1,11 +0,0 @@
|
|
|
1
|
-
import * as i0 from "@angular/core";
|
|
2
|
-
import * as i1 from "./modal.component";
|
|
3
|
-
import * as i2 from "./modal-content.component";
|
|
4
|
-
import * as i3 from "./modal-footer.component";
|
|
5
|
-
import * as i4 from "./modal-header.component";
|
|
6
|
-
import * as i5 from "./modal-is-dirty.directive";
|
|
7
|
-
export declare class SkyModalModule {
|
|
8
|
-
static ɵfac: i0.ɵɵFactoryDeclaration<SkyModalModule, never>;
|
|
9
|
-
static ɵmod: i0.ɵɵNgModuleDeclaration<SkyModalModule, never, [typeof i1.SkyModalComponent, typeof i2.SkyModalContentComponent, typeof i3.SkyModalFooterComponent, typeof i4.SkyModalHeaderComponent, typeof i5.SkyModalIsDirtyDirective], [typeof i1.SkyModalComponent, typeof i2.SkyModalContentComponent, typeof i3.SkyModalFooterComponent, typeof i4.SkyModalHeaderComponent, typeof i5.SkyModalIsDirtyDirective]>;
|
|
10
|
-
static ɵinj: i0.ɵɵInjectorDeclaration<SkyModalModule>;
|
|
11
|
-
}
|
|
@@ -1,36 +0,0 @@
|
|
|
1
|
-
import { SkyDynamicComponentLegacyService, SkyDynamicComponentService } from '@skyux/core';
|
|
2
|
-
import { SkyModalInstance } from './modal-instance';
|
|
3
|
-
import { SkyModalServiceInterface } from './modal-service-interface';
|
|
4
|
-
import { SkyModalConfigurationInterface } from './modal.interface';
|
|
5
|
-
import * as i0 from "@angular/core";
|
|
6
|
-
/**
|
|
7
|
-
* A service that launches modals.
|
|
8
|
-
*/
|
|
9
|
-
export declare class SkyModalService implements SkyModalServiceInterface {
|
|
10
|
-
#private;
|
|
11
|
-
private static host;
|
|
12
|
-
constructor(dynamicComponentService: SkyDynamicComponentService);
|
|
13
|
-
/**
|
|
14
|
-
* @internal
|
|
15
|
-
* Removes the modal host from the DOM.
|
|
16
|
-
*/
|
|
17
|
-
dispose(): void;
|
|
18
|
-
/**
|
|
19
|
-
* Opens a modal using the specified component.
|
|
20
|
-
* @param component Determines the component to render.
|
|
21
|
-
* @param {SkyModalConfigurationInterface} config Specifies configuration options for the modal.
|
|
22
|
-
*/
|
|
23
|
-
open(component: any, config?: SkyModalConfigurationInterface | any[]): SkyModalInstance;
|
|
24
|
-
static ɵfac: i0.ɵɵFactoryDeclaration<SkyModalService, never>;
|
|
25
|
-
static ɵprov: i0.ɵɵInjectableDeclaration<SkyModalService>;
|
|
26
|
-
}
|
|
27
|
-
/**
|
|
28
|
-
* A service that launches modals.
|
|
29
|
-
* @internal
|
|
30
|
-
* @deprecated Use `SkyModalService` to open a standalone component instead.
|
|
31
|
-
*/
|
|
32
|
-
export declare class SkyModalLegacyService extends SkyModalService {
|
|
33
|
-
constructor(dynamicComponentSvc: SkyDynamicComponentLegacyService);
|
|
34
|
-
static ɵfac: i0.ɵɵFactoryDeclaration<SkyModalLegacyService, never>;
|
|
35
|
-
static ɵprov: i0.ɵɵInjectableDeclaration<SkyModalLegacyService>;
|
|
36
|
-
}
|
|
@@ -1,10 +0,0 @@
|
|
|
1
|
-
import * as i0 from "@angular/core";
|
|
2
|
-
import * as i1 from "@skyux/i18n";
|
|
3
|
-
/**
|
|
4
|
-
* Import into any component library module that needs to use resource strings.
|
|
5
|
-
*/
|
|
6
|
-
export declare class SkyModalsResourcesModule {
|
|
7
|
-
static ɵfac: i0.ɵɵFactoryDeclaration<SkyModalsResourcesModule, never>;
|
|
8
|
-
static ɵmod: i0.ɵɵNgModuleDeclaration<SkyModalsResourcesModule, never, never, [typeof i1.SkyI18nModule]>;
|
|
9
|
-
static ɵinj: i0.ɵɵInjectorDeclaration<SkyModalsResourcesModule>;
|
|
10
|
-
}
|
|
@@ -1,57 +0,0 @@
|
|
|
1
|
-
import { ComponentFixture } from '@angular/core/testing';
|
|
2
|
-
/**
|
|
3
|
-
* Allows interaction with a SKY UX modal component.
|
|
4
|
-
* @internal
|
|
5
|
-
*/
|
|
6
|
-
export declare class SkyModalFixture {
|
|
7
|
-
#private;
|
|
8
|
-
constructor(fixture: ComponentFixture<unknown>, skyTestId: string);
|
|
9
|
-
/**
|
|
10
|
-
* The modal component's ARIA describedby attribute.
|
|
11
|
-
*/
|
|
12
|
-
get ariaDescribedBy(): string | undefined;
|
|
13
|
-
/**
|
|
14
|
-
* The modal component's ARIA labelledby attribute.
|
|
15
|
-
*/
|
|
16
|
-
get ariaLabelledBy(): string | undefined;
|
|
17
|
-
/**
|
|
18
|
-
* The modal component's role attribute.
|
|
19
|
-
*/
|
|
20
|
-
get ariaRole(): string | undefined;
|
|
21
|
-
/**
|
|
22
|
-
* Whether or not the modal is a full page modal.
|
|
23
|
-
*/
|
|
24
|
-
get fullPage(): boolean;
|
|
25
|
-
/**
|
|
26
|
-
* The size of the modal.
|
|
27
|
-
*/
|
|
28
|
-
get size(): string | undefined;
|
|
29
|
-
/**
|
|
30
|
-
* Whether or not the modal is set up for tiled content.
|
|
31
|
-
*/
|
|
32
|
-
get tiledBody(): boolean;
|
|
33
|
-
/**
|
|
34
|
-
* Clicks the modal header's "close" button.
|
|
35
|
-
*/
|
|
36
|
-
clickHeaderCloseButton(): void;
|
|
37
|
-
/**
|
|
38
|
-
* Clicks the modal header's "help" button.
|
|
39
|
-
*/
|
|
40
|
-
clickHelpButton(): void;
|
|
41
|
-
/**
|
|
42
|
-
* Returns the main modal element.
|
|
43
|
-
*/
|
|
44
|
-
getModalDiv(): any;
|
|
45
|
-
/**
|
|
46
|
-
* Returns the modal's content element.
|
|
47
|
-
*/
|
|
48
|
-
getModalContentEl(): any;
|
|
49
|
-
/**
|
|
50
|
-
* Returns the modal's footer element.
|
|
51
|
-
*/
|
|
52
|
-
getModalFooterEl(): any;
|
|
53
|
-
/**
|
|
54
|
-
* Returns the modal's header element.
|
|
55
|
-
*/
|
|
56
|
-
getModalHeaderEl(): any;
|
|
57
|
-
}
|
|
@@ -1,14 +0,0 @@
|
|
|
1
|
-
import { BaseHarnessFilters } from '@angular/cdk/testing';
|
|
2
|
-
/**
|
|
3
|
-
* A set of criteria that can be used to filter a list of SkyConfirmButtonHarness instances.
|
|
4
|
-
*/
|
|
5
|
-
export interface SkyConfirmButtonHarnessFilters extends Omit<BaseHarnessFilters, 'selector'> {
|
|
6
|
-
/**
|
|
7
|
-
* Only find instances whose content matches the given value.
|
|
8
|
-
*/
|
|
9
|
-
text?: string | RegExp;
|
|
10
|
-
/**
|
|
11
|
-
* Only find instances whose style matches the given value.
|
|
12
|
-
*/
|
|
13
|
-
styleType?: string;
|
|
14
|
-
}
|
|
@@ -1,29 +0,0 @@
|
|
|
1
|
-
import { ComponentHarness, HarnessPredicate } from '@angular/cdk/testing';
|
|
2
|
-
import { SkyConfirmButtonStyleType } from '@skyux/modals';
|
|
3
|
-
import { SkyConfirmButtonHarnessFilters } from './confirm-button-harness-filters';
|
|
4
|
-
/**
|
|
5
|
-
* Harness for interacting with a confirm component in tests.
|
|
6
|
-
*/
|
|
7
|
-
export declare class SkyConfirmButtonHarness extends ComponentHarness {
|
|
8
|
-
/**
|
|
9
|
-
* @internal
|
|
10
|
-
*/
|
|
11
|
-
static hostSelector: string;
|
|
12
|
-
/**
|
|
13
|
-
* Gets a `HarnessPredicate` that can be used to search for a
|
|
14
|
-
* `SkyConfirmButtonHarness` that meets certain criteria.
|
|
15
|
-
*/
|
|
16
|
-
static with(filters: SkyConfirmButtonHarnessFilters): HarnessPredicate<SkyConfirmButtonHarness>;
|
|
17
|
-
/**
|
|
18
|
-
* Clicks the confirm button.
|
|
19
|
-
*/
|
|
20
|
-
click(): Promise<void>;
|
|
21
|
-
/**
|
|
22
|
-
* Gets the button style of the confirm button.
|
|
23
|
-
*/
|
|
24
|
-
getStyleType(): Promise<SkyConfirmButtonStyleType>;
|
|
25
|
-
/**
|
|
26
|
-
* Gets the text content of the confirm button.
|
|
27
|
-
*/
|
|
28
|
-
getText(): Promise<string>;
|
|
29
|
-
}
|
|
@@ -1,42 +0,0 @@
|
|
|
1
|
-
import { SkyComponentHarness } from '@skyux/core/testing';
|
|
2
|
-
import { SkyConfirmType } from '@skyux/modals';
|
|
3
|
-
import { SkyConfirmButtonHarness } from './confirm-button-harness';
|
|
4
|
-
import { SkyConfirmButtonHarnessFilters } from './confirm-button-harness-filters';
|
|
5
|
-
/**
|
|
6
|
-
* Harness for interacting with a confirm component in tests.
|
|
7
|
-
*/
|
|
8
|
-
export declare class SkyConfirmHarness extends SkyComponentHarness {
|
|
9
|
-
#private;
|
|
10
|
-
/**
|
|
11
|
-
* @internal
|
|
12
|
-
*/
|
|
13
|
-
static hostSelector: string;
|
|
14
|
-
/**
|
|
15
|
-
* Clicks a confirm button.
|
|
16
|
-
*/
|
|
17
|
-
clickCustomButton(filters: SkyConfirmButtonHarnessFilters): Promise<void>;
|
|
18
|
-
/**
|
|
19
|
-
* Clicks a confirm button.
|
|
20
|
-
*/
|
|
21
|
-
clickOkButton(): Promise<void>;
|
|
22
|
-
/**
|
|
23
|
-
* Gets the body of the confirm component.
|
|
24
|
-
*/
|
|
25
|
-
getBodyText(): Promise<string | undefined>;
|
|
26
|
-
/**
|
|
27
|
-
* Gets the confirm component's custom buttons.
|
|
28
|
-
*/
|
|
29
|
-
getCustomButtons(filters?: SkyConfirmButtonHarnessFilters): Promise<SkyConfirmButtonHarness[]>;
|
|
30
|
-
/**
|
|
31
|
-
* Gets the message of the confirm component.
|
|
32
|
-
*/
|
|
33
|
-
getMessageText(): Promise<string>;
|
|
34
|
-
/**
|
|
35
|
-
* Gets the type of the confirm component.
|
|
36
|
-
*/
|
|
37
|
-
getType(): Promise<SkyConfirmType>;
|
|
38
|
-
/**
|
|
39
|
-
* Whether the whitespace is preserved on the confirm component.
|
|
40
|
-
*/
|
|
41
|
-
isWhiteSpacePreserved(): Promise<boolean>;
|
|
42
|
-
}
|
|
@@ -1,28 +0,0 @@
|
|
|
1
|
-
import { SkyConfirmCloseEventArgs, SkyConfirmConfig } from '@skyux/modals';
|
|
2
|
-
/**
|
|
3
|
-
* A controller to be injected into tests, which mocks the confirm service
|
|
4
|
-
* and handles interactions with confirm dialogs.
|
|
5
|
-
*/
|
|
6
|
-
export declare abstract class SkyConfirmTestingController {
|
|
7
|
-
/**
|
|
8
|
-
* Closes the confirm dialog with the "cancel" action.
|
|
9
|
-
*/
|
|
10
|
-
abstract cancel(): void;
|
|
11
|
-
/**
|
|
12
|
-
* Throws if a confirm dialog is open.
|
|
13
|
-
*/
|
|
14
|
-
abstract expectNone(): void;
|
|
15
|
-
/**
|
|
16
|
-
* Throws if the open confirm dialog does not match the provided configuration.
|
|
17
|
-
* @param config
|
|
18
|
-
*/
|
|
19
|
-
abstract expectOpen(config: SkyConfirmConfig): void;
|
|
20
|
-
/**
|
|
21
|
-
* Closes the confirm dialog with the provided action.
|
|
22
|
-
*/
|
|
23
|
-
abstract close(args: SkyConfirmCloseEventArgs): void;
|
|
24
|
-
/**
|
|
25
|
-
* Closes the confirm dialog with the "ok" action.
|
|
26
|
-
*/
|
|
27
|
-
abstract ok(): void;
|
|
28
|
-
}
|
|
@@ -1,9 +0,0 @@
|
|
|
1
|
-
import * as i0 from "@angular/core";
|
|
2
|
-
/**
|
|
3
|
-
* Configures the `SkyConfirmTestingController` as the backend for the `SkyConfirmService`.
|
|
4
|
-
*/
|
|
5
|
-
export declare class SkyConfirmTestingModule {
|
|
6
|
-
static ɵfac: i0.ɵɵFactoryDeclaration<SkyConfirmTestingModule, never>;
|
|
7
|
-
static ɵmod: i0.ɵɵNgModuleDeclaration<SkyConfirmTestingModule, never, never, never>;
|
|
8
|
-
static ɵinj: i0.ɵɵInjectorDeclaration<SkyConfirmTestingModule>;
|
|
9
|
-
}
|
|
@@ -1,14 +0,0 @@
|
|
|
1
|
-
import { SkyConfirmCloseEventArgs, SkyConfirmConfig, SkyConfirmInstance, SkyConfirmServiceInterface } from '@skyux/modals';
|
|
2
|
-
import { SkyConfirmTestingController } from './confirm-testing.controller';
|
|
3
|
-
/**
|
|
4
|
-
* @internal
|
|
5
|
-
*/
|
|
6
|
-
export declare class SkyConfirmTestingService extends SkyConfirmTestingController implements SkyConfirmServiceInterface {
|
|
7
|
-
#private;
|
|
8
|
-
cancel(): void;
|
|
9
|
-
ok(): void;
|
|
10
|
-
close(args: SkyConfirmCloseEventArgs): void;
|
|
11
|
-
expectNone(): void;
|
|
12
|
-
expectOpen(expectedConfig: SkyConfirmConfig): void;
|
|
13
|
-
open(config: SkyConfirmConfig): SkyConfirmInstance;
|
|
14
|
-
}
|