@skyux/popovers 7.5.0 → 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.
Files changed (38) hide show
  1. package/documentation.json +38 -38
  2. package/esm2020/lib/modules/dropdown/dropdown-item.component.mjs +2 -2
  3. package/esm2020/lib/modules/dropdown/dropdown-menu.component.mjs +3 -3
  4. package/esm2020/lib/modules/dropdown/dropdown.component.mjs +8 -8
  5. package/esm2020/lib/modules/dropdown/types/dropdown-horizontal-alignment.mjs +1 -1
  6. package/esm2020/lib/modules/dropdown/types/dropdown-menu-change.mjs +1 -1
  7. package/esm2020/lib/modules/dropdown/types/dropdown-message-type.mjs +2 -2
  8. package/esm2020/lib/modules/dropdown/types/dropdown-message.mjs +1 -1
  9. package/esm2020/lib/modules/dropdown/types/dropdown-trigger-type.mjs +1 -1
  10. package/esm2020/lib/modules/popover/popover.component.mjs +6 -6
  11. package/esm2020/lib/modules/popover/popover.directive.mjs +3 -3
  12. package/esm2020/lib/modules/popover/types/popover-message-type.mjs +2 -2
  13. package/esm2020/lib/modules/popover/types/popover-trigger.mjs +1 -1
  14. package/esm2020/testing/dropdown/dropdown-fixture.mjs +2 -2
  15. package/esm2020/testing/popover/popover-fixture.mjs +2 -2
  16. package/fesm2015/skyux-popovers-testing.mjs +2 -2
  17. package/fesm2015/skyux-popovers-testing.mjs.map +1 -1
  18. package/fesm2015/skyux-popovers.mjs +19 -19
  19. package/fesm2015/skyux-popovers.mjs.map +1 -1
  20. package/fesm2020/skyux-popovers-testing.mjs +2 -2
  21. package/fesm2020/skyux-popovers-testing.mjs.map +1 -1
  22. package/fesm2020/skyux-popovers.mjs +19 -19
  23. package/fesm2020/skyux-popovers.mjs.map +1 -1
  24. package/lib/modules/dropdown/dropdown-item.component.d.ts +1 -1
  25. package/lib/modules/dropdown/dropdown-menu.component.d.ts +3 -3
  26. package/lib/modules/dropdown/dropdown.component.d.ts +9 -9
  27. package/lib/modules/dropdown/types/dropdown-horizontal-alignment.d.ts +1 -1
  28. package/lib/modules/dropdown/types/dropdown-menu-change.d.ts +3 -3
  29. package/lib/modules/dropdown/types/dropdown-message-type.d.ts +1 -1
  30. package/lib/modules/dropdown/types/dropdown-message.d.ts +1 -1
  31. package/lib/modules/dropdown/types/dropdown-trigger-type.d.ts +1 -1
  32. package/lib/modules/popover/popover.component.d.ts +6 -6
  33. package/lib/modules/popover/popover.directive.d.ts +5 -5
  34. package/lib/modules/popover/types/popover-message-type.d.ts +1 -1
  35. package/lib/modules/popover/types/popover-trigger.d.ts +1 -1
  36. package/package.json +6 -6
  37. package/testing/dropdown/dropdown-fixture.d.ts +1 -1
  38. package/testing/popover/popover-fixture.d.ts +1 -1
