@skyux/core 6.0.0-beta.0 → 6.0.0-beta.11

package/index.d.ts

@@ -27,6 +27,8 @@ export * from './lib/modules/format/app-format';
 export * from './lib/modules/id/id.module';
 export * from './lib/modules/log/log.module';
 export * from './lib/modules/log/log.service';
+export * from './lib/modules/log/types/log-level';
+export * from './lib/modules/log/types/log-level-token';
 export * from './lib/modules/media-query/media-breakpoints';
 export * from './lib/modules/media-query/media-query-listener';
 export * from './lib/modules/media-query/media-query.module';
@@ -43,6 +45,8 @@ export * from './lib/modules/overlay/overlay.module';
 export * from './lib/modules/overlay/overlay.service';
 export * from './lib/modules/percent-pipe/percent-pipe.module';
 export * from './lib/modules/percent-pipe/percent.pipe';
+export * from './lib/modules/resize-observer/resize-observer.service';
+export * from './lib/modules/resize-observer/resize-observer-media-query.service';
 export * from './lib/modules/scrollable-host/scrollable-host.service';
 export * from './lib/modules/title/set-title-args';
 export * from './lib/modules/title/title.service';

package/lib/modules/log/log.service.d.ts

@@ -1,9 +1,43 @@
+import { SkyAppFormat } from '../format/app-format';
+import { SkyLogDeprecatedArgs } from './types/log-deprecation-args';
+import { SkyLogLevel } from './types/log-level';
 import * as i0 from "@angular/core";
 /**
- * @deprecated The `SkyLogService` will be removed in the next major version of `@skyux/core`.
+ * Logs information to the console based on the application's log level as provided by the `SKY_LOG_LEVEL` injection token. If no token is provided, only `error` logs will be shown.
+ * @internal
  */
 export declare class SkyLogService {
-    warn(message?: any, ...optionalParams: any[]): void;
-    static ɵfac: i0.ɵɵFactoryDeclaration<SkyLogService, never>;
+    private formatter;
+    private applicationLogLevel;
+    constructor(formatter: SkyAppFormat, applicationLogLevel: SkyLogLevel);
+    /**
+     * Logs a deprecation warning for a class, property, function, etc. This will be logged as a console warning unless a different log level is given in the the `args` parameter.
+     * @param name The name of the deprecated class, property, function, etc.
+     * @param args Information about the deprecation and replacement recommendations.
+     * @returns
+     */
+    deprecated(name: string, args?: SkyLogDeprecatedArgs): Promise<void>;
+    /**
+     * Logs a console error if the application's log level is `SkyLogLevel.Error`.
+     * @param message The error message
+     * @param params Optional parameters for the error message.
+     */
+    error(message: string, params?: unknown[]): void;
+    /**
+     * Logs console information if the application's log level is `SkyLogLevel.Info` or above.
+     * @param message The infomational message
+     * @param params Optional parameters for the informational message.
+     */
+    info(message: string, params?: unknown[]): void;
+    /**
+     * Logs a console warning if the application's log level is `SkyLogLevel.Warn` or above.
+     * @param message The warning message
+     * @param params Optional parameters for the warning message.
+     */
+    warn(message: string, params?: unknown[]): void;
+    private convertStringToCode;
+    private canLog;
+    private logBasedOnLevel;
+    static ɵfac: i0.ɵɵFactoryDeclaration<SkyLogService, [null, { optional: true; }]>;
     static ɵprov: i0.ɵɵInjectableDeclaration<SkyLogService>;
 }

package/lib/modules/log/types/log-deprecation-args.d.ts

@@ -0,0 +1,27 @@
+import { SkyLogLevel } from './log-level';
+/**
+ * @internal
+ * Arguments used when logging that a class, property, function, etc. is depcrecated.
+ */
+export interface SkyLogDeprecatedArgs {
+    /**
+     * The major version which deprecated the feature.
+     */
+    deprecationMajorVersion?: number;
+    /**
+     * The log level for the console logging. The `SkyLogService` will assume `SkyLogLevel.Warn` if this is not provided.
+     */
+    logLevel?: SkyLogLevel;
+    /**
+     * A URL which gives more information about the deprecation or the replacement recommendation.
+     */
+    moreInfoUrl?: string;
+    /**
+     * The major version which will remove the deprecated feature.
+     */
+    removalMajorVersion?: number;
+    /**
+     * The recommendation for how to replace the deprecated feature.
+     */
+    replacementRecommendation?: string;
+}

package/lib/modules/log/types/log-level-token.d.ts

@@ -0,0 +1,6 @@
+import { InjectionToken } from '@angular/core';
+import { SkyLogLevel } from './log-level';
+/**
+ * @internal
+ */
+export declare const SKY_LOG_LEVEL: InjectionToken<SkyLogLevel>;

package/lib/modules/log/types/log-level.d.ts

@@ -0,0 +1,8 @@
+/**
+ * @internal
+ */
+export declare const enum SkyLogLevel {
+    Info = 1,
+    Warn = 2,
+    Error = 3
+}

