@skyux/forms 10.7.0 → 10.8.0

package/lib/modules/checkbox/checkbox-group.component.d.ts

@@ -1,3 +1,4 @@
+import { TemplateRef } from '@angular/core';
 import { FormGroup } from '@angular/forms';
 import * as i0 from "@angular/core";
 /**
@@ -5,6 +6,19 @@ import * as i0 from "@angular/core";
  */
 export declare class SkyCheckboxGroupComponent {
     #private;
+    /**
+     * The content of the help popover. When specified along with `labelText`, a [help inline](https://developer.blackbaud.com/skyux/components/help-inline)
+     * button is added to the checkbox group fieldset legend. The help inline button displays a [popover](https://developer.blackbaud.com/skyux/components/popover)
+     * when clicked using the specified content and optional title.
+     * @preview
+     */
+    helpPopoverContent: string | TemplateRef<unknown> | undefined;
+    /**
+     * The title of the help popover. This property only applies when `helpPopoverContent` is
+     * also specified.
+     * @preview
+     */
+    helpPopoverTitle: string | undefined;
     /**
      * The text to display as the checkbox group's label.
      * @preview
@@ -35,7 +49,7 @@ export declare class SkyCheckboxGroupComponent {
     protected errorId: string;
     protected formErrorsDataId: string;
     static ɵfac: i0.ɵɵFactoryDeclaration<SkyCheckboxGroupComponent, never>;
-    static ɵcmp: i0.ɵɵComponentDeclaration<SkyCheckboxGroupComponent, "sky-checkbox-group", never, { "labelText": { "alias": "labelText"; "required": true; }; "labelHidden": { "alias": "labelHidden"; "required": false; }; "required": { "alias": "required"; "required": false; }; "stacked": { "alias": "stacked"; "required": false; }; "formGroup": { "alias": "formGroup"; "required": true; }; }, {}, never, ["sky-checkbox[icon]", "sky-checkbox", "sky-form-error"], true, never>;
+    static ɵcmp: i0.ɵɵComponentDeclaration<SkyCheckboxGroupComponent, "sky-checkbox-group", never, { "helpPopoverContent": { "alias": "helpPopoverContent"; "required": false; }; "helpPopoverTitle": { "alias": "helpPopoverTitle"; "required": false; }; "labelText": { "alias": "labelText"; "required": true; }; "labelHidden": { "alias": "labelHidden"; "required": false; }; "required": { "alias": "required"; "required": false; }; "stacked": { "alias": "stacked"; "required": false; }; "formGroup": { "alias": "formGroup"; "required": true; }; }, {}, never, ["sky-checkbox[icon]", "sky-checkbox", "sky-form-error"], true, never>;
     static ngAcceptInputType_labelHidden: unknown;
     static ngAcceptInputType_required: unknown;
     static ngAcceptInputType_stacked: unknown;

package/lib/modules/checkbox/checkbox.component.d.ts

@@ -1,4 +1,4 @@
-import { ElementRef, EventEmitter, OnInit } from '@angular/core';
+import { ElementRef, EventEmitter, OnInit, TemplateRef } from '@angular/core';
 import { ControlValueAccessor, NgControl } from '@angular/forms';
 import { Observable } from 'rxjs';
 import { SkyCheckboxChange } from './checkbox-change';
@@ -53,6 +53,19 @@ export declare class SkyCheckboxComponent implements ControlValueAccessor, OnIni
      */
     set name(value: string | undefined);
     get name(): string;
+    /**
+     * The content of the help popover. When specified along with `labelText`, a [help inline](https://developer.blackbaud.com/skyux/components/help-inline)
+     * button is added to the checkbox label. The help inline button displays a [popover](https://developer.blackbaud.com/skyux/components/popover)
+     * when clicked using the specified content and optional title.
+     * @preview
+     */
+    helpPopoverContent: string | TemplateRef<unknown> | undefined;
+    /**
+     * The title of the help popover. This property only applies when `helpPopoverContent` is
+     * also specified.
+     * @preview
+     */
+    helpPopoverTitle: string | undefined;
     /**
      * Fires when the selected value changes.
      */
@@ -108,6 +121,12 @@ export declare class SkyCheckboxComponent implements ControlValueAccessor, OnIni
      * @preview
      */
     labelHidden: boolean;
+    /**
+     * [Persistent inline help text](https://developer.blackbaud.com/skyux/design/guidelines/user-assistance#inline-help) that provides
+     * additional context to the user.
+     * @preview
+     */
+    hintText: string | undefined;
     /**
      * Fires when users select or deselect the checkbox.
      */
@@ -153,6 +172,6 @@ export declare class SkyCheckboxComponent implements ControlValueAccessor, OnIni
     /** Called when the checkbox is blurred. Needed to properly implement ControlValueAccessor. */
     onTouched: () => any;
     static ɵfac: i0.ɵɵFactoryDeclaration<SkyCheckboxComponent, never>;
-    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; }; "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; }; }, { "change": "change"; "checkedChange": "checkedChange"; "disabledChange": "disabledChange"; "indeterminateChange": "indeterminateChange"; }, never, ["sky-checkbox-label", "sky-form-error"], false, never>;
+    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; }; }, { "change": "change"; "checkedChange": "checkedChange"; "disabledChange": "disabledChange"; "indeterminateChange": "indeterminateChange"; }, never, ["sky-checkbox-label", "sky-form-error"], false, never>;
     static ngAcceptInputType_labelHidden: unknown;
 }

