@skyux/forms 12.27.0 → 13.0.0-alpha.1

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.
Files changed (117) hide show
  1. package/fesm2022/skyux-forms-testing.mjs.map +1 -1
  2. package/fesm2022/skyux-forms.mjs +159 -159
  3. package/fesm2022/skyux-forms.mjs.map +1 -1
  4. package/index.d.ts +1800 -61
  5. package/package.json +14 -14
  6. package/testing/index.d.ts +1117 -3
  7. package/lib/modules/character-counter/character-counter-indicator.component.d.ts +0 -12
  8. package/lib/modules/character-counter/character-counter-screen-reader.pipe.d.ts +0 -8
  9. package/lib/modules/character-counter/character-counter.directive.d.ts +0 -29
  10. package/lib/modules/character-counter/character-counter.module.d.ts +0 -12
  11. package/lib/modules/checkbox/checkbox-change.d.ts +0 -9
  12. package/lib/modules/checkbox/checkbox-group-heading-level.d.ts +0 -1
  13. package/lib/modules/checkbox/checkbox-group-heading-style.d.ts +0 -1
  14. package/lib/modules/checkbox/checkbox-group.component.d.ts +0 -76
  15. package/lib/modules/checkbox/checkbox-label-text-label.component.d.ts +0 -12
  16. package/lib/modules/checkbox/checkbox-label.component.d.ts +0 -11
  17. package/lib/modules/checkbox/checkbox.component.d.ts +0 -195
  18. package/lib/modules/checkbox/checkbox.module.d.ts +0 -19
  19. package/lib/modules/field-group/field-group-heading-level.d.ts +0 -1
  20. package/lib/modules/field-group/field-group-heading-style.d.ts +0 -1
  21. package/lib/modules/field-group/field-group.component.d.ts +0 -61
  22. package/lib/modules/field-group/field-group.module.d.ts +0 -7
  23. package/lib/modules/file-attachment/file-attachment/file-attachment-change.d.ts +0 -7
  24. package/lib/modules/file-attachment/file-attachment/file-attachment-click.d.ts +0 -7
  25. package/lib/modules/file-attachment/file-attachment/file-attachment-join-ids.pipe.d.ts +0 -11
  26. package/lib/modules/file-attachment/file-attachment/file-attachment-label.component.d.ts +0 -17
  27. package/lib/modules/file-attachment/file-attachment/file-attachment.component.d.ts +0 -153
  28. package/lib/modules/file-attachment/file-attachment/file-attachment.module.d.ts +0 -9
  29. package/lib/modules/file-attachment/file-attachment/file-attachment.service.d.ts +0 -17
  30. package/lib/modules/file-attachment/file-attachments.module.d.ts +0 -11
  31. package/lib/modules/file-attachment/file-drop/file-drop-change.d.ts +0 -11
  32. package/lib/modules/file-attachment/file-drop/file-drop.component.d.ts +0 -162
  33. package/lib/modules/file-attachment/file-drop/file-drop.module.d.ts +0 -9
  34. package/lib/modules/file-attachment/file-drop/file-item.component.d.ts +0 -33
  35. package/lib/modules/file-attachment/file-drop/file-link.d.ts +0 -6
  36. package/lib/modules/file-attachment/shared/file-item-error-type.d.ts +0 -4
  37. package/lib/modules/file-attachment/shared/file-item.d.ts +0 -20
  38. package/lib/modules/file-attachment/shared/file-item.service.d.ts +0 -13
  39. package/lib/modules/file-attachment/shared/file-size.pipe.d.ts +0 -13
  40. package/lib/modules/file-attachment/shared/file-validate-function.d.ts +0 -5
  41. package/lib/modules/form-error/form-error.component.d.ts +0 -25
  42. package/lib/modules/form-error/form-error.module.d.ts +0 -7
  43. package/lib/modules/form-error/form-errors-enabled-token.d.ts +0 -5
  44. package/lib/modules/form-error/form-errors.component.d.ts +0 -30
  45. package/lib/modules/form-error/form-errors.module.d.ts +0 -11
  46. package/lib/modules/input-box/input-box-adapter.service.d.ts +0 -28
  47. package/lib/modules/input-box/input-box-control.directive.d.ts +0 -11
  48. package/lib/modules/input-box/input-box-hint-text.pipe.d.ts +0 -10
  49. package/lib/modules/input-box/input-box-host.service.d.ts +0 -40
  50. package/lib/modules/input-box/input-box-populate-args.d.ts +0 -12
  51. package/lib/modules/input-box/input-box.component.d.ts +0 -118
  52. package/lib/modules/input-box/input-box.module.d.ts +0 -16
  53. package/lib/modules/radio/radio-group-id.service.d.ts +0 -24
  54. package/lib/modules/radio/radio-group.component.d.ts +0 -157
  55. package/lib/modules/radio/radio-label.component.d.ts +0 -13
  56. package/lib/modules/radio/radio.component.d.ts +0 -169
  57. package/lib/modules/radio/radio.module.d.ts +0 -18
  58. package/lib/modules/radio/types/radio-change.d.ts +0 -9
  59. package/lib/modules/radio/types/radio-group-heading-level.d.ts +0 -1
  60. package/lib/modules/radio/types/radio-group-heading-style.d.ts +0 -1
  61. package/lib/modules/radio/types/radio-type.d.ts +0 -4
  62. package/lib/modules/required-state/required-state.directive.d.ts +0 -17
  63. package/lib/modules/selection-box/selection-box-adapter.service.d.ts +0 -46
  64. package/lib/modules/selection-box/selection-box-description.component.d.ts +0 -8
  65. package/lib/modules/selection-box/selection-box-grid.component.d.ts +0 -29
  66. package/lib/modules/selection-box/selection-box-header.component.d.ts +0 -8
  67. package/lib/modules/selection-box/selection-box.component.d.ts +0 -29
  68. package/lib/modules/selection-box/selection-box.module.d.ts +0 -12
  69. package/lib/modules/selection-box/types/selection-box-grid-align-items-type.d.ts +0 -4
  70. package/lib/modules/selection-box/types/selection-box-grid-align-items.d.ts +0 -14
  71. package/lib/modules/shared/sky-forms-resources.module.d.ts +0 -10
  72. package/lib/modules/toggle-switch/toggle-switch-label.component.d.ts +0 -12
  73. package/lib/modules/toggle-switch/toggle-switch.component.d.ts +0 -81
  74. package/lib/modules/toggle-switch/toggle-switch.module.d.ts +0 -12
  75. package/lib/modules/toggle-switch/types/toggle-switch-change.d.ts +0 -6
  76. package/testing/legacy/checkbox-fixture.d.ts +0 -38
  77. package/testing/legacy/radio-fixture.d.ts +0 -26
  78. package/testing/modules/character-counter/character-counter-indicator-harness-filters.d.ts +0 -6
  79. package/testing/modules/character-counter/character-counter-indicator-harness.d.ts +0 -31
  80. package/testing/modules/checkbox/checkbox-group-harness-filters.d.ts +0 -6
  81. package/testing/modules/checkbox/checkbox-group-harness.d.ts +0 -73
  82. package/testing/modules/checkbox/checkbox-harness-filters.d.ts +0 -6
  83. package/testing/modules/checkbox/checkbox-harness.d.ts +0 -103
  84. package/testing/modules/checkbox/checkbox-label-harness.d.ts +0 -16
  85. package/testing/modules/checkbox/checkbox-label-text-label.harness.d.ts +0 -16
  86. package/testing/modules/field-group/field-group-harness-filters.d.ts +0 -6
  87. package/testing/modules/field-group/field-group-harness.d.ts +0 -56
  88. package/testing/modules/file-attachment/file-attachment/file-attachment-harness-filters.d.ts +0 -6
  89. package/testing/modules/file-attachment/file-attachment/file-attachment-harness.d.ts +0 -101
  90. package/testing/modules/file-attachment/file-drop/file-drop-harness-filters.d.ts +0 -6
  91. package/testing/modules/file-attachment/file-drop/file-drop-harness.d.ts +0 -124
  92. package/testing/modules/file-attachment/file-drop/file-drop-link-upload-harness.d.ts +0 -28
  93. package/testing/modules/file-attachment/file-drop/file-drop-link-upload-input-harness.d.ts +0 -14
  94. package/testing/modules/file-attachment/file-drop/file-item-harness-filters.d.ts +0 -10
  95. package/testing/modules/file-attachment/file-drop/file-item-harness.d.ts +0 -28
  96. package/testing/modules/file-attachment/shared/provide-file-attachment-testing.d.ts +0 -11
  97. package/testing/modules/form-error/form-error-harness.d.ts +0 -23
  98. package/testing/modules/form-error/form-error-harness.filters.d.ts +0 -6
  99. package/testing/modules/form-error/form-errors-harness.d.ts +0 -24
  100. package/testing/modules/form-error/form-errors-harness.filters.d.ts +0 -6
  101. package/testing/modules/input-box/input-box-harness-filters.d.ts +0 -6
  102. package/testing/modules/input-box/input-box-harness.d.ts +0 -108
  103. package/testing/modules/radio/radio-group-harness-filters.d.ts +0 -6
  104. package/testing/modules/radio/radio-group-harness.d.ts +0 -69
  105. package/testing/modules/radio/radio-harness-filters.d.ts +0 -6
  106. package/testing/modules/radio/radio-harness.d.ts +0 -79
  107. package/testing/modules/radio/radio-label-harness.d.ts +0 -16
  108. package/testing/modules/selection-box/selection-box-description-harness.d.ts +0 -15
  109. package/testing/modules/selection-box/selection-box-grid-harness-filters.d.ts +0 -6
  110. package/testing/modules/selection-box/selection-box-grid-harness.d.ts +0 -27
  111. package/testing/modules/selection-box/selection-box-harness-filters.d.ts +0 -6
  112. package/testing/modules/selection-box/selection-box-harness.d.ts +0 -36
  113. package/testing/modules/selection-box/selection-box-header-harness.d.ts +0 -15
  114. package/testing/modules/toggle-switch/toggle-switch-harness-filters.d.ts +0 -6
  115. package/testing/modules/toggle-switch/toggle-switch-harness.d.ts +0 -67
  116. package/testing/modules/toggle-switch/toggle-switch-label-harness.d.ts +0 -16
  117. package/testing/public-api.d.ts +0 -35
