@skyux/core 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 (35) hide show
  1. package/documentation.json +418 -677
  2. package/esm2020/lib/modules/adapter-service/adapter.service.mjs +4 -4
  3. package/esm2020/lib/modules/affix/affix-config.mjs +1 -1
  4. package/esm2020/lib/modules/affix/affixer.mjs +2 -2
  5. package/esm2020/lib/modules/dock/dock.service.mjs +2 -2
  6. package/esm2020/lib/modules/dynamic-component/dynamic-component-options.mjs +1 -1
  7. package/esm2020/lib/modules/dynamic-component/dynamic-component.service.mjs +47 -36
  8. package/esm2020/lib/modules/log/log.service.mjs +2 -2
  9. package/esm2020/lib/modules/log/types/log-deprecation-args.mjs +1 -1
  10. package/esm2020/lib/modules/media-query/media-breakpoints.mjs +5 -5
  11. package/esm2020/lib/modules/media-query/media-query-listener.mjs +1 -1
  12. package/esm2020/lib/modules/numeric/numeric.service.mjs +2 -2
  13. package/esm2020/lib/modules/overlay/overlay-config.mjs +1 -1
  14. package/esm2020/lib/modules/overlay/overlay-context.mjs +2 -2
  15. package/esm2020/lib/modules/trim/trim.directive.mjs +2 -2
  16. package/esm2020/lib/modules/viewkeeper/viewkeeper-options.mjs +1 -1
  17. package/esm2020/lib/modules/window/window-ref.mjs +2 -2
  18. package/fesm2015/skyux-core.mjs +60 -49
  19. package/fesm2015/skyux-core.mjs.map +1 -1
  20. package/fesm2020/skyux-core.mjs +60 -49
  21. package/fesm2020/skyux-core.mjs.map +1 -1
  22. package/lib/modules/adapter-service/adapter.service.d.ts +3 -3
  23. package/lib/modules/affix/affix-config.d.ts +5 -5
  24. package/lib/modules/dock/dock.service.d.ts +1 -1
  25. package/lib/modules/dynamic-component/dynamic-component-options.d.ts +5 -1
  26. package/lib/modules/dynamic-component/dynamic-component.service.d.ts +3 -2
  27. package/lib/modules/log/log.service.d.ts +1 -1
  28. package/lib/modules/log/types/log-deprecation-args.d.ts +1 -1
  29. package/lib/modules/media-query/media-breakpoints.d.ts +4 -4
  30. package/lib/modules/media-query/media-query-listener.d.ts +1 -1
  31. package/lib/modules/overlay/overlay-config.d.ts +6 -6
  32. package/lib/modules/overlay/overlay-context.d.ts +1 -1
  33. package/lib/modules/viewkeeper/viewkeeper-options.d.ts +3 -3
  34. package/lib/modules/window/window-ref.d.ts +1 -1
  35. package/package.json +2 -2
