@skyux/core 12.27.0 → 13.0.0-alpha.1

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 (140) hide show
  1. package/fesm2022/skyux-core-testing.mjs +26 -26
  2. package/fesm2022/skyux-core-testing.mjs.map +1 -1
  3. package/fesm2022/skyux-core.mjs +181 -181
  4. package/fesm2022/skyux-core.mjs.map +1 -1
  5. package/index.d.ts +1658 -96
  6. package/package.json +7 -7
  7. package/testing/index.d.ts +227 -3
  8. package/lib/modules/adapter-service/adapter.module.d.ts +0 -10
  9. package/lib/modules/adapter-service/adapter.service.d.ts +0 -76
  10. package/lib/modules/adapter-service/focusable-children-options.d.ts +0 -15
  11. package/lib/modules/affix/affix-auto-fit-context.d.ts +0 -10
  12. package/lib/modules/affix/affix-config.d.ts +0 -46
  13. package/lib/modules/affix/affix-horizontal-alignment.d.ts +0 -4
  14. package/lib/modules/affix/affix-offset-change.d.ts +0 -7
  15. package/lib/modules/affix/affix-offset.d.ts +0 -9
  16. package/lib/modules/affix/affix-placement-change.d.ts +0 -7
  17. package/lib/modules/affix/affix-placement.d.ts +0 -4
  18. package/lib/modules/affix/affix-position.d.ts +0 -1
  19. package/lib/modules/affix/affix-rect.d.ts +0 -11
  20. package/lib/modules/affix/affix-utils.d.ts +0 -3
  21. package/lib/modules/affix/affix-vertical-alignment.d.ts +0 -4
  22. package/lib/modules/affix/affix.directive.d.ts +0 -71
  23. package/lib/modules/affix/affix.module.d.ts +0 -8
  24. package/lib/modules/affix/affix.service.d.ts +0 -14
  25. package/lib/modules/affix/affixer.d.ts +0 -40
  26. package/lib/modules/affix/dom-utils.d.ts +0 -23
  27. package/lib/modules/breakpoint-observer/breakpoint-observer.d.ts +0 -9
  28. package/lib/modules/breakpoint-observer/breakpoint-observer.token.d.ts +0 -7
  29. package/lib/modules/breakpoint-observer/breakpoint-utils.d.ts +0 -17
  30. package/lib/modules/breakpoint-observer/breakpoint.d.ts +0 -9
  31. package/lib/modules/breakpoint-observer/container-breakpoint-observer.d.ts +0 -18
  32. package/lib/modules/breakpoint-observer/media-breakpoint-observer.d.ts +0 -18
  33. package/lib/modules/breakpoint-observer/provide-breakpoint-observer.d.ts +0 -7
  34. package/lib/modules/breakpoint-observer/responsive-host.directive.d.ts +0 -32
  35. package/lib/modules/content-info-provider/content-info-descriptor.d.ts +0 -16
  36. package/lib/modules/content-info-provider/content-info-provider.d.ts +0 -17
  37. package/lib/modules/content-info-provider/content-info.d.ts +0 -13
  38. package/lib/modules/default-input-provider/default-input-provider.d.ts +0 -10
  39. package/lib/modules/dock/dock-dom-adapter.service.d.ts +0 -17
  40. package/lib/modules/dock/dock-insert-component-config.d.ts +0 -8
  41. package/lib/modules/dock/dock-item-config.d.ts +0 -11
  42. package/lib/modules/dock/dock-item-reference.d.ts +0 -9
  43. package/lib/modules/dock/dock-item.d.ts +0 -22
  44. package/lib/modules/dock/dock-location.d.ts +0 -17
  45. package/lib/modules/dock/dock-options.d.ts +0 -18
  46. package/lib/modules/dock/dock.component.d.ts +0 -17
  47. package/lib/modules/dock/dock.module.d.ts +0 -10
  48. package/lib/modules/dock/dock.service.d.ts +0 -33
  49. package/lib/modules/dock/sort-by-stack-order.d.ts +0 -4
  50. package/lib/modules/dynamic-component/dynamic-component-location.d.ts +0 -25
  51. package/lib/modules/dynamic-component/dynamic-component-options.d.ts +0 -31
  52. package/lib/modules/dynamic-component/dynamic-component.module.d.ts +0 -11
  53. package/lib/modules/dynamic-component/dynamic-component.service.d.ts +0 -33
  54. package/lib/modules/file-reader/file-reader.service.d.ts +0 -10
  55. package/lib/modules/format/app-format.d.ts +0 -6
  56. package/lib/modules/help/help-global-options-token.d.ts +0 -6
  57. package/lib/modules/help/help-global-options.d.ts +0 -13
  58. package/lib/modules/help/help-open-args.d.ts +0 -9
  59. package/lib/modules/help/help-update-args.d.ts +0 -13
  60. package/lib/modules/help/help.service.d.ts +0 -25
  61. package/lib/modules/id/id.directive.d.ts +0 -15
  62. package/lib/modules/id/id.module.d.ts +0 -7
  63. package/lib/modules/id/id.service.d.ts +0 -9
  64. package/lib/modules/layout-host/layout-host-for-child-args.d.ts +0 -3
  65. package/lib/modules/layout-host/layout-host.directive.d.ts +0 -11
  66. package/lib/modules/layout-host/layout-host.service.d.ts +0 -13
  67. package/lib/modules/live-announcer/live-announcer.service.d.ts +0 -31
  68. package/lib/modules/live-announcer/types/live-announcer-args.d.ts +0 -12
  69. package/lib/modules/live-announcer/types/live-announcer-politeness.d.ts +0 -5
  70. package/lib/modules/log/log.module.d.ts +0 -10
  71. package/lib/modules/log/log.service.d.ts +0 -47
  72. package/lib/modules/log/types/log-deprecation-args.d.ts +0 -27
  73. package/lib/modules/log/types/log-level-token.d.ts +0 -6
  74. package/lib/modules/log/types/log-level.d.ts +0 -8
  75. package/lib/modules/media-query/media-breakpoints.d.ts +0 -22
  76. package/lib/modules/media-query/media-query-listener.d.ts +0 -7
  77. package/lib/modules/media-query/media-query.module.d.ts +0 -10
  78. package/lib/modules/media-query/media-query.service.d.ts +0 -55
  79. package/lib/modules/mutation/mutation-observer-service.d.ts +0 -9
  80. package/lib/modules/numeric/numeric-symbol.d.ts +0 -7
  81. package/lib/modules/numeric/numeric.module.d.ts +0 -8
  82. package/lib/modules/numeric/numeric.options.d.ts +0 -61
  83. package/lib/modules/numeric/numeric.pipe.d.ts +0 -22
  84. package/lib/modules/numeric/numeric.service.d.ts +0 -24
  85. package/lib/modules/overlay/overlay-adapter.service.d.ts +0 -15
  86. package/lib/modules/overlay/overlay-config.d.ts +0 -41
  87. package/lib/modules/overlay/overlay-context.d.ts +0 -9
  88. package/lib/modules/overlay/overlay-instance.d.ts +0 -42
  89. package/lib/modules/overlay/overlay-position.d.ts +0 -1
  90. package/lib/modules/overlay/overlay.component.d.ts +0 -30
  91. package/lib/modules/overlay/overlay.module.d.ts +0 -10
  92. package/lib/modules/overlay/overlay.service.d.ts +0 -39
  93. package/lib/modules/percent-pipe/percent-pipe.module.d.ts +0 -8
  94. package/lib/modules/percent-pipe/percent.pipe.d.ts +0 -12
  95. package/lib/modules/resize-observer/resize-observer-media-query.service.d.ts +0 -45
  96. package/lib/modules/resize-observer/resize-observer.service.d.ts +0 -17
  97. package/lib/modules/screen-reader-label/screen-reader-label.directive.d.ts +0 -20
  98. package/lib/modules/scroll-shadow/scroll-shadow-event-args.d.ts +0 -7
  99. package/lib/modules/scroll-shadow/scroll-shadow.directive.d.ts +0 -19
  100. package/lib/modules/scrollable-host/scrollable-host.service.d.ts +0 -32
  101. package/lib/modules/shared/number-format/number-format-utility.d.ts +0 -5
  102. package/lib/modules/shared/sky-core-resources.module.d.ts +0 -10
  103. package/lib/modules/stacking-context/stacking-context-token.d.ts +0 -6
  104. package/lib/modules/stacking-context/stacking-context.d.ts +0 -7
  105. package/lib/modules/title/set-title-args.d.ts +0 -3
  106. package/lib/modules/title/title.service.d.ts +0 -18
  107. package/lib/modules/trim/trim.directive.d.ts +0 -14
  108. package/lib/modules/trim/trim.module.d.ts +0 -7
  109. package/lib/modules/ui-config/ui-config.service.d.ts +0 -8
  110. package/lib/modules/viewkeeper/viewkeeper-boundary-info.d.ts +0 -11
  111. package/lib/modules/viewkeeper/viewkeeper-fixed-styles.d.ts +0 -10
  112. package/lib/modules/viewkeeper/viewkeeper-host-options.d.ts +0 -14
  113. package/lib/modules/viewkeeper/viewkeeper-offset.d.ts +0 -4
  114. package/lib/modules/viewkeeper/viewkeeper-options.d.ts +0 -45
  115. package/lib/modules/viewkeeper/viewkeeper.d.ts +0 -7
  116. package/lib/modules/viewkeeper/viewkeeper.directive.d.ts +0 -17
  117. package/lib/modules/viewkeeper/viewkeeper.module.d.ts +0 -7
  118. package/lib/modules/viewkeeper/viewkeeper.service.d.ts +0 -23
  119. package/lib/modules/window/window-ref.d.ts +0 -18
  120. package/testing/legacy/core-testing.module.d.ts +0 -9
  121. package/testing/legacy/mock-media-query.service.d.ts +0 -23
  122. package/testing/legacy/mock-ui-config.service.d.ts +0 -11
  123. package/testing/legacy/resize-observer-mock.d.ts +0 -15
  124. package/testing/modules/file-reader/file-reader-testing.service.d.ts +0 -10
  125. package/testing/modules/file-reader/provide-file-reader-testing.d.ts +0 -12
  126. package/testing/modules/help/help-testing-controller.d.ts +0 -15
  127. package/testing/modules/help/help-testing.module.d.ts +0 -9
  128. package/testing/modules/help/help-testing.service.d.ts +0 -16
  129. package/testing/modules/media-query/breakpoint-observer-testing.d.ts +0 -15
  130. package/testing/modules/media-query/media-query-testing-controller.d.ts +0 -15
  131. package/testing/modules/media-query/provide-media-query-testing.d.ts +0 -5
  132. package/testing/modules/overlay/overlay-harness-filters.d.ts +0 -7
  133. package/testing/modules/overlay/overlay-harness.d.ts +0 -18
  134. package/testing/public-api.d.ts +0 -16
  135. package/testing/shared/component-harness.d.ts +0 -9
  136. package/testing/shared/harness-filters.d.ts +0 -10
  137. package/testing/shared/harness-utility.d.ts +0 -4
  138. package/testing/shared/input-harness.d.ts +0 -35
  139. package/testing/shared/queryable-component-harness.d.ts +0 -31
  140. package/version.d.ts +0 -15
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@skyux/core",
3
- "version": "12.27.0",
3
+ "version": "13.0.0-alpha.1",
4
4
  "author": "Blackbaud, Inc.",