package/lib/modules/checkbox/checkbox.module.d.ts

@@ -8,10 +8,11 @@ import * as i6 from "./checkbox-group.component";
 import * as i7 from "../form-error/form-error.module";
 import * as i8 from "../form-error/form-errors.module";
 import * as i9 from "../shared/sky-forms-resources.module";
-import * as i10 from "@skyux/indicators";
-import * as i11 from "@skyux/core";
+import * as i10 from "@skyux/help-inline";
+import * as i11 from "@skyux/indicators";
+import * as i12 from "@skyux/core";
 export declare class SkyCheckboxModule {
     static ɵfac: i0.ɵɵFactoryDeclaration<SkyCheckboxModule, never>;
-    static ɵmod: i0.ɵɵNgModuleDeclaration<SkyCheckboxModule, [typeof i1.SkyCheckboxComponent, typeof i2.SkyCheckboxLabelComponent, typeof i3.SkyCheckboxLabelTextLabelComponent], [typeof i4.CommonModule, typeof i5.FormsModule, typeof i6.SkyCheckboxGroupComponent, typeof i7.SkyFormErrorModule, typeof i8.SkyFormErrorsModule, typeof i9.SkyFormsResourcesModule, typeof i10.SkyIconModule, typeof i11.SkyTrimModule], [typeof i1.SkyCheckboxComponent, typeof i2.SkyCheckboxLabelComponent, typeof i6.SkyCheckboxGroupComponent, typeof i7.SkyFormErrorModule]>;
+    static ɵmod: i0.ɵɵNgModuleDeclaration<SkyCheckboxModule, [typeof i1.SkyCheckboxComponent, typeof i2.SkyCheckboxLabelComponent, typeof i3.SkyCheckboxLabelTextLabelComponent], [typeof i4.CommonModule, typeof i5.FormsModule, typeof i6.SkyCheckboxGroupComponent, typeof i7.SkyFormErrorModule, typeof i8.SkyFormErrorsModule, typeof i9.SkyFormsResourcesModule, typeof i10.SkyHelpInlineModule, typeof i11.SkyIconModule, typeof i12.SkyIdModule, typeof i12.SkyTrimModule], [typeof i1.SkyCheckboxComponent, typeof i2.SkyCheckboxLabelComponent, typeof i6.SkyCheckboxGroupComponent, typeof i7.SkyFormErrorModule]>;
     static ɵinj: i0.ɵɵInjectorDeclaration<SkyCheckboxModule>;
 }

package/lib/modules/field-group/field-group.component.d.ts

