@skyux/forms 10.31.1 → 10.33.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.
Files changed (22) hide show
  1. package/documentation.json +1133 -1455
  2. package/esm2022/lib/modules/checkbox/checkbox-group.component.mjs +2 -7
  3. package/esm2022/lib/modules/checkbox/checkbox.component.mjs +2 -4
  4. package/esm2022/lib/modules/field-group/field-group.component.mjs +2 -6
  5. package/esm2022/lib/modules/file-attachment/file-attachment.component.mjs +1 -1
  6. package/esm2022/lib/modules/file-attachment/file-drop.component.mjs +2 -5
  7. package/esm2022/lib/modules/form-error/form-error.component.mjs +2 -2
  8. package/esm2022/lib/modules/input-box/input-box.component.mjs +2 -2
  9. package/esm2022/lib/modules/radio/radio-group.component.mjs +2 -6
  10. package/esm2022/lib/modules/radio/radio.component.mjs +2 -3
  11. package/esm2022/lib/modules/toggle-switch/toggle-switch.component.mjs +2 -3
  12. package/fesm2022/skyux-forms.mjs +10 -30
  13. package/fesm2022/skyux-forms.mjs.map +1 -1
  14. package/lib/modules/checkbox/checkbox-group.component.d.ts +0 -10
  15. package/lib/modules/checkbox/checkbox.component.d.ts +0 -7
  16. package/lib/modules/field-group/field-group.component.d.ts +0 -9
  17. package/lib/modules/file-attachment/file-drop.component.d.ts +0 -8
  18. package/lib/modules/input-box/input-box.component.d.ts +0 -1
  19. package/lib/modules/radio/radio-group.component.d.ts +0 -9
  20. package/lib/modules/radio/radio.component.d.ts +0 -6
  21. package/lib/modules/toggle-switch/toggle-switch.component.d.ts +0 -5
  22. package/package.json +9 -9