5
5
  "keywords": [
6
6
  "blackbaud",
@@ -16,12 +16,12 @@
16
16
  },
17
17
  "homepage": "https://github.com/blackbaud/skyux#readme",
18
18
  "peerDependencies": {
19
- "@angular/cdk": "^19.2.19",
20
- "@angular/common": "^19.2.14",
21
- "@angular/core": "^19.2.14",
22
- "@angular/platform-browser": "^19.2.14",
23
- "@angular/router": "^19.2.14",
24
- "@skyux/i18n": "12.27.0"
19
+ "@angular/cdk": "^20.0.4",
20
+ "@angular/common": "^20.0.5",
21
+ "@angular/core": "^20.0.5",
22
+ "@angular/platform-browser": "^20.0.5",
23
+ "@angular/router": "^20.0.5",
24
+ "@skyux/i18n": "13.0.0-alpha.1"
25
25
  },
26
26
  "dependencies": {
27
27
  "tslib": "^2.8.1"
@@ -1,5 +1,229 @@
1
+ import * as i0 from '@angular/core';
2
+ import { Provider } from '@angular/core';
3
+ import { SkyMediaQueryService, SkyMediaBreakpoints, SkyMediaQueryListener, SkyUIConfigService, SkyBreakpoint } from '@skyux/core';
4
+ import { BehaviorSubject, Subscription, Observable } from 'rxjs';
5
+ import { BaseHarnessFilters, ComponentHarness, ComponentHarnessConstructor, HarnessPredicate, HarnessQuery, TestElement } from '@angular/cdk/testing';
6
+
1
7
  /**
2
- * Generated bundle index. Do not edit.
8
+ * @internal
3
9
  */
4
- /// <amd-module name="@skyux/core/testing" />
5
- export * from './public-api';
10
+ declare class SkyCoreTestingModule {
11
+ static ɵfac: i0.ɵɵFactoryDeclaration<SkyCoreTestingModule, never>;
12
+ static ɵmod: i0.ɵɵNgModuleDeclaration<SkyCoreTestingModule, never, never, never>;
13
+ static ɵinj: i0.ɵɵInjectorDeclaration<SkyCoreTestingModule>;
14
+ }
15
+
16
+ /**
17
+ * @internal
18
+ * @deprecated Use `provideSkyMediaQueryTesting()` coupled with `SkyMediaQueryTestingController`.
19
+ */
20
+ declare class MockSkyMediaQueryService extends SkyMediaQueryService {
21
+ static xs: string;
22
+ static sm: string;
23
+ static md: string;
24
+ static lg: string;
25
+ get current(): SkyMediaBreakpoints;
26
+ set current(breakpoints: SkyMediaBreakpoints);
27
+ currentMockSubject: BehaviorSubject<SkyMediaBreakpoints>;
28
+ protected currentBreakpoints: SkyMediaBreakpoints;
29
+ constructor();
30
+ subscribe(listener: SkyMediaQueryListener): Subscription;
31
+ fire(args: SkyMediaBreakpoints): void;
32
+ destroy(): void;
33
+ static ɵfac: i0.ɵɵFactoryDeclaration<MockSkyMediaQueryService, never>;
34
+ static ɵprov: i0.ɵɵInjectableDeclaration<MockSkyMediaQueryService>;
35
+ }
36
+
37
+ /**
38
+ * @internal
39
+ */
40
+ declare class MockSkyUIConfigService extends SkyUIConfigService {
41
+ getConfig(key: string, defaultConfig?: any): Observable<any>;
42
+ static ɵfac: i0.ɵɵFactoryDeclaration<MockSkyUIConfigService, never>;
43
+ static ɵprov: i0.ɵɵInjectableDeclaration<MockSkyUIConfigService>;
44
+ }
45
+
46
+ /**
47
+ * @internal
48
+ */
49
+ declare const mockResizeObserverEntry: ResizeObserverEntry;
50
+ /**
51
+ * @internal
52
+ */
53
+ declare const mockResizeObserverHandle: {
54
+ callback: ResizeObserverCallback;
55
+ emit: (entries: ResizeObserverEntry[], observer?: ResizeObserver) => void;
56
+ };
57
+ /**
58
+ * @internal
59
+ */
60
+ declare function mockResizeObserver(): void;
61
+
62
+ /**
63
+ * Provides mocks for file reader testing.
64
+ * @internal
65
+ * @example
66
+ * ```typescript
67
+ * TestBed.configureTestingModule({
68
+ * providers: [provideSkyFileReaderTesting()]
69
+ * });
70
+ * ```
71
+ */
72
+ declare function provideSkyFileReaderTesting(): Provider[];
73
+
74
+ /**
75
+ * Provides methods for validating global help in unit tests.
76
+ */
77
+ declare class SkyHelpTestingController {
78
+ #private;
79
+ /**
80
+ * Validates the current help key and throws an error if the current help key does not match the expected help key.
81
+ * @param expectedHelpKey The expected help key.
82
+ */
83
+ expectCurrentHelpKey(expectedHelpKey: string | undefined): void;
84
+ /**
85
+ * Close the current help.
86
+ */
87
+ closeHelp(): void;
88
+ }
89
+
90
+ /**
91
+ * Mocks SkyHelpService to enable testing of global help.
92
+ */
93
+ declare class SkyHelpTestingModule {
94
+ static ɵfac: i0.ɵɵFactoryDeclaration<SkyHelpTestingModule, never>;
95
+ static ɵmod: i0.ɵɵNgModuleDeclaration<SkyHelpTestingModule, never, never, never>;
96
+ static ɵinj: i0.ɵɵInjectorDeclaration<SkyHelpTestingModule>;
97
+ }
98
+
99
+ /**
100
+ * A controller to be injected into tests, which mocks the
101
+ * `SkyMediaQueryService` and handles interactions with breakpoints.
102
+ */
103
+ declare class SkyMediaQueryTestingController {
104
+ #private;
105
+ /**
106
+ * Emits the provided breakpoint to all subscribers.
107
+ */
108
+ setBreakpoint(breakpoint: SkyBreakpoint): void;
109
+ static ɵfac: i0.ɵɵFactoryDeclaration<SkyMediaQueryTestingController, never>;
110
+ static ɵprov: i0.ɵɵInjectableDeclaration<SkyMediaQueryTestingController>;
111
+ }
112
+
113
+ /**
114
+ * Adds mocks to allow interactions with breakpoints in tests.
115
+ */
116
+ declare function provideSkyMediaQueryTesting(): Provider[];
117
+
118
+ /**
119
+ * A set of criteria that can be used to filter a list of `SkyComponentHarness` instances.
120
+ */
121
+ interface SkyHarnessFilters extends BaseHarnessFilters {
122
+ /**
123
+ * Only find instances whose `data-sky-id` attribute matches the given value.
124
+ */
125
+ dataSkyId?: string | RegExp;
126
+ }
127
+
128
+ /**
129
+ * @internal
130
+ */
131
+ declare abstract class SkyComponentHarness extends ComponentHarness {
132
+ #private;
133
+ protected static getDataSkyIdPredicate<T extends SkyComponentHarness>(this: ComponentHarnessConstructor<T>, filters: SkyHarnessFilters): HarnessPredicate<T>;
134
+ }
135
+
136
+ /**
137
+ * @internal
138
+ */
139
+ declare abstract class SkyQueryableComponentHarness extends SkyComponentHarness {
140
+ /**
141
+ * Returns a child harness or throws an error if not found.
142
+ */
143
+ queryHarness<T extends ComponentHarness>(query: HarnessQuery<T>): Promise<T>;
144
+ /**
145
+ * Returns a child harness or null if not found.
146
+ */
147
+ queryHarnessOrNull<T extends ComponentHarness>(query: HarnessQuery<T>): Promise<T | null>;
148
+ /**
149
+ * Returns child harnesses.
150
+ */
151
+ queryHarnesses<T extends ComponentHarness>(harness: HarnessQuery<T>): Promise<T[]>;
152
+ /**
153
+ * Returns a child test element or throws an error if not found.
154
+ */
155
+ querySelector(selector: string): Promise<TestElement>;
156
+ /**
157
+ * Returns a child test element or null if not found.
158
+ */
159
+ querySelectorOrNull(selector: string): Promise<TestElement | null>;
160
+ /**
161
+ * Returns child test elements.
162
+ */
163
+ querySelectorAll(selector: string): Promise<TestElement[]>;
164
+ }
165
+
166
+ /**
167
+ * A set of criteria that can be used to filter a list of SkyOverlayHarness instances.
168
+ * @internal
169
+ */
170
+ interface SkyOverlayHarnessFilters extends BaseHarnessFilters {
171
+ }
172
+
173
+ /**
174
+ * Harness for interacting with an overlay component in tests.
175
+ * @internal
176
+ */
177
+ declare class SkyOverlayHarness extends SkyQueryableComponentHarness {
178
+ /**
179
+ * @internal
180
+ */
181
+ static hostSelector: string;
182
+ /**
183
+ * Gets a `HarnessPredicate` that can be used to search for a
184
+ * `SkyOverlayHarness` that meets certain criteria.
185
+ */
186
+ static with(filters: SkyOverlayHarnessFilters): HarnessPredicate<SkyOverlayHarness>;
187
+ }
188
+
189
+ declare class SkyHarnessUtility {
190
+ static getBackgroundImageUrl(el: TestElement): Promise<string | undefined>;
191
+ }
192
+
193
+ /**
194
+ * Harness used to interact with native input elements in tests.
195
+ */
196
+ declare class SkyInputHarness extends ComponentHarness {
197
+ /**
198
+ * Blurs the input.
199
+ */
200
+ blur(): Promise<void>;
201
+ /**
202
+ * Clears the input value.
203
+ */
204
+ clear(): Promise<void>;
205
+ /**
206
+ * Focuses the input.
207
+ */
208
+ focus(): Promise<void>;
209
+ /**
210
+ * Gets the value of the input.
211
+ */
212
+ getValue(): Promise<string>;
213
+ /**
214
+ * Whether the input is disabled.
215
+ */
216
+ isDisabled(): Promise<boolean>;
217
+ /**
218
+ * Whether the input is focused.
219
+ */
220
+ isFocused(): Promise<boolean>;
221
+ /**
222
+ * Sets the value of the input. The value will be set by simulating key
223
+ * presses that correspond to the given value.
224
+ */
225
+ setValue(value: string): Promise<void>;
226
+ }
227
+
228
+ export { MockSkyMediaQueryService, MockSkyUIConfigService, SkyComponentHarness, SkyCoreTestingModule, SkyHarnessUtility, SkyHelpTestingController, SkyHelpTestingModule, SkyInputHarness, SkyMediaQueryTestingController, SkyOverlayHarness, SkyQueryableComponentHarness, mockResizeObserver, mockResizeObserverEntry, mockResizeObserverHandle, provideSkyFileReaderTesting, provideSkyMediaQueryTesting };
229
+ export type { SkyHarnessFilters, SkyOverlayHarnessFilters };
@@ -1,10 +0,0 @@
1
- import * as i0 from "@angular/core";
2
- /**
3
- * @deprecated The `SkyCoreAdapterService` no longer needs the `SkyCoreAdapterModule`.
4
- * The `SkyCoreAdapterModule` can be removed from your project.
5
- */
6
- export declare class SkyCoreAdapterModule {
7
- static ɵfac: i0.ɵɵFactoryDeclaration<SkyCoreAdapterModule, never>;
8
- static ɵmod: i0.ɵɵNgModuleDeclaration<SkyCoreAdapterModule, never, never, never>;
9
- static ɵinj: i0.ɵɵInjectorDeclaration<SkyCoreAdapterModule>;
10
- }
@@ -1,76 +0,0 @@
1
- import { ElementRef, RendererFactory2 } from '@angular/core';
2
- import { SkyBreakpoint } from '../breakpoint-observer/breakpoint';
3
- import { SkyMediaBreakpoints } from '../media-query/media-breakpoints';
4
- import { SkyFocusableChildrenOptions } from './focusable-children-options';
5
- import * as i0 from "@angular/core";
6
- export declare class SkyCoreAdapterService {
7
- #private;
8
- constructor(rendererFactory: RendererFactory2);
9
- /**
10
- * Set the responsive container CSS class for a given element.
11
- *
12
- * @param elementRef - The element that will receive the new CSS class.
13
- * @param breakpoint - The breakpoint to determine which class gets set.
14
- * For example a breakpoint of "xs" will set a CSS class of "sky-responsive-container-xs".
15
- * @deprecated Use the `SkyResponsiveHostDirective` instead.
16
- */
17
- setResponsiveContainerClass(elementRef: ElementRef, breakpoint: SkyBreakpoint | SkyMediaBreakpoints): void;
18
- /**
19
- * This method temporarily enables/disables pointer events.
20
- * This is helpful to prevent iFrames from interfering with drag events.
21
- *
22
- * @param enable - Set to `true` to enable pointer events. Set to `false` to disable.
23
- */
24
- toggleIframePointerEvents(enable: boolean): void;
25
- /**
26
- * Focuses on the first element found with an `autofocus` attribute inside the supplied `elementRef`.
27
- *
28
- * @param elementRef - The element to search within.
29
- * @return Returns `true` if a child element with autofocus is found.
30
- */
31
- applyAutoFocus(elementRef?: ElementRef): boolean;
32
- /**
33
- * Sets focus on the first focusable child of the `elementRef` parameter.
34
- * If no focusable children are found, and `focusOnContainerIfNoChildrenFound` is `true`,
35
- * focus will be set on the container element.
36
- *
37
- * @param elementRef - The element to search within.
38
- * @param containerSelector - A CSS selector indicating the container that should
39
- * receive focus if no focusable children are found.
40
- * @param focusOnContainerIfNoChildrenFound - It set to `true`, the container will
41
- * receive focus if no focusable children are found.
42
- */
43
- getFocusableChildrenAndApplyFocus(elementRef: ElementRef, containerSelector?: string, focusOnContainerIfNoChildrenFound?: boolean): void;
44
- /**
45
- * Returns an array of all focusable children of provided `element`.
46
- *
47
- * @param element - The HTMLElement to search within.
48
- * @param options - Options for getting focusable children.
49
- */
50
- getFocusableChildren(element?: HTMLElement, options?: SkyFocusableChildrenOptions): HTMLElement[];
51
- /**
52
- * Returns the clientWidth of the provided elementRef.
53
- * @param elementRef - The element to calculate width from.
54
- */
55
- getWidth(elementRef: ElementRef): number;
56
- /**
57
- * Checks if an event target has a higher z-index than a given element.
58
- * @param target The event target element.
59
- * @param element The element to test against. A z-index must be explicitly set for this element.
60
- */
61
- isTargetAboveElement(target: EventTarget, element: HTMLElement): boolean;
62
- /**
63
- * Remove inline height styles from the provided elements.
64
- * @param elementRef - The element to search within.
65
- * @param selector - The CSS selector to use when finding elements for removing height.
66
- */
67
- resetHeight(elementRef: ElementRef, selector: string): void;
68
- /**
69
- * Sets all element heights to match the height of the tallest element.
70
- * @param elementRef - The element to search within.
71
- * @param selector - The CSS selector to use when finding elements for syncing height.
72
- */
73
- syncMaxHeight(elementRef: ElementRef, selector: string): void;
74
- static ɵfac: i0.ɵɵFactoryDeclaration<SkyCoreAdapterService, never>;
75
- static ɵprov: i0.ɵɵInjectableDeclaration<SkyCoreAdapterService>;
76
- }
@@ -1,15 +0,0 @@
1
- /**
2
- * Options for getting focusable children.
3
- */
4
- export interface SkyFocusableChildrenOptions {
5
- /**
6
- * By default, the `getFocusableChildren()` function will filter out elements with
7
- * a `tabIndex` of `-1`. Setting `ignoreTabIndex = true` will ignore this filter.
8
- */
9
- ignoreTabIndex?: boolean;
10
- /**
11
- * By default, the `getFocusableChildren()` function will only return visible elements.
12
- * Setting `ignoreVisibility = true` will ignore this filter.
13
- */
14
- ignoreVisibility?: boolean;
15
- }
@@ -1,10 +0,0 @@
1
- export declare enum SkyAffixAutoFitContext {
2
- /**
3
- * Auto-fit functionality will respect the nearest overflow parent element's dimensions.
4
- */
5
- OverflowParent = 0,
6
- /**
7
- * Auto-fit functionality will respect the browser viewport dimensions.
8
- */
9
- Viewport = 1
10
- }
@@ -1,46 +0,0 @@
1
- import { SkyAffixAutoFitContext } from './affix-auto-fit-context';
2
- import { SkyAffixHorizontalAlignment } from './affix-horizontal-alignment';
3
- import { SkyAffixOffset } from './affix-offset';
4
- import { SkyAffixPlacement } from './affix-placement';
5
- import { SkyAffixPosition } from './affix-position';
6
- import { SkyAffixVerticalAlignment } from './affix-vertical-alignment';
7
- export interface SkyAffixConfig {
8
- /**
9
- * Which parent element is used by the auto-fit functionality.
10
- */
11
- autoFitContext?: SkyAffixAutoFitContext;
12
- /**
13
- * This optional offset is added to (or subtracted from) the [[SkyAffixAutoFitContext]] element's
14
- * offset during an auto-fit placement calculation. This value is useful if you need to consider
15
- * another `position: fixed` element on the page (such as a navbar) when the auto-fit
16
- * functionality attempts to find the best possible placement.
17
- * (In the case of a navbar, you would add a `top` value equal to the navbar's height in pixels.)
18
- */
19
- autoFitOverflowOffset?: SkyAffixOffset;
20
- /**
21
- * Whether the affix service tries to find the best placement for the affixed element
22
- * if the element would be hidden otherwise. If this setting is disabled, the affix service
23
- * forces the placement of the affixed element.
24
- */
25
- enableAutoFit?: boolean;
26
- /**
27
- * The horizontal alignment of the affixed element to the base element.
28
- */
29
- horizontalAlignment?: SkyAffixHorizontalAlignment;
30
- /**
31
- * Whether the affixed element remains affixed to the base element when the window is scrolled or resized.
32
- */
33
- isSticky?: boolean;
34
- /**
35
- * The placement of the affixed element around the base element.
36
- */
37
- placement?: SkyAffixPlacement;
38
- /**
39
- * The vertical alignment of the affixed element to the base element.
40
- */
41
- verticalAlignment?: SkyAffixVerticalAlignment;
42
- /**
43
- * The position of the element being affixed.
44
- */
45
- position?: SkyAffixPosition;
46
- }
@@ -1,4 +0,0 @@
1
- /**
2
- * The horizontal alignment of the affixed element to the base element.
3
- */
4
- export type SkyAffixHorizontalAlignment = 'left' | 'center' | 'right';
@@ -1,7 +0,0 @@
1
- import { SkyAffixOffset } from './affix-offset';
2
- /**
3
- * The arguments supplied to the affix offset change event listener.
4
- */
5
- export interface SkyAffixOffsetChange {
6
- offset?: SkyAffixOffset;
7
- }
@@ -1,9 +0,0 @@
1
- /**
2
- * Offset values used by the affixer.
3
- */
4
- export interface SkyAffixOffset {
5
- bottom?: number;
6
- left?: number;
7
- right?: number;
8
- top?: number;
9
- }
@@ -1,7 +0,0 @@
1
- import { SkyAffixPlacement } from './affix-placement';
2
- export interface SkyAffixPlacementChange {
3
- /**
4
- * The changed placement value.
5
- */
6
- placement: SkyAffixPlacement | null;
7
- }
@@ -1,4 +0,0 @@
1
- /**
2
- * The placement of the affixed element around the base element.
3
- */
4
- export type SkyAffixPlacement = 'above' | 'below' | 'left' | 'right';
@@ -1 +0,0 @@
1
- export type SkyAffixPosition = 'absolute' | 'fixed';
@@ -1,11 +0,0 @@
1
- /**
2
- * @internal
3
- */
4
- export interface AffixRect {
5
- bottom: number;
6
- top: number;
7
- left: number;
8
- right: number;
9
- width: number;
10
- height: number;
11
- }
@@ -1,3 +0,0 @@
1
- import { SkyAffixPlacement } from './affix-placement';
2
- export declare function getNextPlacement(placement: SkyAffixPlacement): SkyAffixPlacement;
3
- export declare function getInversePlacement(placement: SkyAffixPlacement): SkyAffixPlacement;
@@ -1,4 +0,0 @@
1
- /**
2
- * The vertical alignment of the affixed element to the base element.
3
- */
4
- export type SkyAffixVerticalAlignment = 'top' | 'middle' | 'bottom';
@@ -1,71 +0,0 @@
1
- import { ElementRef, EventEmitter, OnChanges, OnDestroy, OnInit, SimpleChanges } from '@angular/core';
2
- import { SkyAffixAutoFitContext } from './affix-auto-fit-context';
3
- import { SkyAffixHorizontalAlignment } from './affix-horizontal-alignment';
4
- import { SkyAffixOffset } from './affix-offset';
5
- import { SkyAffixOffsetChange } from './affix-offset-change';
6
- import { SkyAffixPlacement } from './affix-placement';
7
- import { SkyAffixPlacementChange } from './affix-placement-change';
8
- import { SkyAffixPosition } from './affix-position';
9
- import { SkyAffixVerticalAlignment } from './affix-vertical-alignment';
10
- import { SkyAffixService } from './affix.service';
11
- import * as i0 from "@angular/core";
12
- /**
13
- * Affixes the host element to a base element.
14
- */
15
- export declare class SkyAffixDirective implements OnInit, OnChanges, OnDestroy {
16
- #private;
17
- /**
18
- * The base element to affix the host element.
19
- */
20
- skyAffixTo: HTMLElement | undefined;
21
- /**
22
- * Sets the `autoFitContext` property of [[SkyAffixConfig]].
23
- */
24
- affixAutoFitContext: SkyAffixAutoFitContext | undefined;
25
- /**
26
- * Sets the `autoFitOverflowOffset` property of [[SkyAffixConfig]].
27
- */
28
- affixAutoFitOverflowOffset: SkyAffixOffset | undefined;
29
- /**
30
- * Sets the `enableAutoFit` property of [[SkyAffixConfig]].
31
- */
32
- affixEnableAutoFit: boolean | undefined;
33
- /**
34
- * Sets the `horizontalAlignment` property of [[SkyAffixConfig]].
35
- */
36
- affixHorizontalAlignment: SkyAffixHorizontalAlignment | undefined;
37
- /**
38
- * Sets the `isSticky` property of [[SkyAffixConfig]].
39
- */
40
- affixIsSticky: boolean | undefined;
41
- /**
42
- * Sets the `placement` property of [[SkyAffixConfig]].
43
- */
44
- affixPlacement: SkyAffixPlacement | undefined;
45
- /**
46
- * Sets the `position` property of [[SkyAffixConfig]].
47
- */
48
- affixPosition: SkyAffixPosition | undefined;
49
- /**
50
- * Sets the `verticalAlignment` property of [[SkyAffixConfig]].
51
- */
52
- affixVerticalAlignment: SkyAffixVerticalAlignment | undefined;
53
- /**
54
- * Fires when the affixed element's offset changes.
55
- */
56
- affixOffsetChange: EventEmitter<SkyAffixOffsetChange>;
57
- /**
58
- * Fires when the affixed element's overflow container is scrolled.
59
- */
60
- affixOverflowScroll: EventEmitter<void>;
61
- /**
62
- * Fires when the placement value changes.
63
- */
64
- affixPlacementChange: EventEmitter<SkyAffixPlacementChange>;
65
- constructor(elementRef: ElementRef, affixService: SkyAffixService);
66
- ngOnInit(): void;
67
- ngOnChanges(changes: SimpleChanges): void;
68
- ngOnDestroy(): void;
69
- static ɵfac: i0.ɵɵFactoryDeclaration<SkyAffixDirective, never>;
70
- static ɵdir: i0.ɵɵDirectiveDeclaration<SkyAffixDirective, "[skyAffixTo]", never, { "skyAffixTo": { "alias": "skyAffixTo"; "required": false; }; "affixAutoFitContext": { "alias": "affixAutoFitContext"; "required": false; }; "affixAutoFitOverflowOffset": { "alias": "affixAutoFitOverflowOffset"; "required": false; }; "affixEnableAutoFit": { "alias": "affixEnableAutoFit"; "required": false; }; "affixHorizontalAlignment": { "alias": "affixHorizontalAlignment"; "required": false; }; "affixIsSticky": { "alias": "affixIsSticky"; "required": false; }; "affixPlacement": { "alias": "affixPlacement"; "required": false; }; "affixPosition": { "alias": "affixPosition"; "required": false; }; "affixVerticalAlignment": { "alias": "affixVerticalAlignment"; "required": false; }; }, { "affixOffsetChange": "affixOffsetChange"; "affixOverflowScroll": "affixOverflowScroll"; "affixPlacementChange": "affixPlacementChange"; }, never, never, false, never>;
71
- }
@@ -1,8 +0,0 @@
1
- import * as i0 from "@angular/core";
2
- import * as i1 from "./affix.directive";
3
- import * as i2 from "@angular/common";
4
- export declare class SkyAffixModule {
5
- static ɵfac: i0.ɵɵFactoryDeclaration<SkyAffixModule, never>;
6
- static ɵmod: i0.ɵɵNgModuleDeclaration<SkyAffixModule, [typeof i1.SkyAffixDirective], [typeof i2.CommonModule], [typeof i1.SkyAffixDirective]>;
7
- static ɵinj: i0.ɵɵInjectorDeclaration<SkyAffixModule>;
8
- }
@@ -1,14 +0,0 @@
1
- import { ElementRef, OnDestroy } from '@angular/core';
2
- import { SkyAffixer } from './affixer';
3
- import * as i0 from "@angular/core";
4
- export declare class SkyAffixService implements OnDestroy {
5
- #private;
6
- ngOnDestroy(): void;
7
- /**
8
- * Creates an instance of [[SkyAffixer]].
9
- * @param affixed The element to be affixed.
10
- */
11
- createAffixer(affixed: ElementRef): SkyAffixer;
12
- static ɵfac: i0.ɵɵFactoryDeclaration<SkyAffixService, never>;
13
- static ɵprov: i0.ɵɵInjectableDeclaration<SkyAffixService>;
14
- }
@@ -1,40 +0,0 @@
1
- import { ViewportRuler } from '@angular/cdk/overlay';
2
- import { NgZone, Renderer2 } from '@angular/core';
3
- import { Observable } from 'rxjs';
4
- import { SkyAffixConfig } from './affix-config';
5
- import { SkyAffixOffsetChange } from './affix-offset-change';
6
- import { SkyAffixPlacementChange } from './affix-placement-change';
7
- export declare class SkyAffixer {
8
- #private;
9
- /**
10
- * Fires when the affixed element's offset changes.
11
- */
12
- get offsetChange(): Observable<SkyAffixOffsetChange>;
13
- /**
14
- * Fires when the base element's nearest overflow parent is scrolling. This is useful if you need
15
- * to perform an additional action during the scroll event but don't want to generate another
16
- * event listener.
17
- */
18
- get overflowScroll(): Observable<void>;
19
- /**
20
- * Fires when the placement value changes. A `null` value indicates that a suitable
21
- * placement could not be found.
22
- */
23
- get placementChange(): Observable<SkyAffixPlacementChange>;
24
- constructor(affixedElement: HTMLElement, renderer: Renderer2, viewportRuler: ViewportRuler, zone: NgZone, layoutViewport: HTMLElement);
25
- /**
26
- * Affixes an element to a base element.
27
- * @param baseElement The base element.
28
- * @param config Configuration for the affix action.
29
- */
30
- affixTo(baseElement: HTMLElement, config?: SkyAffixConfig): void;
31
- getConfig(): SkyAffixConfig;
32
- /**
33
- * Re-runs the affix calculation.
34
- */
35
- reaffix(): void;
36
- /**
37
- * Destroys the affixer.
38
- */
39
- destroy(): void;
40
- }
@@ -1,23 +0,0 @@
1
- import { ViewportRuler } from '@angular/cdk/overlay';
2
- import { SkyAffixOffset } from './affix-offset';
3
- import { AffixRect } from './affix-rect';
4
- /**
5
- * Returns the offset values of a given element.
6
- * @param element The HTML element.
7
- * @param bufferOffset An optional offset to add/subtract to the element's actual offset.
8
- */
9
- export declare function getElementOffset(element: HTMLElement, bufferOffset?: SkyAffixOffset): Required<SkyAffixOffset>;
10
- /**
11
- * Returns an AffixRect that represents the outer dimensions of a given element.
12
- */
13
- export declare function getOuterRect(element: HTMLElement): Required<AffixRect>;
14
- /**
15
- * Returns the visible rect for a given element.
16
- */
17
- export declare function getVisibleRectForElement(viewportRuler: ViewportRuler, element: HTMLElement): Required<AffixRect>;
18
- export declare function getOverflowParents(child: HTMLElement): HTMLElement[];
19
- /**
20
- * Confirms offset is fully visible within a parent element.
21
- */
22
- export declare function isOffsetFullyVisibleWithinParent(viewportRuler: ViewportRuler, parent: HTMLElement, offset: Required<SkyAffixOffset>, bufferOffset?: SkyAffixOffset): boolean;
23
- export declare function isOffsetPartiallyVisibleWithinParent(viewportRuler: ViewportRuler, parent: HTMLElement, offset: Required<SkyAffixOffset>, bufferOffset?: SkyAffixOffset): boolean;
@@ -1,9 +0,0 @@
1
- import { Observable } from 'rxjs';
2
- import { SkyBreakpoint } from './breakpoint';
3
- /**
4
- * @internal
5
- */
6
- export interface SkyBreakpointObserver {
7
- get breakpointChange(): Observable<SkyBreakpoint>;
8
- destroy(): void;
9
- }