@skyux/forms 10.19.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/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.
@@ -29,6 +31,18 @@ export declare class SkyCheckboxGroupComponent {
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.
@@ -59,9 +73,12 @@ export declare class SkyCheckboxGroupComponent {
59
73
  helpKey: string | undefined;
60
74
  protected errorId: string;
61
75
  protected formErrorsDataId: string;
76
+ protected headingClass: string;
62
77
  static ɵfac: i0.ɵɵFactoryDeclaration<SkyCheckboxGroupComponent, never>;
63
- 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; }; "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>;
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>;
64
79
  static ngAcceptInputType_headingHidden: unknown;
80
+ static ngAcceptInputType_headingLevel: unknown;
81
+ static ngAcceptInputType_headingStyle: unknown;
65
82
  static ngAcceptInputType_required: unknown;
66
83
  static ngAcceptInputType_stacked: unknown;
67
84
  }
@@ -29,13 +29,15 @@ 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
  /**
@@ -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
  }
@@ -41,13 +41,15 @@ export declare class SkyRadioGroupComponent implements AfterContentInit, AfterVi
41
41
  set disabled(value: boolean | undefined);
42
42
  get disabled(): boolean;
43
43
  /**
44
- * The heading level in the document structure.
44
+ * The semantic heading level in the document structure.
45
45
  * @preview
46
+ * @default 3
46
47
  */
47
48
  headingLevel: SkyRadioGroupHeadingLevel;
48
49
  /**
49
- * The heading font style.
50
+ * The heading [font style](https://developer.blackbaud.com/skyux/design/styles/typography#headings).
50
51
  * @preview
52
+ * @default 3
51
53
  */
52
54
  set headingStyle(value: SkyRadioGroupHeadingStyle);
53
55
  /**
@@ -118,6 +120,12 @@ export declare class SkyRadioGroupComponent implements AfterContentInit, AfterVi
118
120
  * @preview
119
121
  */
120
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;
121
129
  /**
122
130
  * Our radio components are usually implemented using an unordered list. This is an
123
131
  * accessibility violation because the unordered list has an implicit role which
@@ -145,7 +153,7 @@ export declare class SkyRadioGroupComponent implements AfterContentInit, AfterVi
145
153
  registerOnChange(fn: (value: any) => void): void;
146
154
  registerOnTouched(fn: any): void;
147
155
  static ɵfac: i0.ɵɵFactoryDeclaration<SkyRadioGroupComponent, [null, null, { optional: true; self: true; }]>;
148
- 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; }; }, {}, ["radios"], ["*", "sky-form-error"], false, never>;
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>;
149
157
  static ngAcceptInputType_headingLevel: unknown;
150
158
  static ngAcceptInputType_headingStyle: unknown;
151
159
  static ngAcceptInputType_stacked: unknown;
@@ -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
  }
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@skyux/forms",
3
- "version": "10.19.0",
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.19.0",
45
- "@skyux/core": "10.19.0",
46
- "@skyux/help-inline": "10.19.0",
47
- "@skyux/i18n": "10.19.0",
48
- "@skyux/indicators": "10.19.0",
49
- "@skyux/popovers": "10.19.0",
50
- "@skyux/theme": "10.19.0"
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"