@skyux/core 9.5.0 → 9.6.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/index.d.ts CHANGED
@@ -15,6 +15,7 @@ export { SkyAffixService } from './lib/modules/affix/affix.service';
15
15
  export { SkyAffixer } from './lib/modules/affix/affixer';
16
16
  export { SkyContentInfoProvider } from './lib/modules/content-info-provider/content-info-provider';
17
17
  export { SkyContentInfo } from './lib/modules/content-info-provider/content-info';
18
+ export { SkyContentInfoDescriptor } from './lib/modules/content-info-provider/content-info-descriptor';
18
19
  export { SkyDefaultInputProvider } from './lib/modules/default-input-provider/default-input-provider';
19
20
  export { SkyDockInsertComponentConfig } from './lib/modules/dock/dock-insert-component-config';
20
21
  export { SkyDockItem } from './lib/modules/dock/dock-item';
@@ -58,6 +59,7 @@ export { SkyPercentPipeModule } from './lib/modules/percent-pipe/percent-pipe.mo
58
59
  export { SkyPercentPipe } from './lib/modules/percent-pipe/percent.pipe';
59
60
  export { SkyResizeObserverService } from './lib/modules/resize-observer/resize-observer.service';
60
61
  export { SkyResizeObserverMediaQueryService } from './lib/modules/resize-observer/resize-observer-media-query.service';
62
+ export { SkyScreenReaderLabelDirective } from './lib/modules/screen-reader-label/screen-reader-label.directive';
61
63
  export { SkyScrollableHostService } from './lib/modules/scrollable-host/scrollable-host.service';
62
64
  export { SkyStackingContext } from './lib/modules/stacking-context/stacking-context';
63
65
  export { SKY_STACKING_CONTEXT } from './lib/modules/stacking-context/stacking-context-token';
@@ -0,0 +1,16 @@
1
+ /**
2
+ * Text or an element that describes the content a consumer renders in a component.
3
+ *
4
+ * @internal
5
+ */
6
+ export type SkyContentInfoDescriptor = {
7
+ /**
8
+ * A descriptor of type `text` is an already localized string that describes a parent's content, i.e. constituent.
9
+ * 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.
10
+ */
11
+ type: 'text' | 'elementId';
12
+ /**
13
+ * A value of the given type.
14
+ */
15
+ value: string;
16
+ };
@@ -1,3 +1,13 @@
1
+ import { SkyContentInfoDescriptor } from './content-info-descriptor';
2
+ /**
3
+ * Information about the content a consumer is rendering within a component.
4
+ *
5
+ * @internal
6
+ */
1
7
  export type SkyContentInfo = {
2
- descriptor?: string;
8
+ /**
9
+ * Information that describes the content within a parent component a consumer has rendered, i.e. "constituents".
10
+ * Provided as localized text or an element ID pointing to text that is the descriptor.
11
+ */
12
+ descriptor?: SkyContentInfoDescriptor;
3
13
  };
@@ -2,7 +2,6 @@ import { ElementRef, OnDestroy } from '@angular/core';
2
2
  import { Subscription } from 'rxjs';
3
3
  import { SkyMediaBreakpoints } from '../media-query/media-breakpoints';
4
4
  import { SkyMediaQueryListener } from '../media-query/media-query-listener';
5
- import { SkyResizeObserverService } from './resize-observer.service';
6
5
  import * as i0 from "@angular/core";
7
6
  /**
8
7
  * Acts like `SkyMediaQueryService` for a container element, emitting the same responsive breakpoints.
@@ -13,7 +12,6 @@ export declare class SkyResizeObserverMediaQueryService implements OnDestroy {
13
12
  * Returns the current breakpoint.
14
13
  */
15
14
  get current(): SkyMediaBreakpoints;
16
- constructor(resizeObserverSvc: SkyResizeObserverService);
17
15
  ngOnDestroy(): void;
18
16
  /**
19
17
  * @internal
@@ -1,4 +1,4 @@
1
- import { ElementRef, NgZone, OnDestroy } from '@angular/core';
1
+ import { ElementRef, OnDestroy } from '@angular/core';
2
2
  import { Observable } from 'rxjs';
3
3
  import * as i0 from "@angular/core";
4
4
  /**
@@ -6,7 +6,6 @@ import * as i0 from "@angular/core";
6
6
  */
7
7
  export declare class SkyResizeObserverService implements OnDestroy {
8
8
  #private;
9
- constructor(zone: NgZone);
10
9
  ngOnDestroy(): void;
11
10
  /**
12
11
  * Create rxjs observable to get size changes for an element ref.
@@ -0,0 +1,20 @@
1
+ import { OnDestroy } from '@angular/core';
2
+ import * as i0 from "@angular/core";
3
+ /**
4
+ * Adds the element to a screen reader only section of the body.
5
+ * This prevents components' DOM from including text only intended for screen readers.
6
+ *
7
+ * @internal
8
+ */
9
+ export declare class SkyScreenReaderLabelDirective implements OnDestroy {
10
+ #private;
11
+ ngOnDestroy(): void;
12
+ /**
13
+ * Indicates if the label should be created in the DOM.
14
+ * @default false
15
+ */
16
+ set createLabel(value: boolean | undefined);
17
+ get createLabel(): boolean;
18
+ static ɵfac: i0.ɵɵFactoryDeclaration<SkyScreenReaderLabelDirective, never>;
19
+ static ɵdir: i0.ɵɵDirectiveDeclaration<SkyScreenReaderLabelDirective, "[skyScreenReaderLabel]", never, { "createLabel": { "alias": "createLabel"; "required": false; }; }, {}, never, never, true, never>;
20
+ }
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@skyux/core",
3
- "version": "9.5.0",
3
+ "version": "9.6.0",
4
4
  "author": "Blackbaud, Inc.",
5
5
  "keywords": [
6
6
  "blackbaud",
@@ -41,7 +41,7 @@
41
41
  "@angular/core": "^16.2.5",
42
42
  "@angular/platform-browser": "^16.2.5",
43
43
  "@angular/router": "^16.2.5",
44
- "@skyux/i18n": "9.5.0"
44
+ "@skyux/i18n": "9.6.0"
45
45
  },
46
46
  "dependencies": {
47
47
  "tslib": "^2.6.2"