@skyux/layout 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 (51) hide show
  1. package/documentation.json +74 -74
  2. package/esm2020/lib/modules/action-button/action-button-container.component.mjs +2 -2
  3. package/esm2020/lib/modules/action-button/action-button-icon.component.mjs +1 -1
  4. package/esm2020/lib/modules/action-button/action-button-permalink.mjs +1 -1
  5. package/esm2020/lib/modules/action-button/action-button.component.mjs +1 -1
  6. package/esm2020/lib/modules/back-to-top/back-to-top.directive.mjs +3 -3
  7. package/esm2020/lib/modules/back-to-top/models/back-to-top-message-type.mjs +2 -2
  8. package/esm2020/lib/modules/back-to-top/models/back-to-top-message.mjs +1 -1
  9. package/esm2020/lib/modules/back-to-top/models/back-to-top-options.mjs +1 -1
  10. package/esm2020/lib/modules/box/box.component.mjs +1 -1
  11. package/esm2020/lib/modules/card/card.component.mjs +4 -4
  12. package/esm2020/lib/modules/definition-list/definition-list.component.mjs +3 -3
  13. package/esm2020/lib/modules/description-list/description-list.component.mjs +3 -4
  14. package/esm2020/lib/modules/description-list/types/description-list-mode-type.mjs +1 -1
  15. package/esm2020/lib/modules/description-list/types/description-list-mode.mjs +2 -2
  16. package/esm2020/lib/modules/fluid-grid/column.component.mjs +2 -2
  17. package/esm2020/lib/modules/fluid-grid/fluid-grid.component.mjs +2 -2
  18. package/esm2020/lib/modules/fluid-grid/row.component.mjs +2 -2
  19. package/esm2020/lib/modules/inline-delete/inline-delete-adapter.service.mjs +8 -8
  20. package/esm2020/lib/modules/inline-delete/inline-delete-type.mjs +2 -2
  21. package/esm2020/lib/modules/inline-delete/inline-delete.component.mjs +2 -2
  22. package/esm2020/lib/modules/page/page.component.mjs +2 -2
  23. package/esm2020/lib/modules/text-expand/text-expand.component.mjs +6 -6
  24. package/esm2020/lib/modules/text-expand-repeater/text-expand-repeater.component.mjs +4 -4
  25. package/fesm2015/skyux-layout.mjs +33 -34
  26. package/fesm2015/skyux-layout.mjs.map +1 -1
  27. package/fesm2020/skyux-layout.mjs +33 -34
  28. package/fesm2020/skyux-layout.mjs.map +1 -1
  29. package/lib/modules/action-button/action-button-container.component.d.ts +1 -1
  30. package/lib/modules/action-button/action-button-icon.component.d.ts +1 -1
  31. package/lib/modules/action-button/action-button-permalink.d.ts +2 -2
  32. package/lib/modules/action-button/action-button.component.d.ts +1 -1
  33. package/lib/modules/back-to-top/back-to-top.directive.d.ts +2 -2
  34. package/lib/modules/back-to-top/models/back-to-top-message-type.d.ts +1 -1
  35. package/lib/modules/back-to-top/models/back-to-top-message.d.ts +1 -1
  36. package/lib/modules/back-to-top/models/back-to-top-options.d.ts +1 -1
  37. package/lib/modules/box/box.component.d.ts +3 -3
  38. package/lib/modules/card/card.component.d.ts +3 -3
  39. package/lib/modules/definition-list/definition-list.component.d.ts +2 -2
  40. package/lib/modules/description-list/description-list.component.d.ts +3 -4
  41. package/lib/modules/description-list/types/description-list-mode-type.d.ts +1 -1
  42. package/lib/modules/description-list/types/description-list-mode.d.ts +1 -1
  43. package/lib/modules/fluid-grid/column.component.d.ts +4 -4
  44. package/lib/modules/fluid-grid/fluid-grid.component.d.ts +1 -1
  45. package/lib/modules/fluid-grid/row.component.d.ts +1 -1
  46. package/lib/modules/inline-delete/inline-delete-type.d.ts +1 -1
  47. package/lib/modules/inline-delete/inline-delete.component.d.ts +1 -1
  48. package/lib/modules/page/page.component.d.ts +1 -1
  49. package/lib/modules/text-expand/text-expand.component.d.ts +6 -6
  50. package/lib/modules/text-expand-repeater/text-expand-repeater.component.d.ts +4 -4
  51. package/package.json +9 -9