@@ -10,6 +10,12 @@ export declare class SkyFieldGroupComponent {
      * @preview
      */
     labelText: string;
+    /**
+     * [Persistent inline help text](https://developer.blackbaud.com/skyux/design/guidelines/user-assistance#inline-help) that provides
+     * additional context to the user.
+     * @preview
+     */
+    hintText: string | undefined;
     /**
      * Indicates whether to hide the `labelText`.
      * @preview
@@ -33,7 +39,7 @@ export declare class SkyFieldGroupComponent {
     set headingStyle(value: SkyFieldGroupHeadingStyle);
     protected headingClass: string;
     static ɵfac: i0.ɵɵFactoryDeclaration<SkyFieldGroupComponent, never>;
-    static ɵcmp: i0.ɵɵComponentDeclaration<SkyFieldGroupComponent, "sky-field-group", never, { "labelText": { "alias": "labelText"; "required": true; }; "labelHidden": { "alias": "labelHidden"; "required": false; }; "stacked": { "alias": "stacked"; "required": false; }; "headingLevel": { "alias": "headingLevel"; "required": false; }; "headingStyle": { "alias": "headingStyle"; "required": false; }; }, {}, never, ["*"], true, never>;
+    static ɵcmp: i0.ɵɵComponentDeclaration<SkyFieldGroupComponent, "sky-field-group", never, { "labelText": { "alias": "labelText"; "required": true; }; "hintText": { "alias": "hintText"; "required": false; }; "labelHidden": { "alias": "labelHidden"; "required": false; }; "stacked": { "alias": "stacked"; "required": false; }; "headingLevel": { "alias": "headingLevel"; "required": false; }; "headingStyle": { "alias": "headingStyle"; "required": false; }; }, {}, never, ["*"], true, never>;
     static ngAcceptInputType_labelHidden: unknown;
     static ngAcceptInputType_stacked: unknown;
     static ngAcceptInputType_headingLevel: unknown;

package/lib/modules/file-attachment/file-attachment.component.d.ts

@@ -30,7 +30,7 @@ export declare class SkyFileAttachmentComponent implements AfterViewInit, AfterC
     get disabled(): boolean;
     /**
      * The content of the help popover. When specified along with `labelText`, a [help inline](https://developer.blackbaud.com/skyux/components/help-inline)
-     * button is added to the input box label. The help inline button displays a [popover](https://developer.blackbaud.com/skyux/components/popover)
+     * button is added to the single file attachment label. The help inline button displays a [popover](https://developer.blackbaud.com/skyux/components/popover)
      * when clicked using the specified content and optional title.
      * @preview
      */
@@ -51,6 +51,12 @@ export declare class SkyFileAttachmentComponent implements AfterViewInit, AfterC
      * @preview
      */
     labelHidden: boolean;
+    /**
+     * [Persistent inline help text](https://developer.blackbaud.com/skyux/design/guidelines/user-assistance#inline-help) that provides
+     * additional context to the user.
+     * @preview
+     */
+    hintText: string | undefined;
     /**
      * The maximum size in bytes for valid files.
      * @default 500000
@@ -127,6 +133,6 @@ export declare class SkyFileAttachmentComponent implements AfterViewInit, AfterC
     setDisabledState(isDisabled: boolean): void;
     emitClick(): void;
     static ɵfac: i0.ɵɵFactoryDeclaration<SkyFileAttachmentComponent, [null, null, null, { optional: true; self: true; }, { optional: true; }]>;
-    static ɵcmp: i0.ɵɵComponentDeclaration<SkyFileAttachmentComponent, "sky-file-attachment", never, { "acceptedTypes": { "alias": "acceptedTypes"; "required": false; }; "disabled": { "alias": "disabled"; "required": false; }; "helpPopoverContent": { "alias": "helpPopoverContent"; "required": false; }; "helpPopoverTitle": { "alias": "helpPopoverTitle"; "required": false; }; "labelText": { "alias": "labelText"; "required": false; }; "labelHidden": { "alias": "labelHidden"; "required": false; }; "maxFileSize": { "alias": "maxFileSize"; "required": false; }; "minFileSize": { "alias": "minFileSize"; "required": false; }; "validateFn": { "alias": "validateFn"; "required": false; }; "required": { "alias": "required"; "required": false; }; }, { "fileChange": "fileChange"; "fileClick": "fileClick"; }, ["labelComponents"], ["sky-form-error", "sky-file-attachment-label"], false, never>;
+    static ɵcmp: i0.ɵɵComponentDeclaration<SkyFileAttachmentComponent, "sky-file-attachment", never, { "acceptedTypes": { "alias": "acceptedTypes"; "required": false; }; "disabled": { "alias": "disabled"; "required": false; }; "helpPopoverContent": { "alias": "helpPopoverContent"; "required": false; }; "helpPopoverTitle": { "alias": "helpPopoverTitle"; "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; }; "validateFn": { "alias": "validateFn"; "required": false; }; "required": { "alias": "required"; "required": false; }; }, { "fileChange": "fileChange"; "fileClick": "fileClick"; }, ["labelComponents"], ["sky-form-error", "sky-file-attachment-label"], false, never>;
     static ngAcceptInputType_labelHidden: unknown;
 }

package/lib/modules/radio/radio.component.d.ts

@@ -105,6 +105,12 @@ export declare class SkyRadioComponent implements OnDestroy, ControlValueAccesso
      * @preview
      */
     labelHidden: boolean;
+    /**
+     * [Persistent inline help text](https://developer.blackbaud.com/skyux/design/guidelines/user-assistance#inline-help) that provides
+     * additional context to the user.
+     * @preview
+     */
+    hintText: string | undefined;
     /**
      * Fires when users select a radio button.
      */
@@ -135,6 +141,6 @@ export declare class SkyRadioComponent implements OnDestroy, ControlValueAccesso
     onInputChange(event: Event): void;
     onInputFocusChange(): void;
     static ɵfac: i0.ɵɵFactoryDeclaration<SkyRadioComponent, never>;
-    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; }; "icon": { "alias": "icon"; "required": false; }; "radioType": { "alias": "radioType"; "required": false; }; "labelText": { "alias": "labelText"; "required": false; }; "labelHidden": { "alias": "labelHidden"; "required": false; }; }, { "change": "change"; "checkedChange": "checkedChange"; "disabledChange": "disabledChange"; }, never, ["sky-radio-label"], false, never>;
+    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; }; "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>;
     static ngAcceptInputType_labelHidden: unknown;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@skyux/forms",
