@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.
- package/fesm2022/skyux-core-testing.mjs +26 -26
- package/fesm2022/skyux-core-testing.mjs.map +1 -1
- package/fesm2022/skyux-core.mjs +181 -181
- package/fesm2022/skyux-core.mjs.map +1 -1
- package/index.d.ts +1658 -96
- package/package.json +7 -7
- package/testing/index.d.ts +227 -3
- package/lib/modules/adapter-service/adapter.module.d.ts +0 -10
- package/lib/modules/adapter-service/adapter.service.d.ts +0 -76
- package/lib/modules/adapter-service/focusable-children-options.d.ts +0 -15
- package/lib/modules/affix/affix-auto-fit-context.d.ts +0 -10
- package/lib/modules/affix/affix-config.d.ts +0 -46
- package/lib/modules/affix/affix-horizontal-alignment.d.ts +0 -4
- package/lib/modules/affix/affix-offset-change.d.ts +0 -7
- package/lib/modules/affix/affix-offset.d.ts +0 -9
- package/lib/modules/affix/affix-placement-change.d.ts +0 -7
- package/lib/modules/affix/affix-placement.d.ts +0 -4
- package/lib/modules/affix/affix-position.d.ts +0 -1
- package/lib/modules/affix/affix-rect.d.ts +0 -11
- package/lib/modules/affix/affix-utils.d.ts +0 -3
- package/lib/modules/affix/affix-vertical-alignment.d.ts +0 -4
- package/lib/modules/affix/affix.directive.d.ts +0 -71
- package/lib/modules/affix/affix.module.d.ts +0 -8
- package/lib/modules/affix/affix.service.d.ts +0 -14
- package/lib/modules/affix/affixer.d.ts +0 -40
- package/lib/modules/affix/dom-utils.d.ts +0 -23
- package/lib/modules/breakpoint-observer/breakpoint-observer.d.ts +0 -9
- package/lib/modules/breakpoint-observer/breakpoint-observer.token.d.ts +0 -7
- package/lib/modules/breakpoint-observer/breakpoint-utils.d.ts +0 -17
- package/lib/modules/breakpoint-observer/breakpoint.d.ts +0 -9
- package/lib/modules/breakpoint-observer/container-breakpoint-observer.d.ts +0 -18
- package/lib/modules/breakpoint-observer/media-breakpoint-observer.d.ts +0 -18
- package/lib/modules/breakpoint-observer/provide-breakpoint-observer.d.ts +0 -7
- package/lib/modules/breakpoint-observer/responsive-host.directive.d.ts +0 -32
- package/lib/modules/content-info-provider/content-info-descriptor.d.ts +0 -16
- package/lib/modules/content-info-provider/content-info-provider.d.ts +0 -17
- package/lib/modules/content-info-provider/content-info.d.ts +0 -13
- package/lib/modules/default-input-provider/default-input-provider.d.ts +0 -10
- package/lib/modules/dock/dock-dom-adapter.service.d.ts +0 -17
- package/lib/modules/dock/dock-insert-component-config.d.ts +0 -8
- package/lib/modules/dock/dock-item-config.d.ts +0 -11
- package/lib/modules/dock/dock-item-reference.d.ts +0 -9
- package/lib/modules/dock/dock-item.d.ts +0 -22
- package/lib/modules/dock/dock-location.d.ts +0 -17
- package/lib/modules/dock/dock-options.d.ts +0 -18
- package/lib/modules/dock/dock.component.d.ts +0 -17
- package/lib/modules/dock/dock.module.d.ts +0 -10
- package/lib/modules/dock/dock.service.d.ts +0 -33
- package/lib/modules/dock/sort-by-stack-order.d.ts +0 -4
- package/lib/modules/dynamic-component/dynamic-component-location.d.ts +0 -25
- package/lib/modules/dynamic-component/dynamic-component-options.d.ts +0 -31
- package/lib/modules/dynamic-component/dynamic-component.module.d.ts +0 -11
- package/lib/modules/dynamic-component/dynamic-component.service.d.ts +0 -33
- package/lib/modules/file-reader/file-reader.service.d.ts +0 -10
- package/lib/modules/format/app-format.d.ts +0 -6
- package/lib/modules/help/help-global-options-token.d.ts +0 -6
- package/lib/modules/help/help-global-options.d.ts +0 -13
- package/lib/modules/help/help-open-args.d.ts +0 -9
- package/lib/modules/help/help-update-args.d.ts +0 -13
- package/lib/modules/help/help.service.d.ts +0 -25
- package/lib/modules/id/id.directive.d.ts +0 -15
- package/lib/modules/id/id.module.d.ts +0 -7
- package/lib/modules/id/id.service.d.ts +0 -9
- package/lib/modules/layout-host/layout-host-for-child-args.d.ts +0 -3
- package/lib/modules/layout-host/layout-host.directive.d.ts +0 -11
- package/lib/modules/layout-host/layout-host.service.d.ts +0 -13
- package/lib/modules/live-announcer/live-announcer.service.d.ts +0 -31
- package/lib/modules/live-announcer/types/live-announcer-args.d.ts +0 -12
- package/lib/modules/live-announcer/types/live-announcer-politeness.d.ts +0 -5
- package/lib/modules/log/log.module.d.ts +0 -10
- package/lib/modules/log/log.service.d.ts +0 -47
- package/lib/modules/log/types/log-deprecation-args.d.ts +0 -27
- package/lib/modules/log/types/log-level-token.d.ts +0 -6
- package/lib/modules/log/types/log-level.d.ts +0 -8
- package/lib/modules/media-query/media-breakpoints.d.ts +0 -22
- package/lib/modules/media-query/media-query-listener.d.ts +0 -7
- package/lib/modules/media-query/media-query.module.d.ts +0 -10
- package/lib/modules/media-query/media-query.service.d.ts +0 -55
- package/lib/modules/mutation/mutation-observer-service.d.ts +0 -9
- package/lib/modules/numeric/numeric-symbol.d.ts +0 -7
- package/lib/modules/numeric/numeric.module.d.ts +0 -8
- package/lib/modules/numeric/numeric.options.d.ts +0 -61
- package/lib/modules/numeric/numeric.pipe.d.ts +0 -22
- package/lib/modules/numeric/numeric.service.d.ts +0 -24
- package/lib/modules/overlay/overlay-adapter.service.d.ts +0 -15
- package/lib/modules/overlay/overlay-config.d.ts +0 -41
- package/lib/modules/overlay/overlay-context.d.ts +0 -9
- package/lib/modules/overlay/overlay-instance.d.ts +0 -42
- package/lib/modules/overlay/overlay-position.d.ts +0 -1
- package/lib/modules/overlay/overlay.component.d.ts +0 -30
- package/lib/modules/overlay/overlay.module.d.ts +0 -10
- package/lib/modules/overlay/overlay.service.d.ts +0 -39
- package/lib/modules/percent-pipe/percent-pipe.module.d.ts +0 -8
- package/lib/modules/percent-pipe/percent.pipe.d.ts +0 -12
- package/lib/modules/resize-observer/resize-observer-media-query.service.d.ts +0 -45
- package/lib/modules/resize-observer/resize-observer.service.d.ts +0 -17
- package/lib/modules/screen-reader-label/screen-reader-label.directive.d.ts +0 -20
- package/lib/modules/scroll-shadow/scroll-shadow-event-args.d.ts +0 -7
- package/lib/modules/scroll-shadow/scroll-shadow.directive.d.ts +0 -19
- package/lib/modules/scrollable-host/scrollable-host.service.d.ts +0 -32
- package/lib/modules/shared/number-format/number-format-utility.d.ts +0 -5
- package/lib/modules/shared/sky-core-resources.module.d.ts +0 -10
- package/lib/modules/stacking-context/stacking-context-token.d.ts +0 -6
- package/lib/modules/stacking-context/stacking-context.d.ts +0 -7
- package/lib/modules/title/set-title-args.d.ts +0 -3
- package/lib/modules/title/title.service.d.ts +0 -18
- package/lib/modules/trim/trim.directive.d.ts +0 -14
- package/lib/modules/trim/trim.module.d.ts +0 -7
- package/lib/modules/ui-config/ui-config.service.d.ts +0 -8
- package/lib/modules/viewkeeper/viewkeeper-boundary-info.d.ts +0 -11
- package/lib/modules/viewkeeper/viewkeeper-fixed-styles.d.ts +0 -10
- package/lib/modules/viewkeeper/viewkeeper-host-options.d.ts +0 -14
- package/lib/modules/viewkeeper/viewkeeper-offset.d.ts +0 -4
- package/lib/modules/viewkeeper/viewkeeper-options.d.ts +0 -45
- package/lib/modules/viewkeeper/viewkeeper.d.ts +0 -7
- package/lib/modules/viewkeeper/viewkeeper.directive.d.ts +0 -17
- package/lib/modules/viewkeeper/viewkeeper.module.d.ts +0 -7
- package/lib/modules/viewkeeper/viewkeeper.service.d.ts +0 -23
- package/lib/modules/window/window-ref.d.ts +0 -18
- package/testing/legacy/core-testing.module.d.ts +0 -9
- package/testing/legacy/mock-media-query.service.d.ts +0 -23
- package/testing/legacy/mock-ui-config.service.d.ts +0 -11
- package/testing/legacy/resize-observer-mock.d.ts +0 -15
- package/testing/modules/file-reader/file-reader-testing.service.d.ts +0 -10
- package/testing/modules/file-reader/provide-file-reader-testing.d.ts +0 -12
- package/testing/modules/help/help-testing-controller.d.ts +0 -15
- package/testing/modules/help/help-testing.module.d.ts +0 -9
- package/testing/modules/help/help-testing.service.d.ts +0 -16
- package/testing/modules/media-query/breakpoint-observer-testing.d.ts +0 -15
- package/testing/modules/media-query/media-query-testing-controller.d.ts +0 -15
- package/testing/modules/media-query/provide-media-query-testing.d.ts +0 -5
- package/testing/modules/overlay/overlay-harness-filters.d.ts +0 -7
- package/testing/modules/overlay/overlay-harness.d.ts +0 -18
- package/testing/public-api.d.ts +0 -16
- package/testing/shared/component-harness.d.ts +0 -9
- package/testing/shared/harness-filters.d.ts +0 -10
- package/testing/shared/harness-utility.d.ts +0 -4
- package/testing/shared/input-harness.d.ts +0 -35
- package/testing/shared/queryable-component-harness.d.ts +0 -31
- package/version.d.ts +0 -15
package/index.d.ts
CHANGED
@@ -1,96 +1,1658 @@
|
|
1
|
-
|
2
|
-
|
3
|
-
|
4
|
-
|
5
|
-
|
6
|
-
|
7
|
-
|
8
|
-
|
9
|
-
|
10
|
-
|
11
|
-
|
12
|
-
|
13
|
-
|
14
|
-
|
15
|
-
|
16
|
-
|
17
|
-
|
18
|
-
|
19
|
-
|
20
|
-
|
21
|
-
|
22
|
-
|
23
|
-
|
24
|
-
|
25
|
-
|
26
|
-
|
27
|
-
|
28
|
-
|
29
|
-
|
30
|
-
|
31
|
-
|
32
|
-
|
33
|
-
|
34
|
-
|
35
|
-
|
36
|
-
|
37
|
-
|
38
|
-
|
39
|
-
|
40
|
-
|
41
|
-
|
42
|
-
|
43
|
-
|
44
|
-
|
45
|
-
|
46
|
-
|
47
|
-
|
48
|
-
|
49
|
-
|
50
|
-
|
51
|
-
|
52
|
-
|
53
|
-
|
54
|
-
|
55
|
-
|
56
|
-
|
57
|
-
|
58
|
-
|
59
|
-
|
60
|
-
|
61
|
-
|
62
|
-
|
63
|
-
|
64
|
-
|
65
|
-
|
66
|
-
|
67
|
-
|
68
|
-
|
69
|
-
|
70
|
-
|
71
|
-
|
72
|
-
|
73
|
-
|
74
|
-
|
75
|
-
|
76
|
-
|
77
|
-
|
78
|
-
|
79
|
-
|
80
|
-
|
81
|
-
|
82
|
-
|
83
|
-
|
84
|
-
|
85
|
-
|
86
|
-
|
87
|
-
|
88
|
-
|
89
|
-
|
90
|
-
|
91
|
-
|
92
|
-
|
93
|
-
|
94
|
-
|
95
|
-
|
96
|
-
|
1
|
+
import * as i0 from '@angular/core';
|
2
|
+
import { RendererFactory2, ElementRef, Renderer2, NgZone, OnDestroy, OnInit, OnChanges, EventEmitter, SimpleChanges, StaticProvider, Type, ViewContainerRef, EnvironmentInjector, ApplicationRef, ComponentRef, InjectionToken, Provider, Injector, PipeTransform, ChangeDetectorRef, TemplateRef, EmbeddedViewRef, AfterViewInit } from '@angular/core';
|
3
|
+
import { ViewportRuler } from '@angular/cdk/overlay';
|
4
|
+
import { Observable, ReplaySubject, Subscription } from 'rxjs';
|
5
|
+
import * as i2 from '@angular/common';
|
6
|
+
import * as i1 from '@skyux/i18n';
|
7
|
+
import { SkyLibResourcesService, SkyAppLocaleProvider } from '@skyux/i18n';
|
8
|
+
import { Title } from '@angular/platform-browser';
|
9
|
+
|
10
|
+
/**
|
11
|
+
* @deprecated The `SkyCoreAdapterService` no longer needs the `SkyCoreAdapterModule`.
|
12
|
+
* The `SkyCoreAdapterModule` can be removed from your project.
|
13
|
+
*/
|
14
|
+
declare class SkyCoreAdapterModule {
|
15
|
+
static ɵfac: i0.ɵɵFactoryDeclaration<SkyCoreAdapterModule, never>;
|
16
|
+
static ɵmod: i0.ɵɵNgModuleDeclaration<SkyCoreAdapterModule, never, never, never>;
|
17
|
+
static ɵinj: i0.ɵɵInjectorDeclaration<SkyCoreAdapterModule>;
|
18
|
+
}
|
19
|
+
|
20
|
+
/**
|
21
|
+
* A list of all breakpoints.
|
22
|
+
* @internal
|
23
|
+
*/
|
24
|
+
declare const SKY_BREAKPOINTS: readonly ["xs", "sm", "md", "lg"];
|
25
|
+
/**
|
26
|
+
* The name of a viewport or container breakpoint.
|
27
|
+
*/
|
28
|
+
type SkyBreakpoint = (typeof SKY_BREAKPOINTS)[number];
|
29
|
+
|
30
|
+
/**
|
31
|
+
* Represents all available media breakpoints.
|
32
|
+
* @deprecated Use `SkyBreakpoint` instead.
|
33
|
+
*/
|
34
|
+
declare enum SkyMediaBreakpoints {
|
35
|
+
/**
|
36
|
+
* Screen widths of 767px or less.
|
37
|
+
*/
|
38
|
+
xs = 1,
|
39
|
+
/**
|
40
|
+
* Screen widths of 768px to 991px.
|
41
|
+
*/
|
42
|
+
sm = 2,
|
43
|
+
/**
|
44
|
+
* Screen widths of 992px to 1199px.
|
45
|
+
*/
|
46
|
+
md = 3,
|
47
|
+
/**
|
48
|
+
* Screen widths of 1200px or greater.
|
49
|
+
*/
|
50
|
+
lg = 4
|
51
|
+
}
|
52
|
+
|
53
|
+
/**
|
54
|
+
* Options for getting focusable children.
|
55
|
+
*/
|
56
|
+
interface SkyFocusableChildrenOptions {
|
57
|
+
/**
|
58
|
+
* By default, the `getFocusableChildren()` function will filter out elements with
|
59
|
+
* a `tabIndex` of `-1`. Setting `ignoreTabIndex = true` will ignore this filter.
|
60
|
+
*/
|
61
|
+
ignoreTabIndex?: boolean;
|
62
|
+
/**
|
63
|
+
* By default, the `getFocusableChildren()` function will only return visible elements.
|
64
|
+
* Setting `ignoreVisibility = true` will ignore this filter.
|
65
|
+
*/
|
66
|
+
ignoreVisibility?: boolean;
|
67
|
+
}
|
68
|
+
|
69
|
+
declare class SkyCoreAdapterService {
|
70
|
+
#private;
|
71
|
+
constructor(rendererFactory: RendererFactory2);
|
72
|
+
/**
|
73
|
+
* Set the responsive container CSS class for a given element.
|
74
|
+
*
|
75
|
+
* @param elementRef - The element that will receive the new CSS class.
|
76
|
+
* @param breakpoint - The breakpoint to determine which class gets set.
|
77
|
+
* For example a breakpoint of "xs" will set a CSS class of "sky-responsive-container-xs".
|
78
|
+
* @deprecated Use the `SkyResponsiveHostDirective` instead.
|
79
|
+
*/
|
80
|
+
setResponsiveContainerClass(elementRef: ElementRef, breakpoint: SkyBreakpoint | SkyMediaBreakpoints): void;
|
81
|
+
/**
|
82
|
+
* This method temporarily enables/disables pointer events.
|
83
|
+
* This is helpful to prevent iFrames from interfering with drag events.
|
84
|
+
*
|
85
|
+
* @param enable - Set to `true` to enable pointer events. Set to `false` to disable.
|
86
|
+
*/
|
87
|
+
toggleIframePointerEvents(enable: boolean): void;
|
88
|
+
/**
|
89
|
+
* Focuses on the first element found with an `autofocus` attribute inside the supplied `elementRef`.
|
90
|
+
*
|
91
|
+
* @param elementRef - The element to search within.
|
92
|
+
* @return Returns `true` if a child element with autofocus is found.
|
93
|
+
*/
|
94
|
+
applyAutoFocus(elementRef?: ElementRef): boolean;
|
95
|
+
/**
|
96
|
+
* Sets focus on the first focusable child of the `elementRef` parameter.
|
97
|
+
* If no focusable children are found, and `focusOnContainerIfNoChildrenFound` is `true`,
|
98
|
+
* focus will be set on the container element.
|
99
|
+
*
|
100
|
+
* @param elementRef - The element to search within.
|
101
|
+
* @param containerSelector - A CSS selector indicating the container that should
|
102
|
+
* receive focus if no focusable children are found.
|
103
|
+
* @param focusOnContainerIfNoChildrenFound - It set to `true`, the container will
|
104
|
+
* receive focus if no focusable children are found.
|
105
|
+
*/
|
106
|
+
getFocusableChildrenAndApplyFocus(elementRef: ElementRef, containerSelector?: string, focusOnContainerIfNoChildrenFound?: boolean): void;
|
107
|
+
/**
|
108
|
+
* Returns an array of all focusable children of provided `element`.
|
109
|
+
*
|
110
|
+
* @param element - The HTMLElement to search within.
|
111
|
+
* @param options - Options for getting focusable children.
|
112
|
+
*/
|
113
|
+
getFocusableChildren(element?: HTMLElement, options?: SkyFocusableChildrenOptions): HTMLElement[];
|
114
|
+
/**
|
115
|
+
* Returns the clientWidth of the provided elementRef.
|
116
|
+
* @param elementRef - The element to calculate width from.
|
117
|
+
*/
|
118
|
+
getWidth(elementRef: ElementRef): number;
|
119
|
+
/**
|
120
|
+
* Checks if an event target has a higher z-index than a given element.
|
121
|
+
* @param target The event target element.
|
122
|
+
* @param element The element to test against. A z-index must be explicitly set for this element.
|
123
|
+
*/
|
124
|
+
isTargetAboveElement(target: EventTarget, element: HTMLElement): boolean;
|
125
|
+
/**
|
126
|
+
* Remove inline height styles from the provided elements.
|
127
|
+
* @param elementRef - The element to search within.
|
128
|
+
* @param selector - The CSS selector to use when finding elements for removing height.
|
129
|
+
*/
|
130
|
+
resetHeight(elementRef: ElementRef, selector: string): void;
|
131
|
+
/**
|
132
|
+
* Sets all element heights to match the height of the tallest element.
|
133
|
+
* @param elementRef - The element to search within.
|
134
|
+
* @param selector - The CSS selector to use when finding elements for syncing height.
|
135
|
+
*/
|
136
|
+
syncMaxHeight(elementRef: ElementRef, selector: string): void;
|
137
|
+
static ɵfac: i0.ɵɵFactoryDeclaration<SkyCoreAdapterService, never>;
|
138
|
+
static ɵprov: i0.ɵɵInjectableDeclaration<SkyCoreAdapterService>;
|
139
|
+
}
|
140
|
+
|
141
|
+
declare enum SkyAffixAutoFitContext {
|
142
|
+
/**
|
143
|
+
* Auto-fit functionality will respect the nearest overflow parent element's dimensions.
|
144
|
+
*/
|
145
|
+
OverflowParent = 0,
|
146
|
+
/**
|
147
|
+
* Auto-fit functionality will respect the browser viewport dimensions.
|
148
|
+
*/
|
149
|
+
Viewport = 1
|
150
|
+
}
|
151
|
+
|
152
|
+
/**
|
153
|
+
* The horizontal alignment of the affixed element to the base element.
|
154
|
+
*/
|
155
|
+
type SkyAffixHorizontalAlignment = 'left' | 'center' | 'right';
|
156
|
+
|
157
|
+
/**
|
158
|
+
* Offset values used by the affixer.
|
159
|
+
*/
|
160
|
+
interface SkyAffixOffset {
|
161
|
+
bottom?: number;
|
162
|
+
left?: number;
|
163
|
+
right?: number;
|
164
|
+
top?: number;
|
165
|
+
}
|
166
|
+
|
167
|
+
/**
|
168
|
+
* The placement of the affixed element around the base element.
|
169
|
+
*/
|
170
|
+
type SkyAffixPlacement = 'above' | 'below' | 'left' | 'right';
|
171
|
+
|
172
|
+
type SkyAffixPosition = 'absolute' | 'fixed';
|
173
|
+
|
174
|
+
/**
|
175
|
+
* The vertical alignment of the affixed element to the base element.
|
176
|
+
*/
|
177
|
+
type SkyAffixVerticalAlignment = 'top' | 'middle' | 'bottom';
|
178
|
+
|
179
|
+
interface SkyAffixConfig {
|
180
|
+
/**
|
181
|
+
* Which parent element is used by the auto-fit functionality.
|
182
|
+
*/
|
183
|
+
autoFitContext?: SkyAffixAutoFitContext;
|
184
|
+
/**
|
185
|
+
* This optional offset is added to (or subtracted from) the [[SkyAffixAutoFitContext]] element's
|
186
|
+
* offset during an auto-fit placement calculation. This value is useful if you need to consider
|
187
|
+
* another `position: fixed` element on the page (such as a navbar) when the auto-fit
|
188
|
+
* functionality attempts to find the best possible placement.
|
189
|
+
* (In the case of a navbar, you would add a `top` value equal to the navbar's height in pixels.)
|
190
|
+
*/
|
191
|
+
autoFitOverflowOffset?: SkyAffixOffset;
|
192
|
+
/**
|
193
|
+
* Whether the affix service tries to find the best placement for the affixed element
|
194
|
+
* if the element would be hidden otherwise. If this setting is disabled, the affix service
|
195
|
+
* forces the placement of the affixed element.
|
196
|
+
*/
|
197
|
+
enableAutoFit?: boolean;
|
198
|
+
/**
|
199
|
+
* The horizontal alignment of the affixed element to the base element.
|
200
|
+
*/
|
201
|
+
horizontalAlignment?: SkyAffixHorizontalAlignment;
|
202
|
+
/**
|
203
|
+
* Whether the affixed element remains affixed to the base element when the window is scrolled or resized.
|
204
|
+
*/
|
205
|
+
isSticky?: boolean;
|
206
|
+
/**
|
207
|
+
* The placement of the affixed element around the base element.
|
208
|
+
*/
|
209
|
+
placement?: SkyAffixPlacement;
|
210
|
+
/**
|
211
|
+
* The vertical alignment of the affixed element to the base element.
|
212
|
+
*/
|
213
|
+
verticalAlignment?: SkyAffixVerticalAlignment;
|
214
|
+
/**
|
215
|
+
* The position of the element being affixed.
|
216
|
+
*/
|
217
|
+
position?: SkyAffixPosition;
|
218
|
+
}
|
219
|
+
|
220
|
+
/**
|
221
|
+
* The arguments supplied to the affix offset change event listener.
|
222
|
+
*/
|
223
|
+
interface SkyAffixOffsetChange {
|
224
|
+
offset?: SkyAffixOffset;
|
225
|
+
}
|
226
|
+
|
227
|
+
interface SkyAffixPlacementChange {
|
228
|
+
/**
|
229
|
+
* The changed placement value.
|
230
|
+
*/
|
231
|
+
placement: SkyAffixPlacement | null;
|
232
|
+
}
|
233
|
+
|
234
|
+
declare class SkyAffixer {
|
235
|
+
#private;
|
236
|
+
/**
|
237
|
+
* Fires when the affixed element's offset changes.
|
238
|
+
*/
|
239
|
+
get offsetChange(): Observable<SkyAffixOffsetChange>;
|
240
|
+
/**
|
241
|
+
* Fires when the base element's nearest overflow parent is scrolling. This is useful if you need
|
242
|
+
* to perform an additional action during the scroll event but don't want to generate another
|
243
|
+
* event listener.
|
244
|
+
*/
|
245
|
+
get overflowScroll(): Observable<void>;
|
246
|
+
/**
|
247
|
+
* Fires when the placement value changes. A `null` value indicates that a suitable
|
248
|
+
* placement could not be found.
|
249
|
+
*/
|
250
|
+
get placementChange(): Observable<SkyAffixPlacementChange>;
|
251
|
+
constructor(affixedElement: HTMLElement, renderer: Renderer2, viewportRuler: ViewportRuler, zone: NgZone, layoutViewport: HTMLElement);
|
252
|
+
/**
|
253
|
+
* Affixes an element to a base element.
|
254
|
+
* @param baseElement The base element.
|
255
|
+
* @param config Configuration for the affix action.
|
256
|
+
*/
|
257
|
+
affixTo(baseElement: HTMLElement, config?: SkyAffixConfig): void;
|
258
|
+
getConfig(): SkyAffixConfig;
|
259
|
+
/**
|
260
|
+
* Re-runs the affix calculation.
|
261
|
+
*/
|
262
|
+
reaffix(): void;
|
263
|
+
/**
|
264
|
+
* Destroys the affixer.
|
265
|
+
*/
|
266
|
+
destroy(): void;
|
267
|
+
}
|
268
|
+
|
269
|
+
declare class SkyAffixService implements OnDestroy {
|
270
|
+
#private;
|
271
|
+
ngOnDestroy(): void;
|
272
|
+
/**
|
273
|
+
* Creates an instance of [[SkyAffixer]].
|
274
|
+
* @param affixed The element to be affixed.
|
275
|
+
*/
|
276
|
+
createAffixer(affixed: ElementRef): SkyAffixer;
|
277
|
+
static ɵfac: i0.ɵɵFactoryDeclaration<SkyAffixService, never>;
|
278
|
+
static ɵprov: i0.ɵɵInjectableDeclaration<SkyAffixService>;
|
279
|
+
}
|
280
|
+
|
281
|
+
/**
|
282
|
+
* Affixes the host element to a base element.
|
283
|
+
*/
|
284
|
+
declare class SkyAffixDirective implements OnInit, OnChanges, OnDestroy {
|
285
|
+
#private;
|
286
|
+
/**
|
287
|
+
* The base element to affix the host element.
|
288
|
+
*/
|
289
|
+
skyAffixTo: HTMLElement | undefined;
|
290
|
+
/**
|
291
|
+
* Sets the `autoFitContext` property of [[SkyAffixConfig]].
|
292
|
+
*/
|
293
|
+
affixAutoFitContext: SkyAffixAutoFitContext | undefined;
|
294
|
+
/**
|
295
|
+
* Sets the `autoFitOverflowOffset` property of [[SkyAffixConfig]].
|
296
|
+
*/
|
297
|
+
affixAutoFitOverflowOffset: SkyAffixOffset | undefined;
|
298
|
+
/**
|
299
|
+
* Sets the `enableAutoFit` property of [[SkyAffixConfig]].
|
300
|
+
*/
|
301
|
+
affixEnableAutoFit: boolean | undefined;
|
302
|
+
/**
|
303
|
+
* Sets the `horizontalAlignment` property of [[SkyAffixConfig]].
|
304
|
+
*/
|
305
|
+
affixHorizontalAlignment: SkyAffixHorizontalAlignment | undefined;
|
306
|
+
/**
|
307
|
+
* Sets the `isSticky` property of [[SkyAffixConfig]].
|
308
|
+
*/
|
309
|
+
affixIsSticky: boolean | undefined;
|
310
|
+
/**
|
311
|
+
* Sets the `placement` property of [[SkyAffixConfig]].
|
312
|
+
*/
|
313
|
+
affixPlacement: SkyAffixPlacement | undefined;
|
314
|
+
/**
|
315
|
+
* Sets the `position` property of [[SkyAffixConfig]].
|
316
|
+
*/
|
317
|
+
affixPosition: SkyAffixPosition | undefined;
|
318
|
+
/**
|
319
|
+
* Sets the `verticalAlignment` property of [[SkyAffixConfig]].
|
320
|
+
*/
|
321
|
+
affixVerticalAlignment: SkyAffixVerticalAlignment | undefined;
|
322
|
+
/**
|
323
|
+
* Fires when the affixed element's offset changes.
|
324
|
+
*/
|
325
|
+
affixOffsetChange: EventEmitter<SkyAffixOffsetChange>;
|
326
|
+
/**
|
327
|
+
* Fires when the affixed element's overflow container is scrolled.
|
328
|
+
*/
|
329
|
+
affixOverflowScroll: EventEmitter<void>;
|
330
|
+
/**
|
331
|
+
* Fires when the placement value changes.
|
332
|
+
*/
|
333
|
+
affixPlacementChange: EventEmitter<SkyAffixPlacementChange>;
|
334
|
+
constructor(elementRef: ElementRef, affixService: SkyAffixService);
|
335
|
+
ngOnInit(): void;
|
336
|
+
ngOnChanges(changes: SimpleChanges): void;
|
337
|
+
ngOnDestroy(): void;
|
338
|
+
static ɵfac: i0.ɵɵFactoryDeclaration<SkyAffixDirective, never>;
|
339
|
+
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>;
|
340
|
+
}
|
341
|
+
|
342
|
+
declare class SkyAffixModule {
|
343
|
+
static ɵfac: i0.ɵɵFactoryDeclaration<SkyAffixModule, never>;
|
344
|
+
static ɵmod: i0.ɵɵNgModuleDeclaration<SkyAffixModule, [typeof SkyAffixDirective], [typeof i2.CommonModule], [typeof SkyAffixDirective]>;
|
345
|
+
static ɵinj: i0.ɵɵInjectorDeclaration<SkyAffixModule>;
|
346
|
+
}
|
347
|
+
|
348
|
+
/**
|
349
|
+
* Text or an element that describes the content a consumer renders in a component.
|
350
|
+
*
|
351
|
+
* @internal
|
352
|
+
*/
|
353
|
+
interface SkyContentInfoDescriptor {
|
354
|
+
/**
|
355
|
+
* A descriptor of type `text` is an already localized string that describes a parent's content, i.e. constituent.
|
356
|
+
* A descriptor of type `elementId` is an HTML Element ID of an element that describes a parent's content, i.e. the ID to a box header.
|
357
|
+
*/
|
358
|
+
type: 'text' | 'elementId';
|
359
|
+
/**
|
360
|
+
* A value of the given type.
|
361
|
+
*/
|
362
|
+
value: string;
|
363
|
+
}
|
364
|
+
|
365
|
+
/**
|
366
|
+
* Information about the content a consumer is rendering within a component.
|
367
|
+
*
|
368
|
+
* @internal
|
369
|
+
*/
|
370
|
+
interface SkyContentInfo {
|
371
|
+
/**
|
372
|
+
* Information that describes the content within a parent component a consumer has rendered, i.e. "constituents".
|
373
|
+
* Provided as localized text or an element ID pointing to text that is the descriptor.
|
374
|
+
*/
|
375
|
+
descriptor?: SkyContentInfoDescriptor;
|
376
|
+
}
|
377
|
+
|
378
|
+
/**
|
379
|
+
* @internal
|
380
|
+
* An API to provide information about a parent component's content to child components.
|
381
|
+
* For example, toolbar can use this to provide its child components with a list
|
382
|
+
* descriptor they can use to construct aria labels, or tree view can provide the node
|
383
|
+
* name to its context menus.
|
384
|
+
*/
|
385
|
+
declare class SkyContentInfoProvider {
|
386
|
+
#private;
|
387
|
+
patchInfo(value: SkyContentInfo): void;
|
388
|
+
getInfo(): Observable<SkyContentInfo>;
|
389
|
+
static ɵfac: i0.ɵɵFactoryDeclaration<SkyContentInfoProvider, never>;
|
390
|
+
static ɵprov: i0.ɵɵInjectableDeclaration<SkyContentInfoProvider>;
|
391
|
+
}
|
392
|
+
|
393
|
+
/**
|
394
|
+
* @internal
|
395
|
+
* An API to provide default Angular component input values to child components.
|
396
|
+
*/
|
397
|
+
declare class SkyDefaultInputProvider {
|
398
|
+
#private;
|
399
|
+
setValue<T>(componentName: string, inputName: string, value: T): void;
|
400
|
+
getValue<T>(componentName: string, inputName: string): Observable<T> | undefined;
|
401
|
+
}
|
402
|
+
|
403
|
+
/**
|
404
|
+
* Configuration to be used by the docking action.
|
405
|
+
*/
|
406
|
+
interface SkyDockItemConfig {
|
407
|
+
/**
|
408
|
+
* The stack order of the item. The higher the number, the higher
|
409
|
+
* the item will be placed in the dock. By default, new items will be placed at
|
410
|
+
* the top of the stack.
|
411
|
+
*/
|
412
|
+
stackOrder?: number;
|
413
|
+
}
|
414
|
+
|
415
|
+
interface SkyDockInsertComponentConfig extends SkyDockItemConfig {
|
416
|
+
/**
|
417
|
+
* Static providers to inject into the item's component.
|
418
|
+
*/
|
419
|
+
providers?: StaticProvider[];
|
420
|
+
}
|
421
|
+
|
422
|
+
/**
|
423
|
+
* Represents a single item added to the dock.
|
424
|
+
*/
|
425
|
+
declare class SkyDockItem<T> {
|
426
|
+
#private;
|
427
|
+
readonly componentInstance: T;
|
428
|
+
readonly stackOrder: number;
|
429
|
+
/**
|
430
|
+
* An event that emits when the item is removed from the dock.
|
431
|
+
*/
|
432
|
+
get destroyed(): Observable<void>;
|
433
|
+
/**
|
434
|
+
* @param componentInstance The item's component instance.
|
435
|
+
* @param stackOrder The assigned stack order of the docked item.
|
436
|
+
*/
|
437
|
+
constructor(componentInstance: T, stackOrder: number);
|
438
|
+
/**
|
439
|
+
* Removes the item from the dock.
|
440
|
+
*/
|
441
|
+
destroy(): void;
|
442
|
+
}
|
443
|
+
|
444
|
+
/**
|
445
|
+
* The location on the page where the dock component should be rendered.
|
446
|
+
*/
|
447
|
+
declare enum SkyDockLocation {
|
448
|
+
/**
|
449
|
+
* Renders the dock component before a given element.
|
450
|
+
*/
|
451
|
+
BeforeElement = 0,
|
452
|
+
/**
|
453
|
+
* Renders the dock component as the last element inside the BODY element.
|
454
|
+
*/
|
455
|
+
BodyBottom = 1,
|
456
|
+
/**
|
457
|
+
* Renders the dock component as the last element inside a given element.
|
458
|
+
*/
|
459
|
+
ElementBottom = 2
|
460
|
+
}
|
461
|
+
|
462
|
+
/**
|
463
|
+
* Options for adding a dock component to the page.
|
464
|
+
*/
|
465
|
+
interface SkyDockOptions {
|
466
|
+
/**
|
467
|
+
* The location on the page where the dock component should be rendered.
|
468
|
+
*/
|
469
|
+
location?: SkyDockLocation;
|
470
|
+
/**
|
471
|
+
* The reference element used when using the `BeforeElement` or `ElementBottom` locations.
|
472
|
+
*/
|
473
|
+
referenceEl?: HTMLElement;
|
474
|
+
/**
|
475
|
+
* The z-index for the dock element
|
476
|
+
*/
|
477
|
+
zIndex?: number;
|
478
|
+
}
|
479
|
+
|
480
|
+
/**
|
481
|
+
* @deprecated The `SkyDockModule` is no longer needed and can be removed from your application.
|
482
|
+
* @internal
|
483
|
+
*/
|
484
|
+
declare class SkyDockModule {
|
485
|
+
static ɵfac: i0.ɵɵFactoryDeclaration<SkyDockModule, never>;
|
486
|
+
static ɵmod: i0.ɵɵNgModuleDeclaration<SkyDockModule, never, never, never>;
|
487
|
+
static ɵinj: i0.ɵɵInjectorDeclaration<SkyDockModule>;
|
488
|
+
}
|
489
|
+
|
490
|
+
/**
|
491
|
+
* This service docks components to specific areas on the page.
|
492
|
+
*/
|
493
|
+
declare class SkyDockService {
|
494
|
+
#private;
|
495
|
+
private static dockRef;
|
496
|
+
private static _items;
|
497
|
+
/**
|
498
|
+
* Returns all docked items.
|
499
|
+
*/
|
500
|
+
get items(): SkyDockItem<any>[];
|
501
|
+
/**
|
502
|
+
* Docks a component to the bottom of the page.
|
503
|
+
* @param component The component to dock.
|
504
|
+
* @param config Options that affect the docking action.
|
505
|
+
*/
|
506
|
+
insertComponent<T>(component: Type<T>, config?: SkyDockInsertComponentConfig): SkyDockItem<T>;
|
507
|
+
/**
|
508
|
+
* Sets options for the positioning and styling of the dock component. Since the dock service is a
|
509
|
+
* singleton instance, these options will be applied to all components inserted into the dock. In
|
510
|
+
* order to create a separate dock with different options, consumers should provide a different
|
511
|
+
* instance of the dock service.
|
512
|
+
* @param options The options for positioning and styling
|
513
|
+
*/
|
514
|
+
setDockOptions(options: SkyDockOptions): void;
|
515
|
+
static ɵfac: i0.ɵɵFactoryDeclaration<SkyDockService, never>;
|
516
|
+
static ɵprov: i0.ɵɵInjectableDeclaration<SkyDockService>;
|
517
|
+
}
|
518
|
+
|
519
|
+
/**
|
520
|
+
* The location on the page where the dynamic component should be rendered.
|
521
|
+
*/
|
522
|
+
declare enum SkyDynamicComponentLocation {
|
523
|
+
/**
|
524
|
+
* Renders the dynamic component before a given element.
|
525
|
+
*/
|
526
|
+
BeforeElement = 0,
|
527
|
+
/**
|
528
|
+
* Renders the dynamic component as the last element inside the BODY element.
|
529
|
+
*/
|
530
|
+
BodyBottom = 1,
|
531
|
+
/**
|
532
|
+
* Renders the dynamic component as the first element inside the BODY element.
|
533
|
+
*/
|
534
|
+
BodyTop = 2,
|
535
|
+
/**
|
536
|
+
* Renders the dynamic component as the last element inside a given element.
|
537
|
+
*/
|
538
|
+
ElementBottom = 3,
|
539
|
+
/**
|
540
|
+
* Renders the dynamic component as the first element inside a given element.
|
541
|
+
*/
|
542
|
+
ElementTop = 4
|
543
|
+
}
|
544
|
+
|
545
|
+
/**
|
546
|
+
* Options for adding a dynamic component to the page.
|
547
|
+
*/
|
548
|
+
interface SkyDynamicComponentOptions {
|
549
|
+
/**
|
550
|
+
* The location on the page where the dynamic component should be rendered.
|
551
|
+
*/
|
552
|
+
location?: SkyDynamicComponentLocation;
|
553
|
+
/**
|
554
|
+
* Providers to inject into the new component.
|
555
|
+
*/
|
556
|
+
providers?: StaticProvider[];
|
557
|
+
/**
|
558
|
+
* The reference element used when using the `ElementTop` or `ElementBottom` locations.
|
559
|
+
*/
|
560
|
+
referenceEl?: HTMLElement;
|
561
|
+
/**
|
562
|
+
* The view container reference where the new component should be appended.
|
563
|
+
*/
|
564
|
+
viewContainerRef?: ViewContainerRef;
|
565
|
+
/**
|
566
|
+
* The environment injector to use instead of the dynamic component service's injector.
|
567
|
+
*/
|
568
|
+
environmentInjector?: EnvironmentInjector;
|
569
|
+
/**
|
570
|
+
* A class to add to the created component
|
571
|
+
*/
|
572
|
+
className?: string;
|
573
|
+
}
|
574
|
+
|
575
|
+
/**
|
576
|
+
* Provides services required to create dynamic components on the page.
|
577
|
+
* @deprecated The `SkyDynamicComponentService` no longer needs the `SkyDynamicComponentModule`.
|
578
|
+
* The `SkyDynamicComponentModule` can be removed from your project.
|
579
|
+
*/
|
580
|
+
declare class SkyDynamicComponentModule {
|
581
|
+
static ɵfac: i0.ɵɵFactoryDeclaration<SkyDynamicComponentModule, never>;
|
582
|
+
static ɵmod: i0.ɵɵNgModuleDeclaration<SkyDynamicComponentModule, never, never, never>;
|
583
|
+
static ɵinj: i0.ɵɵInjectorDeclaration<SkyDynamicComponentModule>;
|
584
|
+
}
|
585
|
+
|
586
|
+
/**
|
587
|
+
* The application window reference service references the global window variable.
|
588
|
+
* After users inject SkyAppWindowRef into a component, they can use the service to interact with
|
589
|
+
* window properties and event handlers by referencing its nativeWindow property.
|
590
|
+
*/
|
591
|
+
declare class SkyAppWindowRef {
|
592
|
+
/**
|
593
|
+
* The global `window` variable.
|
594
|
+
*/
|
595
|
+
get nativeWindow(): any;
|
596
|
+
static ɵfac: i0.ɵɵFactoryDeclaration<SkyAppWindowRef, never>;
|
597
|
+
static ɵprov: i0.ɵɵInjectableDeclaration<SkyAppWindowRef>;
|
598
|
+
}
|
599
|
+
|
600
|
+
/**
|
601
|
+
* Angular service for creating and rendering a dynamic component.
|
602
|
+
* @internal
|
603
|
+
*/
|
604
|
+
declare class SkyDynamicComponentService {
|
605
|
+
#private;
|
606
|
+
constructor(applicationRef: ApplicationRef, windowRef: SkyAppWindowRef, rendererFactory: RendererFactory2);
|
607
|
+
/**
|
608
|
+
* Creates an instance of the specified component and adds it to the specified location
|
609
|
+
* on the page.
|
610
|
+
*/
|
611
|
+
createComponent<T>(componentType: Type<T>, options?: SkyDynamicComponentOptions): ComponentRef<T>;
|
612
|
+
/**
|
613
|
+
* Removes a component ref from the page
|
614
|
+
* @param componentRef Component ref for the component being removed
|
615
|
+
*/
|
616
|
+
removeComponent<T>(componentRef: ComponentRef<T> | undefined): void;
|
617
|
+
static ɵfac: i0.ɵɵFactoryDeclaration<SkyDynamicComponentService, never>;
|
618
|
+
static ɵprov: i0.ɵɵInjectableDeclaration<SkyDynamicComponentService>;
|
619
|
+
}
|
620
|
+
/**
|
621
|
+
* Angular service for creating and rendering a dynamic component.
|
622
|
+
* @internal
|
623
|
+
* @deprecated Use `SkyDynamicComponentService` to create a standalone component instead.
|
624
|
+
*/
|
625
|
+
declare class SkyDynamicComponentLegacyService extends SkyDynamicComponentService {
|
626
|
+
static ɵfac: i0.ɵɵFactoryDeclaration<SkyDynamicComponentLegacyService, never>;
|
627
|
+
static ɵprov: i0.ɵɵInjectableDeclaration<SkyDynamicComponentLegacyService>;
|
628
|
+
}
|
629
|
+
|
630
|
+
/**
|
631
|
+
* Wraps the FileReader API so it can be mocked in tests.
|
632
|
+
* @internal
|
633
|
+
*/
|
634
|
+
declare class SkyFileReaderService {
|
635
|
+
readAsDataURL(file: File): Promise<string>;
|
636
|
+
static ɵfac: i0.ɵɵFactoryDeclaration<SkyFileReaderService, never>;
|
637
|
+
static ɵprov: i0.ɵɵInjectableDeclaration<SkyFileReaderService>;
|
638
|
+
}
|
639
|
+
|
640
|
+
declare class SkyAppFormat {
|
641
|
+
formatText(format: string, ...args: any[]): string;
|
642
|
+
static ɵfac: i0.ɵɵFactoryDeclaration<SkyAppFormat, never>;
|
643
|
+
static ɵprov: i0.ɵɵInjectableDeclaration<SkyAppFormat>;
|
644
|
+
}
|
645
|
+
|
646
|
+
/**
|
647
|
+
* Options to apply to all components that invoke global help.
|
648
|
+
*/
|
649
|
+
interface SkyHelpGlobalOptions {
|
650
|
+
/**
|
651
|
+
* The ID of the element that is displayed when the invoking component is clicked.
|
652
|
+
*/
|
653
|
+
ariaControls?: string;
|
654
|
+
/**
|
655
|
+
* The type of popup triggered by the invoking component.
|
656
|
+
*/
|
657
|
+
ariaHaspopup?: 'menu' | 'listbox' | 'tree' | 'grid' | 'dialog';
|
658
|
+
}
|
659
|
+
|
660
|
+
/**
|
661
|
+
* Injection token for specifying and retrieving global help options.
|
662
|
+
*/
|
663
|
+
declare const SKY_HELP_GLOBAL_OPTIONS: InjectionToken<SkyHelpGlobalOptions>;
|
664
|
+
|
665
|
+
/**
|
666
|
+
* Options for displaying a globally accessible help dialog.
|
667
|
+
*/
|
668
|
+
interface SkyHelpOpenArgs {
|
669
|
+
/**
|
670
|
+
* A unique key that identifies the help content to display.
|
671
|
+
* */
|
672
|
+
helpKey: string;
|
673
|
+
}
|
674
|
+
|
675
|
+
/**
|
676
|
+
* Options for updating a globally accessible help dialog.
|
677
|
+
*/
|
678
|
+
interface SkyHelpUpdateArgs {
|
679
|
+
/**
|
680
|
+
* A unique key that identifies the current help content to display. If set to `undefined`, the page's default help content will be displayed.
|
681
|
+
*/
|
682
|
+
helpKey?: string;
|
683
|
+
/**
|
684
|
+
* A unique key that identifies the page's default help content to display. Set this property to `undefined` to unset the current page default help key.
|
685
|
+
* */
|
686
|
+
pageDefaultHelpKey?: string;
|
687
|
+
}
|
688
|
+
|
689
|
+
/**
|
690
|
+
* Provides methods for opening and updating a globally accessible help dialog.
|
691
|
+
*/
|
692
|
+
declare abstract class SkyHelpService {
|
693
|
+
/**
|
694
|
+
* Emits when the help widget ready state changes.
|
695
|
+
*/
|
696
|
+
get widgetReadyStateChange(): Observable<boolean>;
|
697
|
+
/**
|
698
|
+
* Opens a globally accessible help dialog.
|
699
|
+
* @param args The options for opening the help dialog.
|
700
|
+
*/
|
701
|
+
abstract openHelp(args?: SkyHelpOpenArgs): void;
|
702
|
+
/**
|
703
|
+
* Updates a globally accessible help dialog.
|
704
|
+
* @param args The options for updating the help dialog.
|
705
|
+
*/
|
706
|
+
abstract updateHelp(args: SkyHelpUpdateArgs): void;
|
707
|
+
static ɵfac: i0.ɵɵFactoryDeclaration<SkyHelpService, never>;
|
708
|
+
static ɵprov: i0.ɵɵInjectableDeclaration<SkyHelpService>;
|
709
|
+
}
|
710
|
+
|
711
|
+
/**
|
712
|
+
* Generates unique IDs to be used with HTML elements.
|
713
|
+
*/
|
714
|
+
declare class SkyIdService {
|
715
|
+
generateId(): string;
|
716
|
+
static ɵfac: i0.ɵɵFactoryDeclaration<SkyIdService, never>;
|
717
|
+
static ɵprov: i0.ɵɵInjectableDeclaration<SkyIdService>;
|
718
|
+
}
|
719
|
+
|
720
|
+
/**
|
721
|
+
* Sets the element's `id` attribute to a unique ID. To reference this unique ID on other elements,
|
722
|
+
* such as in a `label` element's `for` attribute, assign this directive to a template reference
|
723
|
+
* variable, then use its `id` property.
|
724
|
+
*/
|
725
|
+
declare class SkyIdDirective {
|
726
|
+
#private;
|
727
|
+
get id(): string;
|
728
|
+
constructor(elRef: ElementRef, renderer: Renderer2, idSvc: SkyIdService);
|
729
|
+
static ɵfac: i0.ɵɵFactoryDeclaration<SkyIdDirective, never>;
|
730
|
+
static ɵdir: i0.ɵɵDirectiveDeclaration<SkyIdDirective, "[skyId]", ["skyId"], {}, {}, never, never, false, never>;
|
731
|
+
}
|
732
|
+
|
733
|
+
declare class SkyIdModule {
|
734
|
+
static ɵfac: i0.ɵɵFactoryDeclaration<SkyIdModule, never>;
|
735
|
+
static ɵmod: i0.ɵɵNgModuleDeclaration<SkyIdModule, [typeof SkyIdDirective], never, [typeof SkyIdDirective]>;
|
736
|
+
static ɵinj: i0.ɵɵInjectorDeclaration<SkyIdModule>;
|
737
|
+
}
|
738
|
+
|
739
|
+
interface SkyLayoutHostForChildArgs {
|
740
|
+
layout: string;
|
741
|
+
}
|
742
|
+
|
743
|
+
/**
|
744
|
+
* @internal
|
745
|
+
*/
|
746
|
+
declare class SkyLayoutHostDirective<T = 'none' | 'fit'> {
|
747
|
+
#private;
|
748
|
+
readonly layout: i0.InputSignal<T | undefined>;
|
749
|
+
constructor();
|
750
|
+
static ɵfac: i0.ɵɵFactoryDeclaration<SkyLayoutHostDirective<any>, never>;
|
751
|
+
static ɵdir: i0.ɵɵDirectiveDeclaration<SkyLayoutHostDirective<any>, "[skyLayoutHost]", never, { "layout": { "alias": "layout"; "required": false; "isSignal": true; }; }, {}, never, never, true, never>;
|
752
|
+
}
|
753
|
+
|
754
|
+
/**
|
755
|
+
* @internal
|
756
|
+
*/
|
757
|
+
declare class SkyLayoutHostService {
|
758
|
+
#private;
|
759
|
+
get hostLayoutForChild(): Observable<SkyLayoutHostForChildArgs>;
|
760
|
+
setHostLayoutForChild(layout: SkyLayoutHostForChildArgs): void;
|
761
|
+
static ɵfac: i0.ɵɵFactoryDeclaration<SkyLayoutHostService, never>;
|
762
|
+
static ɵprov: i0.ɵɵInjectableDeclaration<SkyLayoutHostService>;
|
763
|
+
}
|
764
|
+
|
765
|
+
/**
|
766
|
+
* Possible politeness levels for messages announced via the `SkyLiveAnnouncerService`.
|
767
|
+
* @internal
|
768
|
+
*/
|
769
|
+
type SkyLiveAnnouncerPoliteness = 'off' | 'polite' | 'assertive';
|
770
|
+
|
771
|
+
/**
|
772
|
+
* Options used when announcing messages to screen readers via the `SkyLiveAnnouncerService`
|
773
|
+
* @internal
|
774
|
+
*/
|
775
|
+
interface SkyLiveAnnouncerArgs {
|
776
|
+
politeness?: SkyLiveAnnouncerPoliteness;
|
777
|
+
/**
|
778
|
+
* Sets how long the live announcer text persists in DOM.
|
779
|
+
*/
|
780
|
+
duration?: number;
|
781
|
+
}
|
782
|
+
|
783
|
+
/**
|
784
|
+
* Allows for announcing messages to screen reader users through the use of a common `aria-live` element.
|
785
|
+
* @internal
|
786
|
+
*/
|
787
|
+
declare class SkyLiveAnnouncerService implements OnDestroy {
|
788
|
+
#private;
|
789
|
+
announcerElementChanged: ReplaySubject<HTMLElement | undefined>;
|
790
|
+
constructor();
|
791
|
+
/**
|
792
|
+
* Announces a message to screen readers.
|
793
|
+
* @param message Message to be announced to the screen reader.
|
794
|
+
* @param args Options for the announcement of the message.
|
795
|
+
*/
|
796
|
+
announce(message: string, args?: SkyLiveAnnouncerArgs): void;
|
797
|
+
/**
|
798
|
+
* Clears the current text from the announcer element. Can be used to prevent
|
799
|
+
* screen readers from reading the text out again while the user is going
|
800
|
+
* through the page landmarks.
|
801
|
+
*/
|
802
|
+
clear(): void;
|
803
|
+
/**
|
804
|
+
* @internal
|
805
|
+
*/
|
806
|
+
ngOnDestroy(): void;
|
807
|
+
static ɵfac: i0.ɵɵFactoryDeclaration<SkyLiveAnnouncerService, never>;
|
808
|
+
static ɵprov: i0.ɵɵInjectableDeclaration<SkyLiveAnnouncerService>;
|
809
|
+
}
|
810
|
+
|
811
|
+
/**
|
812
|
+
* @deprecated The `SkyLogService` no longer needs the `SkyLogModule`.
|
813
|
+
* The `SkyLogModule` can be removed from your project.
|
814
|
+
*/
|
815
|
+
declare class SkyLogModule {
|
816
|
+
static ɵfac: i0.ɵɵFactoryDeclaration<SkyLogModule, never>;
|
817
|
+
static ɵmod: i0.ɵɵNgModuleDeclaration<SkyLogModule, never, never, never>;
|
818
|
+
static ɵinj: i0.ɵɵInjectorDeclaration<SkyLogModule>;
|
819
|
+
}
|
820
|
+
|
821
|
+
/**
|
822
|
+
* @internal
|
823
|
+
*/
|
824
|
+
declare enum SkyLogLevel {
|
825
|
+
Info = 1,
|
826
|
+
Warn = 2,
|
827
|
+
Error = 3
|
828
|
+
}
|
829
|
+
|
830
|
+
/**
|
831
|
+
* @internal
|
832
|
+
* Arguments used when logging that a class, property, function, etc. is deprecated.
|
833
|
+
*/
|
834
|
+
interface SkyLogDeprecatedArgs {
|
835
|
+
/**
|
836
|
+
* The major version which deprecated the feature.
|
837
|
+
*/
|
838
|
+
deprecationMajorVersion?: number;
|
839
|
+
/**
|
840
|
+
* The log level for the console logging. The `SkyLogService` will assume `SkyLogLevel.Warn` if this is not provided.
|
841
|
+
*/
|
842
|
+
logLevel?: SkyLogLevel;
|
843
|
+
/**
|
844
|
+
* A URL which gives more information about the deprecation or the replacement recommendation.
|
845
|
+
*/
|
846
|
+
moreInfoUrl?: string;
|
847
|
+
/**
|
848
|
+
* The major version which will remove the deprecated feature.
|
849
|
+
*/
|
850
|
+
removalMajorVersion?: number;
|
851
|
+
/**
|
852
|
+
* The recommendation for how to replace the deprecated feature.
|
853
|
+
*/
|
854
|
+
replacementRecommendation?: string;
|
855
|
+
}
|
856
|
+
|
857
|
+
/**
|
858
|
+
* Logs information to the console based on the application's log level as
|
859
|
+
* provided by the `SKY_LOG_LEVEL` injection token. If no token is provided,
|
860
|
+
* only `error` logs will be shown.
|
861
|
+
* @internal
|
862
|
+
*/
|
863
|
+
declare class SkyLogService {
|
864
|
+
#private;
|
865
|
+
constructor(formatter: SkyAppFormat, applicationLogLevel?: SkyLogLevel);
|
866
|
+
/**
|
867
|
+
* Clears previously-logged messages. Primarily used for unit
|
868
|
+
* testing this service.
|
869
|
+
*/
|
870
|
+
static clearPreviousLogs(): void;
|
871
|
+
/**
|
872
|
+
* Logs a deprecation warning for a class, property, function, etc. This will
|
873
|
+
* be logged as a console warning unless a different log level is given in the
|
874
|
+
* `args` parameter.
|
875
|
+
* @param name The name of the deprecated class, property, function, etc.
|
876
|
+
* @param args Information about the deprecation and replacement recommendations.
|
877
|
+
*/
|
878
|
+
deprecated(name: string, args?: SkyLogDeprecatedArgs): void;
|
879
|
+
/**
|
880
|
+
* Logs a console error if the application's log level is `SkyLogLevel.Error`.
|
881
|
+
* @param message The error message
|
882
|
+
* @param params Optional parameters for the error message.
|
883
|
+
*/
|
884
|
+
error(message: string, params?: unknown[]): void;
|
885
|
+
/**
|
886
|
+
* Logs console information if the application's log level is `SkyLogLevel.Info` or above.
|
887
|
+
* @param message The informational message
|
888
|
+
* @param params Optional parameters for the informational message.
|
889
|
+
*/
|
890
|
+
info(message: string, params?: unknown[]): void;
|
891
|
+
/**
|
892
|
+
* Logs a console warning if the application's log level is `SkyLogLevel.Warn` or above.
|
893
|
+
* @param message The warning message
|
894
|
+
* @param params Optional parameters for the warning message.
|
895
|
+
*/
|
896
|
+
warn(message: string, params?: unknown[]): void;
|
897
|
+
static ɵfac: i0.ɵɵFactoryDeclaration<SkyLogService, [null, { optional: true; }]>;
|
898
|
+
static ɵprov: i0.ɵɵInjectableDeclaration<SkyLogService>;
|
899
|
+
}
|
900
|
+
|
901
|
+
/**
|
902
|
+
* @internal
|
903
|
+
*/
|
904
|
+
declare const SKY_LOG_LEVEL: InjectionToken<SkyLogLevel>;
|
905
|
+
|
906
|
+
/**
|
907
|
+
* @internal
|
908
|
+
*/
|
909
|
+
interface SkyBreakpointObserver {
|
910
|
+
get breakpointChange(): Observable<SkyBreakpoint>;
|
911
|
+
destroy(): void;
|
912
|
+
}
|
913
|
+
|
914
|
+
/**
|
915
|
+
* Used to override a breakpoint observer for specific execution contexts.
|
916
|
+
* @internal
|
917
|
+
*/
|
918
|
+
declare const SKY_BREAKPOINT_OBSERVER: InjectionToken<SkyBreakpointObserver>;
|
919
|
+
|
920
|
+
/**
|
921
|
+
* Emits when the width of the host container changes.
|
922
|
+
* @internal
|
923
|
+
*/
|
924
|
+
declare class SkyContainerBreakpointObserver implements OnDestroy, SkyBreakpointObserver {
|
925
|
+
#private;
|
926
|
+
get breakpointChange(): Observable<SkyBreakpoint>;
|
927
|
+
constructor();
|
928
|
+
ngOnDestroy(): void;
|
929
|
+
destroy(): void;
|
930
|
+
static ɵfac: i0.ɵɵFactoryDeclaration<SkyContainerBreakpointObserver, never>;
|
931
|
+
static ɵprov: i0.ɵɵInjectableDeclaration<SkyContainerBreakpointObserver>;
|
932
|
+
}
|
933
|
+
|
934
|
+
/**
|
935
|
+
* Emits when the viewport width changes.
|
936
|
+
* @internal
|
937
|
+
*/
|
938
|
+
declare class SkyMediaBreakpointObserver implements OnDestroy, SkyBreakpointObserver {
|
939
|
+
#private;
|
940
|
+
get breakpointChange(): Observable<SkyBreakpoint>;
|
941
|
+
constructor();
|
942
|
+
ngOnDestroy(): void;
|
943
|
+
destroy(): void;
|
944
|
+
static ɵfac: i0.ɵɵFactoryDeclaration<SkyMediaBreakpointObserver, never>;
|
945
|
+
static ɵprov: i0.ɵɵInjectableDeclaration<SkyMediaBreakpointObserver>;
|
946
|
+
}
|
947
|
+
|
948
|
+
/**
|
949
|
+
* Overrides the default media breakpoint observer with the given observer.
|
950
|
+
* @internal
|
951
|
+
*/
|
952
|
+
declare function provideSkyBreakpointObserver(observer: Type<SkyBreakpointObserver>): Provider[];
|
953
|
+
|
954
|
+
/**
|
955
|
+
* Overrides the `SkyMediaQueryService` to emit breakpoint changes when the host
|
956
|
+
* container is resized. This directive also adds SKY UX CSS classes to the
|
957
|
+
* host element to allow for responsive styles.
|
958
|
+
*/
|
959
|
+
declare class SkyResponsiveHostDirective {
|
960
|
+
#private;
|
961
|
+
/**
|
962
|
+
* Emits when the breakpoint changes.
|
963
|
+
*/
|
964
|
+
get breakpointChange(): Observable<SkyBreakpoint>;
|
965
|
+
/**
|
966
|
+
* The injector of the responsive host. Useful when displaying child components
|
967
|
+
* via `ngTemplateOutlet`.
|
968
|
+
* @example```
|
969
|
+
* <my-container #responsiveHost="skyResponsiveHost">
|
970
|
+
* <ng-container
|
971
|
+
* [ngTemplateOutlet]="myTemplate"
|
972
|
+
* [ngTemplateOutletInjector]="responsiveHost.injector"
|
973
|
+
* />
|
974
|
+
* </my-container>
|
975
|
+
* ```
|
976
|
+
*/
|
977
|
+
get injector(): Injector;
|
978
|
+
constructor();
|
979
|
+
static ɵfac: i0.ɵɵFactoryDeclaration<SkyResponsiveHostDirective, never>;
|
980
|
+
static ɵdir: i0.ɵɵDirectiveDeclaration<SkyResponsiveHostDirective, "[skyResponsiveHost]", ["skyResponsiveHost"], {}, {}, never, never, true, never>;
|
981
|
+
}
|
982
|
+
|
983
|
+
/**
|
984
|
+
* The function that is called when the breakpoints change. It is called
|
985
|
+
* with a `SkyMediaBreakpoints` argument, which is an enum that represents the new breakpoint.
|
986
|
+
* @deprecated Subscribe to the `breakpointChange` observable instead.
|
987
|
+
*/
|
988
|
+
type SkyMediaQueryListener = (args: SkyMediaBreakpoints) => void;
|
989
|
+
|
990
|
+
/**
|
991
|
+
* @deprecated The `SkyMediaQueryService` no longer needs the `SkyMediaQueryModule`.
|
992
|
+
* The `SkyMediaQueryModule` can be removed from your project.
|
993
|
+
*/
|
994
|
+
declare class SkyMediaQueryModule {
|
995
|
+
static ɵfac: i0.ɵɵFactoryDeclaration<SkyMediaQueryModule, never>;
|
996
|
+
static ɵmod: i0.ɵɵNgModuleDeclaration<SkyMediaQueryModule, never, never, never>;
|
997
|
+
static ɵinj: i0.ɵɵInjectorDeclaration<SkyMediaQueryModule>;
|
998
|
+
}
|
999
|
+
|
1000
|
+
/**
|
1001
|
+
* Utility used to subscribe to viewport and container breakpoint changes.
|
1002
|
+
*/
|
1003
|
+
declare class SkyMediaQueryService implements OnDestroy {
|
1004
|
+
#private;
|
1005
|
+
/**
|
1006
|
+
* Emits when the breakpoint changes.
|
1007
|
+
*/
|
1008
|
+
get breakpointChange(): Observable<SkyBreakpoint>;
|
1009
|
+
/**
|
1010
|
+
* The size for the `xs` breakpoint.
|
1011
|
+
* @default "(max-width: 767px)"
|
1012
|
+
*/
|
1013
|
+
static xs: string;
|
1014
|
+
/**
|
1015
|
+
* The size for the `sm` breakpoint.
|
1016
|
+
* @default "(min-width: 768px) and (max-width: 991px)"
|
1017
|
+
*/
|
1018
|
+
static sm: string;
|
1019
|
+
/**
|
1020
|
+
* The size for the `md` breakpoint.
|
1021
|
+
* @default "(min-width: 992px) and (max-width: 1199px)"
|
1022
|
+
*/
|
1023
|
+
static md: string;
|
1024
|
+
/**
|
1025
|
+
* The size for the `lg` breakpoint.
|
1026
|
+
* @default "(min-width: 1200px)"
|
1027
|
+
*/
|
1028
|
+
static lg: string;
|
1029
|
+
/**
|
1030
|
+
* Returns the current breakpoint.
|
1031
|
+
* @deprecated Subscribe to the `breakpointChange` observable instead.
|
1032
|
+
*/
|
1033
|
+
get current(): SkyMediaBreakpoints;
|
1034
|
+
constructor(_zone?: NgZone);
|
1035
|
+
ngOnDestroy(): void;
|
1036
|
+
/**
|
1037
|
+
* @internal
|
1038
|
+
*/
|
1039
|
+
destroy(): void;
|
1040
|
+
/**
|
1041
|
+
* Subscribes to screen size changes.
|
1042
|
+
* @param listener Specifies a function that is called when breakpoints change.
|
1043
|
+
* @deprecated Subscribe to the `breakpointChange` observable instead.
|
1044
|
+
*/
|
1045
|
+
subscribe(listener: SkyMediaQueryListener): Subscription;
|
1046
|
+
static ɵfac: i0.ɵɵFactoryDeclaration<SkyMediaQueryService, never>;
|
1047
|
+
static ɵprov: i0.ɵɵInjectableDeclaration<SkyMediaQueryService>;
|
1048
|
+
}
|
1049
|
+
|
1050
|
+
/**
|
1051
|
+
* @internal
|
1052
|
+
*/
|
1053
|
+
declare class SkyMutationObserverService {
|
1054
|
+
create(callback: MutationCallback): MutationObserver;
|
1055
|
+
static ɵfac: i0.ɵɵFactoryDeclaration<SkyMutationObserverService, never>;
|
1056
|
+
static ɵprov: i0.ɵɵInjectableDeclaration<SkyMutationObserverService>;
|
1057
|
+
}
|
1058
|
+
|
1059
|
+
/**
|
1060
|
+
* @internal
|
1061
|
+
*/
|
1062
|
+
interface SkyNumericSymbol {
|
1063
|
+
value: number;
|
1064
|
+
label: string;
|
1065
|
+
}
|
1066
|
+
|
1067
|
+
/**
|
1068
|
+
* Provides arguments for the number to format.
|
1069
|
+
*/
|
1070
|
+
interface SkyNumericOptions {
|
1071
|
+
/**
|
1072
|
+
* Specifies the maximum number of digits after the decimal separator.
|
1073
|
+
*/
|
1074
|
+
digits?: number;
|
1075
|
+
/**
|
1076
|
+
* Specifies how to format the number. Options are `currency` or `number`.
|
1077
|
+
*/
|
1078
|
+
format?: string;
|
1079
|
+
/**
|
1080
|
+
* Specifies the format of the currency.
|
1081
|
+
*/
|
1082
|
+
currencySign?: 'accounting' | 'standard';
|
1083
|
+
/**
|
1084
|
+
* Specifies the display of the currency. Defaults to 'symbol'.
|
1085
|
+
*/
|
1086
|
+
currencyDisplay?: 'code' | 'symbol' | 'narrowSymbol' | 'name';
|
1087
|
+
/**
|
1088
|
+
* Specifies the ISO4217 currency code to use for currency formatting.
|
1089
|
+
*/
|
1090
|
+
iso?: string;
|
1091
|
+
/**
|
1092
|
+
* Specifies the locale code to use when formatting.
|
1093
|
+
*/
|
1094
|
+
locale?: string;
|
1095
|
+
/**
|
1096
|
+
* Specifies the minimum number of digits after the decimal separator. This property only applies
|
1097
|
+
* when the `truncate` property is set to `false`. If `digits` specifies a maximum number of
|
1098
|
+
* digits, then `minDigits` must be less than that value.
|
1099
|
+
*/
|
1100
|
+
minDigits?: number;
|
1101
|
+
/**
|
1102
|
+
* Indicates whether to shorten numbers to rounded numbers and abbreviation characters
|
1103
|
+
* such as K for thousands, M for millions, B for billions, and T for trillions.
|
1104
|
+
*/
|
1105
|
+
truncate?: boolean;
|
1106
|
+
/**
|
1107
|
+
* Specifies the minimum value at which numbers are shortened to rounded numbers and abbreviation characters. Values less than `1000` are not truncated.
|
1108
|
+
*/
|
1109
|
+
truncateAfter?: number;
|
1110
|
+
}
|
1111
|
+
/**
|
1112
|
+
* Provides arguments for the number to format.
|
1113
|
+
* @deprecated Use the `SkyNumericOptions` interface instead.
|
1114
|
+
* @internal
|
1115
|
+
*/
|
1116
|
+
declare class NumericOptions implements SkyNumericOptions {
|
1117
|
+
digits?: number;
|
1118
|
+
format?: string;
|
1119
|
+
currencySign?: 'accounting' | 'standard';
|
1120
|
+
currencyDisplay?: 'code' | 'symbol' | 'narrowSymbol' | 'name';
|
1121
|
+
iso?: string;
|
1122
|
+
locale?: string;
|
1123
|
+
minDigits?: number;
|
1124
|
+
truncate?: boolean;
|
1125
|
+
truncateAfter?: number;
|
1126
|
+
constructor();
|
1127
|
+
}
|
1128
|
+
|
1129
|
+
declare class SkyNumericService {
|
1130
|
+
#private;
|
1131
|
+
/**
|
1132
|
+
* The browser's current locale.
|
1133
|
+
* @internal
|
1134
|
+
*/
|
1135
|
+
currentLocale: string;
|
1136
|
+
/**
|
1137
|
+
* @internal
|
1138
|
+
*/
|
1139
|
+
shortSymbol: string;
|
1140
|
+
constructor(resourcesSvc: SkyLibResourcesService);
|
1141
|
+
/**
|
1142
|
+
* Formats a number based on the provided options.
|
1143
|
+
* @param value The number to format.
|
1144
|
+
* @param options Format options.
|
1145
|
+
*/
|
1146
|
+
formatNumber(value: number | undefined | null, options: SkyNumericOptions): string;
|
1147
|
+
static ɵfac: i0.ɵɵFactoryDeclaration<SkyNumericService, never>;
|
1148
|
+
static ɵprov: i0.ɵɵInjectableDeclaration<SkyNumericService>;
|
1149
|
+
}
|
1150
|
+
|
1151
|
+
/**
|
1152
|
+
* Shortens numbers to rounded numbers and abbreviation characters such as K for thousands,
|
1153
|
+
* M for millions, B for billions, and T for trillions. The pipe also formats for currency.
|
1154
|
+
* Be sure you have a space after the two curly brackets opening the pipe and
|
1155
|
+
* a space before the two curly brackets closing the pipe or it will not work.
|
1156
|
+
*/
|
1157
|
+
declare class SkyNumericPipe implements PipeTransform, OnDestroy {
|
1158
|
+
#private;
|
1159
|
+
constructor(localeProvider: SkyAppLocaleProvider, numericSvc: SkyNumericService, changeDetector: ChangeDetectorRef);
|
1160
|
+
ngOnDestroy(): void;
|
1161
|
+
/**
|
1162
|
+
* Formats a number based on the provided options.
|
1163
|
+
*/
|
1164
|
+
transform(value: number | undefined | null, config?: SkyNumericOptions): string;
|
1165
|
+
static ɵfac: i0.ɵɵFactoryDeclaration<SkyNumericPipe, never>;
|
1166
|
+
static ɵpipe: i0.ɵɵPipeDeclaration<SkyNumericPipe, "skyNumeric", false>;
|
1167
|
+
}
|
1168
|
+
|
1169
|
+
/**
|
1170
|
+
* Import into any component library module that needs to use resource strings.
|
1171
|
+
*/
|
1172
|
+
declare class SkyCoreResourcesModule {
|
1173
|
+
static ɵfac: i0.ɵɵFactoryDeclaration<SkyCoreResourcesModule, never>;
|
1174
|
+
static ɵmod: i0.ɵɵNgModuleDeclaration<SkyCoreResourcesModule, never, never, [typeof i1.SkyI18nModule]>;
|
1175
|
+
static ɵinj: i0.ɵɵInjectorDeclaration<SkyCoreResourcesModule>;
|
1176
|
+
}
|
1177
|
+
|
1178
|
+
declare class SkyNumericModule {
|
1179
|
+
static ɵfac: i0.ɵɵFactoryDeclaration<SkyNumericModule, never>;
|
1180
|
+
static ɵmod: i0.ɵɵNgModuleDeclaration<SkyNumericModule, [typeof SkyNumericPipe], [typeof SkyCoreResourcesModule], [typeof SkyNumericPipe]>;
|
1181
|
+
static ɵinj: i0.ɵɵInjectorDeclaration<SkyNumericModule>;
|
1182
|
+
}
|
1183
|
+
|
1184
|
+
type SkyOverlayPosition = 'absolute' | 'fixed';
|
1185
|
+
|
1186
|
+
interface SkyOverlayConfig {
|
1187
|
+
/**
|
1188
|
+
* Whether the overlay closes after a navigation change.
|
1189
|
+
*/
|
1190
|
+
closeOnNavigation?: boolean;
|
1191
|
+
/**
|
1192
|
+
* Whether the overlay closes when a user clicks outside the overlay's content.
|
1193
|
+
*/
|
1194
|
+
enableClose?: boolean;
|
1195
|
+
/**
|
1196
|
+
* Whether mouse interactions are allowed below the backdrop.
|
1197
|
+
*/
|
1198
|
+
enablePointerEvents?: boolean;
|
1199
|
+
/**
|
1200
|
+
* Whether window scrolling is enabled when the overlay is opened.
|
1201
|
+
*/
|
1202
|
+
enableScroll?: boolean;
|
1203
|
+
/**
|
1204
|
+
* The environment injector for the overlay component.
|
1205
|
+
*/
|
1206
|
+
environmentInjector?: EnvironmentInjector;
|
1207
|
+
/**
|
1208
|
+
* Whether the overlay's backdrop is visible.
|
1209
|
+
*/
|
1210
|
+
showBackdrop?: boolean;
|
1211
|
+
/**
|
1212
|
+
* Extra CSS classes to add to the overlay's wrapper element.
|
1213
|
+
*/
|
1214
|
+
wrapperClass?: string;
|
1215
|
+
/**
|
1216
|
+
* The position of the overlay instance.
|
1217
|
+
*/
|
1218
|
+
position?: SkyOverlayPosition;
|
1219
|
+
/**
|
1220
|
+
* Hides the overlay's siblings from screen readers so users can't interact
|
1221
|
+
* with content behind the overlay with assistive technology.
|
1222
|
+
*/
|
1223
|
+
hideOthersFromScreenReaders?: boolean;
|
1224
|
+
}
|
1225
|
+
|
1226
|
+
/**
|
1227
|
+
* @internal
|
1228
|
+
*/
|
1229
|
+
declare class SkyOverlayComponent implements OnInit, OnDestroy {
|
1230
|
+
#private;
|
1231
|
+
wrapperClass: string;
|
1232
|
+
get backdropClick(): Observable<void>;
|
1233
|
+
get closed(): Observable<void>;
|
1234
|
+
enablePointerEvents: boolean;
|
1235
|
+
id: string;
|
1236
|
+
showBackdrop: boolean;
|
1237
|
+
zIndex: string;
|
1238
|
+
protected clipPath$: ReplaySubject<string | undefined>;
|
1239
|
+
protected position: SkyOverlayPosition;
|
1240
|
+
overlayContentRef: ElementRef | undefined;
|
1241
|
+
overlayRef: ElementRef | undefined;
|
1242
|
+
targetRef: ViewContainerRef | undefined;
|
1243
|
+
constructor();
|
1244
|
+
ngOnInit(): void;
|
1245
|
+
ngOnDestroy(): void;
|
1246
|
+
attachComponent<C>(component: Type<C>, providers?: StaticProvider[]): ComponentRef<C>;
|
1247
|
+
attachTemplate<T>(templateRef: TemplateRef<T>, context: T): EmbeddedViewRef<T>;
|
1248
|
+
updateClipPath(clipPath: string | undefined): void;
|
1249
|
+
static ɵfac: i0.ɵɵFactoryDeclaration<SkyOverlayComponent, never>;
|
1250
|
+
static ɵcmp: i0.ɵɵComponentDeclaration<SkyOverlayComponent, "sky-overlay", never, {}, {}, never, never, true, never>;
|
1251
|
+
}
|
1252
|
+
|
1253
|
+
/**
|
1254
|
+
* Represents a new overlay instance. It is used to manage the "closed" state of the overlay,
|
1255
|
+
* and access any public members on the appended content component instance.
|
1256
|
+
*/
|
1257
|
+
declare class SkyOverlayInstance {
|
1258
|
+
#private;
|
1259
|
+
/**
|
1260
|
+
* The configuration for the overlay.
|
1261
|
+
*/
|
1262
|
+
readonly config: SkyOverlayConfig;
|
1263
|
+
readonly componentRef: ComponentRef<SkyOverlayComponent>;
|
1264
|
+
/**
|
1265
|
+
* Emits when the overlay is clicked (but not its content).
|
1266
|
+
*/
|
1267
|
+
get backdropClick(): Observable<void>;
|
1268
|
+
/**
|
1269
|
+
* Emits after the overlay is closed.
|
1270
|
+
*/
|
1271
|
+
get closed(): Observable<void>;
|
1272
|
+
id: string;
|
1273
|
+
constructor(
|
1274
|
+
/**
|
1275
|
+
* The configuration for the overlay.
|
1276
|
+
*/
|
1277
|
+
config: SkyOverlayConfig, componentRef: ComponentRef<SkyOverlayComponent>);
|
1278
|
+
/**
|
1279
|
+
* Creates and attaches a component to the overlay.
|
1280
|
+
* @param component The component to attach.
|
1281
|
+
* @param providers Custom providers to apply to the component.
|
1282
|
+
*/
|
1283
|
+
attachComponent<C>(component: Type<C>, providers?: StaticProvider[]): C;
|
1284
|
+
/**
|
1285
|
+
* Attaches a `TemplateRef` to the overlay.
|
1286
|
+
* @param templateRef The `TemplateRef` to attach.
|
1287
|
+
* @param context The context to provide to the template.
|
1288
|
+
*/
|
1289
|
+
attachTemplate<T>(templateRef: TemplateRef<T>, context?: T): void;
|
1290
|
+
}
|
1291
|
+
|
1292
|
+
/**
|
1293
|
+
* @deprecated The `SkyOverlayModule` is no longer needed and can be removed from your application.
|
1294
|
+
* @internal
|
1295
|
+
*/
|
1296
|
+
declare class SkyOverlayModule {
|
1297
|
+
static ɵfac: i0.ɵɵFactoryDeclaration<SkyOverlayModule, never>;
|
1298
|
+
static ɵmod: i0.ɵɵNgModuleDeclaration<SkyOverlayModule, never, never, never>;
|
1299
|
+
static ɵinj: i0.ɵɵInjectorDeclaration<SkyOverlayModule>;
|
1300
|
+
}
|
1301
|
+
|
1302
|
+
/**
|
1303
|
+
* This service is used to create new overlays.
|
1304
|
+
* @internal
|
1305
|
+
*/
|
1306
|
+
declare class SkyOverlayService {
|
1307
|
+
#private;
|
1308
|
+
private static overlays;
|
1309
|
+
constructor(dynamicComponentSvc: SkyDynamicComponentService);
|
1310
|
+
/**
|
1311
|
+
* Creates an empty overlay. Use the returned `SkyOverlayInstance` to append content.
|
1312
|
+
* @param config Configuration for the overlay.
|
1313
|
+
*/
|
1314
|
+
create(config?: SkyOverlayConfig): SkyOverlayInstance;
|
1315
|
+
/**
|
1316
|
+
* Closes (and destroys) an overlay instance.
|
1317
|
+
* @param instance The instance to close.
|
1318
|
+
*/
|
1319
|
+
close(instance: SkyOverlayInstance): void;
|
1320
|
+
/**
|
1321
|
+
* Closes all overlay instances.
|
1322
|
+
*/
|
1323
|
+
closeAll(): void;
|
1324
|
+
static ɵfac: i0.ɵɵFactoryDeclaration<SkyOverlayService, never>;
|
1325
|
+
static ɵprov: i0.ɵɵInjectableDeclaration<SkyOverlayService>;
|
1326
|
+
}
|
1327
|
+
/**
|
1328
|
+
* This service is used to create new overlays.
|
1329
|
+
* @internal
|
1330
|
+
* @deprecated Use `SkyOverlayService` to open a standalone component instead.
|
1331
|
+
*/
|
1332
|
+
declare class SkyOverlayLegacyService extends SkyOverlayService {
|
1333
|
+
constructor(dynamicComponentSvc: SkyDynamicComponentLegacyService);
|
1334
|
+
static ɵfac: i0.ɵɵFactoryDeclaration<SkyOverlayLegacyService, never>;
|
1335
|
+
static ɵprov: i0.ɵɵInjectableDeclaration<SkyOverlayLegacyService>;
|
1336
|
+
}
|
1337
|
+
|
1338
|
+
declare class SkyPercentPipe implements OnDestroy, PipeTransform {
|
1339
|
+
#private;
|
1340
|
+
get defaultLocale(): string;
|
1341
|
+
constructor(localeProvider: SkyAppLocaleProvider);
|
1342
|
+
ngOnDestroy(): void;
|
1343
|
+
transform(value: string, format?: string, locale?: string): string;
|
1344
|
+
static ɵfac: i0.ɵɵFactoryDeclaration<SkyPercentPipe, never>;
|
1345
|
+
static ɵpipe: i0.ɵɵPipeDeclaration<SkyPercentPipe, "skyPercent", false>;
|
1346
|
+
}
|
1347
|
+
|
1348
|
+
declare class SkyPercentPipeModule {
|
1349
|
+
static ɵfac: i0.ɵɵFactoryDeclaration<SkyPercentPipeModule, never>;
|
1350
|
+
static ɵmod: i0.ɵɵNgModuleDeclaration<SkyPercentPipeModule, [typeof SkyPercentPipe], [typeof SkyCoreResourcesModule], [typeof SkyPercentPipe]>;
|
1351
|
+
static ɵinj: i0.ɵɵInjectorDeclaration<SkyPercentPipeModule>;
|
1352
|
+
}
|
1353
|
+
|
1354
|
+
/**
|
1355
|
+
* Acts like `SkyMediaQueryService` for a container element, emitting the same responsive breakpoints.
|
1356
|
+
* @deprecated Use the `SkyResponsiveHostDirective` instead.
|
1357
|
+
*/
|
1358
|
+
declare class SkyResizeObserverMediaQueryService extends SkyMediaQueryService implements OnDestroy {
|
1359
|
+
#private;
|
1360
|
+
/**
|
1361
|
+
* Emits when the breakpoint changes.
|
1362
|
+
*/
|
1363
|
+
get breakpointChange(): Observable<SkyBreakpoint>;
|
1364
|
+
/**
|
1365
|
+
* Returns the current breakpoint.
|
1366
|
+
* @deprecated Subscribe to the `breakpointChange` observable instead.
|
1367
|
+
*/
|
1368
|
+
get current(): SkyMediaBreakpoints;
|
1369
|
+
ngOnDestroy(): void;
|
1370
|
+
/**
|
1371
|
+
* @internal
|
1372
|
+
*/
|
1373
|
+
destroy(): void;
|
1374
|
+
/**
|
1375
|
+
* Sets the container element to watch. The `SkyResizeObserverMediaQueryService` will only observe one element at a
|
1376
|
+
* time. Any previous subscriptions will be unsubscribed when a new element is observed.
|
1377
|
+
*/
|
1378
|
+
observe(element: ElementRef, options?: {
|
1379
|
+
updateResponsiveClasses?: boolean;
|
1380
|
+
}): SkyResizeObserverMediaQueryService;
|
1381
|
+
/**
|
1382
|
+
* Stop watching the container element and remove any added classes.
|
1383
|
+
*/
|
1384
|
+
unobserve(): void;
|
1385
|
+
/**
|
1386
|
+
* Subscribes to element size changes that cross breakpoints.
|
1387
|
+
*/
|
1388
|
+
subscribe(listener: SkyMediaQueryListener): Subscription;
|
1389
|
+
static ɵfac: i0.ɵɵFactoryDeclaration<SkyResizeObserverMediaQueryService, never>;
|
1390
|
+
static ɵprov: i0.ɵɵInjectableDeclaration<SkyResizeObserverMediaQueryService>;
|
1391
|
+
}
|
1392
|
+
|
1393
|
+
/**
|
1394
|
+
* Service to create rxjs observables for changes to the content box dimensions of elements.
|
1395
|
+
*/
|
1396
|
+
declare class SkyResizeObserverService implements OnDestroy {
|
1397
|
+
#private;
|
1398
|
+
constructor();
|
1399
|
+
ngOnDestroy(): void;
|
1400
|
+
/**
|
1401
|
+
* Create rxjs observable to get size changes for an element ref.
|
1402
|
+
*/
|
1403
|
+
observe(element: ElementRef): Observable<ResizeObserverEntry>;
|
1404
|
+
static ɵfac: i0.ɵɵFactoryDeclaration<SkyResizeObserverService, never>;
|
1405
|
+
static ɵprov: i0.ɵɵInjectableDeclaration<SkyResizeObserverService>;
|
1406
|
+
}
|
1407
|
+
|
1408
|
+
/**
|
1409
|
+
* Adds the element to a screen reader only section of the body.
|
1410
|
+
* This prevents components' DOM from including text only intended for screen readers.
|
1411
|
+
*
|
1412
|
+
* @internal
|
1413
|
+
*/
|
1414
|
+
declare class SkyScreenReaderLabelDirective implements OnDestroy {
|
1415
|
+
#private;
|
1416
|
+
ngOnDestroy(): void;
|
1417
|
+
/**
|
1418
|
+
* Indicates if the label should be created in the DOM.
|
1419
|
+
* @default false
|
1420
|
+
*/
|
1421
|
+
set createLabel(value: boolean | undefined);
|
1422
|
+
get createLabel(): boolean;
|
1423
|
+
static ɵfac: i0.ɵɵFactoryDeclaration<SkyScreenReaderLabelDirective, never>;
|
1424
|
+
static ɵdir: i0.ɵɵDirectiveDeclaration<SkyScreenReaderLabelDirective, "[skyScreenReaderLabel]", never, { "createLabel": { "alias": "createLabel"; "required": false; }; }, {}, never, never, true, never>;
|
1425
|
+
}
|
1426
|
+
|
1427
|
+
/**
|
1428
|
+
* @internal
|
1429
|
+
*/
|
1430
|
+
interface SkyScrollShadowEventArgs {
|
1431
|
+
bottomShadow: string;
|
1432
|
+
topShadow: string;
|
1433
|
+
}
|
1434
|
+
|
1435
|
+
/**
|
1436
|
+
* Raises an event when the box shadow for a component's header or footer should be adjusted
|
1437
|
+
* based on the scroll position of the host element.
|
1438
|
+
* @internal
|
1439
|
+
*/
|
1440
|
+
declare class SkyScrollShadowDirective implements OnDestroy {
|
1441
|
+
#private;
|
1442
|
+
set skyScrollShadowEnabled(value: boolean);
|
1443
|
+
get skyScrollShadowEnabled(): boolean;
|
1444
|
+
skyScrollShadow: EventEmitter<SkyScrollShadowEventArgs>;
|
1445
|
+
windowResize(): void;
|
1446
|
+
scroll(): void;
|
1447
|
+
ngOnDestroy(): void;
|
1448
|
+
static ɵfac: i0.ɵɵFactoryDeclaration<SkyScrollShadowDirective, never>;
|
1449
|
+
static ɵdir: i0.ɵɵDirectiveDeclaration<SkyScrollShadowDirective, "[skyScrollShadow]", never, { "skyScrollShadowEnabled": { "alias": "skyScrollShadowEnabled"; "required": false; }; }, { "skyScrollShadow": "skyScrollShadow"; }, never, never, true, never>;
|
1450
|
+
}
|
1451
|
+
|
1452
|
+
declare class SkyScrollableHostService {
|
1453
|
+
#private;
|
1454
|
+
constructor(mutationObserverSvc: SkyMutationObserverService, windowRef: SkyAppWindowRef, resizeObserverSvc?: SkyResizeObserverService, zone?: NgZone);
|
1455
|
+
/**
|
1456
|
+
* Returns the given element's current scrollable host
|
1457
|
+
* @param elementRef The element whose scrollable host is being requested
|
1458
|
+
* @returns The current scrollable host
|
1459
|
+
*/
|
1460
|
+
getScrollableHost(elementRef: ElementRef): HTMLElement | Window;
|
1461
|
+
/**
|
1462
|
+
* Returns an observable which emits the given element's current scrollable host
|
1463
|
+
* @param elementRef The element whose scrollable host is being requested
|
1464
|
+
* @returns An observable which emits the current scrollable host element.
|
1465
|
+
* @internal
|
1466
|
+
*/
|
1467
|
+
watchScrollableHost(elementRef: ElementRef): Observable<HTMLElement | Window>;
|
1468
|
+
/**
|
1469
|
+
* Returns an observable which emits whenever the element's scrollable host emits a scroll event. The observable will always emit the scroll events from the elements current scrollable host and will update based on any scrollable host changes. The observable will also emit once whenever the scrollable host changes.
|
1470
|
+
* @param elementRef The element whose scrollable host scroll events are being requested
|
1471
|
+
* @returns An observable which emits when the elements scrollable host is scrolled or is changed
|
1472
|
+
*/
|
1473
|
+
watchScrollableHostScrollEvents(elementRef: ElementRef): Observable<void>;
|
1474
|
+
watchScrollableHostClipPathChanges(elementRef: ElementRef, additionalContainers?: Observable<ElementRef[]>): Observable<string>;
|
1475
|
+
static ɵfac: i0.ɵɵFactoryDeclaration<SkyScrollableHostService, [null, null, { optional: true; }, { optional: true; }]>;
|
1476
|
+
static ɵprov: i0.ɵɵInjectableDeclaration<SkyScrollableHostService>;
|
1477
|
+
}
|
1478
|
+
|
1479
|
+
/**
|
1480
|
+
* @internal
|
1481
|
+
*/
|
1482
|
+
interface SkyStackingContext {
|
1483
|
+
zIndex: Observable<number>;
|
1484
|
+
}
|
1485
|
+
|
1486
|
+
/**
|
1487
|
+
* @internal
|
1488
|
+
*/
|
1489
|
+
declare const SKY_STACKING_CONTEXT: InjectionToken<SkyStackingContext>;
|
1490
|
+
|
1491
|
+
interface SkyAppSetTitleArgs {
|
1492
|
+
titleParts: string[];
|
1493
|
+
}
|
1494
|
+
|
1495
|
+
/**
|
1496
|
+
* Provides a method for setting a formatted title on the current window.
|
1497
|
+
*/
|
1498
|
+
declare class SkyAppTitleService {
|
1499
|
+
#private;
|
1500
|
+
constructor(title: Title);
|
1501
|
+
/**
|
1502
|
+
* Sets the title on the current window.
|
1503
|
+
* @param args An array of title parts. The parts will be concatenated with a hyphen between
|
1504
|
+
* each part.
|
1505
|
+
*/
|
1506
|
+
setTitle(args: SkyAppSetTitleArgs | undefined): void;
|
1507
|
+
static ɵfac: i0.ɵɵFactoryDeclaration<SkyAppTitleService, never>;
|
1508
|
+
static ɵprov: i0.ɵɵInjectableDeclaration<SkyAppTitleService>;
|
1509
|
+
}
|
1510
|
+
|
1511
|
+
/**
|
1512
|
+
* Trims whitespace in each text node that is a direct descendent of the current element.
|
1513
|
+
*/
|
1514
|
+
declare class SkyTrimDirective implements OnInit, OnDestroy {
|
1515
|
+
#private;
|
1516
|
+
constructor(elRef: ElementRef, mutationObs: SkyMutationObserverService);
|
1517
|
+
ngOnInit(): void;
|
1518
|
+
ngOnDestroy(): void;
|
1519
|
+
static ɵfac: i0.ɵɵFactoryDeclaration<SkyTrimDirective, never>;
|
1520
|
+
static ɵdir: i0.ɵɵDirectiveDeclaration<SkyTrimDirective, "[skyTrim]", never, {}, {}, never, never, false, never>;
|
1521
|
+
}
|
1522
|
+
|
1523
|
+
declare class SkyTrimModule {
|
1524
|
+
static ɵfac: i0.ɵɵFactoryDeclaration<SkyTrimModule, never>;
|
1525
|
+
static ɵmod: i0.ɵɵNgModuleDeclaration<SkyTrimModule, [typeof SkyTrimDirective], never, [typeof SkyTrimDirective]>;
|
1526
|
+
static ɵinj: i0.ɵɵInjectorDeclaration<SkyTrimModule>;
|
1527
|
+
}
|
1528
|
+
|
1529
|
+
declare class SkyUIConfigService {
|
1530
|
+
getConfig(key: string, defaultConfig?: any): Observable<any>;
|
1531
|
+
setConfig(key: string, value: any): Observable<any>;
|
1532
|
+
static ɵfac: i0.ɵɵFactoryDeclaration<SkyUIConfigService, never>;
|
1533
|
+
static ɵprov: i0.ɵɵInjectableDeclaration<SkyUIConfigService>;
|
1534
|
+
}
|
1535
|
+
|
1536
|
+
/**
|
1537
|
+
* Options for creating a viewkeeper instance.
|
1538
|
+
*/
|
1539
|
+
interface SkyViewkeeperOptions {
|
1540
|
+
/**
|
1541
|
+
* The element that defines the bounds in which to keep the element in view. When the
|
1542
|
+
* boundary element is scrolled out of view, the viewkeeper element will be scrolled
|
1543
|
+
* out of view.
|
1544
|
+
*/
|
1545
|
+
boundaryEl?: HTMLElement;
|
1546
|
+
/**
|
1547
|
+
* The element to keep in view.
|
1548
|
+
*/
|
1549
|
+
el?: HTMLElement;
|
1550
|
+
/**
|
1551
|
+
* The scrollable parent where the viewkeeper resides. It should listen to and be
|
1552
|
+
* positioned within the parent.
|
1553
|
+
*/
|
1554
|
+
scrollableHost?: HTMLElement;
|
1555
|
+
/**
|
1556
|
+
* Sets the width of the viewkeeper element to the width of its
|
1557
|
+
* host element. Otherwise, if the element does not have an explicit width specified,
|
1558
|
+
* the element would collapse horizontally as a result of fixing the element to the top
|
1559
|
+
* of the viewport.
|
1560
|
+
*/
|
1561
|
+
setWidth?: boolean;
|
1562
|
+
/**
|
1563
|
+
* Reserved space in pixels above the viewkeeper element.
|
1564
|
+
*/
|
1565
|
+
verticalOffset?: number;
|
1566
|
+
/**
|
1567
|
+
* The element under which the viewkeeper element should be fixed. Typically this is
|
1568
|
+
* another viewkeeper element that is above the current viewkeeper element in the same
|
1569
|
+
* boundary element.
|
1570
|
+
*/
|
1571
|
+
verticalOffsetEl?: HTMLElement;
|
1572
|
+
/**
|
1573
|
+
* Reserved space in pixels at the top of the viewport.
|
1574
|
+
*/
|
1575
|
+
viewportMarginTop?: number;
|
1576
|
+
/**
|
1577
|
+
* Custom CSS property for reserved space at the top of the viewport.
|
1578
|
+
*/
|
1579
|
+
viewportMarginProperty?: `--${string}`;
|
1580
|
+
}
|
1581
|
+
|
1582
|
+
declare class SkyViewkeeper {
|
1583
|
+
#private;
|
1584
|
+
constructor(options: SkyViewkeeperOptions);
|
1585
|
+
syncElPosition(el: HTMLElement, boundaryEl: HTMLElement): void;
|
1586
|
+
destroy(): void;
|
1587
|
+
}
|
1588
|
+
|
1589
|
+
declare class SkyViewkeeperHostOptions implements SkyViewkeeperOptions {
|
1590
|
+
boundaryEl?: HTMLElement;
|
1591
|
+
el?: HTMLElement;
|
1592
|
+
scrollableHost?: HTMLElement;
|
1593
|
+
setWidth?: boolean;
|
1594
|
+
verticalOffset?: number;
|
1595
|
+
verticalOffsetEl?: HTMLElement;
|
1596
|
+
viewportMarginTop?: number;
|
1597
|
+
viewportMarginProperty?: `--${string}`;
|
1598
|
+
static ɵfac: i0.ɵɵFactoryDeclaration<SkyViewkeeperHostOptions, never>;
|
1599
|
+
static ɵprov: i0.ɵɵInjectableDeclaration<SkyViewkeeperHostOptions>;
|
1600
|
+
}
|
1601
|
+
|
1602
|
+
/**
|
1603
|
+
* Provides methods for creating and destroying viewkeeper instances.
|
1604
|
+
*/
|
1605
|
+
declare class SkyViewkeeperService {
|
1606
|
+
#private;
|
1607
|
+
constructor(hostOptions?: SkyViewkeeperHostOptions);
|
1608
|
+
/**
|
1609
|
+
*
|
1610
|
+
* @param options Creates a viewkeeper instance, applying host options where applicable.
|
1611
|
+
*/
|
1612
|
+
create(options: SkyViewkeeperOptions): SkyViewkeeper;
|
1613
|
+
/**
|
1614
|
+
* Destroys a viewkeeper instance.
|
1615
|
+
* @param vk Viewkeeper instance to destroy.
|
1616
|
+
*/
|
1617
|
+
destroy(vk: SkyViewkeeper): void;
|
1618
|
+
static ɵfac: i0.ɵɵFactoryDeclaration<SkyViewkeeperService, [{ optional: true; }]>;
|
1619
|
+
static ɵprov: i0.ɵɵInjectableDeclaration<SkyViewkeeperService>;
|
1620
|
+
}
|
1621
|
+
|
1622
|
+
declare class SkyViewkeeperDirective implements OnInit, OnDestroy, AfterViewInit {
|
1623
|
+
#private;
|
1624
|
+
set skyViewkeeper(value: string[] | undefined);
|
1625
|
+
get skyViewkeeper(): string[] | undefined;
|
1626
|
+
skyViewkeeperOmitShadow: string | undefined;
|
1627
|
+
constructor(el: ElementRef, mutationObserverSvc: SkyMutationObserverService, viewkeeperSvc: SkyViewkeeperService, scrollableHostSvc?: SkyScrollableHostService);
|
1628
|
+
ngOnInit(): void;
|
1629
|
+
ngOnDestroy(): void;
|
1630
|
+
ngAfterViewInit(): void;
|
1631
|
+
static ɵfac: i0.ɵɵFactoryDeclaration<SkyViewkeeperDirective, [null, null, null, { optional: true; }]>;
|
1632
|
+
static ɵdir: i0.ɵɵDirectiveDeclaration<SkyViewkeeperDirective, "[skyViewkeeper]", never, { "skyViewkeeper": { "alias": "skyViewkeeper"; "required": false; }; "skyViewkeeperOmitShadow": { "alias": "skyViewkeeperOmitShadow"; "required": false; }; }, {}, never, never, false, never>;
|
1633
|
+
}
|
1634
|
+
|
1635
|
+
declare class SkyViewkeeperModule {
|
1636
|
+
static ɵfac: i0.ɵɵFactoryDeclaration<SkyViewkeeperModule, never>;
|
1637
|
+
static ɵmod: i0.ɵɵNgModuleDeclaration<SkyViewkeeperModule, [typeof SkyViewkeeperDirective], never, [typeof SkyViewkeeperDirective]>;
|
1638
|
+
static ɵinj: i0.ɵɵInjectorDeclaration<SkyViewkeeperModule>;
|
1639
|
+
}
|
1640
|
+
|
1641
|
+
/**
|
1642
|
+
* Represents the version of a package.
|
1643
|
+
* @internal
|
1644
|
+
*/
|
1645
|
+
declare class Version {
|
1646
|
+
readonly full: string;
|
1647
|
+
readonly major: string;
|
1648
|
+
readonly minor: string;
|
1649
|
+
readonly patch: string;
|
1650
|
+
constructor(full: string);
|
1651
|
+
}
|
1652
|
+
/**
|
1653
|
+
* Represents the version of @skyux/core.
|
1654
|
+
*/
|
1655
|
+
declare const VERSION: Version;
|
1656
|
+
|
1657
|
+
export { NumericOptions, SKY_BREAKPOINTS, SKY_BREAKPOINT_OBSERVER, SKY_HELP_GLOBAL_OPTIONS, SKY_LOG_LEVEL, SKY_STACKING_CONTEXT, SkyAffixAutoFitContext, SkyAffixModule, SkyAffixService, SkyAffixer, SkyAppFormat, SkyAppTitleService, SkyAppWindowRef, SkyContainerBreakpointObserver, SkyContentInfoProvider, SkyCoreAdapterModule, SkyCoreAdapterService, SkyDefaultInputProvider, SkyDockItem, SkyDockLocation, SkyDockModule, SkyDockService, SkyDynamicComponentLegacyService, SkyDynamicComponentLocation, SkyDynamicComponentModule, SkyDynamicComponentService, SkyFileReaderService, SkyHelpService, SkyIdModule, SkyIdService, SkyLayoutHostDirective, SkyLayoutHostService, SkyLiveAnnouncerService, SkyLogLevel, SkyLogModule, SkyLogService, SkyMediaBreakpointObserver, SkyMediaBreakpoints, SkyMediaQueryModule, SkyMediaQueryService, SkyMutationObserverService, SkyNumericModule, SkyNumericPipe, SkyNumericService, SkyOverlayInstance, SkyOverlayLegacyService, SkyOverlayModule, SkyOverlayService, SkyPercentPipe, SkyPercentPipeModule, SkyResizeObserverMediaQueryService, SkyResizeObserverService, SkyResponsiveHostDirective, SkyScreenReaderLabelDirective, SkyScrollShadowDirective, SkyScrollableHostService, SkyTrimModule, SkyUIConfigService, SkyViewkeeper, SkyViewkeeperHostOptions, SkyViewkeeperModule, SkyViewkeeperService, VERSION, provideSkyBreakpointObserver, SkyAffixDirective as λ1, SkyIdDirective as λ2, SkyViewkeeperDirective as λ3, SkyTrimDirective as λ4 };
|
1658
|
+
export type { SkyAffixConfig, SkyAffixHorizontalAlignment, SkyAffixOffset, SkyAffixOffsetChange, SkyAffixPlacement, SkyAffixPlacementChange, SkyAffixPosition, SkyAffixVerticalAlignment, SkyAppSetTitleArgs, SkyBreakpoint, SkyBreakpointObserver, SkyContentInfo, SkyContentInfoDescriptor, SkyDockInsertComponentConfig, SkyDockItemConfig, SkyDockOptions, SkyDynamicComponentOptions, SkyFocusableChildrenOptions, SkyHelpGlobalOptions, SkyHelpOpenArgs, SkyHelpUpdateArgs, SkyLayoutHostForChildArgs, SkyLiveAnnouncerArgs, SkyLiveAnnouncerPoliteness, SkyMediaQueryListener, SkyNumericOptions, SkyNumericSymbol, SkyOverlayConfig, SkyOverlayPosition, SkyScrollShadowEventArgs, SkyStackingContext, SkyViewkeeperOptions };
|