@@ -7,7 +7,7 @@ export declare class SkyDropdownItemComponent implements AfterViewInit {
7
7
  #private;
8
8
  elementRef: ElementRef;
9
9
  /**
10
- * Specifies an ARIA role for the dropdown menu item
10
+ * The ARIA role for the dropdown menu item
11
11
  * [to support accessibility](https://developer.blackbaud.com/skyux/learn/accessibility)
12
12
  * by indicating how the item functions and what it controls. For information about
13
13
  * how an ARIA role indicates what an item represents on a web page, see the
@@ -10,13 +10,13 @@ import * as i0 from "@angular/core";
10
10
  export declare class SkyDropdownMenuComponent implements AfterContentInit, OnDestroy {
11
11
  #private;
12
12
  /**
13
- * Specifies the HTML element ID of the element that labels
13
+ * The HTML element ID of the element that labels
14
14
  * the dropdown menu. This sets the dropdown menu's `aria-labelledby` attribute
15
15
  * [to support accessibility](https://developer.blackbaud.com/skyux/learn/accessibility).
16
16
  */
17
17
  ariaLabelledBy: string | undefined;
18
18
  /**
19
- * Specifies an ARIA role for the dropdown menu
19
+ * The ARIA role for the dropdown menu
20
20
  * [to support accessibility](https://developer.blackbaud.com/skyux/learn/accessibility)
21
21
  * by indicating how the dropdown menu functions and what it controls. The dropdown button
22
22
  * inherits this value to set its `aria-haspopup` property. For information
@@ -27,7 +27,7 @@ export declare class SkyDropdownMenuComponent implements AfterContentInit, OnDes
27
27
  set ariaRole(value: string | undefined);
28
28
  get ariaRole(): string;
29
29
  /**
30
- * Indicates whether to use the browser's native focus function when users navigate through menu
30
+ * Whether to use the browser's native focus function when users navigate through menu
31
31
  * items with the keyboard. To disable the native focus function, set this property to `false`.
32
32
  * For example, to let users interact with the dropdown menu but keep the keyboard focus on a
33
33
  * different element, set this property to `false`.
@@ -13,7 +13,7 @@ import * as i0 from "@angular/core";
13
13
  export declare class SkyDropdownComponent implements OnInit, OnDestroy {
14
14
  #private;
15
15
  /**
16
- * Specifies a background color for the dropdown button. Available values are `default`,
16
+ * The background color for the dropdown button. Available values are `default`,
17
17
  * `primary`, and `link`. These values set the background color and hover behavior from the
18
18
  * [secondary and primary button classes](https://developer.blackbaud.com/skyux/components/button) respectively.
19
19
  * @default "default"
@@ -21,7 +21,7 @@ export declare class SkyDropdownComponent implements OnInit, OnDestroy {
21
21
  set buttonStyle(value: string | undefined);
22
22
  get buttonStyle(): string;
23
23
  /**
24
- * Specifies the type of button to render as the dropdown's trigger element. To display a button
24
+ * The type of button to render as the dropdown's trigger element. To display a button
25
25
  * with a caret, specify `'select'` and render the button text or icon in a
26
26
  * `sky-dropdown-button` element. To display a round button with an ellipsis, specify
27
27
  * `'context-menu'`.
@@ -30,39 +30,39 @@ export declare class SkyDropdownComponent implements OnInit, OnDestroy {
30
30
  set buttonType(value: SkyDropdownButtonType | string | undefined);
31
31
  get buttonType(): SkyDropdownButtonType | string;
32
32
  /**
33
- * Indicates whether to disable the dropdown button.
33
+ * Whether to disable the dropdown button.
34
34
  * @default false
35
35
  */
36
36
  disabled: boolean | undefined;
37
37
  /**
38
- * Indicates whether to close the dropdown when users click away from the menu.
38
+ * Whether to close the dropdown when users click away from the menu.
39
39
  * @default true
40
40
  */
41
41
  set dismissOnBlur(value: boolean | undefined);
42
42
  get dismissOnBlur(): boolean;
43
43
  /**
44
- * Specifies an ARIA label for the dropdown. This sets the dropdown's `aria-label` attribute
44
+ * The ARIA label for the dropdown. This sets the dropdown's `aria-label` attribute
45
45
  * [to support accessibility](https://developer.blackbaud.com/skyux/learn/accessibility).
46
46
  */
47
47
  label: string | undefined;
48
48
  /**
49
- * Specifies the horizontal alignment of the dropdown menu in relation to the dropdown button.
49
+ * The horizontal alignment of the dropdown menu in relation to the dropdown button.
50
50
  * @default "left"
51
51
  */
52
52
  set horizontalAlignment(value: SkyDropdownHorizontalAlignment | undefined);
53
53
  get horizontalAlignment(): SkyDropdownHorizontalAlignment;
54
54
  /**
55
- * Provides an observable to send commands to the dropdown. The commands should respect
55
+ * The observable that sends commands to the dropdown. The commands should respect
56
56
  * the [[SkyDropdownMessage]] type.
57
57
  * @internal
58
58
  */
59
59
  messageStream: Subject<SkyDropdownMessage> | undefined;
60
60
  /**
61
- * Specifies a title to display in a tooltip when users hover the mouse over the dropdown button.
61
+ * The title to display in a tooltip when users hover the mouse over the dropdown button.
62
62
  */
63
63
  title: string | undefined;
64
64
  /**
65
- * Specifies how users interact with the dropdown button to expose the dropdown menu.
65
+ * How users interact with the dropdown button to expose the dropdown menu.
66
66
  * We recommend the default `click` value because the `hover` value can pose
67
67
  * [accessibility](https://developer.blackbaud.com/skyux/learn/accessibility) issues
68
68
  * for users on touch devices such as phones and tablets.
@@ -1,4 +1,4 @@
1
1
  /**
2
- * Specifies the horizontal alignment for the dropdown.
2
+ * The horizontal alignment for the dropdown.
3
3
  */
4
4
  export declare type SkyDropdownHorizontalAlignment = 'left' | 'center' | 'right';
@@ -5,15 +5,15 @@ import { SkyDropdownItemComponent } from '../dropdown-item.component';
5
5
  */
6
6
  export interface SkyDropdownMenuChange {
7
7
  /**
8
- * Indicates the active menu index.
8
+ * The active menu index.
9
9
  */
10
10
  activeIndex?: number;
11
11
  /**
12
- * Indicates the items in the menu.
12
+ * The items in the menu.
13
13
  */
14
14
  items?: SkyDropdownItemComponent[];
15
15
  /**
16
- * Indicates the selected item in the menu.
16
+ * The selected item in the menu.
17
17
  */
18
18
  selectedItem?: SkyDropdownItemComponent;
19
19
  }
@@ -1,5 +1,5 @@
1
1
  /**
2
- * Specifies the type of message to send.
2
+ * The type of message to send.
3
3
  * @internal
4
4
  */
5
5
  export declare enum SkyDropdownMessageType {
@@ -5,7 +5,7 @@ import { SkyDropdownMessageType } from './dropdown-message-type';
5
5
  */
6
6
  export interface SkyDropdownMessage {
7
7
  /**
8
- * Indicates the type of message to send.
8
+ * The type of message to send.
9
9
  */
10
10
  type?: SkyDropdownMessageType;
11
11
  }
@@ -1,4 +1,4 @@
1
1
  /**
2
- * Specifies how users interact with the dropdown button to expose the dropdown menu.
2
+ * How users interact with the dropdown button to expose the dropdown menu.
3
3
  */
4
4
  export declare type SkyDropdownTriggerType = 'click' | 'hover';
@@ -7,32 +7,32 @@ import * as i0 from "@angular/core";
7
7
  export declare class SkyPopoverComponent implements OnDestroy {
8
8
  #private;
9
9
  /**
10
- * Specifies the horizontal alignment of the popover in relation to the trigger element.
10
+ * The horizontal alignment of the popover in relation to the trigger element.
11
11
  * The `skyPopoverAlignment` property on the popover directive takes precedence over this property when specified.
12
12
  * @default "center"
13
13
  */
14
14
  set alignment(value: SkyPopoverAlignment | undefined);
15
15
  get alignment(): SkyPopoverAlignment;
16
16
  /**
17
- * Indicates whether to close the popover when it loses focus.
17
+ * Whether to close the popover when it loses focus.
18
18
  * To require users to click a trigger button to close the popover, set this input to false.
19
19
  * @default true
20
20
  */
21
21
  set dismissOnBlur(value: boolean | undefined);
22
22
  get dismissOnBlur(): boolean;
23
23
  /**
24
- * Specifies the placement of the popover in relation to the trigger element.
24
+ * The placement of the popover in relation to the trigger element.
25
25
  * The `skyPopoverPlacement` property on the popover directive takes precedence over this property when specified.
26
26
  * @default "above"
27
27
  */
28
28
  set placement(value: SkyPopoverPlacement | undefined);
29
29
  get placement(): SkyPopoverPlacement;
30
30
  /**
31
- * Specifies a title for the popover.
31
+ * The title for the popover.
32
32
  */
33
33
  popoverTitle: string | undefined;
34
34
  /**
35
- * Specifies the type of popover.
35
+ * The type of popover.
36
36
  * @default "info"
37
37
  */
38
38
  set popoverType(value: SkyPopoverType | undefined);
@@ -46,7 +46,7 @@ export declare class SkyPopoverComponent implements OnDestroy {
46
46
  */
47
47
  popoverOpened: EventEmitter<SkyPopoverComponent>;
48
48
  /**
49
- * Indicates that the popover is in the process of being opened or closed.
49
+ * Whether the popover is in the process of being opened or closed.
50
50
  * @internal
51
51
  */
52
52
  isActive: boolean;
@@ -9,25 +9,25 @@ import * as i0 from "@angular/core";
9
9
  export declare class SkyPopoverDirective implements OnInit, OnDestroy {
10
10
  #private;
11
11
  /**
12
- * References the popover component to display. Add this directive to the trigger element that opens the popover.
12
+ * The popover component to display. Add this directive to the trigger element that opens the popover.
13
13
  * @required
14
14
  */
15
15
  skyPopover: SkyPopoverComponent | undefined;
16
16
  /**
17
- * Specifies the horizontal alignment of the popover in relation to the trigger element.
17
+ * The horizontal alignment of the popover in relation to the trigger element.
18
18
  */
19
19
  skyPopoverAlignment: SkyPopoverAlignment | undefined;
20
20
  /**
21
- * Provides an RxJS `Subject` to send commands to the popover that respect the `SkyPopoverMessage` type.
21
+ * The RxJS `Subject` to send commands to the popover that respect the `SkyPopoverMessage` type.
22
22
  */
23
23
  set skyPopoverMessageStream(value: Subject<SkyPopoverMessage> | undefined);
24
24
  get skyPopoverMessageStream(): Subject<SkyPopoverMessage>;
25
25
  /**
26
- * Specifies the placement of the popover in relation to the trigger element.
26
+ * The placement of the popover in relation to the trigger element.
27
27
  */
28
28
  skyPopoverPlacement: SkyPopoverPlacement | undefined;
29
29
  /**
30
- * Specifies the user action that displays the popover.
30
+ * The user action that displays the popover.
31
31
  */
32
32
  set skyPopoverTrigger(value: SkyPopoverTrigger | undefined);
33
33
  get skyPopoverTrigger(): SkyPopoverTrigger;
@@ -1,5 +1,5 @@
1
1
  /**
2
- * Specifies the type of message to send to the popover component.
2
+ * The type of message to send to the popover component.
3
3
  */
4
4
  export declare enum SkyPopoverMessageType {
5
5
  /**
@@ -1,4 +1,4 @@
1
1
  /**
2
- * Specifies the user action that displays the popover.
2
+ * The user action that displays the popover.
3
3
  */
4
4
  export declare type SkyPopoverTrigger = 'click' | 'mouseenter';
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@skyux/popovers",
3
- "version": "7.5.0",
3
+ "version": "7.6.0",
4
4
  "author": "Blackbaud, Inc.",
5
5
  "keywords": [
6
6
  "blackbaud",
@@ -44,11 +44,11 @@
44
44
  "@angular/common": "^14.2.11",
45
45
  "@angular/core": "^14.2.11",
46
46
  "@angular/platform-browser": "^14.2.11",
47
- "@skyux-sdk/testing": "7.5.0",
48
- "@skyux/core": "7.5.0",
49
- "@skyux/i18n": "7.5.0",
50
- "@skyux/indicators": "7.5.0",
51
- "@skyux/theme": "7.5.0"
47
+ "@skyux-sdk/testing": "7.6.0",
48
+ "@skyux/core": "7.6.0",
49
+ "@skyux/i18n": "7.6.0",
50
+ "@skyux/indicators": "7.6.0",
51
+ "@skyux/theme": "7.6.0"
52
52
  },
53
53
  "dependencies": {
54
54
  "tslib": "^2.3.1"
@@ -23,7 +23,7 @@ export declare class SkyDropdownFixture {
23
23
  */
24
24
  get dropdownMenu(): SkyPopoversFixtureDropdownMenu | undefined;
25
25
  /**
26
- * Indicates if the dropdown menu is open and visible.
26
+ * Whether the dropdown menu is open and visible.
27
27
  */
28
28
  get dropdownMenuIsVisible(): boolean;
29
29
  constructor(fixture: ComponentFixture<unknown>, skyTestId: string);
@@ -24,7 +24,7 @@ export declare class SkyPopoverFixture {
24
24
  */
25
25
  get popoverTitle(): string | undefined;
26
26
  /**
27
- * Indicates if the popover is open and visible.
27
+ * Whether the popover is open and visible.
28
28
  */
29
29
  get popoverIsVisible(): boolean;
30
30
  constructor(fixture: ComponentFixture<unknown>);