@skyux/modals 7.4.2 → 7.6.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.
Files changed (30) hide show
  1. package/documentation.json +273 -296
  2. package/esm2020/lib/modules/confirm/confirm-button-config.mjs +1 -1
  3. package/esm2020/lib/modules/confirm/confirm-config.mjs +1 -1
  4. package/esm2020/lib/modules/modal/modal-adapter.service.mjs +2 -2
  5. package/esm2020/lib/modules/modal/modal-close-args.mjs +1 -1
  6. package/esm2020/lib/modules/modal/modal-host.component.mjs +2 -2
  7. package/esm2020/lib/modules/modal/modal-scroll-shadow.directive.mjs +2 -2
  8. package/esm2020/lib/modules/modal/modal.component.mjs +7 -11
  9. package/esm2020/lib/modules/modal/modal.interface.mjs +1 -1
  10. package/esm2020/lib/modules/modal/modal.module.mjs +5 -2
  11. package/esm2020/lib/modules/modal/modal.service.mjs +2 -2
  12. package/esm2020/testing/confirm/confirm-harness.mjs +2 -2
  13. package/esm2020/testing/modal-fixture.mjs +6 -6
  14. package/fesm2015/skyux-modals-testing.mjs +6 -6
  15. package/fesm2015/skyux-modals-testing.mjs.map +1 -1
  16. package/fesm2015/skyux-modals.mjs +14 -15
  17. package/fesm2015/skyux-modals.mjs.map +1 -1
  18. package/fesm2020/skyux-modals-testing.mjs +6 -6
  19. package/fesm2020/skyux-modals-testing.mjs.map +1 -1
  20. package/fesm2020/skyux-modals.mjs +14 -15
  21. package/fesm2020/skyux-modals.mjs.map +1 -1
  22. package/lib/modules/confirm/confirm-button-config.d.ts +4 -4
  23. package/lib/modules/confirm/confirm-config.d.ts +5 -5
  24. package/lib/modules/modal/modal-adapter.service.d.ts +1 -1
  25. package/lib/modules/modal/modal-close-args.d.ts +1 -1
  26. package/lib/modules/modal/modal.component.d.ts +2 -4
  27. package/lib/modules/modal/modal.interface.d.ts +9 -8
  28. package/lib/modules/modal/modal.module.d.ts +4 -4
  29. package/package.json +5 -5
  30. package/testing/confirm/confirm-harness.d.ts +1 -1
