@skyux/forms 11.2.0 → 11.4.0

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

@@ -9,9 +9,9 @@ import * as i0 from "@angular/core";
 export declare class SkyCheckboxGroupComponent implements Validator {
     #private;
     /**
-     * The content of the help popover. When specified, a [help inline](https://developer.blackbaud.com/skyux/components/help-inline)
+     * The content of the help popover. When specified along with `headingText`, 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.
+     * when clicked using the specified content and optional title. This property only applies when `headingText` is also specified.
      */
     helpPopoverContent: string | TemplateRef<unknown> | undefined;
     /**
@@ -53,9 +53,9 @@ export declare class SkyCheckboxGroupComponent implements Validator {
     set stacked(value: boolean);
     get stacked(): boolean;
     /**
-     * A help key that identifies the global help content to display. When specified, a [help inline](https://developer.blackbaud.com/skyux/components/help-inline)
+     * A help key that identifies the global help content to display. When specified along with `headingText`, a [help inline](https://developer.blackbaud.com/skyux/components/help-inline)
      * button is placed beside the checkbox group heading. Clicking the button invokes [global help](https://developer.blackbaud.com/skyux/learn/develop/global-help)
-     * as configured by the application.
+     * as configured by the application. This property only applies when `headingText` is also specified.
      */
     helpKey: string | undefined;
     stackedLg: boolean;

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

@@ -57,7 +57,7 @@ export declare class SkyCheckboxComponent implements ControlValueAccessor, Valid
     /**
      * 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.
+     * when clicked using the specified content and optional title. This property only applies when `labelText` is also specified.
      */
     helpPopoverContent: string | TemplateRef<unknown> | undefined;
     /**
@@ -129,9 +129,9 @@ export declare class SkyCheckboxComponent implements ControlValueAccessor, Valid
      */
     stacked: boolean;
     /**
-     * A help key that identifies the global help content to display. When specified, a [help inline](https://developer.blackbaud.com/skyux/components/help-inline)
+     * A help key that identifies the global help content to display. When specified along with `labelText`, a [help inline](https://developer.blackbaud.com/skyux/components/help-inline)
      * button is placed beside the checkbox label. Clicking the button invokes [global help](https://developer.blackbaud.com/skyux/learn/develop/global-help)
-     * as configured by the application.
+     * as configured by the application. This property only applies when `labelText` is also specified.
      */
     helpKey: string | undefined;
     /**

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

@@ -35,9 +35,9 @@ export declare class SkyFieldGroupComponent {
      */
     set headingStyle(value: SkyFieldGroupHeadingStyle);
     /**
-     * The content of the help popover. When specified, a [help inline](https://developer.blackbaud.com/skyux/components/help-inline)
+     * The content of the help popover. When specified along with `headingText`, a [help inline](https://developer.blackbaud.com/skyux/components/help-inline)
      * button is added to the field group heading. The help inline button displays a [popover](https://developer.blackbaud.com/skyux/components/popover)
-     * when clicked using the specified content and optional title.
+     * when clicked using the specified content and optional title. This property only applies when `headingText` is also specified.
      */
     helpPopoverContent: string | TemplateRef<unknown> | undefined;
     /**
@@ -46,9 +46,9 @@ export declare class SkyFieldGroupComponent {
      */
     helpPopoverTitle: string | undefined;
     /**
-     * A help key that identifies the global help content to display. When specified, a [help inline](https://developer.blackbaud.com/skyux/components/help-inline)
+     * A help key that identifies the global help content to display. When specified along with `headingText`, a [help inline](https://developer.blackbaud.com/skyux/components/help-inline)
      * button is placed beside the field group heading. Clicking the button invokes [global help](https://developer.blackbaud.com/skyux/learn/develop/global-help)
-     * as configured by the application.
+     * as configured by the application. This property only applies when `headingText` is also specified.
      */
     helpKey: string | undefined;
     protected headingClass: string;

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

@@ -34,7 +34,7 @@ export declare class SkyFileAttachmentComponent implements AfterViewInit, AfterC
     /**
      * 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 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.
+     * when clicked using the specified content and optional title. This property only applies when `labelText` is also specified.
      */
     helpPopoverContent: string | TemplateRef<unknown> | undefined;
     /**
@@ -43,9 +43,9 @@ export declare class SkyFileAttachmentComponent implements AfterViewInit, AfterC
      */
     helpPopoverTitle: string | undefined;
     /**
-     * A help key that identifies the global help content to display. When specified, a [help inline](https://developer.blackbaud.com/skyux/components/help-inline)
+     * A help key that identifies the global help content to display. When specified along with `labelText`, a [help inline](https://developer.blackbaud.com/skyux/components/help-inline)
      * button is placed beside the single file attachment label. Clicking the button invokes [global help](https://developer.blackbaud.com/skyux/learn/develop/global-help)
-     * as configured by the application.
+     * as configured by the application. This property only applies when `labelText` is also specified.
      */
     helpKey: string | undefined;
     /**

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

@@ -107,7 +107,7 @@ export declare class SkyFileDropComponent implements OnDestroy {
     /**
      * 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 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.
+     * when clicked using the specified content and optional title. This property only applies when `labelText` is also specified.
      */
     helpPopoverContent: string | TemplateRef<unknown> | undefined;
     /**
@@ -121,9 +121,9 @@ export declare class SkyFileDropComponent implements OnDestroy {
      */
     stacked: boolean;
     /**
-     * A help key that identifies the global help content to display. When specified, a [help inline](https://developer.blackbaud.com/skyux/components/help-inline)
+     * A help key that identifies the global help content to display. When specified along with `labelText`, a [help inline](https://developer.blackbaud.com/skyux/components/help-inline)
      * button is placed beside the file attachment label. Clicking the button invokes [global help](https://developer.blackbaud.com/skyux/learn/develop/global-help)
-     * as configured by the application.
+     * as configured by the application. This property only applies when `labelText` is also specified.
      */
     helpKey: string | undefined;
     inputEl: ElementRef | undefined;

package/lib/modules/input-box/input-box.component.d.ts

@@ -49,15 +49,15 @@ export declare class SkyInputBoxComponent implements OnInit, AfterContentChecked
      */
     helpPopoverTitle: string | undefined;
     /**
-     * The content of the help popover. When specified, a [help inline](https://developer.blackbaud.com/skyux/components/help-inline)
+     * 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)
-     * when clicked using the specified content and optional title.
+     * when clicked using the specified content and optional title. This property only applies when `labelText` is also specified.
      */
     helpPopoverContent: string | TemplateRef<unknown> | undefined;
     /**
-     * A help key that identifies the global help content to display. When specified, a [help inline](https://developer.blackbaud.com/skyux/components/help-inline)
+     * A help key that identifies the global help content to display. When specified along with `labelText`, a [help inline](https://developer.blackbaud.com/skyux/components/help-inline)
      * button is placed beside the input box label. Clicking the button invokes [global help](https://developer.blackbaud.com/skyux/learn/develop/global-help)
-     * as configured by the application.
+     * as configured by the application. This property only applies when `labelText` is also specified.
      */
     helpKey: string | undefined;
     /**

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

@@ -104,7 +104,7 @@ export declare class SkyRadioGroupComponent implements AfterContentInit, OnDestr
     /**
      * The content of the help popover. When specified along with `headingText`, a [help inline](https://developer.blackbaud.com/skyux/components/help-inline)
      * button is added to radio group. The help inline button displays a [popover](https://developer.blackbaud.com/skyux/components/popover)
-     * when clicked using the specified content and optional title.
+     * when clicked using the specified content and optional title. This property only applies when `headingText` is also specified.
      */
     helpPopoverContent: string | TemplateRef<unknown> | undefined;
     /**
@@ -113,9 +113,9 @@ export declare class SkyRadioGroupComponent implements AfterContentInit, OnDestr
      */
     helpPopoverTitle: string | undefined;
     /**
-     * A help key that identifies the global help content to display. When specified, a [help inline](https://developer.blackbaud.com/skyux/components/help-inline)
+     * A help key that identifies the global help content to display. When specified along with `headingText`, a [help inline](https://developer.blackbaud.com/skyux/components/help-inline)
      * button is placed beside the radio group heading. Clicking the button invokes [global help](https://developer.blackbaud.com/skyux/learn/develop/global-help)
-     * as configured by the application.
+     * as configured by the application. This property only applies when `headingText` is also specified.
      */
     helpKey: string | undefined;
     /**

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

@@ -81,7 +81,7 @@ export declare class SkyRadioComponent implements OnDestroy, ControlValueAccesso
     /**
      * 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 radio button. The help inline button displays a [popover](https://developer.blackbaud.com/skyux/components/popover)
-     * when clicked using the specified content and optional title.
+     * when clicked using the specified content and optional title. This property only applies when `labelText` is also specified.
      */
     helpPopoverContent: string | TemplateRef<unknown> | undefined;
     /**
@@ -120,9 +120,9 @@ export declare class SkyRadioComponent implements OnDestroy, ControlValueAccesso
      */
     hintText: string | undefined;
     /**
-     * A help key that identifies the global help content to display. When specified, a [help inline](https://developer.blackbaud.com/skyux/components/help-inline)
+     * A help key that identifies the global help content to display. When specified along with `labelText`, a [help inline](https://developer.blackbaud.com/skyux/components/help-inline)
      * button is placed beside the radio button label. Clicking the button invokes [global help](https://developer.blackbaud.com/skyux/learn/develop/global-help)
-     * as configured by the application.
+     * as configured by the application. This property only applies when `labelText` is also specified.
      */
     helpKey: string | undefined;
     /**

package/lib/modules/toggle-switch/toggle-switch.component.d.ts

@@ -30,7 +30,7 @@ export declare class SkyToggleSwitchComponent implements AfterContentInit, OnDes
     /**
      * 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 toggle switch. The help inline button displays a [popover](https://developer.blackbaud.com/skyux/components/popover)
-     * when clicked using the specified content and optional title.
+     * when clicked using the specified content and optional title. This property only applies when `labelText` is also specified.
      */
     helpPopoverContent: string | TemplateRef<unknown> | undefined;
     /**
@@ -52,9 +52,9 @@ export declare class SkyToggleSwitchComponent implements AfterContentInit, OnDes
      */
     labelHidden: boolean;
     /**
-     * A help key that identifies the global help content to display. When specified, a [help inline](https://developer.blackbaud.com/skyux/components/help-inline)
+     * A help key that identifies the global help content to display. When specified along with `labelText`, a [help inline](https://developer.blackbaud.com/skyux/components/help-inline)
      * button is placed beside the toggle switch label. Clicking the button invokes [global help](https://developer.blackbaud.com/skyux/learn/develop/global-help)
-     * as configured by the application.
+     * as configured by the application. This property only applies when `labelText` is also specified.
      */
     helpKey: string | undefined;
     /**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@skyux/forms",
-  "version": "11.2.0",
+  "version": "11.4.0",
   "author": "Blackbaud, Inc.",
   "keywords": [
     "blackbaud",
@@ -36,19 +36,19 @@
     }
   },
   "peerDependencies": {
-    "@angular/cdk": "^18.2.3",
-    "@angular/common": "^18.2.3",
-    "@angular/core": "^18.2.3",
-    "@angular/forms": "^18.2.3",
-    "@angular/platform-browser": "^18.2.3",
-    "@skyux-sdk/testing": "11.2.0",
-    "@skyux/core": "11.2.0",
-    "@skyux/help-inline": "11.2.0",
-    "@skyux/i18n": "11.2.0",
-    "@skyux/icon": "11.2.0",
-    "@skyux/indicators": "11.2.0",
-    "@skyux/popovers": "11.2.0",
-    "@skyux/theme": "11.2.0"
+    "@angular/cdk": "^18.2.4",
+    "@angular/common": "^18.2.5",
+    "@angular/core": "^18.2.5",
+    "@angular/forms": "^18.2.5",
+    "@angular/platform-browser": "^18.2.5",
+    "@skyux-sdk/testing": "11.4.0",
+    "@skyux/core": "11.4.0",
+    "@skyux/help-inline": "11.4.0",
+    "@skyux/i18n": "11.4.0",
+    "@skyux/icon": "11.4.0",
+    "@skyux/indicators": "11.4.0",
+    "@skyux/popovers": "11.4.0",
+    "@skyux/theme": "11.4.0"
   },
   "dependencies": {
     "tslib": "^2.6.3"

package/testing/public-api.d.ts

@@ -11,3 +11,8 @@ export { SkyFormErrorsHarnessFilters } from './form-error/form-errors-harness.fi
 export { SkyFormErrorHarness } from './form-error/form-error-harness';
 export { SkyFormErrorHarnessFilters } from './form-error/form-error-harness.filters';
 export { SkyRadioFixture } from './radio-fixture';
+export { SkyRadioGroupHarness } from './radio/radio-group-harness';
+export { SkyRadioGroupHarnessFilters } from './radio/radio-group-harness-filters';
+export { SkyRadioHarness } from './radio/radio-harness';
+export { SkyRadioHarnessFilters } from './radio/radio-harness-filters';
+export { SkyRadioLabelHarness } from './radio/radio-label-harness';

package/testing/radio/radio-group-harness-filters.d.ts

@@ -0,0 +1,7 @@
+import { SkyHarnessFilters } from '@skyux/core/testing';
+/**
+ * A set of criteria that can be used to filter a list of `SkyRadioGroupHarness` instances.
+ * @internal
+ */
+export interface SkyRadioGroupHarnessFilters extends SkyHarnessFilters {
+}

package/testing/radio/radio-group-harness.d.ts

@@ -0,0 +1,69 @@
+import { HarnessPredicate } from '@angular/cdk/testing';
+import { SkyComponentHarness } from '@skyux/core/testing';
+import { SkyRadioGroupHeadingLevel, SkyRadioGroupHeadingStyle } from '@skyux/forms';
+import { SkyRadioGroupHarnessFilters } from './radio-group-harness-filters';
+import { SkyRadioHarness } from './radio-harness';
+/**
+ * Harness for interacting with a radio group component in tests.
+ */
+export declare class SkyRadioGroupHarness extends SkyComponentHarness {
+    #private;
+    /**
+     * @internal
+     */
+    static hostSelector: string;
+    /**
+     * Gets a `HarnessPredicate` that can be used to search for a
+     * `SkyRadioGroupHarness` that meets certain criteria.
+     */
+    static with(filters: SkyRadioGroupHarnessFilters): HarnessPredicate<SkyRadioGroupHarness>;
+    /**
+     * Clicks the help inline button.
+     */
+    clickHelpInline(): Promise<void>;
+    /**
+     * Whether the heading is hidden.
+     */
+    getHeadingHidden(): Promise<boolean>;
+    /**
+     * The semantic heading level used for the radio group. Returns undefined if heading level is not set.
+     */
+    getHeadingLevel(): Promise<SkyRadioGroupHeadingLevel | undefined>;
+    /**
+     * The heading style used for the radio group.
+     */
+    getHeadingStyle(): Promise<SkyRadioGroupHeadingStyle>;
+    /**
+     * Gets the radio group's heading text. If `headingHidden` is true,
+     * the text will still be returned.
+     */
+    getHeadingText(): Promise<string | undefined>;
+    /**
+     * Gets the help popover content.
+     */
+    getHelpPopoverContent(): Promise<string | undefined>;
+    /**
+     * Gets the help popover title.
+     */
+    getHelpPopoverTitle(): Promise<string | undefined>;
+    /**
+     * Gets the radio group's hint text.
+     */
+    getHintText(): Promise<string>;
+    /**
+     * Gets an array of harnesses for the radio buttons in the radio group.
+     */
+    getRadioButtons(): Promise<SkyRadioHarness[]>;
+    /**
+     * Whether the radio group is required.
+     */
+    getRequired(): Promise<boolean>;
+    /**
+     * Whether the radio group is stacked.
+     */
+    getStacked(): Promise<boolean>;
+    /**
+     * Whether the radio group has errors.
+     */
+    hasError(errorName: string): Promise<boolean>;
+}

package/testing/radio/radio-harness-filters.d.ts

@@ -0,0 +1,7 @@
+import { SkyHarnessFilters } from '@skyux/core/testing';
+/**
+ * A set of criteria that can be used to filter a list of `SkyRadioHarness` instances.
+ * @internal
+ */
+export interface SkyRadioHarnessFilters extends SkyHarnessFilters {
+}

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

@@ -0,0 +1,79 @@
+import { HarnessPredicate } from '@angular/cdk/testing';
+import { SkyComponentHarness } from '@skyux/core/testing';
+import { SkyRadioHarnessFilters } from './radio-harness-filters';
+/**
+ * Harness for interacting with a radio button component in tests.
+ */
+export declare class SkyRadioHarness extends SkyComponentHarness {
+    #private;
+    /**
+     * @internal
+     */
+    static hostSelector: string;
+    /**
+     * Gets a `HarnessPredicate` that can be used to search for a
+     * `SkyRadioHarness` that meets certain criteria.
+     */
+    static with(filters: SkyRadioHarnessFilters): HarnessPredicate<SkyRadioHarness>;
+    /**
+     * Blurs the radio button.
+     */
+    blur(): Promise<void>;
+    /**
+     * Puts the radio button in a checked state if it is currently unchecked.
+     */
+    check(): Promise<void>;
+    /**
+     * Clicks the help inline button.
+     */
+    clickHelpInline(): Promise<void>;
+    /**
+     * Focuses the radio button.
+     */
+    focus(): Promise<void>;
+    /**
+     * Gets the radio button's aria-label.
+     */
+    getAriaLabel(): Promise<string | null>;
+    /**
+     * Gets the radio button's aria-labelledby.
+     */
+    getAriaLabelledby(): Promise<string | null>;
+    /**
+     * Gets the help popover content.
+     */
+    getHelpPopoverContent(): Promise<string | undefined>;
+    /**
+     * Gets the help popover title.
+     */
+    getHelpPopoverTitle(): Promise<string | undefined>;
+    /**
+     * Gets the radio button's hint text.
+     */
+    getHintText(): Promise<string>;
+    /**
+     * Whether the label is hidden. Only supported when using the `labelText` input to set the label.
+     */
+    getLabelHidden(): Promise<boolean>;
+    /**
+     * Gets the radio button's label text. If the label is set via `labelText` and `labelHidden` is true,
+     * the text will still be returned.
+     */
+    getLabelText(): Promise<string | undefined>;
+    /**
+     * Gets the radio button's name.
+     */
+    getName(): Promise<string | null>;
+    /**
+     * Whether the radio button is checked.
+     */
+    isChecked(): Promise<boolean>;
+    /**
+     * Whether the radio button is disabled.
+     */
+    isDisabled(): Promise<boolean>;
+    /**
+     * Whether the radio button is focused.
+     */
+    isFocused(): Promise<boolean>;
+}

package/testing/radio/radio-label-harness.d.ts

@@ -0,0 +1,16 @@
+import { ComponentHarness } from '@angular/cdk/testing';
+/**
+ * Harness for interacting with a radio label component in tests.
+ * @internal
+ */
+export declare class SkyRadioLabelHarness extends ComponentHarness {
+    #private;
+    /**
+     * @internal
+     */
+    static hostSelector: string;
+    /**
+     * Gets the text content of the radio label.
+     */
+    getText(): Promise<string>;
+}