@skyux/forms 10.18.0 → 10.20.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/documentation.json +3919 -3229
- package/esm2022/index.mjs +1 -1
- package/esm2022/lib/modules/checkbox/checkbox-group-heading-level.mjs +2 -0
- package/esm2022/lib/modules/checkbox/checkbox-group-heading-style.mjs +2 -0
- package/esm2022/lib/modules/checkbox/checkbox-group.component.mjs +31 -8
- package/esm2022/lib/modules/checkbox/checkbox.component.mjs +6 -4
- package/esm2022/lib/modules/field-group/field-group.component.mjs +11 -9
- package/esm2022/lib/modules/file-attachment/file-drop.component.mjs +6 -4
- package/esm2022/lib/modules/input-box/input-box.component.mjs +11 -5
- package/esm2022/lib/modules/radio/radio-group.component.mjs +38 -15
- package/esm2022/lib/modules/radio/radio.component.mjs +5 -3
- package/esm2022/lib/modules/radio/types/radio-group-heading-level.mjs +2 -0
- package/esm2022/lib/modules/radio/types/radio-group-heading-style.mjs +2 -0
- package/esm2022/testing/checkbox/checkbox-harness.mjs +2 -2
- package/esm2022/testing/input-box/input-box-harness.mjs +2 -2
- package/fesm2022/skyux-forms-testing.mjs +2 -2
- package/fesm2022/skyux-forms-testing.mjs.map +1 -1
- package/fesm2022/skyux-forms.mjs +99 -39
- package/fesm2022/skyux-forms.mjs.map +1 -1
- package/index.d.ts +5 -1
- package/lib/modules/checkbox/checkbox-group-heading-level.d.ts +1 -0
- package/lib/modules/checkbox/checkbox-group-heading-style.d.ts +1 -0
- package/lib/modules/checkbox/checkbox-group.component.d.ts +30 -7
- package/lib/modules/checkbox/checkbox.component.d.ts +7 -1
- package/lib/modules/field-group/field-group.component.d.ts +13 -11
- package/lib/modules/file-attachment/file-drop.component.d.ts +7 -1
- package/lib/modules/input-box/input-box.component.d.ts +5 -1
- package/lib/modules/radio/radio-group.component.d.ts +32 -9
- package/lib/modules/radio/radio.component.d.ts +7 -1
- package/lib/modules/radio/types/radio-group-heading-level.d.ts +1 -0
- package/lib/modules/radio/types/radio-group-heading-style.d.ts +1 -0
- package/package.json +8 -8
package/index.d.ts
CHANGED
|
@@ -1,5 +1,7 @@
|
|
|
1
1
|
export { SkyCharacterCounterModule } from './lib/modules/character-counter/character-counter.module';
|
|
2
2
|
export { SkyCheckboxChange } from './lib/modules/checkbox/checkbox-change';
|
|
3
|
+
export { SkyCheckboxGroupHeadingLevel } from './lib/modules/checkbox/checkbox-group-heading-level';
|
|
4
|
+
export { SkyCheckboxGroupHeadingStyle } from './lib/modules/checkbox/checkbox-group-heading-style';
|
|
3
5
|
export { SkyCheckboxModule } from './lib/modules/checkbox/checkbox.module';
|
|
4
6
|
export { SkyFieldGroupModule } from './lib/modules/field-group/field-group.module';
|
|
5
7
|
export { SkyFieldGroupHeadingLevel } from './lib/modules/field-group/field-group-heading-level';
|
|
@@ -17,8 +19,10 @@ export { SkyFormErrorModule } from './lib/modules/form-error/form-error.module';
|
|
|
17
19
|
export { SkyInputBoxHostService } from './lib/modules/input-box/input-box-host.service';
|
|
18
20
|
export { SkyInputBoxPopulateArgs } from './lib/modules/input-box/input-box-populate-args';
|
|
19
21
|
export { SkyInputBoxModule } from './lib/modules/input-box/input-box.module';
|
|
20
|
-
export { SkyRadioModule } from './lib/modules/radio/radio.module';
|
|
21
22
|
export { SkyRadioChange } from './lib/modules/radio/types/radio-change';
|
|
23
|
+
export { SkyRadioGroupHeadingLevel } from './lib/modules/radio/types/radio-group-heading-level';
|
|
24
|
+
export { SkyRadioGroupHeadingStyle } from './lib/modules/radio/types/radio-group-heading-style';
|
|
25
|
+
export { SkyRadioModule } from './lib/modules/radio/radio.module';
|
|
22
26
|
export { SkyRadioType } from './lib/modules/radio/types/radio-type';
|
|
23
27
|
export { SkyRequiredStateDirective } from './lib/modules/required-state/required-state.directive';
|
|
24
28
|
export { SkySelectionBoxModule } from './lib/modules/selection-box/selection-box.module';
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export type SkyCheckboxGroupHeadingLevel = 3 | 4 | 5;
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export type SkyCheckboxGroupHeadingStyle = 3 | 4 | 5;
|
|
@@ -1,5 +1,7 @@
|
|
|
1
1
|
import { TemplateRef } from '@angular/core';
|
|
2
2
|
import { FormGroup } from '@angular/forms';
|
|
3
|
+
import { SkyCheckboxGroupHeadingLevel } from './checkbox-group-heading-level';
|
|
4
|
+
import { SkyCheckboxGroupHeadingStyle } from './checkbox-group-heading-style';
|
|
3
5
|
import * as i0 from "@angular/core";
|
|
4
6
|
/**
|
|
5
7
|
* Organizes checkboxes into a group.
|
|
@@ -7,7 +9,7 @@ import * as i0 from "@angular/core";
|
|
|
7
9
|
export declare class SkyCheckboxGroupComponent {
|
|
8
10
|
#private;
|
|
9
11
|
/**
|
|
10
|
-
* The content of the help popover. When specified
|
|
12
|
+
* The content of the help popover. When specified, a [help inline](https://developer.blackbaud.com/skyux/components/help-inline)
|
|
11
13
|
* button is added to the checkbox group fieldset legend. The help inline button displays a [popover](https://developer.blackbaud.com/skyux/components/popover)
|
|
12
14
|
* when clicked using the specified content and optional title.
|
|
13
15
|
* @preview
|
|
@@ -20,15 +22,27 @@ export declare class SkyCheckboxGroupComponent {
|
|
|
20
22
|
*/
|
|
21
23
|
helpPopoverTitle: string | undefined;
|
|
22
24
|
/**
|
|
23
|
-
* The text to display as the checkbox group's
|
|
25
|
+
* The text to display as the checkbox group's heading.
|
|
24
26
|
* @preview
|
|
25
27
|
*/
|
|
26
|
-
|
|
28
|
+
headingText: string;
|
|
27
29
|
/**
|
|
28
|
-
* Indicates whether to hide the `
|
|
30
|
+
* Indicates whether to hide the `headingText`.
|
|
29
31
|
* @preview
|
|
30
32
|
*/
|
|
31
|
-
|
|
33
|
+
headingHidden: boolean;
|
|
34
|
+
/**
|
|
35
|
+
* The semantic heading level in the document structure.
|
|
36
|
+
* @preview
|
|
37
|
+
* @default 3
|
|
38
|
+
*/
|
|
39
|
+
headingLevel: SkyCheckboxGroupHeadingLevel;
|
|
40
|
+
/**
|
|
41
|
+
* The heading [font style](https://developer.blackbaud.com/skyux/design/styles/typography#headings).
|
|
42
|
+
* @preview
|
|
43
|
+
* @default 3
|
|
44
|
+
*/
|
|
45
|
+
set headingStyle(value: SkyCheckboxGroupHeadingStyle);
|
|
32
46
|
/**
|
|
33
47
|
* [Persistent inline help text](https://developer.blackbaud.com/skyux/design/guidelines/user-assistance#inline-help) that provides
|
|
34
48
|
* additional context to the user.
|
|
@@ -51,11 +65,20 @@ export declare class SkyCheckboxGroupComponent {
|
|
|
51
65
|
* @preview
|
|
52
66
|
*/
|
|
53
67
|
formGroup: FormGroup;
|
|
68
|
+
/**
|
|
69
|
+
* A help key that identifies the global help content to display. When specified, a [help inline](https://developer.blackbaud.com/skyux/components/help-inline) button is
|
|
70
|
+
* placed beside the checkbox group heading. Clicking the button invokes global help as configured by the application.
|
|
71
|
+
* @preview
|
|
72
|
+
*/
|
|
73
|
+
helpKey: string | undefined;
|
|
54
74
|
protected errorId: string;
|
|
55
75
|
protected formErrorsDataId: string;
|
|
76
|
+
protected headingClass: string;
|
|
56
77
|
static ɵfac: i0.ɵɵFactoryDeclaration<SkyCheckboxGroupComponent, never>;
|
|
57
|
-
static ɵcmp: i0.ɵɵComponentDeclaration<SkyCheckboxGroupComponent, "sky-checkbox-group", never, { "helpPopoverContent": { "alias": "helpPopoverContent"; "required": false; }; "helpPopoverTitle": { "alias": "helpPopoverTitle"; "required": false; }; "
|
|
58
|
-
static
|
|
78
|
+
static ɵcmp: i0.ɵɵComponentDeclaration<SkyCheckboxGroupComponent, "sky-checkbox-group", never, { "helpPopoverContent": { "alias": "helpPopoverContent"; "required": false; }; "helpPopoverTitle": { "alias": "helpPopoverTitle"; "required": false; }; "headingText": { "alias": "headingText"; "required": true; }; "headingHidden": { "alias": "headingHidden"; "required": false; }; "headingLevel": { "alias": "headingLevel"; "required": false; }; "headingStyle": { "alias": "headingStyle"; "required": false; }; "hintText": { "alias": "hintText"; "required": false; }; "required": { "alias": "required"; "required": false; }; "stacked": { "alias": "stacked"; "required": false; }; "formGroup": { "alias": "formGroup"; "required": true; }; "helpKey": { "alias": "helpKey"; "required": false; }; }, {}, never, ["sky-checkbox[icon]", "sky-checkbox", "sky-form-error"], true, never>;
|
|
79
|
+
static ngAcceptInputType_headingHidden: unknown;
|
|
80
|
+
static ngAcceptInputType_headingLevel: unknown;
|
|
81
|
+
static ngAcceptInputType_headingStyle: unknown;
|
|
59
82
|
static ngAcceptInputType_required: unknown;
|
|
60
83
|
static ngAcceptInputType_stacked: unknown;
|
|
61
84
|
}
|
|
@@ -133,6 +133,12 @@ export declare class SkyCheckboxComponent implements ControlValueAccessor, OnIni
|
|
|
133
133
|
* @preview
|
|
134
134
|
*/
|
|
135
135
|
stacked: boolean;
|
|
136
|
+
/**
|
|
137
|
+
* A help key that identifies the global help content to display. When specified, a [help inline](https://developer.blackbaud.com/skyux/components/help-inline) button is
|
|
138
|
+
* placed beside the checkbox label. Clicking the button invokes global help as configured by the application.
|
|
139
|
+
* @preview
|
|
140
|
+
*/
|
|
141
|
+
helpKey: string | undefined;
|
|
136
142
|
/**
|
|
137
143
|
* Fires when users select or deselect the checkbox.
|
|
138
144
|
*/
|
|
@@ -181,7 +187,7 @@ export declare class SkyCheckboxComponent implements ControlValueAccessor, OnIni
|
|
|
181
187
|
/** Called when the checkbox is blurred. Needed to properly implement ControlValueAccessor. */
|
|
182
188
|
onTouched: () => any;
|
|
183
189
|
static ɵfac: i0.ɵɵFactoryDeclaration<SkyCheckboxComponent, never>;
|
|
184
|
-
static ɵcmp: i0.ɵɵComponentDeclaration<SkyCheckboxComponent, "sky-checkbox", never, { "label": { "alias": "label"; "required": false; }; "labelledBy": { "alias": "labelledBy"; "required": false; }; "id": { "alias": "id"; "required": false; }; "disabled": { "alias": "disabled"; "required": false; }; "tabindex": { "alias": "tabindex"; "required": false; }; "name": { "alias": "name"; "required": false; }; "helpPopoverContent": { "alias": "helpPopoverContent"; "required": false; }; "helpPopoverTitle": { "alias": "helpPopoverTitle"; "required": false; }; "icon": { "alias": "icon"; "required": false; }; "checkboxType": { "alias": "checkboxType"; "required": false; }; "checked": { "alias": "checked"; "required": false; }; "indeterminate": { "alias": "indeterminate"; "required": false; }; "required": { "alias": "required"; "required": false; }; "labelText": { "alias": "labelText"; "required": false; }; "labelHidden": { "alias": "labelHidden"; "required": false; }; "hintText": { "alias": "hintText"; "required": false; }; "stacked": { "alias": "stacked"; "required": false; }; }, { "change": "change"; "checkedChange": "checkedChange"; "disabledChange": "disabledChange"; "indeterminateChange": "indeterminateChange"; }, never, ["sky-checkbox-label", "sky-form-error"], false, never>;
|
|
190
|
+
static ɵcmp: i0.ɵɵComponentDeclaration<SkyCheckboxComponent, "sky-checkbox", never, { "label": { "alias": "label"; "required": false; }; "labelledBy": { "alias": "labelledBy"; "required": false; }; "id": { "alias": "id"; "required": false; }; "disabled": { "alias": "disabled"; "required": false; }; "tabindex": { "alias": "tabindex"; "required": false; }; "name": { "alias": "name"; "required": false; }; "helpPopoverContent": { "alias": "helpPopoverContent"; "required": false; }; "helpPopoverTitle": { "alias": "helpPopoverTitle"; "required": false; }; "icon": { "alias": "icon"; "required": false; }; "checkboxType": { "alias": "checkboxType"; "required": false; }; "checked": { "alias": "checked"; "required": false; }; "indeterminate": { "alias": "indeterminate"; "required": false; }; "required": { "alias": "required"; "required": false; }; "labelText": { "alias": "labelText"; "required": false; }; "labelHidden": { "alias": "labelHidden"; "required": false; }; "hintText": { "alias": "hintText"; "required": false; }; "stacked": { "alias": "stacked"; "required": false; }; "helpKey": { "alias": "helpKey"; "required": false; }; }, { "change": "change"; "checkedChange": "checkedChange"; "disabledChange": "disabledChange"; "indeterminateChange": "indeterminateChange"; }, never, ["sky-checkbox-label", "sky-form-error"], false, never>;
|
|
185
191
|
static ngAcceptInputType_required: unknown;
|
|
186
192
|
static ngAcceptInputType_labelHidden: unknown;
|
|
187
193
|
static ngAcceptInputType_stacked: unknown;
|
|
@@ -7,10 +7,10 @@ import * as i0 from "@angular/core";
|
|
|
7
7
|
*/
|
|
8
8
|
export declare class SkyFieldGroupComponent {
|
|
9
9
|
/**
|
|
10
|
-
* The text to display as the field group's
|
|
10
|
+
* The text to display as the field group's heading.
|
|
11
11
|
* @preview
|
|
12
12
|
*/
|
|
13
|
-
|
|
13
|
+
headingText: string;
|
|
14
14
|
/**
|
|
15
15
|
* [Persistent inline help text](https://developer.blackbaud.com/skyux/design/guidelines/user-assistance#inline-help) that provides
|
|
16
16
|
* additional context to the user.
|
|
@@ -18,10 +18,10 @@ export declare class SkyFieldGroupComponent {
|
|
|
18
18
|
*/
|
|
19
19
|
hintText: string | undefined;
|
|
20
20
|
/**
|
|
21
|
-
* Indicates whether to hide the `
|
|
21
|
+
* Indicates whether to hide the `headingText`.
|
|
22
22
|
* @preview
|
|
23
23
|
*/
|
|
24
|
-
|
|
24
|
+
headingHidden: boolean;
|
|
25
25
|
/**
|
|
26
26
|
* Whether the field group is stacked on another field group. When specified, the appropriate
|
|
27
27
|
* vertical spacing is automatically added to the field group.
|
|
@@ -29,18 +29,20 @@ export declare class SkyFieldGroupComponent {
|
|
|
29
29
|
*/
|
|
30
30
|
stacked: boolean;
|
|
31
31
|
/**
|
|
32
|
-
* The heading level in the document structure.
|
|
32
|
+
* The semantic heading level in the document structure.
|
|
33
33
|
* @preview
|
|
34
|
+
* @default 3
|
|
34
35
|
*/
|
|
35
36
|
headingLevel: SkyFieldGroupHeadingLevel;
|
|
36
37
|
/**
|
|
37
|
-
* The heading font style.
|
|
38
|
+
* The heading [font style](https://developer.blackbaud.com/skyux/design/styles/typography#headings).
|
|
38
39
|
* @preview
|
|
40
|
+
* @default 3
|
|
39
41
|
*/
|
|
40
42
|
set headingStyle(value: SkyFieldGroupHeadingStyle);
|
|
41
43
|
/**
|
|
42
|
-
* The content of the help popover. When specified
|
|
43
|
-
* button is added to the field group
|
|
44
|
+
* The content of the help popover. When specified, a [help inline](https://developer.blackbaud.com/skyux/components/help-inline)
|
|
45
|
+
* button is added to the field group heading. The help inline button displays a [popover](https://developer.blackbaud.com/skyux/components/popover)
|
|
44
46
|
* when clicked using the specified content and optional title.
|
|
45
47
|
* @preview
|
|
46
48
|
*/
|
|
@@ -53,14 +55,14 @@ export declare class SkyFieldGroupComponent {
|
|
|
53
55
|
helpPopoverTitle: string | undefined;
|
|
54
56
|
/**
|
|
55
57
|
* A help key that identifies the global help content to display. When specified, a [help inline](https://developer.blackbaud.com/skyux/components/help-inline) button is
|
|
56
|
-
* placed beside the field group
|
|
58
|
+
* placed beside the field group heading. Clicking the button invokes global help as configured by the application.
|
|
57
59
|
* @preview
|
|
58
60
|
*/
|
|
59
61
|
helpKey: string | undefined;
|
|
60
62
|
protected headingClass: string;
|
|
61
63
|
static ɵfac: i0.ɵɵFactoryDeclaration<SkyFieldGroupComponent, never>;
|
|
62
|
-
static ɵcmp: i0.ɵɵComponentDeclaration<SkyFieldGroupComponent, "sky-field-group", never, { "
|
|
63
|
-
static
|
|
64
|
+
static ɵcmp: i0.ɵɵComponentDeclaration<SkyFieldGroupComponent, "sky-field-group", never, { "headingText": { "alias": "headingText"; "required": true; }; "hintText": { "alias": "hintText"; "required": false; }; "headingHidden": { "alias": "headingHidden"; "required": false; }; "stacked": { "alias": "stacked"; "required": false; }; "headingLevel": { "alias": "headingLevel"; "required": false; }; "headingStyle": { "alias": "headingStyle"; "required": false; }; "helpPopoverContent": { "alias": "helpPopoverContent"; "required": false; }; "helpPopoverTitle": { "alias": "helpPopoverTitle"; "required": false; }; "helpKey": { "alias": "helpKey"; "required": false; }; }, {}, never, ["*"], true, never>;
|
|
65
|
+
static ngAcceptInputType_headingHidden: unknown;
|
|
64
66
|
static ngAcceptInputType_stacked: unknown;
|
|
65
67
|
static ngAcceptInputType_headingLevel: unknown;
|
|
66
68
|
static ngAcceptInputType_headingStyle: unknown;
|
|
@@ -122,6 +122,12 @@ export declare class SkyFileDropComponent implements OnInit, OnDestroy {
|
|
|
122
122
|
* @preview
|
|
123
123
|
*/
|
|
124
124
|
stacked: boolean;
|
|
125
|
+
/**
|
|
126
|
+
* A help key that identifies the global help content to display. When specified, a [help inline](https://developer.blackbaud.com/skyux/components/help-inline) button is
|
|
127
|
+
* placed beside the file attachment label. Clicking the button invokes global help as configured by the application.
|
|
128
|
+
* @preview
|
|
129
|
+
*/
|
|
130
|
+
helpKey: string | undefined;
|
|
125
131
|
inputEl: ElementRef | undefined;
|
|
126
132
|
display: string | undefined;
|
|
127
133
|
rejectedOver: boolean;
|
|
@@ -141,7 +147,7 @@ export declare class SkyFileDropComponent implements OnInit, OnDestroy {
|
|
|
141
147
|
addLink(event: Event): void;
|
|
142
148
|
onLinkBlur(): void;
|
|
143
149
|
static ɵfac: i0.ɵɵFactoryDeclaration<SkyFileDropComponent, never>;
|
|
144
|
-
static ɵcmp: i0.ɵɵComponentDeclaration<SkyFileDropComponent, "sky-file-drop", never, { "fileUploadAriaLabel": { "alias": "fileUploadAriaLabel"; "required": false; }; "linkUploadAriaLabel": { "alias": "linkUploadAriaLabel"; "required": false; }; "minFileSize": { "alias": "minFileSize"; "required": false; }; "maxFileSize": { "alias": "maxFileSize"; "required": false; }; "multiple": { "alias": "multiple"; "required": false; }; "validateFn": { "alias": "validateFn"; "required": false; }; "acceptedTypes": { "alias": "acceptedTypes"; "required": false; }; "noClick": { "alias": "noClick"; "required": false; }; "allowLinks": { "alias": "allowLinks"; "required": false; }; "labelText": { "alias": "labelText"; "required": false; }; "labelHidden": { "alias": "labelHidden"; "required": false; }; "hintText": { "alias": "hintText"; "required": false; }; "required": { "alias": "required"; "required": false; }; "helpPopoverContent": { "alias": "helpPopoverContent"; "required": false; }; "helpPopoverTitle": { "alias": "helpPopoverTitle"; "required": false; }; "stacked": { "alias": "stacked"; "required": false; }; }, { "filesChanged": "filesChanged"; "linkInputBlur": "linkInputBlur"; "linkChanged": "linkChanged"; }, never, ["*"], false, never>;
|
|
150
|
+
static ɵcmp: i0.ɵɵComponentDeclaration<SkyFileDropComponent, "sky-file-drop", never, { "fileUploadAriaLabel": { "alias": "fileUploadAriaLabel"; "required": false; }; "linkUploadAriaLabel": { "alias": "linkUploadAriaLabel"; "required": false; }; "minFileSize": { "alias": "minFileSize"; "required": false; }; "maxFileSize": { "alias": "maxFileSize"; "required": false; }; "multiple": { "alias": "multiple"; "required": false; }; "validateFn": { "alias": "validateFn"; "required": false; }; "acceptedTypes": { "alias": "acceptedTypes"; "required": false; }; "noClick": { "alias": "noClick"; "required": false; }; "allowLinks": { "alias": "allowLinks"; "required": false; }; "labelText": { "alias": "labelText"; "required": false; }; "labelHidden": { "alias": "labelHidden"; "required": false; }; "hintText": { "alias": "hintText"; "required": false; }; "required": { "alias": "required"; "required": false; }; "helpPopoverContent": { "alias": "helpPopoverContent"; "required": false; }; "helpPopoverTitle": { "alias": "helpPopoverTitle"; "required": false; }; "stacked": { "alias": "stacked"; "required": false; }; "helpKey": { "alias": "helpKey"; "required": false; }; }, { "filesChanged": "filesChanged"; "linkInputBlur": "linkInputBlur"; "linkChanged": "linkChanged"; }, never, ["*"], false, never>;
|
|
145
151
|
static ngAcceptInputType_labelHidden: unknown;
|
|
146
152
|
static ngAcceptInputType_required: unknown;
|
|
147
153
|
static ngAcceptInputType_stacked: unknown;
|
|
@@ -66,6 +66,10 @@ export declare class SkyInputBoxComponent implements OnInit, AfterContentChecked
|
|
|
66
66
|
*/
|
|
67
67
|
set hintText(value: string | undefined);
|
|
68
68
|
get hintText(): string | undefined;
|
|
69
|
+
/**
|
|
70
|
+
* @internal
|
|
71
|
+
*/
|
|
72
|
+
errorsScreenReaderOnly: import("@angular/core").InputSignalWithTransform<boolean, unknown>;
|
|
69
73
|
hostInputTemplate: TemplateRef<unknown> | undefined;
|
|
70
74
|
hostButtonsTemplate: TemplateRef<unknown> | undefined;
|
|
71
75
|
hostButtonsInsetTemplate: TemplateRef<unknown> | undefined;
|
|
@@ -103,5 +107,5 @@ export declare class SkyInputBoxComponent implements OnInit, AfterContentChecked
|
|
|
103
107
|
setHostHintText(value: string | undefined): void;
|
|
104
108
|
setHintTextScreenReaderOnly(hide: boolean): void;
|
|
105
109
|
static ɵfac: i0.ɵɵFactoryDeclaration<SkyInputBoxComponent, never>;
|
|
106
|
-
static ɵcmp: i0.ɵɵComponentDeclaration<SkyInputBoxComponent, "sky-input-box", never, { "hasErrors": { "alias": "hasErrors"; "required": false; }; "disabled": { "alias": "disabled"; "required": false; }; "labelText": { "alias": "labelText"; "required": false; }; "characterLimit": { "alias": "characterLimit"; "required": false; }; "stacked": { "alias": "stacked"; "required": false; }; "helpPopoverTitle": { "alias": "helpPopoverTitle"; "required": false; }; "helpPopoverContent": { "alias": "helpPopoverContent"; "required": false; }; "helpKey": { "alias": "helpKey"; "required": false; }; "hintText": { "alias": "hintText"; "required": false; }; }, {}, ["formControl", "formControlByName", "ngModel", "inputRef"], [".sky-control-label", ".sky-control-help", "sky-character-counter-indicator", "input,select,.sky-form-control:not(textarea),sky-text-editor", "textarea", ".sky-input-group-btn.sky-input-box-btn-left", ".sky-input-group-btn:not(.sky-input-box-btn-left):not(.sky-input-box-btn-inset)", ".sky-input-group-btn.sky-input-box-btn-inset", ".sky-input-group-icon.sky-input-box-icon-inset", ".sky-input-group-icon.sky-input-box-icon-inset-left", "sky-form-error", ".sky-error-label,.sky-error-indicator"], false, never>;
|
|
110
|
+
static ɵcmp: i0.ɵɵComponentDeclaration<SkyInputBoxComponent, "sky-input-box", never, { "hasErrors": { "alias": "hasErrors"; "required": false; }; "disabled": { "alias": "disabled"; "required": false; }; "labelText": { "alias": "labelText"; "required": false; }; "characterLimit": { "alias": "characterLimit"; "required": false; }; "stacked": { "alias": "stacked"; "required": false; }; "helpPopoverTitle": { "alias": "helpPopoverTitle"; "required": false; }; "helpPopoverContent": { "alias": "helpPopoverContent"; "required": false; }; "helpKey": { "alias": "helpKey"; "required": false; }; "hintText": { "alias": "hintText"; "required": false; }; "errorsScreenReaderOnly": { "alias": "errorsScreenReaderOnly"; "required": false; "isSignal": true; }; }, {}, ["formControl", "formControlByName", "ngModel", "inputRef"], [".sky-control-label", ".sky-control-help", "sky-character-counter-indicator", "input,select,.sky-form-control:not(textarea),sky-text-editor", "textarea", ".sky-input-group-btn.sky-input-box-btn-left", ".sky-input-group-btn:not(.sky-input-box-btn-left):not(.sky-input-box-btn-inset)", ".sky-input-group-btn.sky-input-box-btn-inset", ".sky-input-group-icon.sky-input-box-icon-inset", ".sky-input-group-icon.sky-input-box-icon-inset-left", "sky-form-error", ".sky-error-label,.sky-error-indicator"], false, never>;
|
|
107
111
|
}
|
|
@@ -2,6 +2,8 @@ import { AfterContentInit, AfterViewInit, ChangeDetectorRef, OnDestroy, OnInit,
|
|
|
2
2
|
import { NgControl } from '@angular/forms';
|
|
3
3
|
import { SkyRadioGroupIdService } from './radio-group-id.service';
|
|
4
4
|
import { SkyRadioComponent } from './radio.component';
|
|
5
|
+
import { SkyRadioGroupHeadingLevel } from './types/radio-group-heading-level';
|
|
6
|
+
import { SkyRadioGroupHeadingStyle } from './types/radio-group-heading-style';
|
|
5
7
|
import * as i0 from "@angular/core";
|
|
6
8
|
/**
|
|
7
9
|
* Organizes radio buttons into a group. It is required for radio
|
|
@@ -17,7 +19,7 @@ export declare class SkyRadioGroupComponent implements AfterContentInit, AfterVi
|
|
|
17
19
|
* [to support accessibility](https://developer.blackbaud.com/skyux/learn/accessibility).
|
|
18
20
|
* If the radio button group does not include a visible label, use `ariaLabel` instead.
|
|
19
21
|
* For more information about the `aria-labelledby` attribute, see the [WAI-ARIA definition](https://www.w3.org/TR/wai-aria/#aria-labelledby).
|
|
20
|
-
* @deprecated Use `
|
|
22
|
+
* @deprecated Use `headingText` instead.
|
|
21
23
|
*/
|
|
22
24
|
set ariaLabelledBy(value: string | undefined);
|
|
23
25
|
get ariaLabelledBy(): string | undefined;
|
|
@@ -27,7 +29,7 @@ export declare class SkyRadioGroupComponent implements AfterContentInit, AfterVi
|
|
|
27
29
|
* [to support accessibility](https://developer.blackbaud.com/skyux/learn/accessibility).
|
|
28
30
|
* If the radio button group includes a visible label, use `ariaLabelledBy` instead.
|
|
29
31
|
* For more information about the `aria-label` attribute, see the [WAI-ARIA definition](https://www.w3.org/TR/wai-aria/#aria-label).
|
|
30
|
-
* @deprecated Use `
|
|
32
|
+
* @deprecated Use `headingText` instead.
|
|
31
33
|
*/
|
|
32
34
|
set ariaLabel(value: string | undefined);
|
|
33
35
|
get ariaLabel(): string | undefined;
|
|
@@ -38,6 +40,18 @@ export declare class SkyRadioGroupComponent implements AfterContentInit, AfterVi
|
|
|
38
40
|
*/
|
|
39
41
|
set disabled(value: boolean | undefined);
|
|
40
42
|
get disabled(): boolean;
|
|
43
|
+
/**
|
|
44
|
+
* The semantic heading level in the document structure.
|
|
45
|
+
* @preview
|
|
46
|
+
* @default 3
|
|
47
|
+
*/
|
|
48
|
+
headingLevel: SkyRadioGroupHeadingLevel;
|
|
49
|
+
/**
|
|
50
|
+
* The heading [font style](https://developer.blackbaud.com/skyux/design/styles/typography#headings).
|
|
51
|
+
* @preview
|
|
52
|
+
* @default 3
|
|
53
|
+
*/
|
|
54
|
+
set headingStyle(value: SkyRadioGroupHeadingStyle);
|
|
41
55
|
/**
|
|
42
56
|
* The name for the collection of radio buttons that the component groups together.
|
|
43
57
|
* This property overwrites the deprecated `name` property on individual `sky-radio` elements,
|
|
@@ -77,15 +91,15 @@ export declare class SkyRadioGroupComponent implements AfterContentInit, AfterVi
|
|
|
77
91
|
set tabIndex(value: number | undefined);
|
|
78
92
|
get tabIndex(): number | undefined;
|
|
79
93
|
/**
|
|
80
|
-
* The text to display as the radio group's
|
|
94
|
+
* The text to display as the radio group's heading.
|
|
81
95
|
* @preview
|
|
82
96
|
*/
|
|
83
|
-
|
|
97
|
+
headingText: string | undefined;
|
|
84
98
|
/**
|
|
85
|
-
* Indicates whether to hide the `
|
|
99
|
+
* Indicates whether to hide the `headingText`.
|
|
86
100
|
* @preview
|
|
87
101
|
*/
|
|
88
|
-
|
|
102
|
+
headingHidden: boolean;
|
|
89
103
|
display: string | undefined;
|
|
90
104
|
/**
|
|
91
105
|
* [Persistent inline help text](https://developer.blackbaud.com/skyux/design/guidelines/user-assistance#inline-help) that provides
|
|
@@ -94,7 +108,7 @@ export declare class SkyRadioGroupComponent implements AfterContentInit, AfterVi
|
|
|
94
108
|
*/
|
|
95
109
|
hintText: string | undefined;
|
|
96
110
|
/**
|
|
97
|
-
* The content of the help popover. When specified along with `
|
|
111
|
+
* The content of the help popover. When specified along with `headingText`, a [help inline](https://developer.blackbaud.com/skyux/components/help-inline)
|
|
98
112
|
* button is added to radio group. The help inline button displays a [popover](https://developer.blackbaud.com/skyux/components/popover)
|
|
99
113
|
* when clicked using the specified content and optional title.
|
|
100
114
|
* @preview
|
|
@@ -106,6 +120,12 @@ export declare class SkyRadioGroupComponent implements AfterContentInit, AfterVi
|
|
|
106
120
|
* @preview
|
|
107
121
|
*/
|
|
108
122
|
helpPopoverTitle: string | undefined;
|
|
123
|
+
/**
|
|
124
|
+
* A help key that identifies the global help content to display. When specified, a [help inline](https://developer.blackbaud.com/skyux/components/help-inline) button is
|
|
125
|
+
* placed beside the radio group heading. Clicking the button invokes global help as configured by the application.
|
|
126
|
+
* @preview
|
|
127
|
+
*/
|
|
128
|
+
helpKey: string | undefined;
|
|
109
129
|
/**
|
|
110
130
|
* Our radio components are usually implemented using an unordered list. This is an
|
|
111
131
|
* accessibility violation because the unordered list has an implicit role which
|
|
@@ -117,6 +137,7 @@ export declare class SkyRadioGroupComponent implements AfterContentInit, AfterVi
|
|
|
117
137
|
radios: QueryList<SkyRadioComponent> | undefined;
|
|
118
138
|
protected errorId: string;
|
|
119
139
|
protected ngControl: NgControl | undefined;
|
|
140
|
+
protected headingClass: string;
|
|
120
141
|
constructor(changeDetector: ChangeDetectorRef, radioGroupIdSvc: SkyRadioGroupIdService, ngControl: NgControl);
|
|
121
142
|
ngAfterContentInit(): void;
|
|
122
143
|
ngAfterViewInit(): void;
|
|
@@ -132,7 +153,9 @@ export declare class SkyRadioGroupComponent implements AfterContentInit, AfterVi
|
|
|
132
153
|
registerOnChange(fn: (value: any) => void): void;
|
|
133
154
|
registerOnTouched(fn: any): void;
|
|
134
155
|
static ɵfac: i0.ɵɵFactoryDeclaration<SkyRadioGroupComponent, [null, null, { optional: true; self: true; }]>;
|
|
135
|
-
static ɵcmp: i0.ɵɵComponentDeclaration<SkyRadioGroupComponent, "sky-radio-group", never, { "ariaLabelledBy": { "alias": "ariaLabelledBy"; "required": false; }; "ariaLabel": { "alias": "ariaLabel"; "required": false; }; "disabled": { "alias": "disabled"; "required": false; }; "name": { "alias": "name"; "required": false; }; "required": { "alias": "required"; "required": false; }; "stacked": { "alias": "stacked"; "required": false; }; "value": { "alias": "value"; "required": false; }; "tabIndex": { "alias": "tabIndex"; "required": false; }; "
|
|
156
|
+
static ɵcmp: i0.ɵɵComponentDeclaration<SkyRadioGroupComponent, "sky-radio-group", never, { "ariaLabelledBy": { "alias": "ariaLabelledBy"; "required": false; }; "ariaLabel": { "alias": "ariaLabel"; "required": false; }; "disabled": { "alias": "disabled"; "required": false; }; "headingLevel": { "alias": "headingLevel"; "required": false; }; "headingStyle": { "alias": "headingStyle"; "required": false; }; "name": { "alias": "name"; "required": false; }; "required": { "alias": "required"; "required": false; }; "stacked": { "alias": "stacked"; "required": false; }; "value": { "alias": "value"; "required": false; }; "tabIndex": { "alias": "tabIndex"; "required": false; }; "headingText": { "alias": "headingText"; "required": false; }; "headingHidden": { "alias": "headingHidden"; "required": false; }; "hintText": { "alias": "hintText"; "required": false; }; "helpPopoverContent": { "alias": "helpPopoverContent"; "required": false; }; "helpPopoverTitle": { "alias": "helpPopoverTitle"; "required": false; }; "helpKey": { "alias": "helpKey"; "required": false; }; }, {}, ["radios"], ["*", "sky-form-error"], false, never>;
|
|
157
|
+
static ngAcceptInputType_headingLevel: unknown;
|
|
158
|
+
static ngAcceptInputType_headingStyle: unknown;
|
|
136
159
|
static ngAcceptInputType_stacked: unknown;
|
|
137
|
-
static
|
|
160
|
+
static ngAcceptInputType_headingHidden: unknown;
|
|
138
161
|
}
|
|
@@ -124,6 +124,12 @@ export declare class SkyRadioComponent implements OnInit, OnDestroy, ControlValu
|
|
|
124
124
|
* @preview
|
|
125
125
|
*/
|
|
126
126
|
hintText: string | undefined;
|
|
127
|
+
/**
|
|
128
|
+
* A help key that identifies the global help content to display. When specified, a [help inline](https://developer.blackbaud.com/skyux/components/help-inline) button is
|
|
129
|
+
* placed beside the radio button label. Clicking the button invokes global help as configured by the application.
|
|
130
|
+
* @preview
|
|
131
|
+
*/
|
|
132
|
+
helpKey: string | undefined;
|
|
127
133
|
/**
|
|
128
134
|
* Fires when users select a radio button.
|
|
129
135
|
*/
|
|
@@ -156,6 +162,6 @@ export declare class SkyRadioComponent implements OnInit, OnDestroy, ControlValu
|
|
|
156
162
|
onInputChange(event: Event): void;
|
|
157
163
|
onInputFocusChange(): void;
|
|
158
164
|
static ɵfac: i0.ɵɵFactoryDeclaration<SkyRadioComponent, never>;
|
|
159
|
-
static ɵcmp: i0.ɵɵComponentDeclaration<SkyRadioComponent, "sky-radio", never, { "checked": { "alias": "checked"; "required": false; }; "disabled": { "alias": "disabled"; "required": false; }; "id": { "alias": "id"; "required": false; }; "label": { "alias": "label"; "required": false; }; "labelledBy": { "alias": "labelledBy"; "required": false; }; "name": { "alias": "name"; "required": false; }; "tabindex": { "alias": "tabindex"; "required": false; }; "value": { "alias": "value"; "required": false; }; "helpPopoverContent": { "alias": "helpPopoverContent"; "required": false; }; "helpPopoverTitle": { "alias": "helpPopoverTitle"; "required": false; }; "icon": { "alias": "icon"; "required": false; }; "radioType": { "alias": "radioType"; "required": false; }; "labelText": { "alias": "labelText"; "required": false; }; "labelHidden": { "alias": "labelHidden"; "required": false; }; "hintText": { "alias": "hintText"; "required": false; }; }, { "change": "change"; "checkedChange": "checkedChange"; "disabledChange": "disabledChange"; }, never, ["sky-radio-label"], false, never>;
|
|
165
|
+
static ɵcmp: i0.ɵɵComponentDeclaration<SkyRadioComponent, "sky-radio", never, { "checked": { "alias": "checked"; "required": false; }; "disabled": { "alias": "disabled"; "required": false; }; "id": { "alias": "id"; "required": false; }; "label": { "alias": "label"; "required": false; }; "labelledBy": { "alias": "labelledBy"; "required": false; }; "name": { "alias": "name"; "required": false; }; "tabindex": { "alias": "tabindex"; "required": false; }; "value": { "alias": "value"; "required": false; }; "helpPopoverContent": { "alias": "helpPopoverContent"; "required": false; }; "helpPopoverTitle": { "alias": "helpPopoverTitle"; "required": false; }; "icon": { "alias": "icon"; "required": false; }; "radioType": { "alias": "radioType"; "required": false; }; "labelText": { "alias": "labelText"; "required": false; }; "labelHidden": { "alias": "labelHidden"; "required": false; }; "hintText": { "alias": "hintText"; "required": false; }; "helpKey": { "alias": "helpKey"; "required": false; }; }, { "change": "change"; "checkedChange": "checkedChange"; "disabledChange": "disabledChange"; }, never, ["sky-radio-label"], false, never>;
|
|
160
166
|
static ngAcceptInputType_labelHidden: unknown;
|
|
161
167
|
}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export type SkyRadioGroupHeadingLevel = 3 | 4 | 5;
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export type SkyRadioGroupHeadingStyle = 3 | 4 | 5;
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@skyux/forms",
|
|
3
|
-
"version": "10.
|
|
3
|
+
"version": "10.20.0",
|
|
4
4
|
"author": "Blackbaud, Inc.",
|
|
5
5
|
"keywords": [
|
|
6
6
|
"blackbaud",
|
|
@@ -41,13 +41,13 @@
|
|
|
41
41
|
"@angular/core": "^17.3.4",
|
|
42
42
|
"@angular/forms": "^17.3.4",
|
|
43
43
|
"@angular/platform-browser": "^17.3.4",
|
|
44
|
-
"@skyux-sdk/testing": "10.
|
|
45
|
-
"@skyux/core": "10.
|
|
46
|
-
"@skyux/help-inline": "10.
|
|
47
|
-
"@skyux/i18n": "10.
|
|
48
|
-
"@skyux/indicators": "10.
|
|
49
|
-
"@skyux/popovers": "10.
|
|
50
|
-
"@skyux/theme": "10.
|
|
44
|
+
"@skyux-sdk/testing": "10.20.0",
|
|
45
|
+
"@skyux/core": "10.20.0",
|
|
46
|
+
"@skyux/help-inline": "10.20.0",
|
|
47
|
+
"@skyux/i18n": "10.20.0",
|
|
48
|
+
"@skyux/indicators": "10.20.0",
|
|
49
|
+
"@skyux/popovers": "10.20.0",
|
|
50
|
+
"@skyux/theme": "10.20.0"
|
|
51
51
|
},
|
|
52
52
|
"dependencies": {
|
|
53
53
|
"tslib": "^2.6.2"
|