-  "version": "10.7.0",
+  "version": "10.8.0",
   "author": "Blackbaud, Inc.",
   "keywords": [
     "blackbaud",
@@ -41,13 +41,13 @@
     "@angular/core": "^17.3.4",
     "@angular/forms": "^17.3.4",
     "@angular/platform-browser": "^17.3.4",
-    "@skyux-sdk/testing": "10.7.0",
-    "@skyux/core": "10.7.0",
-    "@skyux/help-inline": "10.7.0",
-    "@skyux/i18n": "10.7.0",
-    "@skyux/indicators": "10.7.0",
-    "@skyux/popovers": "10.7.0",
-    "@skyux/theme": "10.7.0"
+    "@skyux-sdk/testing": "10.8.0",
+    "@skyux/core": "10.8.0",
+    "@skyux/help-inline": "10.8.0",
+    "@skyux/i18n": "10.8.0",
+    "@skyux/indicators": "10.8.0",
+    "@skyux/popovers": "10.8.0",
+    "@skyux/theme": "10.8.0"
   },
   "dependencies": {
     "tslib": "^2.6.2"

package/testing/checkbox/checkbox-harness.d.ts

@@ -1,4 +1,5 @@
 import { HarnessPredicate } from '@angular/cdk/testing';
+import { TemplateRef } from '@angular/core';
 import { SkyComponentHarness } from '@skyux/core/testing';
 import { SkyCheckboxHarnessFilters } from './checkbox-harness-filters';
 /**
@@ -20,6 +21,10 @@ export declare class SkyCheckboxHarness extends SkyComponentHarness {
      * Blurs the checkbox.
      */
     blur(): Promise<void>;
+    /**
+     * Clicks the help inline button.
+     */
+    clickHelpInline(): Promise<void>;
     /**
      * Puts the checkbox in a checked state by toggling it if it is currently unchecked, or doing nothing if it is already checked.
      */
@@ -36,6 +41,14 @@ export declare class SkyCheckboxHarness extends SkyComponentHarness {
      * Gets the checkbox's aria-labelledby.
      */
     getAriaLabelledby(): Promise<string | null>;
+    /**
+     * Gets the help popover content.
+     */
+    getHelpPopoverContent(): Promise<TemplateRef<unknown> | string | undefined>;
+    /**
+     * Gets the help popover title.
+     */
+    getHelpPopoverTitle(): Promise<string | undefined>;
     /**
      * Gets the checkbox's label text. If the label is set via `labelText` and `labelHidden` is true,
      * the text will still be returned.
@@ -45,6 +58,10 @@ export declare class SkyCheckboxHarness extends SkyComponentHarness {
      * Whether the label is hidden. Only supported when using the `labelText` input to set the label.
      */
     getLabelHidden(): Promise<boolean>;
+    /**
+     * Gets the checkbox's hint text.
+     */
+    getHintText(): Promise<string>;
     /**
      * Gets the checkbox's name.
      */
@@ -53,6 +70,14 @@ export declare class SkyCheckboxHarness extends SkyComponentHarness {
      * Gets the checkbox's value.
      */
     getValue(): Promise<string | null>;
+    /**
+     * Whether the checkbox displays custom error.
+     */
+    hasCustomError(errorName: string): Promise<boolean>;
+    /**
+     * Whether the checkbox displays an error that it is required.
+     */
+    hasRequiredError(): Promise<boolean>;
     /**
      * Whether the checkbox is checked.
      */
@@ -73,6 +98,4 @@ export declare class SkyCheckboxHarness extends SkyComponentHarness {
      * Puts the checkbox in an unchecked state by toggling it if it is currently checked, or doing nothing if it is already unchecked.
      */
     uncheck(): Promise<void>;
-    hasRequiredError(): Promise<boolean>;
-    hasCustomError(errorName: string): Promise<boolean>;
 }