package/lib/modules/media-query/media-query-listener.d.ts

@@ -1,6 +1,6 @@
 import { SkyMediaBreakpoints } from './media-breakpoints';
 /**
- * Specifies a funciton that is called when the breakpoints change. It is called
+ * Specifies a function that is called when the breakpoints change. It is called
  * with a `SkyMediaBreakpoints` argument, which is an enum that represents the new breakpoint.
  */
 export declare type SkyMediaQueryListener = (args: SkyMediaBreakpoints) => void;

package/lib/modules/media-query/media-query.service.d.ts

@@ -36,7 +36,7 @@ export declare class SkyMediaQueryService implements OnDestroy {
     constructor(zone: NgZone);
     ngOnDestroy(): void;
     /**
-     * Suscribes to screen size changes.
+     * Subscribes to screen size changes.
      * @param listener Specifies a function that is called when breakpoints change.
      */
     subscribe(listener: SkyMediaQueryListener): Subscription;

package/lib/modules/numeric/numeric.options.d.ts

@@ -1,27 +1,21 @@
 /**
  * Provides arguments for the number to format.
  */
-export declare class NumericOptions {
+export interface SkyNumericOptions {
     /**
      * Specifies the maximum number of digits after the decimal separator.
-     * @default 1
      */
     digits?: number;
     /**
      * Specifies how to format the number. Options are `currency` or `number`.
-     * @default "number"
      */
     format?: string;
     /**
      * Specifies the format of the currency.
-     * @default "standard"
      */
     currencySign?: 'accounting' | 'standard';
     /**
-     * Specifies the ISO4217 currency code to use for currency formatting. If you do not specify a
-     * currency code, the component uses the browser's culture to determine the currency unless your
-     * SPA provides a different culture with `SkyAppLocaleProvider`.
-     * @default "USD"
+     * Specifies the ISO4217 currency code to use for currency formatting.
      */
     iso?: string;
     /**
@@ -40,9 +34,21 @@ export declare class NumericOptions {
      */
     truncate?: boolean;
     /**
-     * Specifies the starting point after which numbers are shortened to rounded numbers
-     * and abbreviation characters.
-     * @default 0
+     * Specifies the minimum value at which numbers are shortened to rounded numbers and abbreviation characters. Values less than `1000` are not truncated.
      */
     truncateAfter?: number;
 }
+/**
+ * Provides arguments for the number to format.
+ * @deprecated Use the `SkyNumericOptions` interface instead.
+ */
+export declare class NumericOptions implements SkyNumericOptions {
+    digits?: number;
+    format?: string;
+    currencySign?: 'accounting' | 'standard';
+    iso?: string;
+    locale?: string;
+    minDigits?: number;
+    truncate?: boolean;
+    truncateAfter?: number;
+}

package/lib/modules/numeric/numeric.pipe.d.ts

@@ -1,6 +1,6 @@
 import { ChangeDetectorRef, OnDestroy, PipeTransform } from '@angular/core';
 import { SkyAppLocaleProvider } from '@skyux/i18n';
-import { NumericOptions } from './numeric.options';
+import { SkyNumericOptions } from './numeric.options';
 import { SkyNumericService } from './numeric.service';
 import * as i0 from "@angular/core";
 /**
@@ -19,13 +19,11 @@ export declare class SkyNumericPipe implements PipeTransform, OnDestroy {
     private changeDetector;
     private cacheKey;
     private formattedValue;
-    private lastTransformLocale;
-    private rawValue;
     private providerLocale;
     private ngUnsubscribe;
     constructor(localeProvider: SkyAppLocaleProvider, numericService: SkyNumericService, changeDetector: ChangeDetectorRef);
     ngOnDestroy(): void;
-    transform(value: number, config?: NumericOptions): string;
+    transform(value: number, config?: SkyNumericOptions): string;
     static ɵfac: i0.ɵɵFactoryDeclaration<SkyNumericPipe, never>;
     static ɵpipe: i0.ɵɵPipeDeclaration<SkyNumericPipe, "skyNumeric">;
 }

package/lib/modules/numeric/numeric.service.d.ts

@@ -1,5 +1,5 @@
 import { SkyLibResourcesService } from '@skyux/i18n';
-import { NumericOptions } from './numeric.options';
+import { SkyNumericOptions } from './numeric.options';
 import * as i0 from "@angular/core";
 export declare class SkyNumericService {
     private resourcesService;
@@ -21,7 +21,7 @@ export declare class SkyNumericService {
      * @param value The number to format.
      * @param options Format options.
      */
-    formatNumber(value: number, options: NumericOptions): string;
+    formatNumber(value: number, options: SkyNumericOptions): string;
     /**
      * Rounds a given number
      *

package/lib/modules/resize-observer/resize-observer-media-query.service.d.ts

@@ -0,0 +1,44 @@
+import { ElementRef, OnDestroy } from '@angular/core';
+import { Subscription } from 'rxjs';
+import { SkyMediaBreakpoints } from '../media-query/media-breakpoints';
+import { SkyMediaQueryListener } from '../media-query/media-query-listener';
+import { SkyResizeObserverService } from './resize-observer.service';
+import * as i0 from "@angular/core";
+/**
+ * Acts like `SkyMediaQueryService` for a container element, emitting the same responsive breakpoints.
+ */
+export declare class SkyResizeObserverMediaQueryService implements OnDestroy {
+    private resizeObserverService;
+    /**
+     * Returns the current breakpoint.
+     */
+    get current(): SkyMediaBreakpoints | undefined;
+    private _breakpoints;
+    private _currentBreakpointObservable;
+    private _currentBreakpoint;
+    private _stopListening;
+    private _target?;
+    constructor(resizeObserverService: SkyResizeObserverService);
+    ngOnDestroy(): void;
+    /**
+     * @internal
+     */
+    destroy(): void;
+    /**
+     * Sets the container element to watch. The `SkyResizeObserverMediaQueryService` will only observe one element at a
+     * time. Any previous subscriptions will be unsubscribed when a new element is observed.
+     */
+    observe(element: ElementRef): SkyResizeObserverMediaQueryService;
+    /**
+     * Stop watching the container element.
+     */
+    unobserve(): void;
+    /**
+     * Subscribes to element size changes that cross breakpoints.
+     */
+    subscribe(listener: SkyMediaQueryListener): Subscription;
+    private updateBreakpoint;
+    private checkBreakpoint;
+    static ɵfac: i0.ɵɵFactoryDeclaration<SkyResizeObserverMediaQueryService, never>;
+    static ɵprov: i0.ɵɵInjectableDeclaration<SkyResizeObserverMediaQueryService>;
+}

package/lib/modules/resize-observer/resize-observer.service.d.ts

@@ -0,0 +1,21 @@
+import { ElementRef, NgZone, OnDestroy } from '@angular/core';
+import { Observable } from 'rxjs';
+import * as i0 from "@angular/core";
+/**
+ * Service to create rxjs observables for changes to the content box dimensions of elements.
+ */
+export declare class SkyResizeObserverService implements OnDestroy {
+    private zone;
+    private _resizeObserver;
+    private _tracking;
+    constructor(zone: NgZone);
+    ngOnDestroy(): void;
+    /**
+     * Create rxjs observable to get size changes for an element ref.
+     */
+    observe(element: ElementRef): Observable<ResizeObserverEntry>;
+    private observeAndTrack;
+    private callback;
+    static ɵfac: i0.ɵɵFactoryDeclaration<SkyResizeObserverService, never>;
+    static ɵprov: i0.ɵɵInjectableDeclaration<SkyResizeObserverService>;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@skyux/core",
-  "version": "6.0.0-beta.0",
+  "version": "6.0.0-beta.11",
   "author": "Blackbaud, Inc.",
   "keywords": [
     "blackbaud",
@@ -15,22 +15,6 @@
     "url": "https://github.com/blackbaud/skyux/issues"
   },
   "homepage": "https://github.com/blackbaud/skyux#readme",
-  "peerDependencies": {
-    "@angular/common": "^13.2.7",
-    "@angular/core": "^13.2.7",
-    "@angular/platform-browser": "^13.2.7",
-    "@angular/router": "^13.2.7",
-    "@skyux/i18n": "6.0.0-beta.0"
-  },
-  "dependencies": {
-    "tslib": "^2.3.1"
-  },
-  "module": "fesm2015/skyux-core.mjs",
-  "es2020": "fesm2020/skyux-core.mjs",
-  "esm2020": "esm2020/skyux-core.mjs",
-  "fesm2020": "fesm2020/skyux-core.mjs",
-  "fesm2015": "fesm2015/skyux-core.mjs",
-  "typings": "skyux-core.d.ts",
   "exports": {
     "./package.json": {
       "default": "./package.json"
@@ -50,7 +34,26 @@
       "es2015": "./fesm2015/skyux-core-testing.mjs",
       "node": "./fesm2015/skyux-core-testing.mjs",
       "default": "./fesm2020/skyux-core-testing.mjs"
+    },
+    "./documentation.json": {
+      "default": "./documentation.json"
     }
   },
+  "peerDependencies": {
+    "@angular/common": "^13.3.2",
+    "@angular/core": "^13.3.2",
+    "@angular/platform-browser": "^13.3.2",
+    "@angular/router": "^13.3.2",
+    "@skyux/i18n": "6.0.0-beta.11"
+  },
+  "dependencies": {
+    "tslib": "^2.3.1"
+  },
+  "module": "fesm2015/skyux-core.mjs",
+  "es2020": "fesm2020/skyux-core.mjs",
+  "esm2020": "esm2020/skyux-core.mjs",
+  "fesm2020": "fesm2020/skyux-core.mjs",
+  "fesm2015": "fesm2015/skyux-core.mjs",
+  "typings": "skyux-core.d.ts",
   "sideEffects": false
-}
+}