@skyux/forms 15.0.0-alpha.1 → 15.0.0-alpha.10
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-forms-testing.mjs +115 -31
- package/fesm2022/skyux-forms-testing.mjs.map +1 -1
- package/fesm2022/skyux-forms.mjs +256 -276
- package/fesm2022/skyux-forms.mjs.map +1 -1
- package/package.json +13 -19
- package/types/skyux-forms-testing.d.ts +26 -0
- package/types/skyux-forms.d.ts +41 -52
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@skyux/forms",
|
|
3
|
-
"version": "15.0.0-alpha.
|
|
3
|
+
"version": "15.0.0-alpha.10",
|
|
4
4
|
"author": "Blackbaud, Inc.",
|
|
5
5
|
"keywords": [
|
|
6
6
|
"blackbaud",
|
|
@@ -16,28 +16,22 @@
|
|
|
16
16
|
},
|
|
17
17
|
"homepage": "https://github.com/blackbaud/skyux#readme",
|
|
18
18
|
"peerDependencies": {
|
|
19
|
-
"@angular/cdk": "^22.
|
|
20
|
-
"@angular/common": "^22.
|
|
21
|
-
"@angular/core": "^22.
|
|
22
|
-
"@angular/forms": "^22.
|
|
23
|
-
"@angular/platform-browser": "^22.
|
|
24
|
-
"@skyux
|
|
25
|
-
"@skyux/
|
|
26
|
-
"@skyux/
|
|
27
|
-
"@skyux/
|
|
28
|
-
"@skyux/
|
|
29
|
-
"@skyux/
|
|
30
|
-
"@skyux/
|
|
31
|
-
"@skyux/theme": "15.0.0-alpha.1"
|
|
19
|
+
"@angular/cdk": "^22.1.2",
|
|
20
|
+
"@angular/common": "^22.1.2",
|
|
21
|
+
"@angular/core": "^22.1.2",
|
|
22
|
+
"@angular/forms": "^22.1.2",
|
|
23
|
+
"@angular/platform-browser": "^22.1.2",
|
|
24
|
+
"@skyux/core": "15.0.0-alpha.10",
|
|
25
|
+
"@skyux/help-inline": "15.0.0-alpha.10",
|
|
26
|
+
"@skyux/i18n": "15.0.0-alpha.10",
|
|
27
|
+
"@skyux/icon": "15.0.0-alpha.10",
|
|
28
|
+
"@skyux/indicators": "15.0.0-alpha.10",
|
|
29
|
+
"@skyux/popovers": "15.0.0-alpha.10",
|
|
30
|
+
"@skyux/theme": "15.0.0-alpha.10"
|
|
32
31
|
},
|
|
33
32
|
"dependencies": {
|
|
34
33
|
"tslib": "^2.8.1"
|
|
35
34
|
},
|
|
36
|
-
"peerDependenciesMeta": {
|
|
37
|
-
"@skyux-sdk/testing": {
|
|
38
|
-
"optional": true
|
|
39
|
-
}
|
|
40
|
-
},
|
|
41
35
|
"sideEffects": false,
|
|
42
36
|
"module": "fesm2022/skyux-forms.mjs",
|
|
43
37
|
"typings": "types/skyux-forms.d.ts",
|
|
@@ -9,12 +9,18 @@ import { SkyIconHarness } from '@skyux/icon/testing';
|
|
|
9
9
|
|
|
10
10
|
/**
|
|
11
11
|
* A set of criteria that can be used to filter a list of SkyCharacterCounterIndicatorHarness instances.
|
|
12
|
+
*
|
|
13
|
+
* @deprecated Use `SkyInputBoxHarnessFilters` with an input box that sets the
|
|
14
|
+
* `characterLimit` input instead.
|
|
12
15
|
*/
|
|
13
16
|
interface SkyCharacterCounterIndicatorHarnessFilters extends SkyHarnessFilters {
|
|
14
17
|
}
|
|
15
18
|
|
|
16
19
|
/**
|
|
17
20
|
* Harness for interacting with a character counter indicator component in tests.
|
|
21
|
+
*
|
|
22
|
+
* @deprecated Use `SkyInputBoxHarness` with an input box that sets the
|
|
23
|
+
* `characterLimit` input instead.
|
|
18
24
|
*/
|
|
19
25
|
declare class SkyCharacterCounterIndicatorHarness extends SkyComponentHarness {
|
|
20
26
|
#private;
|
|
@@ -100,8 +106,28 @@ declare class SkyInputBoxHarness extends SkyQueryableComponentHarness {
|
|
|
100
106
|
/**
|
|
101
107
|
* Gets the character counter indicator for the input box or throws an error if
|
|
102
108
|
* a character limit is not specified.
|
|
109
|
+
*
|
|
110
|
+
* @deprecated Use `getCharacterCount()`, `getCharacterLimit()`, and
|
|
111
|
+
* `isOverCharacterLimit()` instead. Those methods require the `characterLimit`
|
|
112
|
+
* input, so an input box that projects a `sky-character-counter-indicator` component
|
|
113
|
+
* must migrate to that input first.
|
|
103
114
|
*/
|
|
104
115
|
getCharacterCounter(): Promise<SkyCharacterCounterIndicatorHarness>;
|
|
116
|
+
/**
|
|
117
|
+
* Gets the current character count, or throws an error if the input box does
|
|
118
|
+
* not set the `characterLimit` input.
|
|
119
|
+
*/
|
|
120
|
+
getCharacterCount(): Promise<number>;
|
|
121
|
+
/**
|
|
122
|
+
* Gets the character limit, or throws an error if the input box does not set
|
|
123
|
+
* the `characterLimit` input.
|
|
124
|
+
*/
|
|
125
|
+
getCharacterLimit(): Promise<number>;
|
|
126
|
+
/**
|
|
127
|
+
* Whether the character count has exceeded the character limit. Throws an
|
|
128
|
+
* error if the input box does not set the `characterLimit` input.
|
|
129
|
+
*/
|
|
130
|
+
isOverCharacterLimit(): Promise<boolean>;
|
|
105
131
|
/**
|
|
106
132
|
* Gets a list of status indicator harnesses for errors not automatically
|
|
107
133
|
* handled by input box.
|
package/types/skyux-forms.d.ts
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import * as i0 from '@angular/core';
|
|
2
|
-
import { PipeTransform, AfterViewInit, TemplateRef, EventEmitter, ElementRef,
|
|
2
|
+
import { PipeTransform, AfterViewInit, TemplateRef, EventEmitter, ElementRef, OnInit, OnDestroy, DoCheck, AfterContentChecked, AfterContentInit, QueryList, InjectionToken } from '@angular/core';
|
|
3
3
|
import * as i4$1 from '@angular/forms';
|
|
4
4
|
import { Validator, AbstractControl, ValidationErrors, ControlValueAccessor, FormGroup, NgControl, FormControlDirective, FormControlName, NgModel, AbstractControlDirective } from '@angular/forms';
|
|
5
5
|
import * as i4 from '@angular/common';
|
|
@@ -11,6 +11,10 @@ import * as i11 from '@skyux/icon';
|
|
|
11
11
|
import * as i12 from '@skyux/core';
|
|
12
12
|
import { NumberInput, BooleanInput } from '@angular/cdk/coercion';
|
|
13
13
|
|
|
14
|
+
/**
|
|
15
|
+
* @deprecated Use [input box](https://developer.blackbaud.com/skyux/components/input-box)
|
|
16
|
+
* with its `characterLimit` input instead.
|
|
17
|
+
*/
|
|
14
18
|
declare class SkyCharacterCounterIndicatorComponent {
|
|
15
19
|
#private;
|
|
16
20
|
get characterCount(): number;
|
|
@@ -26,6 +30,8 @@ declare class SkyCharacterCounterIndicatorComponent {
|
|
|
26
30
|
* an `input` or `textarea` element. If users enter more characters than allowed, then the
|
|
27
31
|
* input field is invalid and the component displays an error indicator.
|
|
28
32
|
* @required
|
|
33
|
+
* @deprecated Use [input box](https://developer.blackbaud.com/skyux/components/input-box)
|
|
34
|
+
* with its `characterLimit` input instead.
|
|
29
35
|
*/
|
|
30
36
|
declare class SkyCharacterCounterInputDirective implements Validator {
|
|
31
37
|
#private;
|
|
@@ -48,6 +54,10 @@ declare class SkyCharacterCounterInputDirective implements Validator {
|
|
|
48
54
|
static ɵdir: i0.ɵɵDirectiveDeclaration<SkyCharacterCounterInputDirective, "[skyCharacterCounter]", never, { "skyCharacterCounterIndicator": { "alias": "skyCharacterCounterIndicator"; "required": false; }; "skyCharacterCounterLimit": { "alias": "skyCharacterCounterLimit"; "required": false; }; }, {}, never, never, false, never>;
|
|
49
55
|
}
|
|
50
56
|
|
|
57
|
+
/**
|
|
58
|
+
* @deprecated Use [input box](https://developer.blackbaud.com/skyux/components/input-box)
|
|
59
|
+
* with its `characterLimit` input instead.
|
|
60
|
+
*/
|
|
51
61
|
declare class SkyCharacterCounterScreenReaderPipe implements PipeTransform {
|
|
52
62
|
#private;
|
|
53
63
|
transform(characterCount: number | undefined, characterCountLimit: number | undefined): string;
|
|
@@ -64,6 +74,10 @@ declare class SkyFormsResourcesModule {
|
|
|
64
74
|
static ɵinj: i0.ɵɵInjectorDeclaration<SkyFormsResourcesModule>;
|
|
65
75
|
}
|
|
66
76
|
|
|
77
|
+
/**
|
|
78
|
+
* @deprecated Use [input box](https://developer.blackbaud.com/skyux/components/input-box)
|
|
79
|
+
* with its `characterLimit` input instead.
|
|
80
|
+
*/
|
|
67
81
|
declare class SkyCharacterCounterModule {
|
|
68
82
|
static ɵfac: i0.ɵɵFactoryDeclaration<SkyCharacterCounterModule, never>;
|
|
69
83
|
static ɵmod: i0.ɵɵNgModuleDeclaration<SkyCharacterCounterModule, [typeof SkyCharacterCounterInputDirective, typeof SkyCharacterCounterIndicatorComponent], [typeof i4.CommonModule, typeof i4$1.FormsModule, typeof i4$1.ReactiveFormsModule, typeof SkyCharacterCounterScreenReaderPipe, typeof SkyFormsResourcesModule], [typeof SkyCharacterCounterInputDirective, typeof SkyCharacterCounterIndicatorComponent]>;
|
|
@@ -548,27 +562,10 @@ interface SkyFileAttachmentClick {
|
|
|
548
562
|
*/
|
|
549
563
|
type SkyFileValidateFn = (file: SkyFileItem) => string | undefined;
|
|
550
564
|
|
|
551
|
-
/**
|
|
552
|
-
* Displays a label above the file attachment element. To display a help button
|
|
553
|
-
* beside the label, include a help button element, such as `sky-help-inline`,
|
|
554
|
-
* in the `sky-file-attachment-label` element and a `sky-control-help` CSS class
|
|
555
|
-
* on that help button element.
|
|
556
|
-
* @deprecated Use the `labelText` input on the single file attachment component
|
|
557
|
-
* instead.
|
|
558
|
-
*/
|
|
559
|
-
declare class SkyFileAttachmentLabelComponent {
|
|
560
|
-
labelContentId: {
|
|
561
|
-
id: string;
|
|
562
|
-
} | undefined;
|
|
563
|
-
constructor();
|
|
564
|
-
static ɵfac: i0.ɵɵFactoryDeclaration<SkyFileAttachmentLabelComponent, never>;
|
|
565
|
-
static ɵcmp: i0.ɵɵComponentDeclaration<SkyFileAttachmentLabelComponent, "sky-file-attachment-label", never, {}, {}, never, ["*", ".sky-control-help"], true, never>;
|
|
566
|
-
}
|
|
567
|
-
|
|
568
565
|
/**
|
|
569
566
|
* Provides an element to attach a single local file.
|
|
570
567
|
*/
|
|
571
|
-
declare class SkyFileAttachmentComponent implements AfterViewInit,
|
|
568
|
+
declare class SkyFileAttachmentComponent implements AfterViewInit, ControlValueAccessor, OnInit, OnDestroy {
|
|
572
569
|
#private;
|
|
573
570
|
/**
|
|
574
571
|
* The comma-delimited string literal of MIME types that users can attach.
|
|
@@ -649,7 +646,6 @@ declare class SkyFileAttachmentComponent implements AfterViewInit, AfterContentI
|
|
|
649
646
|
*/
|
|
650
647
|
fileClick: EventEmitter<SkyFileAttachmentClick>;
|
|
651
648
|
acceptedOver: boolean;
|
|
652
|
-
hasLabelComponent: boolean;
|
|
653
649
|
rejectedOver: boolean;
|
|
654
650
|
/**
|
|
655
651
|
* Whether the input is required for form validation.
|
|
@@ -666,7 +662,6 @@ declare class SkyFileAttachmentComponent implements AfterViewInit, AfterContentI
|
|
|
666
662
|
showFileAttachmentButton: boolean;
|
|
667
663
|
truncatedFileName: string;
|
|
668
664
|
inputEl: ElementRef | undefined;
|
|
669
|
-
labelComponents: QueryList<SkyFileAttachmentLabelComponent> | undefined;
|
|
670
665
|
isImage: boolean;
|
|
671
666
|
protected get isRequired(): boolean;
|
|
672
667
|
protected readonly ngControl: NgControl | null;
|
|
@@ -678,7 +673,6 @@ declare class SkyFileAttachmentComponent implements AfterViewInit, AfterContentI
|
|
|
678
673
|
constructor();
|
|
679
674
|
ngOnInit(): void;
|
|
680
675
|
ngAfterViewInit(): void;
|
|
681
|
-
ngAfterContentInit(): void;
|
|
682
676
|
onButtonBlur(): void;
|
|
683
677
|
onFileCancel(): void;
|
|
684
678
|
onDropClicked(): void;
|
|
@@ -700,7 +694,7 @@ declare class SkyFileAttachmentComponent implements AfterViewInit, AfterContentI
|
|
|
700
694
|
setDisabledState(isDisabled: boolean): void;
|
|
701
695
|
emitClick(): void;
|
|
702
696
|
static ɵfac: i0.ɵɵFactoryDeclaration<SkyFileAttachmentComponent, never>;
|
|
703
|
-
static ɵcmp: i0.ɵɵComponentDeclaration<SkyFileAttachmentComponent, "sky-file-attachment", never, { "acceptedTypes": { "alias": "acceptedTypes"; "required": false; }; "acceptedTypesErrorMessage": { "alias": "acceptedTypesErrorMessage"; "required": false; }; "disabled": { "alias": "disabled"; "required": false; }; "helpPopoverContent": { "alias": "helpPopoverContent"; "required": false; }; "helpPopoverTitle": { "alias": "helpPopoverTitle"; "required": false; }; "helpKey": { "alias": "helpKey"; "required": false; }; "labelText": { "alias": "labelText"; "required": false; }; "labelHidden": { "alias": "labelHidden"; "required": false; }; "hintText": { "alias": "hintText"; "required": false; }; "maxFileSize": { "alias": "maxFileSize"; "required": false; }; "minFileSize": { "alias": "minFileSize"; "required": false; }; "stacked": { "alias": "stacked"; "required": false; }; "validateFn": { "alias": "validateFn"; "required": false; }; "required": { "alias": "required"; "required": false; }; }, { "fileChange": "fileChange"; "fileClick": "fileClick"; },
|
|
697
|
+
static ɵcmp: i0.ɵɵComponentDeclaration<SkyFileAttachmentComponent, "sky-file-attachment", never, { "acceptedTypes": { "alias": "acceptedTypes"; "required": false; }; "acceptedTypesErrorMessage": { "alias": "acceptedTypesErrorMessage"; "required": false; }; "disabled": { "alias": "disabled"; "required": false; }; "helpPopoverContent": { "alias": "helpPopoverContent"; "required": false; }; "helpPopoverTitle": { "alias": "helpPopoverTitle"; "required": false; }; "helpKey": { "alias": "helpKey"; "required": false; }; "labelText": { "alias": "labelText"; "required": false; }; "labelHidden": { "alias": "labelHidden"; "required": false; }; "hintText": { "alias": "hintText"; "required": false; }; "maxFileSize": { "alias": "maxFileSize"; "required": false; }; "minFileSize": { "alias": "minFileSize"; "required": false; }; "stacked": { "alias": "stacked"; "required": false; }; "validateFn": { "alias": "validateFn"; "required": false; }; "required": { "alias": "required"; "required": false; }; }, { "fileChange": "fileChange"; "fileClick": "fileClick"; }, never, ["sky-form-error"], true, [{ directive: typeof i1$1.SkyThemeComponentClassDirective; inputs: {}; outputs: {}; }]>;
|
|
704
698
|
static ngAcceptInputType_disabled: unknown;
|
|
705
699
|
static ngAcceptInputType_labelHidden: unknown;
|
|
706
700
|
static ngAcceptInputType_stacked: unknown;
|
|
@@ -709,7 +703,7 @@ declare class SkyFileAttachmentComponent implements AfterViewInit, AfterContentI
|
|
|
709
703
|
|
|
710
704
|
declare class SkyFileAttachmentModule {
|
|
711
705
|
static ɵfac: i0.ɵɵFactoryDeclaration<SkyFileAttachmentModule, never>;
|
|
712
|
-
static ɵmod: i0.ɵɵNgModuleDeclaration<SkyFileAttachmentModule, never, [typeof SkyFileAttachmentComponent
|
|
706
|
+
static ɵmod: i0.ɵɵNgModuleDeclaration<SkyFileAttachmentModule, never, [typeof SkyFileAttachmentComponent], [typeof SkyFileAttachmentComponent, typeof SkyFormErrorModule]>;
|
|
713
707
|
static ɵinj: i0.ɵɵInjectorDeclaration<SkyFileAttachmentModule>;
|
|
714
708
|
}
|
|
715
709
|
|
|
@@ -981,13 +975,13 @@ declare class SkyInputBoxComponent implements OnInit, AfterContentChecked, OnDes
|
|
|
981
975
|
*/
|
|
982
976
|
labelText: string | undefined;
|
|
983
977
|
/**
|
|
984
|
-
* The
|
|
985
|
-
*
|
|
986
|
-
*
|
|
987
|
-
*
|
|
988
|
-
*
|
|
989
|
-
* `maxLength`
|
|
990
|
-
*
|
|
978
|
+
* The character limit for the input box. If users exceed the limit, the input box's form control
|
|
979
|
+
* becomes invalid and the property adds [Validators.maxLength](https://angular.dev/api/forms/Validators).
|
|
980
|
+
* The validation error message and screen reader announcement use `labelText`. This property also
|
|
981
|
+
* displays a character count indicator in the top right with the number of characters that users enter,
|
|
982
|
+
* the character limit, and a danger icon if users exceed the limit. If users are unlikely to exceed a
|
|
983
|
+
* character limit, use `Validators.maxLength` directly instead with a `maxLength` attribute on the
|
|
984
|
+
* input element.
|
|
991
985
|
*/
|
|
992
986
|
set characterLimit(value: NumberInput);
|
|
993
987
|
get characterLimit(): number | undefined;
|
|
@@ -1106,6 +1100,16 @@ declare class SkyInputBoxHostService implements OnDestroy {
|
|
|
1106
1100
|
static ɵprov: i0.ɵɵInjectableDeclaration<SkyInputBoxHostService>;
|
|
1107
1101
|
}
|
|
1108
1102
|
|
|
1103
|
+
declare class SkyInputBoxCharacterLimit {
|
|
1104
|
+
readonly characterCount: i0.InputSignal<number>;
|
|
1105
|
+
readonly characterLimit: i0.InputSignal<number>;
|
|
1106
|
+
protected readonly ratio: i0.Signal<string>;
|
|
1107
|
+
protected readonly limitReached: i0.Signal<boolean>;
|
|
1108
|
+
protected readonly announcedCount: i0.WritableSignal<number>;
|
|
1109
|
+
static ɵfac: i0.ɵɵFactoryDeclaration<SkyInputBoxCharacterLimit, never>;
|
|
1110
|
+
static ɵcmp: i0.ɵɵComponentDeclaration<SkyInputBoxCharacterLimit, "sky-input-box-character-limit", never, { "characterCount": { "alias": "characterCount"; "required": true; "isSignal": true; }; "characterLimit": { "alias": "characterLimit"; "required": true; "isSignal": true; }; }, {}, never, never, true, never>;
|
|
1111
|
+
}
|
|
1112
|
+
|
|
1109
1113
|
/**
|
|
1110
1114
|
* @internal
|
|
1111
1115
|
*/
|
|
@@ -1128,7 +1132,7 @@ declare class SkyInputBoxHintTextPipe implements PipeTransform {
|
|
|
1128
1132
|
|
|
1129
1133
|
declare class SkyInputBoxModule {
|
|
1130
1134
|
static ɵfac: i0.ɵɵFactoryDeclaration<SkyInputBoxModule, never>;
|
|
1131
|
-
static ɵmod: i0.ɵɵNgModuleDeclaration<SkyInputBoxModule, [typeof SkyInputBoxComponent], [typeof i4.CommonModule, typeof SkyCharacterCounterModule, typeof SkyFormErrorsModule, typeof SkyFormErrorModule, typeof SkyFormsResourcesModule, typeof i10.SkyHelpInlineModule, typeof SkyInputBoxControlDirective, typeof SkyInputBoxHintTextPipe, typeof i1$1.SkyThemeModule], [typeof SkyInputBoxHintTextPipe, typeof SkyInputBoxComponent, typeof SkyInputBoxControlDirective, typeof SkyFormErrorModule]>;
|
|
1135
|
+
static ɵmod: i0.ɵɵNgModuleDeclaration<SkyInputBoxModule, [typeof SkyInputBoxComponent], [typeof i4.CommonModule, typeof SkyCharacterCounterModule, typeof SkyFormErrorsModule, typeof SkyFormErrorModule, typeof SkyFormsResourcesModule, typeof i10.SkyHelpInlineModule, typeof SkyInputBoxCharacterLimit, typeof SkyInputBoxControlDirective, typeof SkyInputBoxHintTextPipe, typeof i1$1.SkyThemeModule], [typeof SkyInputBoxHintTextPipe, typeof SkyInputBoxComponent, typeof SkyInputBoxControlDirective, typeof SkyFormErrorModule]>;
|
|
1132
1136
|
static ɵinj: i0.ɵɵInjectorDeclaration<SkyInputBoxModule>;
|
|
1133
1137
|
}
|
|
1134
1138
|
|
|
@@ -1581,18 +1585,6 @@ declare const enum SkySelectionBoxGridAlignItems {
|
|
|
1581
1585
|
Left = "left"
|
|
1582
1586
|
}
|
|
1583
1587
|
|
|
1584
|
-
/**
|
|
1585
|
-
* Specifies the label to display beside the toggle switch. To display a help button beside the label, include a help
|
|
1586
|
-
* button element, such as `sky-help-inline`, in the `sky-toggle-switch` element and a `sky-control-help` CSS class on
|
|
1587
|
-
* that help button element.
|
|
1588
|
-
* @deprecated Use the `labelText` input on the toggle switch component instead.
|
|
1589
|
-
*/
|
|
1590
|
-
declare class SkyToggleSwitchLabelComponent {
|
|
1591
|
-
constructor();
|
|
1592
|
-
static ɵfac: i0.ɵɵFactoryDeclaration<SkyToggleSwitchLabelComponent, never>;
|
|
1593
|
-
static ɵcmp: i0.ɵɵComponentDeclaration<SkyToggleSwitchLabelComponent, "sky-toggle-switch-label", never, {}, {}, never, ["*"], false, never>;
|
|
1594
|
-
}
|
|
1595
|
-
|
|
1596
1588
|
/**
|
|
1597
1589
|
* Indicates whether the toggle switch is selected.
|
|
1598
1590
|
*/
|
|
@@ -1600,13 +1592,13 @@ interface SkyToggleSwitchChange {
|
|
|
1600
1592
|
checked: boolean;
|
|
1601
1593
|
}
|
|
1602
1594
|
|
|
1603
|
-
declare class SkyToggleSwitchComponent implements AfterContentInit,
|
|
1595
|
+
declare class SkyToggleSwitchComponent implements AfterContentInit, ControlValueAccessor, Validator {
|
|
1604
1596
|
#private;
|
|
1605
1597
|
/**
|
|
1606
1598
|
* The ARIA label for the toggle switch. This sets the `aria-label`
|
|
1607
1599
|
* attribute to provide a text equivalent for screen readers [to support accessibility](https://developer.blackbaud.com/skyux/learn/accessibility).
|
|
1608
1600
|
* Use a context-sensitive label, such as "Activate annual fundraiser" for a toggle switch that activates and deactivates an annual fundraiser. Context is especially important if multiple toggle switches are in close proximity.
|
|
1609
|
-
*
|
|
1601
|
+
* This property only applies when `labelText` is not set, since `labelText` takes precedence when both inputs are provided.
|
|
1610
1602
|
* For more information about the `aria-label` attribute, see the [WAI-ARIA definition](https://www.w3.org/TR/wai-aria/#aria-label).
|
|
1611
1603
|
* @deprecated Use the `labelText` input instead.
|
|
1612
1604
|
*/
|
|
@@ -1657,13 +1649,10 @@ declare class SkyToggleSwitchComponent implements AfterContentInit, OnDestroy, C
|
|
|
1657
1649
|
* Fires when the checked state of a toggle switch changes.
|
|
1658
1650
|
*/
|
|
1659
1651
|
toggleChange: EventEmitter<SkyToggleSwitchChange>;
|
|
1660
|
-
hasLabelComponent: boolean;
|
|
1661
1652
|
labelId: string;
|
|
1662
1653
|
enableIndicatorAnimation: boolean;
|
|
1663
|
-
labelComponents: QueryList<SkyToggleSwitchLabelComponent> | undefined;
|
|
1664
1654
|
constructor();
|
|
1665
1655
|
ngAfterContentInit(): void;
|
|
1666
|
-
ngOnDestroy(): void;
|
|
1667
1656
|
writeValue(value: boolean): void;
|
|
1668
1657
|
validate(control: AbstractControl): ValidationErrors | null;
|
|
1669
1658
|
registerOnChange(fn: (value: any) => void): void;
|
|
@@ -1672,13 +1661,13 @@ declare class SkyToggleSwitchComponent implements AfterContentInit, OnDestroy, C
|
|
|
1672
1661
|
onButtonClick(event: any): void;
|
|
1673
1662
|
onButtonBlur(): void;
|
|
1674
1663
|
static ɵfac: i0.ɵɵFactoryDeclaration<SkyToggleSwitchComponent, never>;
|
|
1675
|
-
static ɵcmp: i0.ɵɵComponentDeclaration<SkyToggleSwitchComponent, "sky-toggle-switch", never, { "ariaLabel": { "alias": "ariaLabel"; "required": false; }; "checked": { "alias": "checked"; "required": false; }; "disabled": { "alias": "disabled"; "required": false; }; "helpPopoverContent": { "alias": "helpPopoverContent"; "required": false; }; "helpPopoverTitle": { "alias": "helpPopoverTitle"; "required": false; }; "tabIndex": { "alias": "tabIndex"; "required": false; }; "labelText": { "alias": "labelText"; "required": false; }; "labelHidden": { "alias": "labelHidden"; "required": false; }; "helpKey": { "alias": "helpKey"; "required": false; }; }, { "toggleChange": "toggleChange"; },
|
|
1664
|
+
static ɵcmp: i0.ɵɵComponentDeclaration<SkyToggleSwitchComponent, "sky-toggle-switch", never, { "ariaLabel": { "alias": "ariaLabel"; "required": false; }; "checked": { "alias": "checked"; "required": false; }; "disabled": { "alias": "disabled"; "required": false; }; "helpPopoverContent": { "alias": "helpPopoverContent"; "required": false; }; "helpPopoverTitle": { "alias": "helpPopoverTitle"; "required": false; }; "tabIndex": { "alias": "tabIndex"; "required": false; }; "labelText": { "alias": "labelText"; "required": false; }; "labelHidden": { "alias": "labelHidden"; "required": false; }; "helpKey": { "alias": "helpKey"; "required": false; }; }, { "toggleChange": "toggleChange"; }, never, [".sky-control-help"], false, never>;
|
|
1676
1665
|
static ngAcceptInputType_labelHidden: unknown;
|
|
1677
1666
|
}
|
|
1678
1667
|
|
|
1679
1668
|
declare class SkyToggleSwitchModule {
|
|
1680
1669
|
static ɵfac: i0.ɵɵFactoryDeclaration<SkyToggleSwitchModule, never>;
|
|
1681
|
-
static ɵmod: i0.ɵɵNgModuleDeclaration<SkyToggleSwitchModule, [typeof
|
|
1670
|
+
static ɵmod: i0.ɵɵNgModuleDeclaration<SkyToggleSwitchModule, [typeof SkyToggleSwitchComponent], [typeof i4.CommonModule, typeof i4$1.FormsModule, typeof i10.SkyHelpInlineModule, typeof i12.SkyIdModule, typeof i12.SkyTrimModule], [typeof SkyToggleSwitchComponent]>;
|
|
1682
1671
|
static ɵinj: i0.ɵɵInjectorDeclaration<SkyToggleSwitchModule>;
|
|
1683
1672
|
}
|
|
1684
1673
|
|
|
@@ -1687,5 +1676,5 @@ declare class SkyToggleSwitchModule {
|
|
|
1687
1676
|
*/
|
|
1688
1677
|
declare const SKY_FORM_ERRORS_ENABLED: InjectionToken<boolean>;
|
|
1689
1678
|
|
|
1690
|
-
export { SKY_FORM_ERRORS_ENABLED, SkyCharacterCounterModule, SkyCheckboxModule, SkyFieldGroupModule, SkyFileAttachmentModule, SkyFileAttachmentsModule, SkyFileDropModule, SkyFileSizePipe, SkyFormErrorModule, SkyFormErrorsModule, SkyInputBoxHostService, SkyInputBoxModule, SkyRadioModule, SkyRequiredStateDirective, SkySelectionBoxGridAlignItems, SkySelectionBoxModule, SkyToggleSwitchModule, SkyCharacterCounterIndicatorComponent as λ1, SkyInputBoxComponent as λ10, SkyRadioGroupComponent as λ11, SkyRadioLabelComponent as λ12, SkyRadioComponent as λ13, SkySelectionBoxDescriptionComponent as λ14, SkySelectionBoxGridComponent as λ15, SkySelectionBoxHeaderComponent as λ16, SkySelectionBoxComponent as λ17,
|
|
1679
|
+
export { SKY_FORM_ERRORS_ENABLED, SkyCharacterCounterModule, SkyCheckboxModule, SkyFieldGroupModule, SkyFileAttachmentModule, SkyFileAttachmentsModule, SkyFileDropModule, SkyFileSizePipe, SkyFormErrorModule, SkyFormErrorsModule, SkyInputBoxHostService, SkyInputBoxModule, SkyRadioModule, SkyRequiredStateDirective, SkySelectionBoxGridAlignItems, SkySelectionBoxModule, SkyToggleSwitchModule, SkyCharacterCounterIndicatorComponent as λ1, SkyInputBoxComponent as λ10, SkyRadioGroupComponent as λ11, SkyRadioLabelComponent as λ12, SkyRadioComponent as λ13, SkySelectionBoxDescriptionComponent as λ14, SkySelectionBoxGridComponent as λ15, SkySelectionBoxHeaderComponent as λ16, SkySelectionBoxComponent as λ17, SkyToggleSwitchComponent as λ19, SkyCharacterCounterInputDirective as λ2, SkyInputBoxControlDirective as λ20, SkyFormErrorsComponent as λ21, SkyFormErrorComponent as λ22, SkyCharacterCounterScreenReaderPipe as λ23, SkyCheckboxGroupComponent as λ24, SkyFieldGroupComponent as λ25, SkyInputBoxHintTextPipe as λ26, SkyCheckboxComponent as λ3, SkyCheckboxLabelComponent as λ4, SkyFileAttachmentComponent as λ7, SkyFileDropComponent as λ8, SkyFileItemComponent as λ9 };
|
|
1691
1680
|
export type { SkyCheckboxChange, SkyCheckboxGroupHeadingLevel, SkyCheckboxGroupHeadingStyle, SkyFieldGroupHeadingLevel, SkyFieldGroupHeadingStyle, SkyFileAttachmentChange, SkyFileAttachmentClick, SkyFileDropChange, SkyFileItem, SkyFileItemErrorType, SkyFileLink, SkyFileValidateFn, SkyInputBoxPopulateArgs, SkyRadioChange, SkyRadioGroupHeadingLevel, SkyRadioGroupHeadingStyle, SkyRadioType, SkySelectionBoxGridAlignItemsType, SkyToggleSwitchChange };
|