@skyux/indicators 7.4.2 → 7.6.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/documentation.json +93 -55
- package/esm2020/lib/modules/alert/alert.component.mjs +4 -4
- package/esm2020/lib/modules/chevron/chevron.component.mjs +3 -3
- package/esm2020/lib/modules/expansion-indicator/expansion-indicator.component.mjs +2 -2
- package/esm2020/lib/modules/icon/icon-stack-item.mjs +1 -1
- package/esm2020/lib/modules/icon/icon-stack.component.mjs +1 -1
- package/esm2020/lib/modules/icon/icon.component.mjs +1 -1
- package/esm2020/lib/modules/key-info/key-info.component.mjs +3 -3
- package/esm2020/lib/modules/label/label.component.mjs +3 -3
- package/esm2020/lib/modules/shared/indicator-icon.mjs +1 -1
- package/esm2020/lib/modules/status-indicator/status-indicator.component.mjs +4 -4
- package/esm2020/lib/modules/text-highlight/text-highlight.directive.mjs +2 -2
- package/esm2020/lib/modules/tokens/token.component.mjs +4 -4
- package/esm2020/lib/modules/tokens/tokens.component.mjs +7 -7
- package/esm2020/lib/modules/tokens/types/token-selected-event-args.mjs +1 -1
- package/esm2020/lib/modules/tokens/types/token.mjs +1 -1
- package/esm2020/lib/modules/tokens/types/tokens-message.mjs +1 -1
- package/esm2020/lib/modules/wait/wait-page.component.mjs +3 -3
- package/esm2020/lib/modules/wait/wait.component.mjs +2 -2
- package/esm2020/testing/alert/alert-harness.mjs +3 -3
- package/esm2020/testing/wait/wait-harness-filters.mjs +1 -1
- package/esm2020/testing/wait/wait-harness.mjs +11 -1
- package/fesm2015/skyux-indicators-testing.mjs +12 -2
- package/fesm2015/skyux-indicators-testing.mjs.map +1 -1
- package/fesm2015/skyux-indicators.mjs +26 -26
- package/fesm2015/skyux-indicators.mjs.map +1 -1
- package/fesm2020/skyux-indicators-testing.mjs +12 -2
- package/fesm2020/skyux-indicators-testing.mjs.map +1 -1
- package/fesm2020/skyux-indicators.mjs +26 -26
- package/fesm2020/skyux-indicators.mjs.map +1 -1
- package/lib/modules/alert/alert.component.d.ts +5 -5
- package/lib/modules/chevron/chevron.component.d.ts +4 -4
- package/lib/modules/expansion-indicator/expansion-indicator.component.d.ts +1 -1
- package/lib/modules/icon/icon-stack-item.d.ts +3 -3
- package/lib/modules/icon/icon-stack.component.d.ts +1 -1
- package/lib/modules/icon/icon.component.d.ts +6 -6
- package/lib/modules/key-info/key-info.component.d.ts +2 -2
- package/lib/modules/label/label.component.d.ts +2 -2
- package/lib/modules/shared/indicator-icon.d.ts +1 -1
- package/lib/modules/status-indicator/status-indicator.component.d.ts +3 -3
- package/lib/modules/text-highlight/text-highlight.directive.d.ts +1 -1
- package/lib/modules/tokens/token.component.d.ts +4 -4
- package/lib/modules/tokens/tokens.component.d.ts +7 -7
- package/lib/modules/tokens/types/token-selected-event-args.d.ts +1 -1
- package/lib/modules/tokens/types/token.d.ts +1 -1
- package/lib/modules/tokens/types/tokens-message.d.ts +1 -1
- package/lib/modules/wait/wait.component.d.ts +1 -1
- package/package.json +5 -5
- package/testing/alert/alert-harness.d.ts +2 -2
- package/testing/wait/wait-harness-filters.d.ts +4 -0
|
@@ -7,28 +7,28 @@ import * as i0 from "@angular/core";
|
|
|
7
7
|
export declare class SkyAlertComponent implements OnInit, OnDestroy {
|
|
8
8
|
#private;
|
|
9
9
|
/**
|
|
10
|
-
*
|
|
10
|
+
* The style for the alert, which determines the icon and background color.
|
|
11
11
|
* The valid options are `danger`, `info`, `success`, and `warning`.
|
|
12
12
|
* @default "warning"
|
|
13
13
|
*/
|
|
14
14
|
set alertType(value: SkyIndicatorIconType | undefined);
|
|
15
15
|
/**
|
|
16
|
-
*
|
|
16
|
+
* Whether to include a close button for users to dismiss the alert.
|
|
17
17
|
* @default false
|
|
18
18
|
*/
|
|
19
19
|
closeable: boolean | undefined;
|
|
20
20
|
/**
|
|
21
|
-
*
|
|
21
|
+
* Whether the alert is closed.
|
|
22
22
|
* @default false
|
|
23
23
|
*/
|
|
24
24
|
closed: boolean | undefined;
|
|
25
25
|
/**
|
|
26
|
-
*
|
|
26
|
+
* The predefined text to be read by screen readers for users who cannot see the alert icon.
|
|
27
27
|
* This property is optional but will be required in future versions of SKY UX.
|
|
28
28
|
*/
|
|
29
29
|
set descriptionType(value: SkyIndicatorDescriptionType | undefined);
|
|
30
30
|
/**
|
|
31
|
-
*
|
|
31
|
+
* The text to be read by screen readers for users who cannot see
|
|
32
32
|
* the indicator icon when `descriptionType` is `custom`.
|
|
33
33
|
*/
|
|
34
34
|
set customDescription(value: string | undefined);
|
|
@@ -6,22 +6,22 @@ import * as i0 from "@angular/core";
|
|
|
6
6
|
*/
|
|
7
7
|
export declare class SkyChevronComponent {
|
|
8
8
|
/**
|
|
9
|
-
*
|
|
9
|
+
* The element whose contents are controlled by the chevron.
|
|
10
10
|
* This sets the chevron's aria-controls attribute
|
|
11
11
|
* [to support accessibility](https://developer.blackbaud.com/skyux/learn/accessibility).
|
|
12
12
|
*/
|
|
13
13
|
ariaControls: string | undefined;
|
|
14
14
|
/**
|
|
15
|
-
*
|
|
15
|
+
* The ARIA label for the chevron. This sets the chevron's aria-label attribute
|
|
16
16
|
* [to support accessibility](https://developer.blackbaud.com/skyux/learn/accessibility).
|
|
17
17
|
*/
|
|
18
18
|
ariaLabel: string | undefined;
|
|
19
19
|
/**
|
|
20
|
-
*
|
|
20
|
+
* The direction that the chevron points, which can be up or down.
|
|
21
21
|
*/
|
|
22
22
|
set direction(value: string | undefined);
|
|
23
23
|
/**
|
|
24
|
-
*
|
|
24
|
+
* Whether to disable the chevron button.
|
|
25
25
|
*/
|
|
26
26
|
disabled: boolean;
|
|
27
27
|
/**
|
|
@@ -5,7 +5,7 @@ import * as i0 from "@angular/core";
|
|
|
5
5
|
*/
|
|
6
6
|
export declare class SkyExpansionIndicatorComponent {
|
|
7
7
|
/**
|
|
8
|
-
*
|
|
8
|
+
* The direction that the chevron points, which can be up or down.
|
|
9
9
|
*/
|
|
10
10
|
set direction(value: string | undefined);
|
|
11
11
|
directionOrDefault: string;
|
|
@@ -4,15 +4,15 @@ import { SkyIconType } from './types/icon-type';
|
|
|
4
4
|
*/
|
|
5
5
|
export interface SkyIconStackItem {
|
|
6
6
|
/**
|
|
7
|
-
*
|
|
7
|
+
* The name of
|
|
8
8
|
* [the Font Awesome 4.7 icon](https://fontawesome.com/v4.7/icons/) to
|
|
9
9
|
* display. Do not specify the `fa fa-` classes.
|
|
10
10
|
* @required
|
|
11
11
|
*/
|
|
12
12
|
icon: string;
|
|
13
13
|
/**
|
|
14
|
-
*
|
|
15
|
-
* while specifying `skyux`
|
|
14
|
+
* The type of icon to display. Specifying `fa` displays a Font Awesome icon,
|
|
15
|
+
* while specifying `skyux` displays an icon from the custom SKY UX icon font. Note that
|
|
16
16
|
* the custom SKY UX icon font is currently in beta.
|
|
17
17
|
*/
|
|
18
18
|
iconType?: SkyIconType;
|
|
@@ -5,7 +5,7 @@ import * as i0 from "@angular/core";
|
|
|
5
5
|
*/
|
|
6
6
|
export declare class SkyIconStackComponent {
|
|
7
7
|
/**
|
|
8
|
-
*
|
|
8
|
+
* The size of the icon using
|
|
9
9
|
* [Font Awesome sizes](https://fontawesome.com/how-to-use/on-the-web/styling/sizing-icons).
|
|
10
10
|
*/
|
|
11
11
|
size: string | undefined;
|
|
@@ -3,31 +3,31 @@ import { SkyIconVariantType } from './types/icon-variant-type';
|
|
|
3
3
|
import * as i0 from "@angular/core";
|
|
4
4
|
export declare class SkyIconComponent {
|
|
5
5
|
/**
|
|
6
|
-
*
|
|
6
|
+
* The name of
|
|
7
7
|
* [the Font Awesome 4.7 icon](https://fontawesome.com/v4.7/icons/) or the SKY UX icon to
|
|
8
8
|
* display. When specifying a Font Awesome icon, do not prefix the name with `fa-`.
|
|
9
9
|
* @required
|
|
10
10
|
*/
|
|
11
11
|
icon: string | undefined;
|
|
12
12
|
/**
|
|
13
|
-
*
|
|
14
|
-
* while specifying `"skyux"`
|
|
13
|
+
* The type of icon to display. Specifying `"fa"` displays a Font Awesome icon,
|
|
14
|
+
* while specifying `"skyux"` displays an icon from the custom SKY UX icon font. Note that
|
|
15
15
|
* the custom SKY UX icon font is currently in beta.
|
|
16
16
|
* @default "fa"
|
|
17
17
|
*/
|
|
18
18
|
iconType: SkyIconType | undefined;
|
|
19
19
|
/**
|
|
20
|
-
*
|
|
20
|
+
* The size of the icon using
|
|
21
21
|
* [Font Awesome sizes](https://fontawesome.com/how-to-use/on-the-web/styling/sizing-icons). Do not prefix the size with `fa-`.
|
|
22
22
|
*/
|
|
23
23
|
size: string | undefined;
|
|
24
24
|
/**
|
|
25
|
-
*
|
|
25
|
+
* Whether the icon has a fixed width.
|
|
26
26
|
* @default false
|
|
27
27
|
*/
|
|
28
28
|
fixedWidth: boolean | undefined;
|
|
29
29
|
/**
|
|
30
|
-
*
|
|
30
|
+
* The icon variant. If the variant doesn't exist for the
|
|
31
31
|
* specified icon, the normal icon is displayed. This property only applies when using SKY UX icons.
|
|
32
32
|
*/
|
|
33
33
|
variant: SkyIconVariantType | undefined;
|
|
@@ -2,8 +2,8 @@ import { SkyKeyInfoLayoutType } from './key-info-layout-type';
|
|
|
2
2
|
import * as i0 from "@angular/core";
|
|
3
3
|
export declare class SkyKeyInfoComponent {
|
|
4
4
|
/**
|
|
5
|
-
*
|
|
6
|
-
* value
|
|
5
|
+
* The layout for the key info. The vertical layout places the label under the
|
|
6
|
+
* value, while the horizontal layout places the label beside the value.
|
|
7
7
|
* @default "vertical"
|
|
8
8
|
*/
|
|
9
9
|
layout: SkyKeyInfoLayoutType | undefined;
|
|
@@ -12,12 +12,12 @@ export declare class SkyLabelComponent implements OnDestroy, OnInit {
|
|
|
12
12
|
*/
|
|
13
13
|
set labelType(value: SkyLabelType | undefined);
|
|
14
14
|
/**
|
|
15
|
-
*
|
|
15
|
+
* The predefined text to be read by screen readers for users who cannot see the indicator icon.
|
|
16
16
|
* This property is optional but will be required in future versions of SKY UX.
|
|
17
17
|
*/
|
|
18
18
|
set descriptionType(value: SkyIndicatorDescriptionType | undefined);
|
|
19
19
|
/**
|
|
20
|
-
*
|
|
20
|
+
* The text to be read by screen readers for users who cannot see
|
|
21
21
|
* the indicator icon when `descriptionType` is `custom`.
|
|
22
22
|
*/
|
|
23
23
|
set customDescription(value: string | undefined);
|
|
@@ -13,19 +13,19 @@ import * as i0 from "@angular/core";
|
|
|
13
13
|
export declare class SkyStatusIndicatorComponent implements OnInit {
|
|
14
14
|
#private;
|
|
15
15
|
/**
|
|
16
|
-
*
|
|
16
|
+
* The style for the status indicator, which determines the icon.
|
|
17
17
|
* @default "warning"
|
|
18
18
|
*/
|
|
19
19
|
set indicatorType(value: SkyIndicatorIconType);
|
|
20
20
|
/**
|
|
21
|
-
*
|
|
21
|
+
* The predefined text to be read by screen readers for users
|
|
22
22
|
* who cannot see the indicator icon.
|
|
23
23
|
* @required
|
|
24
24
|
*/
|
|
25
25
|
set descriptionType(value: SkyIndicatorDescriptionType | undefined);
|
|
26
26
|
get descriptionType(): SkyIndicatorDescriptionType | undefined;
|
|
27
27
|
/**
|
|
28
|
-
*
|
|
28
|
+
* The text to be read by screen readers for users who cannot see
|
|
29
29
|
* the indicator icon when `descriptionType` is `custom`.
|
|
30
30
|
*/
|
|
31
31
|
set customDescription(value: string | undefined);
|
|
@@ -7,7 +7,7 @@ import * as i0 from "@angular/core";
|
|
|
7
7
|
export declare class SkyTextHighlightDirective implements OnChanges, AfterViewInit, OnDestroy {
|
|
8
8
|
#private;
|
|
9
9
|
/**
|
|
10
|
-
*
|
|
10
|
+
* The text to highlight.
|
|
11
11
|
*/
|
|
12
12
|
set skyHighlight(value: string | string[] | undefined);
|
|
13
13
|
constructor(el: ElementRef, observerSvc: SkyMutationObserverService);
|
|
@@ -3,7 +3,7 @@ import * as i0 from "@angular/core";
|
|
|
3
3
|
export declare class SkyTokenComponent {
|
|
4
4
|
#private;
|
|
5
5
|
/**
|
|
6
|
-
*
|
|
6
|
+
* Whether to disable the token to prevent users from selecting it, dismissing it,
|
|
7
7
|
* or navigating to it with the arrow keys. When the token is disabled,
|
|
8
8
|
* users can still place focus on it using the `Tab` key.
|
|
9
9
|
* @default false
|
|
@@ -11,19 +11,19 @@ export declare class SkyTokenComponent {
|
|
|
11
11
|
set disabled(value: boolean | undefined);
|
|
12
12
|
get disabled(): boolean;
|
|
13
13
|
/**
|
|
14
|
-
*
|
|
14
|
+
* The ARIA label for the token's close button. This sets the button's `aria-label`
|
|
15
15
|
* [to support accessibility](https://developer.blackbaud.com/skyux/learn/accessibility).
|
|
16
16
|
* @default "Remove item"
|
|
17
17
|
*/
|
|
18
18
|
ariaLabel: string | undefined;
|
|
19
19
|
/**
|
|
20
|
-
*
|
|
20
|
+
* Whether users can remove the token from the list by selecting the close button.
|
|
21
21
|
* @default true
|
|
22
22
|
*/
|
|
23
23
|
set dismissible(value: boolean | undefined);
|
|
24
24
|
get dismissible(): boolean;
|
|
25
25
|
/**
|
|
26
|
-
*
|
|
26
|
+
* Whether users can place focus on the token using the `Tab`. This does not
|
|
27
27
|
* affect the ability to select the token, dismiss it, or navigate to it with the arrow keys.
|
|
28
28
|
* @default true
|
|
29
29
|
*/
|
|
@@ -13,7 +13,7 @@ import * as i0 from "@angular/core";
|
|
|
13
13
|
export declare class SkyTokensComponent implements OnDestroy {
|
|
14
14
|
#private;
|
|
15
15
|
/**
|
|
16
|
-
*
|
|
16
|
+
* Whether to disable the tokens list to prevent users from selecting tokens,
|
|
17
17
|
* dismissing tokens, or navigating through the list with the arrow keys. When the tokens list
|
|
18
18
|
* is disabled, users can still place focus on items in the list using the `Tab` key.
|
|
19
19
|
* @default false
|
|
@@ -21,24 +21,24 @@ export declare class SkyTokensComponent implements OnDestroy {
|
|
|
21
21
|
set disabled(value: boolean | undefined);
|
|
22
22
|
get disabled(): boolean;
|
|
23
23
|
/**
|
|
24
|
-
*
|
|
24
|
+
* Whether users can remove a token from the list by selecting a token's close button.
|
|
25
25
|
* @default true
|
|
26
26
|
*/
|
|
27
27
|
set dismissible(value: boolean | undefined);
|
|
28
28
|
get dismissible(): boolean;
|
|
29
29
|
/**
|
|
30
|
-
*
|
|
30
|
+
* The token property to display for each item in the tokens list.
|
|
31
31
|
* @default "name"
|
|
32
32
|
*/
|
|
33
33
|
set displayWith(value: string | undefined);
|
|
34
34
|
get displayWith(): string;
|
|
35
35
|
/**
|
|
36
|
-
*
|
|
36
|
+
* The token property that represents the token's unique identifier. When this property
|
|
37
37
|
* is set, animations are enabled when dismissing tokens.
|
|
38
38
|
*/
|
|
39
39
|
trackWith: string | undefined;
|
|
40
40
|
/**
|
|
41
|
-
*
|
|
41
|
+
* Whether users can place focus on tokens in the list using the `Tab` key.
|
|
42
42
|
* This does not affect the ability of users to select tokens, dismiss tokens,
|
|
43
43
|
* or navigate through the list with the arrow keys.
|
|
44
44
|
* @default true
|
|
@@ -46,12 +46,12 @@ export declare class SkyTokensComponent implements OnDestroy {
|
|
|
46
46
|
set focusable(value: boolean | undefined);
|
|
47
47
|
get focusable(): boolean;
|
|
48
48
|
/**
|
|
49
|
-
*
|
|
49
|
+
* The array of tokens to include in the list.
|
|
50
50
|
*/
|
|
51
51
|
set tokens(value: SkyToken[] | undefined);
|
|
52
52
|
get tokens(): SkyToken[];
|
|
53
53
|
/**
|
|
54
|
-
*
|
|
54
|
+
* The observable of `SkyTokensMessage` that can place focus on a
|
|
55
55
|
* particular token or remove the active token from the list.
|
|
56
56
|
*/
|
|
57
57
|
set messageStream(value: Subject<SkyTokensMessage> | undefined);
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
export interface SkyToken<T = any> {
|
|
2
2
|
/**
|
|
3
|
-
*
|
|
3
|
+
* The token's value. The `sky-tokens` component uses its `displayWith`
|
|
4
4
|
* property to determine which of the value's properties to use as the token's label.
|
|
5
5
|
*/
|
|
6
6
|
value: T;
|
|
@@ -6,7 +6,7 @@ import * as i0 from "@angular/core";
|
|
|
6
6
|
export declare class SkyWaitComponent implements OnInit, OnDestroy {
|
|
7
7
|
#private;
|
|
8
8
|
/**
|
|
9
|
-
*
|
|
9
|
+
* The ARIA label for the wait icon while an element or page loads.
|
|
10
10
|
* This sets the icon's `aria-label` attribute
|
|
11
11
|
* [to support accessibility](https://developer.blackbaud.com/skyux/learn/accessibility).
|
|
12
12
|
* The default value varies based on whether the wait is for an element or a page
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@skyux/indicators",
|
|
3
|
-
"version": "7.
|
|
3
|
+
"version": "7.6.0",
|
|
4
4
|
"author": "Blackbaud, Inc.",
|
|
5
5
|
"keywords": [
|
|
6
6
|
"blackbaud",
|
|
@@ -45,10 +45,10 @@
|
|
|
45
45
|
"@angular/common": "^14.2.11",
|
|
46
46
|
"@angular/core": "^14.2.11",
|
|
47
47
|
"@angular/platform-browser": "^14.2.11",
|
|
48
|
-
"@skyux-sdk/testing": "7.
|
|
49
|
-
"@skyux/core": "7.
|
|
50
|
-
"@skyux/i18n": "7.
|
|
51
|
-
"@skyux/theme": "7.
|
|
48
|
+
"@skyux-sdk/testing": "7.6.0",
|
|
49
|
+
"@skyux/core": "7.6.0",
|
|
50
|
+
"@skyux/i18n": "7.6.0",
|
|
51
|
+
"@skyux/theme": "7.6.0"
|
|
52
52
|
},
|
|
53
53
|
"dependencies": {
|
|
54
54
|
"tslib": "^2.3.1"
|
|
@@ -29,11 +29,11 @@ export declare class SkyAlertHarness extends SkyComponentHarness {
|
|
|
29
29
|
*/
|
|
30
30
|
close(): Promise<void>;
|
|
31
31
|
/**
|
|
32
|
-
*
|
|
32
|
+
* Whether the user closed the alert.
|
|
33
33
|
*/
|
|
34
34
|
isClosed(): Promise<boolean>;
|
|
35
35
|
/**
|
|
36
|
-
*
|
|
36
|
+
* Whether the user can close the alert.
|
|
37
37
|
*/
|
|
38
38
|
isCloseable(): Promise<boolean>;
|
|
39
39
|
/**
|
|
@@ -3,4 +3,8 @@ import { SkyHarnessFilters } from '@skyux/core/testing';
|
|
|
3
3
|
* A set of criteria that can be used to filter a list of SkyAlertHarness instances.
|
|
4
4
|
*/
|
|
5
5
|
export interface SkyWaitHarnessFilters extends SkyHarnessFilters {
|
|
6
|
+
/**
|
|
7
|
+
* Only find blocking or non-blocking instances created by the `SkyWaitService`.
|
|
8
|
+
*/
|
|
9
|
+
servicePageWaitType?: 'blocking' | 'non-blocking';
|
|
6
10
|
}
|