@@ -1,40 +0,0 @@
1
- import { OnDestroy } from '@angular/core';
2
- import { Observable } from 'rxjs';
3
- import { SkyInputBoxPopulateArgs } from './input-box-populate-args';
4
- import { SkyInputBoxComponent } from './input-box.component';
5
- import * as i0 from "@angular/core";
6
- /**
7
- * @internal
8
- */
9
- export declare class SkyInputBoxHostService implements OnDestroy {
10
- #private;
11
- required: Observable<boolean>;
12
- get controlId(): string;
13
- get labelId(): string;
14
- get labelText(): string;
15
- get ariaDescribedBy(): Observable<string | undefined> | undefined;
16
- init(host: SkyInputBoxComponent): void;
17
- ngOnDestroy(): void;
18
- populate(args: SkyInputBoxPopulateArgs): void;
19
- setHintText(hintText: string | undefined): void;
20
- setHintTextHidden(hide: boolean): void;
21
- setHintTextScreenReaderOnly(hide: boolean): void;
22
- /**
23
- * Set required so that input box displays the label correctly. When the input is supplied by the consumer it is a content
24
- * child that input box can read required from and this is unnecessary. When the input is supplied internally by the
25
- * component the input box does not have a ref to it, so the component needs to inform the input box of its required state.
26
- */
27
- setRequired(required: boolean): void;
28
- /**
29
- * Whether the focused element is inside the input box.
30
- * @internal
31
- */
32
- focusIsInInput(el: EventTarget): boolean;
33
- /**
34
- * Returns an html element that is inside the input box.
35
- * @internal
36
- */
37
- queryHost(query: string): HTMLElement | undefined;
38
- static ɵfac: i0.ɵɵFactoryDeclaration<SkyInputBoxHostService, never>;
39
- static ɵprov: i0.ɵɵInjectableDeclaration<SkyInputBoxHostService>;
40
- }
@@ -1,12 +0,0 @@
1
- import { TemplateRef } from '@angular/core';
2
- /**
3
- * @internal
4
- */
5
- export interface SkyInputBoxPopulateArgs {
6
- inputTemplate: TemplateRef<unknown>;
7
- buttonsTemplate?: TemplateRef<unknown>;
8
- buttonsLeftTemplate?: TemplateRef<unknown>;
9
- buttonsInsetTemplate?: TemplateRef<unknown>;
10
- iconsInsetTemplate?: TemplateRef<unknown>;
11
- iconsInsetLeftTemplate?: TemplateRef<unknown>;
12
- }
@@ -1,118 +0,0 @@
1
- import { BooleanInput, NumberInput } from '@angular/cdk/coercion';
2
- import { AfterContentChecked, ElementRef, OnDestroy, OnInit, TemplateRef } from '@angular/core';
3
- import { AbstractControlDirective, FormControlDirective, FormControlName, NgModel } from '@angular/forms';
4
- import { ReplaySubject } from 'rxjs';
5
- import { SkyInputBoxPopulateArgs } from './input-box-populate-args';
6
- import * as i0 from "@angular/core";
7
- /**
8
- * A wrapper component that provides styling and accessibility to form elements.
9
- */
10
- export declare class SkyInputBoxComponent implements OnInit, AfterContentChecked, OnDestroy {
11
- #private;
12
- /**
13
- * Whether to visually highlight the input box in an error state. If not specified, the input box
14
- * displays in an error state when either the `ngModel` or the Angular `FormControl` contains an error.
15
- * @default undefined
16
- */
17
- hasErrors: boolean | undefined;
18
- /**
19
- * Whether to visually highlight the input box as disabled. To disable the input box's
20
- * input element, use the HTML `disabled` attribute or the Angular `FormControl.disabled`
21
- * property. If the input element is mapped to an Angular form control
22
- * (e.g. `formControlName`, `ngModel`, etc.), "disabled" styles are applied automatically;
23
- * if the input element is not associated with an Angular form control, the `disabled`
24
- * property on the input box must be set to `true` to visually indicate
25
- * the disabled state on the input box.
26
- * @default false
27
- */
28
- disabled: boolean | undefined;
29
- /**
30
- * The text to display as the input's label and in known validation error messages. The label
31
- * will automatically be associated with the `input`, `select`, `textarea`, or compatible SKY UX
32
- * component included in the input box.
33
- */
34
- labelText: string | undefined;
35
- /**
36
- * The maximum number of characters allowed in the input. A [SKY UX character count](https://developer.blackbaud.com/skyux/components/character-count)
37
- * will be placed on the input element with the appropriate validator.
38
- */
39
- set characterLimit(value: NumberInput);
40
- get characterLimit(): number | undefined;
41
- /**
42
- * Whether the input box is stacked on another input box. When specified, the appropriate
43
- * vertical spacing is automatically added to the input box.
44
- */
45
- set stacked(value: BooleanInput);
46
- /**
47
- * The title of the help popover. This property only applies when `helpPopoverContent` is
48
- * also specified.
49
- */
50
- helpPopoverTitle: string | undefined;
51
- /**
52
- * The content of the help popover. When specified along with `labelText`, a [help inline](https://developer.blackbaud.com/skyux/components/help-inline)
53
- * button is added to the input box label. The help inline button displays a [popover](https://developer.blackbaud.com/skyux/components/popover)
54
- * when clicked using the specified content and optional title. This property only applies when `labelText` is also specified.
55
- */
56
- helpPopoverContent: string | TemplateRef<unknown> | undefined;
57
- /**
58
- * 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)
59
- * button is placed beside the input box label. Clicking the button invokes [global help](https://developer.blackbaud.com/skyux/learn/develop/global-help)
60
- * as configured by the application. This property only applies when `labelText` is also specified.
61
- */
62
- helpKey: string | undefined;
63
- /**
64
- * [Persistent inline help text](https://developer.blackbaud.com/skyux/design/guidelines/user-assistance#inline-help) that provides
65
- * additional context to the user.
66
- */
67
- set hintText(value: string | undefined);
68
- get hintText(): string | undefined;
69
- hostInputTemplate: TemplateRef<unknown> | undefined;
70
- hostButtonsTemplate: TemplateRef<unknown> | undefined;
71
- hostButtonsInsetTemplate: TemplateRef<unknown> | undefined;
72
- hostButtonsLeftTemplate: TemplateRef<unknown> | undefined;
73
- formControlHasFocus: boolean;
74
- hostIconsInsetTemplate: TemplateRef<unknown> | undefined;
75
- hostIconsInsetLeftTemplate: TemplateRef<unknown> | undefined;
76
- protected hintTextHidden: boolean;
77
- protected hintTextScreenReaderOnly: boolean;
78
- protected hostHintText: string | undefined;
79
- readonly controlId: string;
80
- readonly labelId: string;
81
- readonly errorId: string;
82
- readonly hintTextId: string;
83
- readonly ariaDescribedBy: ReplaySubject<string | undefined>;
84
- cssClass: string;
85
- formControl: FormControlDirective | undefined;
86
- formControlByName: FormControlName | undefined;
87
- ngModel: NgModel | undefined;
88
- inputRef: ElementRef | undefined;
89
- protected controlDir: AbstractControlDirective | undefined;
90
- protected get isDisabled(): boolean;
91
- protected get hasErrorsComputed(): boolean;
92
- protected get required(): boolean;
93
- protected characterCountScreenReader: number;
94
- ngOnInit(): void;
95
- ngAfterContentChecked(): void;
96
- ngOnDestroy(): void;
97
- /**
98
- * Whether the input box component contains the focused element.
99
- * @internal
100
- */
101
- containsElement(el: EventTarget): boolean;
102
- formControlFocusIn(): void;
103
- formControlFocusOut(): void;
104
- onInsetIconClick(): void;
105
- populate(args: SkyInputBoxPopulateArgs): void;
106
- /**
107
- * Returns an element inside the input box.
108
- * This can be used to query parts of a input box
109
- * that was populated through the `SkyInputBoxHostService`
110
- * @internal
111
- */
112
- queryPopulatedElement(query: string): HTMLElement;
113
- setHintTextHidden(hide: boolean): void;
114
- setHostHintText(value: string | undefined): void;
115
- setHintTextScreenReaderOnly(hide: boolean): void;
116
- static ɵfac: i0.ɵɵFactoryDeclaration<SkyInputBoxComponent, never>;
117
- 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-autocomplete,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,span.sky-input-box-descendent-form-error", ".sky-error-label,.sky-error-indicator"], false, never>;
118
- }
@@ -1,16 +0,0 @@
1
- import * as i0 from "@angular/core";
2
- import * as i1 from "./input-box.component";
3
- import * as i2 from "@angular/common";
4
- import * as i3 from "../character-counter/character-counter.module";
5
- import * as i4 from "../form-error/form-errors.module";
6
- import * as i5 from "../form-error/form-error.module";
7
- import * as i6 from "../shared/sky-forms-resources.module";
8
- import * as i7 from "@skyux/help-inline";
9
- import * as i8 from "./input-box-control.directive";
10
- import * as i9 from "./input-box-hint-text.pipe";
11
- import * as i10 from "@skyux/theme";
12
- export declare class SkyInputBoxModule {
13
- static ɵfac: i0.ɵɵFactoryDeclaration<SkyInputBoxModule, never>;
14
- static ɵmod: i0.ɵɵNgModuleDeclaration<SkyInputBoxModule, [typeof i1.SkyInputBoxComponent], [typeof i2.CommonModule, typeof i3.SkyCharacterCounterModule, typeof i4.SkyFormErrorsModule, typeof i5.SkyFormErrorModule, typeof i6.SkyFormsResourcesModule, typeof i7.SkyHelpInlineModule, typeof i8.SkyInputBoxControlDirective, typeof i9.SkyInputBoxHintTextPipe, typeof i10.SkyThemeModule], [typeof i9.SkyInputBoxHintTextPipe, typeof i1.SkyInputBoxComponent, typeof i8.SkyInputBoxControlDirective, typeof i5.SkyFormErrorModule]>;
15
- static ɵinj: i0.ɵɵInjectorDeclaration<SkyInputBoxModule>;
16
- }
@@ -1,24 +0,0 @@
1
- import { Observable } from 'rxjs';
2
- import * as i0 from "@angular/core";
3
- /**
4
- * Tracks the element IDs for all radios within a radio group.
5
- * @internal
6
- */
7
- export declare class SkyRadioGroupIdService {
8
- #private;
9
- get radioIds(): Observable<string[]>;
10
- constructor();
11
- /**
12
- * Associates a radio input's ID with its parent radio group.
13
- * @param {string} id A unique ID for the radio component.
14
- * @param {string} inputElementId The ID applied to the radio input element.
15
- */
16
- register(id: string, inputElementId: string): void;
17
- /**
18
- * Disassociates a radio input's ID with its parent radio group.
19
- * @param {string} id The ID used to register the radio component.
20
- */
21
- unregister(id: string): void;
22
- static ɵfac: i0.ɵɵFactoryDeclaration<SkyRadioGroupIdService, never>;
23
- static ɵprov: i0.ɵɵInjectableDeclaration<SkyRadioGroupIdService>;
24
- }
@@ -1,157 +0,0 @@
1
- import { AfterContentInit, ChangeDetectorRef, OnDestroy, QueryList, TemplateRef } from '@angular/core';
2
- import { NgControl } from '@angular/forms';
3
- import { SkyRadioGroupIdService } from './radio-group-id.service';
4
- import { SkyRadioComponent } from './radio.component';
5
- import { SkyRadioGroupHeadingLevel } from './types/radio-group-heading-level';
6
- import { SkyRadioGroupHeadingStyle } from './types/radio-group-heading-style';
7
- import * as i0 from "@angular/core";
8
- import * as i1 from "@skyux/theme";
9
- /**
10
- * Organizes radio buttons into a group. It is required for radio
11
- * buttons on Angular reactive forms, and we recommend using it with all radio buttons.
12
- * On Angular forms, the component manages the selected values and keeps the forms up-to-date.
13
- * When users select a radio button, its value is driven through an `ngModel` attribute that you specify on the `sky-radio-group` element.
14
- */
15
- export declare class SkyRadioGroupComponent implements AfterContentInit, OnDestroy {
16
- #private;
17
- /**
18
- * The HTML element ID of the element that labels
19
- * the radio button group. This sets the radio button group's `aria-labelledby` attribute to provide a text equivalent for screen readers
20
- * [to support accessibility](https://developer.blackbaud.com/skyux/learn/accessibility).
21
- * If the radio button group does not include a visible label, use `ariaLabel` instead.
22
- * For more information about the `aria-labelledby` attribute, see the [WAI-ARIA definition](https://www.w3.org/TR/wai-aria/#aria-labelledby).
23
- * @deprecated Use `headingText` instead.
24
- */
25
- set ariaLabelledBy(value: string | undefined);
26
- get ariaLabelledBy(): string | undefined;
27
- /**
28
- * The ARIA label for the radio button group. This sets the
29
- * radio button group's `aria-label` attribute to provide a text equivalent for screen readers
30
- * [to support accessibility](https://developer.blackbaud.com/skyux/learn/accessibility).
31
- * If the radio button group includes a visible label, use `ariaLabelledBy` instead.
32
- * For more information about the `aria-label` attribute, see the [WAI-ARIA definition](https://www.w3.org/TR/wai-aria/#aria-label).
33
- * @deprecated Use `headingText` instead.
34
- */
35
- set ariaLabel(value: string | undefined);
36
- get ariaLabel(): string | undefined;
37
- /**
38
- * Whether to disable the input on template-driven forms. Don't use this input on reactive forms because they may overwrite the input or leave the control out of sync.
39
- * To set the disabled state on reactive forms, use the `FormControl` instead.
40
- * @default false
41
- */
42
- set disabled(value: boolean);
43
- get disabled(): boolean;
44
- /**
45
- * The semantic heading level in the document structure. By default, the heading text is not wrapped in a heading element.
46
- */
47
- set headingLevel(value: SkyRadioGroupHeadingLevel | undefined);
48
- get headingLevel(): SkyRadioGroupHeadingLevel | undefined;
49
- /**
50
- * The heading [font style](https://developer.blackbaud.com/skyux/design/styles/typography#headings).
51
- * @default 4
52
- */
53
- set headingStyle(value: SkyRadioGroupHeadingStyle);
54
- /**
55
- * The name for the collection of radio buttons that the component groups together.
56
- * This property overwrites the deprecated `name` property on individual `sky-radio` elements,
57
- * and it is required unless the `name` property is set on individual `sky-radio` elements.
58
- * @required
59
- */
60
- set name(value: string | undefined);
61
- get name(): string;
62
- /**
63
- * Whether the input is required for form validation.
64
- * When you set this property to `true`, the component adds `aria-required` and `required`
65
- * attributes to the input element so that forms display an invalid state until the input element
66
- * is complete.
67
- * For more information about the `aria-required` attribute, see the [WAI-ARIA definition](https://www.w3.org/TR/wai-aria/#aria-required).
68
- * @default false
69
- */
70
- required: boolean;
71
- /**
72
- * Whether the radio button group is stacked on another form component. When specified,
73
- * the appropriate vertical spacing is automatically added to the radio button group.
74
- */
75
- set stacked(value: boolean);
76
- get stacked(): boolean;
77
- /**
78
- * The value of the radio button to select by default when the group loads.
79
- * The value corresponds to the `value` property of an individual `sky-radio` element within the
80
- * group.
81
- */
82
- set value(value: any);
83
- /**
84
- * The index for all the radio buttons in the group. If the index is not defined,
85
- * the indices for individual radio buttons are set to their positions on load.
86
- * This property supports accessibility by placing focus on the currently selected radio
87
- * button. If no radio button is selected, it places focus on the first or last button
88
- * depending on how users navigate to the radio button group.
89
- */
90
- set tabIndex(value: number | undefined);
91
- get tabIndex(): number | undefined;
92
- /**
93
- * The text to display as the radio group's heading.
94
- */
95
- headingText: string | undefined;
96
- /**
97
- * Indicates whether to hide the `headingText`.
98
- */
99
- headingHidden: boolean;
100
- /**
101
- * [Persistent inline help text](https://developer.blackbaud.com/skyux/design/guidelines/user-assistance#inline-help) that provides
102
- * additional context to the user.
103
- */
104
- hintText: string | undefined;
105
- /**
106
- * The content of the help popover. When specified along with `headingText`, a [help inline](https://developer.blackbaud.com/skyux/components/help-inline)
107
- * button is added to radio group. The help inline button displays a [popover](https://developer.blackbaud.com/skyux/components/popover)
108
- * when clicked using the specified content and optional title. This property only applies when `headingText` is also specified.
109
- */
110
- helpPopoverContent: string | TemplateRef<unknown> | undefined;
111
- /**
112
- * The title of the help popover. This property only applies when `helpPopoverContent` is
113
- * also specified.
114
- */
115
- helpPopoverTitle: string | undefined;
116
- /**
117
- * 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)
118
- * button is placed beside the radio group heading. Clicking the button invokes [global help](https://developer.blackbaud.com/skyux/learn/develop/global-help)
119
- * as configured by the application. This property only applies when `headingText` is also specified.
120
- */
121
- helpKey: string | undefined;
122
- /**
123
- * Our radio components are usually implemented using an unordered list. This is an
124
- * accessibility violation because the unordered list has an implicit role which
125
- * interrupts the 'radiogroup' and 'radio' relationship. To correct this, we can set the
126
- * radio group's 'aria-owns' attribute to a space-separated list of radio IDs.
127
- * For more information about the `aria-owns` attribute, see the [WAI-ARIA definition](https://www.w3.org/TR/wai-aria/#aria-owns), and for more information about the `radio` role, see [its definition](https://www.w3.org/TR/wai-aria/#radio).
128
- */
129
- ariaOwns: string | undefined;
130
- radios: QueryList<SkyRadioComponent> | undefined;
131
- stackedLg: boolean;
132
- stackedXL: boolean;
133
- protected get isRequired(): boolean;
134
- protected headingClass: string;
135
- protected errorId: string;
136
- protected ngControl: NgControl | undefined;
137
- constructor(changeDetector: ChangeDetectorRef, radioGroupIdSvc: SkyRadioGroupIdService, ngControl: NgControl);
138
- ngAfterContentInit(): void;
139
- watchForSelections(): void;
140
- ngOnDestroy(): void;
141
- writeValue(value: unknown): void;
142
- /**
143
- * @internal
144
- * Whether to disable the control. Implemented as a part of ControlValueAccessor.
145
- */
146
- setDisabledState(isDisabled: boolean): void;
147
- registerOnChange(fn: (value: any) => void): void;
148
- registerOnTouched(fn: any): void;
149
- static ɵfac: i0.ɵɵFactoryDeclaration<SkyRadioGroupComponent, [null, null, { optional: true; self: true; }]>;
150
- 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, [{ directive: typeof i1.SkyThemeComponentClassDirective; inputs: {}; outputs: {}; }]>;
151
- static ngAcceptInputType_disabled: unknown;
152
- static ngAcceptInputType_headingLevel: unknown;
153
- static ngAcceptInputType_headingStyle: unknown;
154
- static ngAcceptInputType_required: unknown;
155
- static ngAcceptInputType_stacked: unknown;
156
- static ngAcceptInputType_headingHidden: unknown;
157
- }
@@ -1,13 +0,0 @@
1
- import * as i0 from "@angular/core";
2
- /**
3
- * Specifies a label for the radio button. To display a help button beside the label, include a help button element,
4
- * such as `sky-help-inline`, in the `sky-radio-label` element and a `sky-control-help` CSS class on that help button
5
- * element.
6
- * @deprecated Use `labelText` input on `sky-radio-component` instead.
7
- */
8
- export declare class SkyRadioLabelComponent {
9
- onClick(event: MouseEvent): void;
10
- constructor();
11
- static ɵfac: i0.ɵɵFactoryDeclaration<SkyRadioLabelComponent, never>;
12
- static ɵcmp: i0.ɵɵComponentDeclaration<SkyRadioLabelComponent, "sky-radio-label", never, {}, {}, never, ["*", ".sky-control-help"], false, never>;
13
- }
@@ -1,169 +0,0 @@
1
- import { EventEmitter, OnDestroy, TemplateRef } from '@angular/core';
2
- import { ControlValueAccessor } from '@angular/forms';
3
- import { Subject } from 'rxjs';
4
- import { SkyRadioChange } from './types/radio-change';
5
- import { SkyRadioType } from './types/radio-type';
6
- import * as i0 from "@angular/core";
7
- import * as i1 from "@skyux/theme";
8
- /**
9
- * Renders a SKY UX-themed replacement for an HTML `input` element
10
- * with `type="radio"`. When users select a radio button, its value is driven through an
11
- * `ngModel` attribute that you specify on the `sky-radio` element or the parent `sky-radio-group` element.
12
- */
13
- export declare class SkyRadioComponent implements OnDestroy, ControlValueAccessor {
14
- #private;
15
- /**
16
- * Fires when users focus off a radio button.
17
- */
18
- blur: Subject<void>;
19
- /**
20
- * Whether the radio button is selected.
21
- * @default false
22
- */
23
- set checked(value: boolean | undefined);
24
- get checked(): boolean;
25
- /**
26
- * Whether to disable the input on template-driven forms. Don't use this input on reactive forms because they may overwrite the input or leave the control out of sync.
27
- * To set the disabled state on reactive forms, use the `FormControl` instead.
28
- * @default false
29
- */
30
- set disabled(value: boolean);
31
- get disabled(): boolean;
32
- /**
33
- * The ID for the radio button.
34
- * If a value is not provided, an autogenerated ID is used.
35
- */
36
- set id(value: string | undefined);
37
- /**
38
- * The ARIA label for the radio button. This sets the radio button's `aria-label`
39
- * attribute to provide a text equivalent for screen readers [to support accessibility](https://developer.blackbaud.com/skyux/learn/accessibility)
40
- * when the radio button does not include a visible label. You must set this property for icon
41
- * radio buttons. If the radio button includes a visible label, use `labelledBy` instead.
42
- * For more information about the `aria-label` attribute, see the [WAI-ARIA definition](https://www.w3.org/TR/wai-aria/#aria-label).
43
- * @deprecated Use `labelText` instead.
44
- */
45
- set label(value: string | undefined);
46
- get label(): string | undefined;
47
- /**
48
- * The HTML element ID of the element that labels
49
- * the radio button. This sets the radio button's `aria-labelledby` attribute to provide a text equivalent for screen readers
50
- * [to support accessibility](https://developer.blackbaud.com/skyux/learn/accessibility).
51
- * If the radio button does not include a visible label, use `label` instead.
52
- * For more information about the `aria-labelledby` attribute, see the [WAI-ARIA definition](https://www.w3.org/TR/wai-aria/#aria-labelledby).
53
- * @deprecated Use `labelText` instead.
54
- */
55
- set labelledBy(value: string | undefined);
56
- get labelledBy(): string | undefined;
57
- /**
58
- * This property is deprecated in favor of the `name` property on the `sky-radio-group element`.
59
- * We recommend using the `sky-radio-group` element with all radio buttons, but if you opt not to,
60
- * then this property specifies a name for a group of radio buttons.
61
- * @deprecated
62
- */
63
- set name(value: string | undefined);
64
- get name(): string | undefined;
65
- /**
66
- * This property is deprecated in favor of
67
- * the `tabIndex` property on the `sky-radio-group` element. It specifies an index for the radio
68
- * button. If the index is not defined, it is set to the position of the radio button on load.
69
- * @deprecated
70
- */
71
- set tabindex(value: number | undefined);
72
- get tabindex(): number;
73
- set groupTabIndex(value: number | undefined);
74
- /**
75
- * The value bound to the radio button's `value` property. The value usually
76
- * corresponds to the radio button's label, which you specify with the `sky-radio-label`
77
- * component.
78
- * @required
79
- */
80
- set value(value: any);
81
- get value(): any;
82
- /**
83
- * The content of the help popover. When specified along with `labelText`, a [help inline](https://developer.blackbaud.com/skyux/components/help-inline)
84
- * button is added to radio button. The help inline button displays a [popover](https://developer.blackbaud.com/skyux/components/popover)
85
- * when clicked using the specified content and optional title. This property only applies when `labelText` is also specified.
86
- */
87
- helpPopoverContent: string | TemplateRef<unknown> | undefined;
88
- /**
89
- * The title of the help popover. This property only applies when `helpPopoverContent` is
90
- * also specified.
91
- */
92
- helpPopoverTitle: string | undefined;
93
- /**
94
- * The icon to display in place of the radio button. To group radio buttons like in
95
- * the demo above, place the `sky-switch-icon-group` class on the direct parent element of the
96
- * radio buttons.
97
- * @deprecated Use `iconName` instead.
98
- */
99
- icon: string | undefined;
100
- /**
101
- * The SVG icon to display in place of the radio button. To group radio buttons like in
102
- * the demo above, place the `sky-switch-icon-group` class on the direct parent element of the
103
- * radio buttons.
104
- */
105
- iconName: string | undefined;
106
- /**
107
- * The background color type after users select an icon radio button.
108
- * The valid options correspond
109
- * [the label component's](https://developer.blackbaud.com/skyux/components/label)
110
- * label types. `danger` creates a red background, `info` creates a blue background,
111
- * `success` creates a green background, and `warning` creates an orange background.
112
- * @default "info"
113
- * @deprecated radioType is no longer supported
114
- */
115
- get radioType(): SkyRadioType;
116
- set radioType(value: SkyRadioType | undefined);
117
- /**
118
- * The text to display as the radio button's label. Use this instead of the `sky-radio-label` when the label is text-only.
119
- */
120
- labelText: string | undefined;
121
- /**
122
- * Indicates whether to hide the `labelText`.
123
- */
124
- labelHidden: boolean;
125
- /**
126
- * [Persistent inline help text](https://developer.blackbaud.com/skyux/design/guidelines/user-assistance#inline-help) that provides
127
- * additional context to the user.
128
- */
129
- hintText: string | undefined;
130
- /**
131
- * 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)
132
- * button is placed beside the radio button label. Clicking the button invokes [global help](https://developer.blackbaud.com/skyux/learn/develop/global-help)
133
- * as configured by the application. This property only applies when `labelText` is also specified.
134
- */
135
- helpKey: string | undefined;
136
- /**
137
- * Fires when users select a radio button.
138
- */
139
- change: EventEmitter<SkyRadioChange>;
140
- /**
141
- * Fires when the selected value changes.
142
- */
143
- checkedChange: EventEmitter<boolean>;
144
- /**
145
- * Fires when the selected value changes.
146
- */
147
- disabledChange: EventEmitter<boolean>;
148
- set selectedValue(value: any);
149
- get selectedValue(): any;
150
- radioGroupDisabled: boolean;
151
- protected inputId: string;
152
- constructor();
153
- ngOnDestroy(): void;
154
- writeValue(value: unknown): void;
155
- /**
156
- * @internal
157
- * Whether to disable the control. Implemented as a part of ControlValueAccessor.
158
- */
159
- setDisabledState(isDisabled: boolean): void;
160
- setGroupDisabledState(isDisabled: boolean): void;
161
- registerOnChange(fn: any): void;
162
- registerOnTouched(fn: any): void;
163
- onInputChange(event: Event): void;
164
- onInputFocusChange(): void;
165
- static ɵfac: i0.ɵɵFactoryDeclaration<SkyRadioComponent, never>;
166
- 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; }; "iconName": { "alias": "iconName"; "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, [{ directive: typeof i1.SkyThemeComponentClassDirective; inputs: {}; outputs: {}; }]>;
167
- static ngAcceptInputType_disabled: unknown;
168
- static ngAcceptInputType_labelHidden: unknown;
169
- }
@@ -1,18 +0,0 @@
1
- import * as i0 from "@angular/core";
2
- import * as i1 from "./radio.component";
3
- import * as i2 from "./radio-group.component";
4
- import * as i3 from "./radio-label.component";
5
- import * as i4 from "@angular/common";
6
- import * as i5 from "@angular/forms";
7
- import * as i6 from "../form-error/form-error.module";
8
- import * as i7 from "../form-error/form-errors.module";
9
- import * as i8 from "@skyux/help-inline";
10
- import * as i9 from "@skyux/icon";
11
- import * as i10 from "@skyux/core";
12
- import * as i11 from "../shared/sky-forms-resources.module";
13
- import * as i12 from "@skyux/theme";
14
- export declare class SkyRadioModule {
15
- static ɵfac: i0.ɵɵFactoryDeclaration<SkyRadioModule, never>;
16
- static ɵmod: i0.ɵɵNgModuleDeclaration<SkyRadioModule, [typeof i1.SkyRadioComponent, typeof i2.SkyRadioGroupComponent, typeof i3.SkyRadioLabelComponent], [typeof i4.CommonModule, typeof i5.FormsModule, typeof i6.SkyFormErrorModule, typeof i7.SkyFormErrorsModule, typeof i8.SkyHelpInlineModule, typeof i9.SkyIconModule, typeof i10.SkyIdModule, typeof i11.SkyFormsResourcesModule, typeof i10.SkyTrimModule, typeof i12.SkyThemeModule], [typeof i6.SkyFormErrorModule, typeof i1.SkyRadioComponent, typeof i2.SkyRadioGroupComponent, typeof i3.SkyRadioLabelComponent]>;
17
- static ɵinj: i0.ɵɵInjectorDeclaration<SkyRadioModule>;
18
- }
@@ -1,9 +0,0 @@
1
- /**
2
- * Fires when users select a radio button.
3
- */
4
- export interface SkyRadioChange {
5
- /**
6
- * The value from the radio component.
7
- */
8
- value: any;
9
- }
@@ -1 +0,0 @@
1
- export type SkyRadioGroupHeadingLevel = 3 | 4 | 5;
@@ -1 +0,0 @@
1
- export type SkyRadioGroupHeadingStyle = 3 | 4 | 5;
@@ -1,4 +0,0 @@
1
- /**
2
- * @deprecated radioType is no longer supported
3
- */
4
- export type SkyRadioType = 'danger' | 'info' | 'success' | 'warning';
@@ -1,17 +0,0 @@
1
- import * as i0 from "@angular/core";
2
- /**
3
- * A host directive used to capture the "required" state of the host's form control.
4
- * @internal
5
- */
6
- export declare class SkyRequiredStateDirective {
7
- #private;
8
- required: boolean;
9
- /**
10
- * Whether the `required` attribute is set to `true`, or the control includes
11
- * the `Validators.required` validator.
12
- */
13
- isRequired(): boolean;
14
- static ɵfac: i0.ɵɵFactoryDeclaration<SkyRequiredStateDirective, never>;
15
- static ɵdir: i0.ɵɵDirectiveDeclaration<SkyRequiredStateDirective, never, never, { "required": { "alias": "required"; "required": false; }; }, {}, never, never, true, never>;
16
- static ngAcceptInputType_required: unknown;
17
- }