@@ -12,7 +12,7 @@ import * as i0 from "@angular/core";
12
12
  export declare class SkyActionButtonContainerComponent implements AfterViewInit, OnDestroy, OnInit {
13
13
  #private;
14
14
  /**
15
- * Specifies how to display the action buttons inside the action button container.
15
+ * How to display the action buttons inside the action button container.
16
16
  * Options are `"center"` or `"left"`.
17
17
  * @default "center"
18
18
  */
@@ -7,7 +7,7 @@ import * as i0 from "@angular/core";
7
7
  export declare class SkyActionButtonIconComponent implements OnDestroy {
8
8
  #private;
9
9
  /**
10
- * Specifies an icon from the
10
+ * The icon from the
11
11
  * [Font Awesome library](https://fontawesome.com/v4.7.0/).
12
12
  * For example, to display the `fa-filter` icon on the action button,
13
13
  * set `iconType` to `filter`. SKY UX supports version 4.7.0 of Font Awesome.
@@ -6,7 +6,7 @@ import { NavigationExtras } from '@angular/router';
6
6
  */
7
7
  export interface SkyActionButtonPermalink {
8
8
  /**
9
- * Specifies an Angular router link for the action button. This property accepts a
9
+ * The Angular router link for the action button. This property accepts a
10
10
  * custom object with a `commands` property to specify router commands and an `extras`
11
11
  * property to specify
12
12
  * [Angular `NavigationExtras`](https://angular.io/api/router/NavigationExtras).
@@ -25,7 +25,7 @@ export interface SkyActionButtonPermalink {
25
25
  extras?: NavigationExtras;
26
26
  };
27
27
  /**
28
- * Specifies a direct link for the action button.
28
+ * The direct link for the action button.
29
29
  */
30
30
  url?: string;
31
31
  }
@@ -9,7 +9,7 @@ export declare class SkyActionButtonComponent {
9
9
  #private;
10
10
  hidden: boolean;
11
11
  /**
12
- * Specifies a link for the action button.
12
+ * The link for the action button.
13
13
  */
14
14
  permalink: SkyActionButtonPermalink | undefined;
15
15
  /**
@@ -12,11 +12,11 @@ import * as i0 from "@angular/core";
12
12
  export declare class SkyBackToTopDirective implements AfterViewInit, OnDestroy {
13
13
  #private;
14
14
  /**
15
- * Specifies configuration options for the back to top component.
15
+ * Configuration options for the back to top component.
16
16
  */
17
17
  set skyBackToTop(value: SkyBackToTopOptions | '' | undefined);
18
18
  /**
19
- * Provides an observable to send commands to the back to top component.
19
+ * The observable to send commands to the back to top component.
20
20
  * The commands respect the `SkyBackToTopMessage` type.
21
21
  */
22
22
  set skyBackToTopMessageStream(value: Subject<SkyBackToTopMessage> | undefined);
@@ -1,5 +1,5 @@
1
1
  /**
2
- * Specifies the type of message to send to the back to top component.
2
+ * The type of message to send to the back to top component.
3
3
  */
4
4
  export declare enum SkyBackToTopMessageType {
5
5
  /**
@@ -4,7 +4,7 @@ import { SkyBackToTopMessageType } from './back-to-top-message-type';
4
4
  */
5
5
  export interface SkyBackToTopMessage {
6
6
  /**
7
- * Specifies the type of message to send.
7
+ * The type of message to send.
8
8
  */
9
9
  type?: SkyBackToTopMessageType;
10
10
  }
@@ -3,7 +3,7 @@
3
3
  */
4
4
  export interface SkyBackToTopOptions {
5
5
  /**
6
- * Indicates whether to hide the back to top button.
6
+ * Whether to hide the back to top button.
7
7
  * @default false
8
8
  */
9
9
  buttonHidden?: boolean;
@@ -4,20 +4,20 @@ import * as i0 from "@angular/core";
4
4
  */
5
5
  export declare class SkyBoxComponent {
6
6
  /**
7
- * Specifies an ARIA label for the box. This sets the box's `aria-label` attribute
7
+ * The ARIA label for the box. This sets the box's `aria-label` attribute
8
8
  * [to support accessibility](https://developer.blackbaud.com/skyux/learn/accessibility).
9
9
  * If the box includes a visible label, use `ariaLabelledBy` instead.
10
10
  */
11
11
  ariaLabel: string | undefined;
12
12
  /**
13
- * Specifies the HTML element ID (without the leading `#`) of the element that labels
13
+ * The HTML element ID (without the leading `#`) of the element that labels
14
14
  * the box. This sets the box's `aria-labelledby` attribute
15
15
  * [to support accessibility](https://developer.blackbaud.com/skyux/learn/accessibility).
16
16
  * If the box does not include a visible label, use `ariaLabel` instead.
17
17
  */
18
18
  ariaLabelledBy: string | undefined;
19
19
  /**
20
- * Specifies an ARIA role for the box
20
+ * The ARIA role for the box
21
21
  * [to support accessibility](https://developer.blackbaud.com/skyux/learn/accessibility)
22
22
  * by indicating what the box contains. For information about
23
23
  * how an ARIA role indicates what an item represents on a web page,
@@ -10,19 +10,19 @@ import * as i0 from "@angular/core";
10
10
  export declare class SkyCardComponent implements AfterContentInit, OnDestroy {
11
11
  #private;
12
12
  /**
13
- * Specifies the size of the card. The valid options are `"large"` and `"small"`.
13
+ * The size of the card. The valid options are `"large"` and `"small"`.
14
14
  * @default "large"
15
15
  */
16
16
  set size(value: string | undefined);
17
17
  get size(): string;
18
18
  /**
19
- * Indicates whether to display a checkbox to the right of the card title.
19
+ * Whether to display a checkbox to the right of the card title.
20
20
  * Users can select multiple checkboxes and perform actions on the selected cards.
21
21
  * @default false
22
22
  */
23
23
  selectable: boolean | undefined;
24
24
  /**
25
- * Indicates whether the card is selected. This only applies to card where
25
+ * Whether the card is selected. This only applies to card where
26
26
  * `selectable` is set to `true`.
27
27
  * @default false
28
28
  */
@@ -7,12 +7,12 @@ import * as i0 from "@angular/core";
7
7
  export declare class SkyDefinitionListComponent {
8
8
  service: SkyDefinitionListService;
9
9
  /**
10
- * Specifies the width of the label portion of the definition list.
10
+ * The width of the label portion of the definition list.
11
11
  * @default "90px"
12
12
  */
13
13
  set labelWidth(value: string | undefined);
14
14
  /**
15
- * Specifies a default value to display when no value is provided
15
+ * The default value to display when no value is provided
16
16
  * for a label-value pair.
17
17
  * @default "None found"
18
18
  */
@@ -10,19 +10,18 @@ import * as i0 from "@angular/core";
10
10
  export declare class SkyDescriptionListComponent implements AfterContentInit, OnDestroy {
11
11
  #private;
12
12
  /**
13
- * Specifies a default description to display when no description is provided
13
+ * The default description to display when no description is provided
14
14
  * for a term-description pair.
15
15
  * @default "None found"
16
16
  */
17
17
  set defaultDescription(value: string);
18
18
  /**
19
- * Specifies the width of term-description pairs when `mode` is set to `"horizontal"`. By default,
19
+ * The width of term-description pairs when `mode` is set to `"horizontal"`. By default,
20
20
  * the width is responsive based on the width of the container element.
21
21
  */
22
22
  listItemWidth: string | undefined;
23
23
  /**
24
- * Specifies how to display term-description pairs within the description list.
25
- * Options include `"horizontal"`, `"longDescription"`, and `"vertical"`.
24
+ * How to display term-description pairs within the description list.
26
25
  * @default "vertical"
27
26
  */
28
27
  set mode(value: SkyDescriptionListModeType | undefined);
@@ -1,4 +1,4 @@
1
1
  /**
2
- * Specifies how to display the term-description pairs within a description list.
2
+ * How to display the term-description pairs within a description list.
3
3
  */
4
4
  export declare type SkyDescriptionListModeType = 'horizontal' | 'longDescription' | 'vertical';
@@ -1,7 +1,7 @@
1
1
  /**
2
2
  * @deprecated Use `SkyDescriptionListModeType` instead.
3
3
  * @internal
4
- * Specifies how to display the term-description pairs within a description list.
4
+ * How to display the term-description pairs within a description list.
5
5
  */
6
6
  export declare enum SkyDescriptionListMode {
7
7
  /**
@@ -6,7 +6,7 @@ import * as i0 from "@angular/core";
6
6
  export declare class SkyColumnComponent implements OnInit, OnChanges {
7
7
  #private;
8
8
  /**
9
- * Specifies the number of columns (1-12) to use on extra-small screens
9
+ * The number of columns (1-12) on extra-small screens
10
10
  * (less than 768px). If you do not specify a value, the fluid grid displays
11
11
  * the column at the full width of the screen.
12
12
  * @default 12
@@ -14,19 +14,19 @@ export declare class SkyColumnComponent implements OnInit, OnChanges {
14
14
  set screenXSmall(value: number | undefined);
15
15
  get screenXSmall(): number;
16
16
  /**
17
- * Specifies the number of columns (1-12) to use on small screens
17
+ * The number of columns (1-12) on small screens
18
18
  * (768-991px). If you do not specify a value, the column inherits
19
19
  * the `screenXSmall` value.
20
20
  */
21
21
  screenSmall: number | undefined;
22
22
  /**
23
- * Specifies the number of columns (1-12) to use on medium screens
23
+ * The number of columns (1-12) on medium screens
24
24
  * (992-1199px). If you do not specify a value, the column inherits
25
25
  * the `screenSmall` value.
26
26
  */
27
27
  screenMedium: number | undefined;
28
28
  /**
29
- * Specifies the number of columns (1-12) to use on large screens
29
+ * The number of columns (1-12) on large screens
30
30
  * (more than 1200px). If you do not specify a value, the column
31
31
  * inherits the `screenMedium` value.
32
32
  */
@@ -12,7 +12,7 @@ export declare class SkyFluidGridComponent {
12
12
  */
13
13
  disableMargin: boolean | undefined;
14
14
  /**
15
- * Specifies a `SkyFluidGridGutterSizeType` to define the size of the padding
15
+ * The type that defines the size of the padding
16
16
  * between columns.
17
17
  * @default "large"
18
18
  */
@@ -5,7 +5,7 @@ import * as i0 from "@angular/core";
5
5
  */
6
6
  export declare class SkyRowComponent {
7
7
  /**
8
- * Indicates whether to reverse the display order for columns in the row.
8
+ * Whether to reverse the display order for columns in the row.
9
9
  * @default false
10
10
  */
11
11
  reverseColumnOrder: boolean | undefined;
@@ -1,5 +1,5 @@
1
1
  /**
2
- * Specifies the type of inline delete that is shown.
2
+ * The type of inline delete that is shown.
3
3
  * @internal
4
4
  */
5
5
  export declare enum SkyInlineDeleteType {
@@ -6,7 +6,7 @@ import * as i0 from "@angular/core";
6
6
  export declare class SkyInlineDeleteComponent implements OnDestroy, OnInit {
7
7
  #private;
8
8
  /**
9
- * Indicates whether the deletion is pending.
9
+ * Whether the deletion is pending.
10
10
  * @default false
11
11
  */
12
12
  pending: boolean | undefined;
@@ -8,7 +8,7 @@ import * as i0 from "@angular/core";
8
8
  export declare class SkyPageComponent implements OnInit, OnDestroy {
9
9
  #private;
10
10
  /**
11
- * Specifies the page layout. Use `auto` to allow the page contents
11
+ * The page layout. Use `auto` to allow the page contents
12
12
  * to expand beyond the bottom of the browser window. Use `fit`
13
13
  * to constrain the page contents to the available viewport.
14
14
  */
@@ -6,12 +6,12 @@ import * as i0 from "@angular/core";
6
6
  export declare class SkyTextExpandComponent implements AfterContentInit {
7
7
  #private;
8
8
  /**
9
- * Specifies a title to display when the component expands the full text in a modal.
9
+ * The title to display when the component expands the full text in a modal.
10
10
  * @default "Expanded view"
11
11
  */
12
12
  expandModalTitle: string | undefined;
13
13
  /**
14
- * Specifies the maximum number of text characters to display inline when users select the link
14
+ * The maximum number of text characters to display inline when users select the link
15
15
  * to expand the full text. If the text exceeds this limit, then the component expands
16
16
  * the full text in a modal instead.
17
17
  * @default 600
@@ -19,7 +19,7 @@ export declare class SkyTextExpandComponent implements AfterContentInit {
19
19
  set maxExpandedLength(value: number | undefined);
20
20
  get maxExpandedLength(): number;
21
21
  /**
22
- * Specifies the maximum number of newline characters to display inline when users select
22
+ * The maximum number of newline characters to display inline when users select
23
23
  * the link to expand the full text. If the text exceeds this limit, then
24
24
  * the component expands the full text in a modal view instead.
25
25
  * @default 2
@@ -27,7 +27,7 @@ export declare class SkyTextExpandComponent implements AfterContentInit {
27
27
  set maxExpandedNewlines(value: number | undefined);
28
28
  get maxExpandedNewlines(): number;
29
29
  /**
30
- * Specifies the number of text characters to display before truncating the text.
30
+ * The number of text characters to display before truncating the text.
31
31
  * To avoid truncating text in the middle of a word, the component looks for a space
32
32
  * in the 10 characters before the last character.
33
33
  * @default 200
@@ -35,12 +35,12 @@ export declare class SkyTextExpandComponent implements AfterContentInit {
35
35
  set maxLength(value: number | undefined);
36
36
  get maxLength(): number;
37
37
  /**
38
- * Specifies the text to truncate.
38
+ * The text to truncate.
39
39
  */
40
40
  set text(value: string | undefined);
41
41
  get text(): string;
42
42
  /**
43
- * Indicates whether to replace newline characters in truncated text with spaces.
43
+ * Whether to replace newline characters in truncated text with spaces.
44
44
  */
45
45
  truncateNewlines: boolean;
46
46
  buttonText: string;
@@ -6,21 +6,21 @@ import * as i0 from "@angular/core";
6
6
  export declare class SkyTextExpandRepeaterComponent implements AfterViewInit {
7
7
  #private;
8
8
  /**
9
- * Specifies the data to truncate.
9
+ * The data to truncate.
10
10
  */
11
11
  set data(value: any[] | undefined);
12
12
  get data(): any[] | undefined;
13
13
  /**
14
- * Specifies a template for items in the list.
14
+ * The template for items in the list.
15
15
  */
16
16
  itemTemplate: TemplateRef<unknown> | undefined;
17
17
  /**
18
- * Specifies the style of bullet to use
18
+ * The style of bullet to use
19
19
  * @default "unordered"
20
20
  */
21
21
  listStyle: SkyTextExpandRepeaterListStyleType | undefined;
22
22
  /**
23
- * Specifies the number of items to display before truncating the list. If not supplied, all items are shown.
23
+ * The number of items to display before truncating the list. If not supplied, all items are shown.
24
24
  */
25
25
  set maxItems(value: number | undefined);
26
26
  get maxItems(): number | undefined;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@skyux/layout",
3
- "version": "7.5.0",
3
+ "version": "7.6.0",
4
4
  "author": "Blackbaud, Inc.",
5
5
  "keywords": [
6
6
  "blackbaud",
@@ -47,14 +47,14 @@
47
47
  "@angular/forms": "^14.2.11",
48
48
  "@angular/platform-browser": "^14.2.11",
49
49
  "@angular/router": "^14.2.11",
50
- "@skyux-sdk/testing": "7.5.0",
51
- "@skyux/core": "7.5.0",
52
- "@skyux/forms": "7.5.0",
53
- "@skyux/i18n": "7.5.0",
54
- "@skyux/indicators": "7.5.0",
55
- "@skyux/modals": "7.5.0",
56
- "@skyux/router": "7.5.0",
57
- "@skyux/theme": "7.5.0"
50
+ "@skyux-sdk/testing": "7.6.0",
51
+ "@skyux/core": "7.6.0",
52
+ "@skyux/forms": "7.6.0",
53
+ "@skyux/i18n": "7.6.0",
54
+ "@skyux/indicators": "7.6.0",
55
+ "@skyux/modals": "7.6.0",
56
+ "@skyux/router": "7.6.0",
57
+ "@skyux/theme": "7.6.0"
58
58
  },
59
59
  "dependencies": {
60
60
  "tslib": "^2.3.1"