@@ -26,16 +26,14 @@ export declare class SkyModalComponent implements AfterViewInit, OnDestroy {
26
26
  * @internal
27
27
  */
28
28
  set ariaDescribedBy(id: string | undefined);
29
- get ariaDescribedBy(): string;
29
+ get ariaDescribedBy(): string | undefined;
30
30
  /**
31
31
  * @internal
32
32
  */
33
33
  set ariaLabelledBy(id: string | undefined);
34
- get ariaLabelledBy(): string;
34
+ get ariaLabelledBy(): string | undefined;
35
35
  helpKey: string | undefined;
36
36
  modalState: string;
37
- modalContentId: string;
38
- modalHeaderId: string;
39
37
  modalZIndex: number | undefined;
40
38
  scrollShadow: SkyModalScrollShadowEventArgs | undefined;
41
39
  size: string;
@@ -4,12 +4,12 @@ import { StaticProvider } from '@angular/core';
4
4
  */
5
5
  export interface SkyModalConfigurationInterface {
6
6
  /**
7
- * Indicates whether to display the modal full screen.
7
+ * Whether to display the modal full screen.
8
8
  * This property defaults to `false`.
9
9
  */
10
10
  fullPage?: boolean;
11
11
  /**
12
- * Specifies a size for the modal. The valid options are `small`, `medium`, and `large`.
12
+ * The size for the modal. The valid options are `small`, `medium`, and `large`.
13
13
  * This property defaults to `medium`.
14
14
  */
15
15
  size?: string;
@@ -20,7 +20,7 @@ export interface SkyModalConfigurationInterface {
20
20
  */
21
21
  providers?: StaticProvider[];
22
22
  /**
23
- * Specifies the HTML element ID (without the leading `#`) of the element that describes
23
+ * The HTML element ID (without the leading `#`) of the element that describes
24
24
  * the modal. This sets the modal's `aria-describedby` attribute
25
25
  * [to support accessibility](https://developer.blackbaud.com/skyux/learn/accessibility).
26
26
  * The description typically includes text on the modal but not on items that users interact
@@ -29,7 +29,7 @@ export interface SkyModalConfigurationInterface {
29
29
  */
30
30
  ariaDescribedBy?: string;
31
31
  /**
32
- * Specifies the HTML element ID (without the leading `#`) of the element that labels
32
+ * The HTML element ID (without the leading `#`) of the element that labels
33
33
  * the modal. This sets the `aria-labelledby` attribute for the modal
34
34
  * [to support accessibility](https://developer.blackbaud.com/skyux/learn/accessibility).
35
35
  * This is typically a header element, and if you do not specify an ID, the default value
@@ -37,7 +37,7 @@ export interface SkyModalConfigurationInterface {
37
37
  */
38
38
  ariaLabelledBy?: string;
39
39
  /**
40
- * Specifies an ARIA role for the modal
40
+ * The ARIA role for the modal
41
41
  * [to support accessibility](https://developer.blackbaud.com/skyux/learn/accessibility)
42
42
  * by indicating how the modal functions and what it controls. For information about
43
43
  * how an ARIA role indicates what an item represents on a web page, see the
@@ -47,14 +47,15 @@ export interface SkyModalConfigurationInterface {
47
47
  */
48
48
  ariaRole?: string;
49
49
  /**
50
- * Indicates whether the modal uses tiles. When set to `true`, the modal's background switches
50
+ * Whether the modal uses tiles. When set to `true`, the modal's background switches
51
51
  * to `$sky-background-color-neutral-light` and tile headings are styled as subsection headings.
52
52
  * This property defaults to `false`.
53
+ * @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.
53
54
  */
54
55
  tiledBody?: boolean;
55
56
  /**
56
57
  * @deprecated To display a help button in the modal header, include a help button element, such as `sky-help-inline`, in the `sky-modal-header` element and a `sky-control-help` CSS class on that help button element
57
- * Specifies a `helpKey` string. This property displays
58
+ * The `helpKey` string. This property displays
58
59
  * the <i class="fa fa-question-circle" aria-hidden="true"></i> button in the modal header.
59
60
  * When users click this button, the `helpOpened` event broadcasts the `helpKey` parameter.
60
61
  * Blackbaud developers can use the Help Widget, which is for internal Blackbaud use only, to
@@ -62,7 +63,7 @@ export interface SkyModalConfigurationInterface {
62
63
  */
63
64
  helpKey?: string;
64
65
  /**
65
- * Specifies a CSS class to add to the modal, such as `ag-custom-component-popup` for
66
+ * The CSS class to add to the modal, such as `ag-custom-component-popup` for
66
67
  * using a modal as part of a cell editor in Data Entry Grid.
67
68
  */
68
69
  wrapperClass?: string;
@@ -8,11 +8,11 @@ import * as i6 from "./modal-scroll-shadow.directive";
8
8
  import * as i7 from "@angular/common";
9
9
  import * as i8 from "@angular/router";
10
10
  import * as i9 from "@skyux/indicators";
11
- import * as i10 from "../shared/sky-modals-resources.module";
12
- import * as i11 from "@skyux/theme";
13
- import * as i12 from "@skyux/core";
11
+ import * as i10 from "@skyux/core";
12
+ import * as i11 from "../shared/sky-modals-resources.module";
13
+ import * as i12 from "@skyux/theme";
14
14
  export declare class SkyModalModule {
15
15
  static ɵfac: i0.ɵɵFactoryDeclaration<SkyModalModule, never>;
16
- static ɵmod: i0.ɵɵNgModuleDeclaration<SkyModalModule, [typeof i1.SkyModalComponent, typeof i2.SkyModalContentComponent, typeof i3.SkyModalFooterComponent, typeof i4.SkyModalHeaderComponent, typeof i5.SkyModalHostComponent, typeof i6.SkyModalScrollShadowDirective], [typeof i7.CommonModule, typeof i8.RouterModule, typeof i9.SkyIconModule, typeof i10.SkyModalsResourcesModule, typeof i11.SkyThemeModule, typeof i12.SkyTrimModule], [typeof i1.SkyModalComponent, typeof i2.SkyModalContentComponent, typeof i3.SkyModalFooterComponent, typeof i4.SkyModalHeaderComponent]>;
16
+ static ɵmod: i0.ɵɵNgModuleDeclaration<SkyModalModule, [typeof i1.SkyModalComponent, typeof i2.SkyModalContentComponent, typeof i3.SkyModalFooterComponent, typeof i4.SkyModalHeaderComponent, typeof i5.SkyModalHostComponent, typeof i6.SkyModalScrollShadowDirective], [typeof i7.CommonModule, typeof i8.RouterModule, typeof i9.SkyIconModule, typeof i10.SkyIdModule, typeof i11.SkyModalsResourcesModule, typeof i12.SkyThemeModule, typeof i10.SkyTrimModule], [typeof i1.SkyModalComponent, typeof i2.SkyModalContentComponent, typeof i3.SkyModalFooterComponent, typeof i4.SkyModalHeaderComponent]>;
17
17
  static ɵinj: i0.ɵɵInjectorDeclaration<SkyModalModule>;
18
18
  }
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@skyux/modals",
3
- "version": "7.4.2",
3
+ "version": "7.6.0",
4
4
  "author": "Blackbaud, Inc.",
5
5
  "keywords": [
6
6
  "blackbaud",
@@ -44,10 +44,10 @@
44
44
  "@angular/common": "^14.2.11",
45
45
  "@angular/core": "^14.2.11",
46
46
  "@angular/router": "^14.2.11",
47
- "@skyux/core": "7.4.2",
48
- "@skyux/i18n": "7.4.2",
49
- "@skyux/indicators": "7.4.2",
50
- "@skyux/theme": "7.4.2"
47
+ "@skyux/core": "7.6.0",
48
+ "@skyux/i18n": "7.6.0",
49
+ "@skyux/indicators": "7.6.0",
50
+ "@skyux/theme": "7.6.0"
51
51
  },
52
52
  "dependencies": {
53
53
  "tslib": "^2.3.1"
@@ -33,7 +33,7 @@ export declare class SkyConfirmHarness extends SkyComponentHarness {
33
33
  */
34
34
  getType(): Promise<SkyConfirmType>;
35
35
  /**
36
- * Indicates if the whitespace is preserved on the confirom component.
36
+ * Whether the whitespace is preserved on the confirm component.
37
37
  */
38
38
  isWhiteSpacePreserved(): Promise<boolean>;
39
39
  }