package/lib/modules/checkbox/checkbox-group.component.d.ts CHANGED
@@ -12,52 +12,43 @@ export declare class SkyCheckboxGroupComponent implements Validator {
12
12
  * The content of the help popover. When specified, a [help inline](https://developer.blackbaud.com/skyux/components/help-inline)
13
13
  * button is added to the checkbox group fieldset legend. The help inline button displays a [popover](https://developer.blackbaud.com/skyux/components/popover)
14
14
  * when clicked using the specified content and optional title.
15
- * @preview
16
15
  */
17
16
  helpPopoverContent: string | TemplateRef<unknown> | undefined;
18
17
  /**
19
18
  * The title of the help popover. This property only applies when `helpPopoverContent` is
20
19
  * also specified.
21
- * @preview
22
20
  */
23
21
  helpPopoverTitle: string | undefined;
24
22
  /**
25
23
  * The text to display as the checkbox group's heading.
26
- * @preview
27
24
  */
28
25
  headingText: string;
29
26
  /**
30
27
  * Indicates whether to hide the `headingText`.
31
- * @preview
32
28
  */
33
29
  headingHidden: boolean;
34
30
  /**
35
31
  * The semantic heading level in the document structure. By default, the heading text is not wrapped in a heading element.
36
- * @preview
37
32
  */
38
33
  set headingLevel(value: SkyCheckboxGroupHeadingLevel | undefined);
39
34
  get headingLevel(): SkyCheckboxGroupHeadingLevel | undefined;
40
35
  /**
41
36
  * The heading [font style](https://developer.blackbaud.com/skyux/design/styles/typography#headings).
42
- * @preview
43
37
  * @default 4
44
38
  */
45
39
  headingStyle: SkyCheckboxGroupHeadingStyle;
46
40
  /**
47
41
  * [Persistent inline help text](https://developer.blackbaud.com/skyux/design/guidelines/user-assistance#inline-help) that provides
48
42
  * additional context to the user.
49
- * @preview
50
43
  */
51
44
  hintText: string | undefined;
52
45
  /**
53
46
  * Whether the checkbox group is required.
54
- * @preview
55
47
  */
56
48
  required: boolean;
57
49
  /**
58
50
  * Whether the checkbox group is stacked on another form component. When specified, the appropriate
59
51
  * vertical spacing is automatically added to the checkbox group.
60
- * @preview
61
52
  */
62
53
  set stacked(value: boolean);
63
54
  get stacked(): boolean;
@@ -65,7 +56,6 @@ export declare class SkyCheckboxGroupComponent implements Validator {
65
56
  * A help key that identifies the global help content to display. When specified, a [help inline](https://developer.blackbaud.com/skyux/components/help-inline)
66
57
  * button is placed beside the checkbox group heading. Clicking the button invokes [global help](https://developer.blackbaud.com/skyux/learn/develop/global-help)
67
58
  * as configured by the application.
68
- * @preview
69
59
  */
70
60
  helpKey: string | undefined;
71
61
  stackedLg: boolean;
package/lib/modules/checkbox/checkbox.component.d.ts CHANGED
@@ -57,13 +57,11 @@ export declare class SkyCheckboxComponent implements ControlValueAccessor, OnIni
57
57
  * The content of the help popover. When specified along with `labelText`, a [help inline](https://developer.blackbaud.com/skyux/components/help-inline)
58
58
  * button is added to the checkbox label. The help inline button displays a [popover](https://developer.blackbaud.com/skyux/components/popover)
59
59
  * when clicked using the specified content and optional title.
60
- * @preview
61
60
  */
62
61
  helpPopoverContent: string | TemplateRef<unknown> | undefined;
63
62
  /**
64
63
  * The title of the help popover. This property only applies when `helpPopoverContent` is
65
64
  * also specified.
66
- * @preview
67
65
  */
68
66
  helpPopoverTitle: string | undefined;
69
67
  /**
@@ -112,32 +110,27 @@ export declare class SkyCheckboxComponent implements ControlValueAccessor, OnIni
112
110
  /**
113
111
  * The text to display as the checkbox's label. Use this instead of the `sky-checkbox-label` when the label is text-only.
114
112
  * Specifying `labelText` also enables automatic error message handling for checkbox.
115
- * @preview
116
113
  */
117
114
  labelText: string | undefined;
118
115
  /**
119
116
  * Indicates whether to hide the `labelText`.
120
- * @preview
121
117
  */
122
118
  labelHidden: boolean;
123
119
  /**
124
120
  * [Persistent inline help text](https://developer.blackbaud.com/skyux/design/guidelines/user-assistance#inline-help) that provides
125
121
  * additional context to the user.
126
- * @preview
127
122
  */
128
123
  hintText: string | undefined;
129
124
  /**
130
125
  * Whether the checkbox is stacked on another form component. When specified, the appropriate
131
126
  * vertical spacing is automatically added to the checkbox. If the checkbox is within a checkbox group,
132
127
  * set `stacked` on the checkbox group component instead.
133
- * @preview
134
128
  */
135
129
  stacked: boolean;
136
130
  /**
137
131
  * A help key that identifies the global help content to display. When specified, a [help inline](https://developer.blackbaud.com/skyux/components/help-inline)
138
132
  * button is placed beside the checkbox label. Clicking the button invokes [global help](https://developer.blackbaud.com/skyux/learn/develop/global-help)
139
133
  * as configured by the application.
140
- * @preview
141
134
  */
142
135
  helpKey: string | undefined;
143
136
  /**
package/lib/modules/field-group/field-group.component.d.ts CHANGED
@@ -8,35 +8,29 @@ import * as i0 from "@angular/core";
8
8
  export declare class SkyFieldGroupComponent {
9
9
  /**
10
10
  * The text to display as the field group's heading.
11
- * @preview
12
11
  */
13
12
  headingText: string;
14
13
  /**
15
14
  * [Persistent inline help text](https://developer.blackbaud.com/skyux/design/guidelines/user-assistance#inline-help) that provides
16
15
  * additional context to the user.
17
- * @preview
18
16
  */
19
17
  hintText: string | undefined;
20
18
  /**
21
19
  * Indicates whether to hide the `headingText`.
22
- * @preview
23
20
  */
24
21
  headingHidden: boolean;
25
22
  /**
26
23
  * Whether the field group is stacked on another field group. When specified, the appropriate
27
24
  * vertical spacing is automatically added to the field group.
28
- * @preview
29
25
  */
30
26
  stacked: boolean;
31
27
  /**
32
28
  * The semantic heading level in the document structure.
33
- * @preview
34
29
  * @default 3
35
30
  */
36
31
  headingLevel: SkyFieldGroupHeadingLevel;
37
32
  /**
38
33
  * The heading [font style](https://developer.blackbaud.com/skyux/design/styles/typography#headings).
39
- * @preview
40
34
  * @default 3
41
35
  */
42
36
  set headingStyle(value: SkyFieldGroupHeadingStyle);
@@ -44,20 +38,17 @@ export declare class SkyFieldGroupComponent {
44
38
  * The content of the help popover. When specified, a [help inline](https://developer.blackbaud.com/skyux/components/help-inline)
45
39
  * button is added to the field group heading. The help inline button displays a [popover](https://developer.blackbaud.com/skyux/components/popover)
46
40
  * when clicked using the specified content and optional title.
47
- * @preview
48
41
  */
49
42
  helpPopoverContent: string | TemplateRef<unknown> | undefined;
50
43
  /**
51
44
  * The title of the help popover. This property only applies when `helpPopoverContent` is
52
45
  * also specified.
53
- * @preview
54
46
  */
55
47
  helpPopoverTitle: string | undefined;
56
48
  /**
57
49
  * A help key that identifies the global help content to display. When specified, a [help inline](https://developer.blackbaud.com/skyux/components/help-inline)
58
50
  * button is placed beside the field group heading. Clicking the button invokes [global help](https://developer.blackbaud.com/skyux/learn/develop/global-help)
59
51
  * as configured by the application.
60
- * @preview
61
52
  */
62
53
  helpKey: string | undefined;
63
54
  protected headingClass: string;
package/lib/modules/file-attachment/file-drop.component.d.ts CHANGED
@@ -80,18 +80,15 @@ export declare class SkyFileDropComponent implements OnInit, OnDestroy {
80
80
  allowLinks: boolean | undefined;
81
81
  /**
82
82
  * The text to display as the file attachment's label.
83
- * @preview
84
83
  */
85
84
  labelText: string | undefined;
86
85
  /**
87
86
  * Whether to hide `labelText` from view.
88
- * @preview
89
87
  */
90
88
  labelHidden: boolean;
91
89
  /**
92
90
  * [Persistent inline help text](https://developer.blackbaud.com/skyux/design/guidelines/user-assistance#inline-help) that provides
93
91
  * additional context to the user.
94
- * @preview
95
92
  */
96
93
  hintText: string | undefined;
97
94
  /**
@@ -100,33 +97,28 @@ export declare class SkyFileDropComponent implements OnInit, OnDestroy {
100
97
  * attributes to the input elements so that screen readers announce an invalid state until the input element
101
98
  * is complete.
102
99
  * For more information about the `aria-required` attribute, see the [WAI-ARIA definition](https://www.w3.org/TR/wai-aria/#aria-required).
103
- * @preview
104
100
  */
105
101
  required: boolean;
106
102
  /**
107
103
  * The content of the help popover. When specified along with `labelText`, a [help inline](https://developer.blackbaud.com/skyux/components/help-inline)
108
104
  * button is added to the file attachment label. The help inline button displays a [popover](https://developer.blackbaud.com/skyux/components/popover)
109
105
  * when clicked using the specified content and optional title.
110
- * @preview
111
106
  */
112
107
  helpPopoverContent: string | TemplateRef<unknown> | undefined;
113
108
  /**
114
109
  * The title of the help popover. This property only applies when `helpPopoverContent` is
115
110
  * also specified.
116
- * @preview
117
111
  */
118
112
  helpPopoverTitle: string | undefined;
119
113
  /**
120
114
  * Whether the file attachment is stacked on another form component. When specified, the appropriate
121
115
  * vertical spacing is automatically added to the file attachment.
122
- * @preview
123
116
  */
124
117
  stacked: boolean;
125
118
  /**
126
119
  * A help key that identifies the global help content to display. When specified, a [help inline](https://developer.blackbaud.com/skyux/components/help-inline)
127
120
  * button is placed beside the file attachment label. Clicking the button invokes [global help](https://developer.blackbaud.com/skyux/learn/develop/global-help)
128
121
  * as configured by the application.
129
- * @preview
130
122
  */
131
123
  helpKey: string | undefined;
132
124
  inputEl: ElementRef | undefined;
package/lib/modules/input-box/input-box.component.d.ts CHANGED
@@ -58,7 +58,6 @@ export declare class SkyInputBoxComponent implements OnInit, AfterContentChecked
58
58
  * A help key that identifies the global help content to display. When specified, a [help inline](https://developer.blackbaud.com/skyux/components/help-inline)
59
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
60
  * as configured by the application.
61
- * @preview
62
61
  */
63
62
  helpKey: string | undefined;
64
63
  /**
package/lib/modules/radio/radio-group.component.d.ts CHANGED
@@ -42,13 +42,11 @@ export declare class SkyRadioGroupComponent implements AfterContentInit, AfterVi
42
42
  get disabled(): boolean;
43
43
  /**
44
44
  * The semantic heading level in the document structure. By default, the heading text is not wrapped in a heading element.
45
- * @preview
46
45
  */
47
46
  set headingLevel(value: SkyRadioGroupHeadingLevel | undefined);
48
47
  get headingLevel(): SkyRadioGroupHeadingLevel | undefined;
49
48
  /**
50
49
  * The heading [font style](https://developer.blackbaud.com/skyux/design/styles/typography#headings).
51
- * @preview
52
50
  * @default 4
53
51
  */
54
52
  headingStyle: SkyRadioGroupHeadingStyle;
@@ -72,7 +70,6 @@ export declare class SkyRadioGroupComponent implements AfterContentInit, AfterVi
72
70
  /**
73
71
  * Whether the radio button group is stacked on another form component. When specified,
74
72
  * the appropriate vertical spacing is automatically added to the radio button group.
75
- * @preview
76
73
  */
77
74
  set stacked(value: boolean);
78
75
  get stacked(): boolean;
@@ -93,38 +90,32 @@ export declare class SkyRadioGroupComponent implements AfterContentInit, AfterVi
93
90
  get tabIndex(): number | undefined;
94
91
  /**
95
92
  * The text to display as the radio group's heading.
96
- * @preview
97
93
  */
98
94
  headingText: string | undefined;
99
95
  /**
100
96
  * Indicates whether to hide the `headingText`.
101
- * @preview
102
97
  */
103
98
  headingHidden: boolean;
104
99
  /**
105
100
  * [Persistent inline help text](https://developer.blackbaud.com/skyux/design/guidelines/user-assistance#inline-help) that provides
106
101
  * additional context to the user.
107
- * @preview
108
102
  */
109
103
  hintText: string | undefined;
110
104
  /**
111
105
  * The content of the help popover. When specified along with `headingText`, a [help inline](https://developer.blackbaud.com/skyux/components/help-inline)
112
106
  * button is added to radio group. The help inline button displays a [popover](https://developer.blackbaud.com/skyux/components/popover)
113
107
  * when clicked using the specified content and optional title.
114
- * @preview
115
108
  */
116
109
  helpPopoverContent: string | TemplateRef<unknown> | undefined;
117
110
  /**
118
111
  * The title of the help popover. This property only applies when `helpPopoverContent` is
119
112
  * also specified.
120
- * @preview
121
113
  */
122
114
  helpPopoverTitle: string | undefined;
123
115
  /**
124
116
  * A help key that identifies the global help content to display. When specified, a [help inline](https://developer.blackbaud.com/skyux/components/help-inline)
125
117
  * button is placed beside the radio group heading. Clicking the button invokes [global help](https://developer.blackbaud.com/skyux/learn/develop/global-help)
126
118
  * as configured by the application.
127
- * @preview
128
119
  */
129
120
  helpKey: string | undefined;
130
121
  get headingClass(): string;
package/lib/modules/radio/radio.component.d.ts CHANGED
@@ -82,13 +82,11 @@ export declare class SkyRadioComponent implements OnInit, OnDestroy, ControlValu
82
82
  * The content of the help popover. When specified along with `labelText`, a [help inline](https://developer.blackbaud.com/skyux/components/help-inline)
83
83
  * button is added to radio button. The help inline button displays a [popover](https://developer.blackbaud.com/skyux/components/popover)
84
84
  * when clicked using the specified content and optional title.
85
- * @preview
86
85
  */
87
86
  helpPopoverContent: string | TemplateRef<unknown> | undefined;
88
87
  /**
89
88
  * The title of the help popover. This property only applies when `helpPopoverContent` is
90
89
  * also specified.
91
- * @preview
92
90
  */
93
91
  helpPopoverTitle: string | undefined;
94
92
  /**
@@ -110,25 +108,21 @@ export declare class SkyRadioComponent implements OnInit, OnDestroy, ControlValu
110
108
  set radioType(value: SkyRadioType | undefined);
111
109
  /**
112
110
  * The text to display as the radio button's label. Use this instead of the `sky-radio-label` when the label is text-only.
113
- * @preview
114
111
  */
115
112
  labelText: string | undefined;
116
113
  /**
117
114
  * Indicates whether to hide the `labelText`.
118
- * @preview
119
115
  */
120
116
  labelHidden: boolean;
121
117
  /**
122
118
  * [Persistent inline help text](https://developer.blackbaud.com/skyux/design/guidelines/user-assistance#inline-help) that provides
123
119
  * additional context to the user.
124
- * @preview
125
120
  */
126
121
  hintText: string | undefined;
127
122
  /**
128
123
  * A help key that identifies the global help content to display. When specified, a [help inline](https://developer.blackbaud.com/skyux/components/help-inline)
129
124
  * button is placed beside the radio button label. Clicking the button invokes [global help](https://developer.blackbaud.com/skyux/learn/develop/global-help)
130
125
  * as configured by the application.
131
- * @preview
132
126
  */
133
127
  helpKey: string | undefined;
134
128
  /**
package/lib/modules/toggle-switch/toggle-switch.component.d.ts CHANGED
@@ -31,13 +31,11 @@ export declare class SkyToggleSwitchComponent implements AfterContentInit, OnIni
31
31
  * The content of the help popover. When specified along with `labelText`, a [help inline](https://developer.blackbaud.com/skyux/components/help-inline)
32
32
  * button is added to the toggle switch. The help inline button displays a [popover](https://developer.blackbaud.com/skyux/components/popover)
33
33
  * when clicked using the specified content and optional title.
34
- * @preview
35
34
  */
36
35
  helpPopoverContent: string | TemplateRef<unknown> | undefined;
37
36
  /**
38
37
  * The title of the help popover. This property only applies when `helpPopoverContent` is
39
38
  * also specified.
40
- * @preview
41
39
  */
42
40
  helpPopoverTitle: string | undefined;
43
41
  /**
@@ -47,19 +45,16 @@ export declare class SkyToggleSwitchComponent implements AfterContentInit, OnIni
47
45
  tabIndex: number | undefined;
48
46
  /**
49
47
  * The text to display as the toggle switch's label.
50
- * @preview
51
48
  */
52
49
  labelText: string | undefined;
53
50
  /**
54
51
  * Whether to hide `labelText` from view.
55
- * @preview
56
52
  */
57
53
  labelHidden: boolean;
58
54
  /**
59
55
  * A help key that identifies the global help content to display. When specified, a [help inline](https://developer.blackbaud.com/skyux/components/help-inline)
60
56
  * button is placed beside the toggle switch label. Clicking the button invokes [global help](https://developer.blackbaud.com/skyux/learn/develop/global-help)
61
57
  * as configured by the application.
62
- * @preview
63
58
  */
64
59
  helpKey: string | undefined;
65
60
  /**
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@skyux/forms",
3
- "version": "10.31.1",
3
+ "version": "10.33.0",
4
4
  "author": "Blackbaud, Inc.",
5
5
  "keywords": [
6
6
  "blackbaud",
@@ -41,16 +41,16 @@
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.31.1",
45
- "@skyux/core": "10.31.1",
46
- "@skyux/help-inline": "10.31.1",
47
- "@skyux/i18n": "10.31.1",
48
- "@skyux/indicators": "10.31.1",
49
- "@skyux/popovers": "10.31.1",
50
- "@skyux/theme": "10.31.1"
44
+ "@skyux-sdk/testing": "10.33.0",
45
+ "@skyux/core": "10.33.0",
46
+ "@skyux/help-inline": "10.33.0",
47
+ "@skyux/i18n": "10.33.0",
48
+ "@skyux/indicators": "10.33.0",
49
+ "@skyux/popovers": "10.33.0",
50
+ "@skyux/theme": "10.33.0"
51
51
  },
52
52
  "dependencies": {
53
- "@skyux/icon": "10.31.1",
53
+ "@skyux/icon": "10.33.0",
54
54
  "tslib": "^2.6.2"
55
55
  },
56
56
  "module": "fesm2022/skyux-forms.mjs",