@@ -8,7 +8,7 @@ export declare class SkyCoreAdapterService {
8
8
  /**
9
9
  * Set the responsive container CSS class for a given element.
10
10
  *
11
- * @param elementRef - The element that will recieve the new CSS class.
11
+ * @param elementRef - The element that will receive the new CSS class.
12
12
  * @param breakpoint - The SkyMediaBreakpoint will determine which class
13
13
  * gets set. For example a SkyMediaBreakpoint of `xs` will set a CSS class of `sky-responsive-container-xs`.
14
14
  */
@@ -34,9 +34,9 @@ export declare class SkyCoreAdapterService {
34
34
  *
35
35
  * @param elementRef - The element to search within.
36
36
  * @param containerSelector - A CSS selector indicating the container that should
37
- * recieve focus if no focusable children are found.
37
+ * receive focus if no focusable children are found.
38
38
  * @param focusOnContainerIfNoChildrenFound - It set to `true`, the container will
39
- * recieve focus if no focusable children are found.
39
+ * receive focus if no focusable children are found.
40
40
  */
41
41
  getFocusableChildrenAndApplyFocus(elementRef: ElementRef, containerSelector?: string, focusOnContainerIfNoChildrenFound?: boolean): void;
42
42
  /**
@@ -5,7 +5,7 @@ import { SkyAffixPlacement } from './affix-placement';
5
5
  import { SkyAffixVerticalAlignment } from './affix-vertical-alignment';
6
6
  export interface SkyAffixConfig {
7
7
  /**
8
- * Indicates which parent element is used by the auto-fit functionality.
8
+ * Which parent element is used by the auto-fit functionality.
9
9
  */
10
10
  autoFitContext?: SkyAffixAutoFitContext;
11
11
  /**
@@ -17,9 +17,9 @@ export interface SkyAffixConfig {
17
17
  */
18
18
  autoFitOverflowOffset?: SkyAffixOffset;
19
19
  /**
20
- * Indicates if the affix service should try and find the best placement for the affixed element
21
- * if the element would be hidden otherwise. If this setting is disabled, the affix service will
22
- * force the placement of the affixed element.
20
+ * Whether the affix service tries to find the best placement for the affixed element
21
+ * if the element would be hidden otherwise. If this setting is disabled, the affix service
22
+ * forces the placement of the affixed element.
23
23
  */
24
24
  enableAutoFit?: boolean;
25
25
  /**
@@ -27,7 +27,7 @@ export interface SkyAffixConfig {
27
27
  */
28
28
  horizontalAlignment?: SkyAffixHorizontalAlignment;
29
29
  /**
30
- * Indicates if the affixed element should remain affixed to the base element when the window is scrolled or resized.
30
+ * Whether the affixed element remains affixed to the base element when the window is scrolled or resized.
31
31
  */
32
32
  isSticky?: boolean;
33
33
  /**
@@ -25,7 +25,7 @@ export declare class SkyDockService {
25
25
  /**
26
26
  * Sets options for the positioning and styling of the dock component. Since the dock service is a
27
27
  * singleton instance, these options will be applied to all components inserted into the dock. In
28
- * order to create a seperate dock with different options, consumers should provide a different
28
+ * order to create a separate dock with different options, consumers should provide a different
29
29
  * instance of the dock service.
30
30
  * @param options The options for positioning and styling
31
31
  */
@@ -1,4 +1,4 @@
1
- import { Injector, StaticProvider } from '@angular/core';
1
+ import { Injector, StaticProvider, ViewContainerRef } from '@angular/core';
2
2
  import { SkyDynamicComponentLocation } from './dynamic-component-location';
3
3
  /**
4
4
  * Options for adding a dynamic component to the page.
@@ -16,6 +16,10 @@ export interface SkyDynamicComponentOptions {
16
16
  * The reference element used when using the `ElementTop` or `ElementBottom` locations.
17
17
  */
18
18
  referenceEl?: HTMLElement;
19
+ /**
20
+ * The view container reference where the new component should be appended.
21
+ */
22
+ viewContainerRef?: ViewContainerRef;
19
23
  /**
20
24
  * Parent injector to use instead of the dynamic component service's injector
21
25
  */
@@ -1,13 +1,14 @@
1
- import { ApplicationRef, ComponentRef, Injector, RendererFactory2, Type } from '@angular/core';
1
+ import { ApplicationRef, ComponentRef, EnvironmentInjector, Injector, RendererFactory2, Type } from '@angular/core';
2
2
  import { SkyAppWindowRef } from '../window/window-ref';
3
3
  import { SkyDynamicComponentOptions } from './dynamic-component-options';
4
4
  import * as i0 from "@angular/core";
5
5
  /**
6
6
  * Angular service for creating and rendering a dynamic component.
7
+ * @internal
7
8
  */
8
9
  export declare class SkyDynamicComponentService {
9
10
  #private;
10
- constructor(applicationRef: ApplicationRef, injector: Injector, windowRef: SkyAppWindowRef, rendererFactory: RendererFactory2);
11
+ constructor(applicationRef: ApplicationRef, injector: Injector, windowRef: SkyAppWindowRef, rendererFactory: RendererFactory2, environmentInjector: EnvironmentInjector);
11
12
  /**
12
13
  * Creates an instance of the specified component and adds it to the specified location
13
14
  * on the page.
@@ -24,7 +24,7 @@ export declare class SkyLogService {
24
24
  error(message: string, params?: unknown[]): void;
25
25
  /**
26
26
  * Logs console information if the application's log level is `SkyLogLevel.Info` or above.
27
- * @param message The infomational message
27
+ * @param message The informational message
28
28
  * @param params Optional parameters for the informational message.
29
29
  */
30
30
  info(message: string, params?: unknown[]): void;
@@ -1,7 +1,7 @@
1
1
  import { SkyLogLevel } from './log-level';
2
2
  /**
3
3
  * @internal
4
- * Arguments used when logging that a class, property, function, etc. is depcrecated.
4
+ * Arguments used when logging that a class, property, function, etc. is deprecated.
5
5
  */
6
6
  export interface SkyLogDeprecatedArgs {
7
7
  /**
@@ -1,18 +1,18 @@
1
1
  export declare enum SkyMediaBreakpoints {
2
2
  /**
3
- * Indicates screen widths of 767px or less.
3
+ * Screen widths of 767px or less.
4
4
  */
5
5
  xs = 1,
6
6
  /**
7
- * Indicates screen widths of 768px to 991px.
7
+ * Screen widths of 768px to 991px.
8
8
  */
9
9
  sm = 2,
10
10
  /**
11
- * Indicates screen widths of 992px to 1199px.
11
+ * Screen widths of 992px to 1199px.
12
12
  */
13
13
  md = 3,
14
14
  /**
15
- * Indicates screen widths of 1200px or greater.
15
+ * Screen widths of 1200px or greater.
16
16
  */
17
17
  lg = 4
18
18
  }
@@ -1,6 +1,6 @@
1
1
  import { SkyMediaBreakpoints } from './media-breakpoints';
2
2
  /**
3
- * Specifies a function that is called when the breakpoints change. It is called
3
+ * The function that is called when the breakpoints change. It is called
4
4
  * with a `SkyMediaBreakpoints` argument, which is an enum that represents the new breakpoint.
5
5
  */
6
6
  export declare type SkyMediaQueryListener = (args: SkyMediaBreakpoints) => void;
@@ -1,26 +1,26 @@
1
1
  export interface SkyOverlayConfig {
2
2
  /**
3
- * Specifies if the overlay should be closed after a navigation change.
3
+ * Whether the overlay closes after a navigation change.
4
4
  */
5
5
  closeOnNavigation?: boolean;
6
6
  /**
7
- * Specifies if the overlay should be closed when a user clicks outside the overlay's content.
7
+ * Whether the overlay closes when a user clicks outside the overlay's content.
8
8
  */
9
9
  enableClose?: boolean;
10
10
  /**
11
- * Specifies if mouse interactions should be allowed below the backdrop.
11
+ * Whether mouse interactions are allowed below the backdrop.
12
12
  */
13
13
  enablePointerEvents?: boolean;
14
14
  /**
15
- * Specifies if window scrolling should be enabled when the overlay is opened.
15
+ * Whether window scrolling is enabled when the overlay is opened.
16
16
  */
17
17
  enableScroll?: boolean;
18
18
  /**
19
- * Specifies if the overlay's backdrop should be visible.
19
+ * Whether the overlay's backdrop is visible.
20
20
  */
21
21
  showBackdrop?: boolean;
22
22
  /**
23
- * Specifies extra CSS classes to be added to the overlay's wrapper element.
23
+ * Extra CSS classes to add to the overlay's wrapper element.
24
24
  */
25
25
  wrapperClass?: string;
26
26
  }
@@ -1,6 +1,6 @@
1
1
  import { SkyOverlayConfig } from './overlay-config';
2
2
  /**
3
- * Provides contextual information to each overlay created.
3
+ * Contextual information for each overlay.
4
4
  * @internal
5
5
  */
6
6
  export declare class SkyOverlayContext {
@@ -13,12 +13,12 @@ export interface SkyViewkeeperOptions {
13
13
  */
14
14
  el?: HTMLElement;
15
15
  /**
16
- * Specifies a scrollable parent which the viewkeeper resides in and should listen to and be
17
- * positioned within.
16
+ * The scrollable parent where the viewkeeper resides. It should listen to and be
17
+ * positioned within the parent.
18
18
  */
19
19
  scrollableHost?: HTMLElement;
20
20
  /**
21
- * Specifies whether to set the width of the viewkeeper element to the width of its
21
+ * Sets the width of the viewkeeper element to the width of its
22
22
  * host element. Otherwise, if the element does not have an explicit width specified,
23
23
  * the element would collapse horizontally as a result of fixing the element to the top
24
24
  * of the viewport.
@@ -10,7 +10,7 @@ export declare function getWindow(): any;
10
10
  */
11
11
  export declare class SkyAppWindowRef {
12
12
  /**
13
- * References the global `window` variable.
13
+ * The global `window` variable.
14
14
  */
15
15
  get nativeWindow(): any;
16
16
  static ɵfac: i0.ɵɵFactoryDeclaration<SkyAppWindowRef, never>;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@skyux/core",
3
- "version": "7.4.2",
3
+ "version": "7.6.0",
4
4
  "author": "Blackbaud, Inc.",
5
5
  "keywords": [
6
6
  "blackbaud",
@@ -45,7 +45,7 @@
45
45
  "@angular/core": "^14.2.11",
46
46
  "@angular/platform-browser": "^14.2.11",
47
47
  "@angular/router": "^14.2.11",
48
- "@skyux/i18n": "7.4.2"
48
+ "@skyux/i18n": "7.6.0"
49
49
  },
50
50
  "dependencies": {
51
51
  "tslib": "^2.3.1"