@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.
- package/documentation.json +74 -74
- package/esm2020/lib/modules/action-button/action-button-container.component.mjs +2 -2
- package/esm2020/lib/modules/action-button/action-button-icon.component.mjs +1 -1
- package/esm2020/lib/modules/action-button/action-button-permalink.mjs +1 -1
- package/esm2020/lib/modules/action-button/action-button.component.mjs +1 -1
- package/esm2020/lib/modules/back-to-top/back-to-top.directive.mjs +3 -3
- package/esm2020/lib/modules/back-to-top/models/back-to-top-message-type.mjs +2 -2
- package/esm2020/lib/modules/back-to-top/models/back-to-top-message.mjs +1 -1
- package/esm2020/lib/modules/back-to-top/models/back-to-top-options.mjs +1 -1
- package/esm2020/lib/modules/box/box.component.mjs +1 -1
- package/esm2020/lib/modules/card/card.component.mjs +4 -4
- package/esm2020/lib/modules/definition-list/definition-list.component.mjs +3 -3
- package/esm2020/lib/modules/description-list/description-list.component.mjs +3 -4
- package/esm2020/lib/modules/description-list/types/description-list-mode-type.mjs +1 -1
- package/esm2020/lib/modules/description-list/types/description-list-mode.mjs +2 -2
- package/esm2020/lib/modules/fluid-grid/column.component.mjs +2 -2
- package/esm2020/lib/modules/fluid-grid/fluid-grid.component.mjs +2 -2
- package/esm2020/lib/modules/fluid-grid/row.component.mjs +2 -2
- package/esm2020/lib/modules/inline-delete/inline-delete-adapter.service.mjs +8 -8
- package/esm2020/lib/modules/inline-delete/inline-delete-type.mjs +2 -2
- package/esm2020/lib/modules/inline-delete/inline-delete.component.mjs +2 -2
- package/esm2020/lib/modules/page/page.component.mjs +2 -2
- package/esm2020/lib/modules/text-expand/text-expand.component.mjs +6 -6
- package/esm2020/lib/modules/text-expand-repeater/text-expand-repeater.component.mjs +4 -4
- package/fesm2015/skyux-layout.mjs +33 -34
- package/fesm2015/skyux-layout.mjs.map +1 -1
- package/fesm2020/skyux-layout.mjs +33 -34
- package/fesm2020/skyux-layout.mjs.map +1 -1
- package/lib/modules/action-button/action-button-container.component.d.ts +1 -1
- package/lib/modules/action-button/action-button-icon.component.d.ts +1 -1
- package/lib/modules/action-button/action-button-permalink.d.ts +2 -2
- package/lib/modules/action-button/action-button.component.d.ts +1 -1
- package/lib/modules/back-to-top/back-to-top.directive.d.ts +2 -2
- package/lib/modules/back-to-top/models/back-to-top-message-type.d.ts +1 -1
- package/lib/modules/back-to-top/models/back-to-top-message.d.ts +1 -1
- package/lib/modules/back-to-top/models/back-to-top-options.d.ts +1 -1
- package/lib/modules/box/box.component.d.ts +3 -3
- package/lib/modules/card/card.component.d.ts +3 -3
- package/lib/modules/definition-list/definition-list.component.d.ts +2 -2
- package/lib/modules/description-list/description-list.component.d.ts +3 -4
- package/lib/modules/description-list/types/description-list-mode-type.d.ts +1 -1
- package/lib/modules/description-list/types/description-list-mode.d.ts +1 -1
- package/lib/modules/fluid-grid/column.component.d.ts +4 -4
- package/lib/modules/fluid-grid/fluid-grid.component.d.ts +1 -1
- package/lib/modules/fluid-grid/row.component.d.ts +1 -1
- package/lib/modules/inline-delete/inline-delete-type.d.ts +1 -1
- package/lib/modules/inline-delete/inline-delete.component.d.ts +1 -1
- package/lib/modules/page/page.component.d.ts +1 -1
- package/lib/modules/text-expand/text-expand.component.d.ts +6 -6
- package/lib/modules/text-expand-repeater/text-expand-repeater.component.d.ts +4 -4
- package/package.json +9 -9
package/documentation.json
CHANGED
|
@@ -81,7 +81,7 @@
|
|
|
81
81
|
"kindString": "Enumeration",
|
|
82
82
|
"flags": {},
|
|
83
83
|
"comment": {
|
|
84
|
-
"shortText": "
|
|
84
|
+
"shortText": "The type of message to send to the back to top component."
|
|
85
85
|
},
|
|
86
86
|
"children": [
|
|
87
87
|
{
|
|
@@ -847,7 +847,7 @@
|
|
|
847
847
|
"isPublic": true
|
|
848
848
|
},
|
|
849
849
|
"comment": {
|
|
850
|
-
"shortText": "
|
|
850
|
+
"shortText": "The link for the action button."
|
|
851
851
|
},
|
|
852
852
|
"decorators": [
|
|
853
853
|
{
|
|
@@ -1262,7 +1262,7 @@
|
|
|
1262
1262
|
"kindString": "Set signature",
|
|
1263
1263
|
"flags": {},
|
|
1264
1264
|
"comment": {
|
|
1265
|
-
"shortText": "
|
|
1265
|
+
"shortText": "The default value to display when no value is provided\nfor a label-value pair.",
|
|
1266
1266
|
"tags": [
|
|
1267
1267
|
{
|
|
1268
1268
|
"tag": "default",
|
|
@@ -1325,7 +1325,7 @@
|
|
|
1325
1325
|
"kindString": "Set signature",
|
|
1326
1326
|
"flags": {},
|
|
1327
1327
|
"comment": {
|
|
1328
|
-
"shortText": "
|
|
1328
|
+
"shortText": "The width of the label portion of the definition list.",
|
|
1329
1329
|
"tags": [
|
|
1330
1330
|
{
|
|
1331
1331
|
"tag": "default",
|
|
@@ -1723,7 +1723,7 @@
|
|
|
1723
1723
|
"sources": [
|
|
1724
1724
|
{
|
|
1725
1725
|
"fileName": "projects/layout/src/modules/description-list/description-list.component.ts",
|
|
1726
|
-
"line":
|
|
1726
|
+
"line": 84,
|
|
1727
1727
|
"character": 2
|
|
1728
1728
|
}
|
|
1729
1729
|
],
|
|
@@ -1804,7 +1804,7 @@
|
|
|
1804
1804
|
"sources": [
|
|
1805
1805
|
{
|
|
1806
1806
|
"fileName": "projects/layout/src/modules/description-list/description-list.component.ts",
|
|
1807
|
-
"line":
|
|
1807
|
+
"line": 67,
|
|
1808
1808
|
"character": 9
|
|
1809
1809
|
}
|
|
1810
1810
|
],
|
|
@@ -1848,7 +1848,7 @@
|
|
|
1848
1848
|
"sources": [
|
|
1849
1849
|
{
|
|
1850
1850
|
"fileName": "projects/layout/src/modules/description-list/description-list.component.ts",
|
|
1851
|
-
"line":
|
|
1851
|
+
"line": 75,
|
|
1852
1852
|
"character": 9
|
|
1853
1853
|
}
|
|
1854
1854
|
],
|
|
@@ -1874,7 +1874,7 @@
|
|
|
1874
1874
|
"isPublic": true
|
|
1875
1875
|
},
|
|
1876
1876
|
"comment": {
|
|
1877
|
-
"shortText": "
|
|
1877
|
+
"shortText": "The width of term-description pairs when `mode` is set to `\"horizontal\"`. By default,\nthe width is responsive based on the width of the container element."
|
|
1878
1878
|
},
|
|
1879
1879
|
"decorators": [
|
|
1880
1880
|
{
|
|
@@ -1935,7 +1935,7 @@
|
|
|
1935
1935
|
"kindString": "Set signature",
|
|
1936
1936
|
"flags": {},
|
|
1937
1937
|
"comment": {
|
|
1938
|
-
"shortText": "
|
|
1938
|
+
"shortText": "The default description to display when no description is provided\nfor a term-description pair.",
|
|
1939
1939
|
"tags": [
|
|
1940
1940
|
{
|
|
1941
1941
|
"tag": "default",
|
|
@@ -1986,7 +1986,7 @@
|
|
|
1986
1986
|
"sources": [
|
|
1987
1987
|
{
|
|
1988
1988
|
"fileName": "projects/layout/src/modules/description-list/description-list.component.ts",
|
|
1989
|
-
"line":
|
|
1989
|
+
"line": 58,
|
|
1990
1990
|
"character": 13
|
|
1991
1991
|
}
|
|
1992
1992
|
],
|
|
@@ -1998,7 +1998,7 @@
|
|
|
1998
1998
|
"kindString": "Get signature",
|
|
1999
1999
|
"flags": {},
|
|
2000
2000
|
"comment": {
|
|
2001
|
-
"shortText": "
|
|
2001
|
+
"shortText": "How to display term-description pairs within the description list.",
|
|
2002
2002
|
"tags": [
|
|
2003
2003
|
{
|
|
2004
2004
|
"tag": "default",
|
|
@@ -2021,7 +2021,7 @@
|
|
|
2021
2021
|
"kindString": "Set signature",
|
|
2022
2022
|
"flags": {},
|
|
2023
2023
|
"comment": {
|
|
2024
|
-
"shortText": "
|
|
2024
|
+
"shortText": "How to display term-description pairs within the description list.",
|
|
2025
2025
|
"tags": [
|
|
2026
2026
|
{
|
|
2027
2027
|
"tag": "default",
|
|
@@ -2061,7 +2061,7 @@
|
|
|
2061
2061
|
"sources": [
|
|
2062
2062
|
{
|
|
2063
2063
|
"fileName": "projects/layout/src/modules/description-list/description-list.component.ts",
|
|
2064
|
-
"line":
|
|
2064
|
+
"line": 94,
|
|
2065
2065
|
"character": 9
|
|
2066
2066
|
}
|
|
2067
2067
|
],
|
|
@@ -2098,7 +2098,7 @@
|
|
|
2098
2098
|
"sources": [
|
|
2099
2099
|
{
|
|
2100
2100
|
"fileName": "projects/layout/src/modules/description-list/description-list.component.ts",
|
|
2101
|
-
"line":
|
|
2101
|
+
"line": 110,
|
|
2102
2102
|
"character": 9
|
|
2103
2103
|
}
|
|
2104
2104
|
],
|
|
@@ -2149,7 +2149,7 @@
|
|
|
2149
2149
|
"sources": [
|
|
2150
2150
|
{
|
|
2151
2151
|
"fileName": "projects/layout/src/modules/description-list/description-list.component.ts",
|
|
2152
|
-
"line":
|
|
2152
|
+
"line": 116,
|
|
2153
2153
|
"character": 9
|
|
2154
2154
|
}
|
|
2155
2155
|
],
|
|
@@ -2577,7 +2577,7 @@
|
|
|
2577
2577
|
"kindString": "Get signature",
|
|
2578
2578
|
"flags": {},
|
|
2579
2579
|
"comment": {
|
|
2580
|
-
"shortText": "
|
|
2580
|
+
"shortText": "How to display the action buttons inside the action button container.\nOptions are `\"center\"` or `\"left\"`.",
|
|
2581
2581
|
"tags": [
|
|
2582
2582
|
{
|
|
2583
2583
|
"tag": "default",
|
|
@@ -2600,7 +2600,7 @@
|
|
|
2600
2600
|
"kindString": "Set signature",
|
|
2601
2601
|
"flags": {},
|
|
2602
2602
|
"comment": {
|
|
2603
|
-
"shortText": "
|
|
2603
|
+
"shortText": "How to display the action buttons inside the action button container.\nOptions are `\"center\"` or `\"left\"`.",
|
|
2604
2604
|
"tags": [
|
|
2605
2605
|
{
|
|
2606
2606
|
"tag": "default",
|
|
@@ -3423,7 +3423,7 @@
|
|
|
3423
3423
|
"kindString": "Get signature",
|
|
3424
3424
|
"flags": {},
|
|
3425
3425
|
"comment": {
|
|
3426
|
-
"shortText": "
|
|
3426
|
+
"shortText": "The type that defines the size of the padding\nbetween columns.",
|
|
3427
3427
|
"tags": [
|
|
3428
3428
|
{
|
|
3429
3429
|
"tag": "default",
|
|
@@ -3446,7 +3446,7 @@
|
|
|
3446
3446
|
"kindString": "Set signature",
|
|
3447
3447
|
"flags": {},
|
|
3448
3448
|
"comment": {
|
|
3449
|
-
"shortText": "
|
|
3449
|
+
"shortText": "The type that defines the size of the padding\nbetween columns.",
|
|
3450
3450
|
"tags": [
|
|
3451
3451
|
{
|
|
3452
3452
|
"tag": "default",
|
|
@@ -3540,7 +3540,7 @@
|
|
|
3540
3540
|
"isPublic": true
|
|
3541
3541
|
},
|
|
3542
3542
|
"comment": {
|
|
3543
|
-
"shortText": "
|
|
3543
|
+
"shortText": "Whether to reverse the display order for columns in the row.",
|
|
3544
3544
|
"tags": [
|
|
3545
3545
|
{
|
|
3546
3546
|
"tag": "default",
|
|
@@ -3665,7 +3665,7 @@
|
|
|
3665
3665
|
"isPublic": true
|
|
3666
3666
|
},
|
|
3667
3667
|
"comment": {
|
|
3668
|
-
"shortText": "
|
|
3668
|
+
"shortText": "The number of columns (1-12) on large screens\n(more than 1200px). If you do not specify a value, the column\ninherits the `screenMedium` value."
|
|
3669
3669
|
},
|
|
3670
3670
|
"decorators": [
|
|
3671
3671
|
{
|
|
@@ -3700,7 +3700,7 @@
|
|
|
3700
3700
|
"isPublic": true
|
|
3701
3701
|
},
|
|
3702
3702
|
"comment": {
|
|
3703
|
-
"shortText": "
|
|
3703
|
+
"shortText": "The number of columns (1-12) on medium screens\n(992-1199px). If you do not specify a value, the column inherits\nthe `screenSmall` value."
|
|
3704
3704
|
},
|
|
3705
3705
|
"decorators": [
|
|
3706
3706
|
{
|
|
@@ -3735,7 +3735,7 @@
|
|
|
3735
3735
|
"isPublic": true
|
|
3736
3736
|
},
|
|
3737
3737
|
"comment": {
|
|
3738
|
-
"shortText": "
|
|
3738
|
+
"shortText": "The number of columns (1-12) on small screens\n(768-991px). If you do not specify a value, the column inherits\nthe `screenXSmall` value."
|
|
3739
3739
|
},
|
|
3740
3740
|
"decorators": [
|
|
3741
3741
|
{
|
|
@@ -3796,7 +3796,7 @@
|
|
|
3796
3796
|
"kindString": "Get signature",
|
|
3797
3797
|
"flags": {},
|
|
3798
3798
|
"comment": {
|
|
3799
|
-
"shortText": "
|
|
3799
|
+
"shortText": "The number of columns (1-12) on extra-small screens\n(less than 768px). If you do not specify a value, the fluid grid displays\nthe column at the full width of the screen.",
|
|
3800
3800
|
"tags": [
|
|
3801
3801
|
{
|
|
3802
3802
|
"tag": "default",
|
|
@@ -3818,7 +3818,7 @@
|
|
|
3818
3818
|
"kindString": "Set signature",
|
|
3819
3819
|
"flags": {},
|
|
3820
3820
|
"comment": {
|
|
3821
|
-
"shortText": "
|
|
3821
|
+
"shortText": "The number of columns (1-12) on extra-small screens\n(less than 768px). If you do not specify a value, the fluid grid displays\nthe column at the full width of the screen.",
|
|
3822
3822
|
"tags": [
|
|
3823
3823
|
{
|
|
3824
3824
|
"tag": "default",
|
|
@@ -4368,7 +4368,7 @@
|
|
|
4368
4368
|
"kindString": "Get signature",
|
|
4369
4369
|
"flags": {},
|
|
4370
4370
|
"comment": {
|
|
4371
|
-
"shortText": "
|
|
4371
|
+
"shortText": "The page layout. Use `auto` to allow the page contents\nto expand beyond the bottom of the browser window. Use `fit`\nto constrain the page contents to the available viewport."
|
|
4372
4372
|
},
|
|
4373
4373
|
"type": {
|
|
4374
4374
|
"type": "reference",
|
|
@@ -4385,7 +4385,7 @@
|
|
|
4385
4385
|
"kindString": "Set signature",
|
|
4386
4386
|
"flags": {},
|
|
4387
4387
|
"comment": {
|
|
4388
|
-
"shortText": "
|
|
4388
|
+
"shortText": "The page layout. Use `auto` to allow the page contents\nto expand beyond the bottom of the browser window. Use `fit`\nto constrain the page contents to the available viewport."
|
|
4389
4389
|
},
|
|
4390
4390
|
"parameters": [
|
|
4391
4391
|
{
|
|
@@ -5433,7 +5433,7 @@
|
|
|
5433
5433
|
"isPublic": true
|
|
5434
5434
|
},
|
|
5435
5435
|
"comment": {
|
|
5436
|
-
"shortText": "
|
|
5436
|
+
"shortText": "The title to display when the component expands the full text in a modal.",
|
|
5437
5437
|
"tags": [
|
|
5438
5438
|
{
|
|
5439
5439
|
"tag": "default",
|
|
@@ -5557,7 +5557,7 @@
|
|
|
5557
5557
|
"isPublic": true
|
|
5558
5558
|
},
|
|
5559
5559
|
"comment": {
|
|
5560
|
-
"shortText": "
|
|
5560
|
+
"shortText": "Whether to replace newline characters in truncated text with spaces."
|
|
5561
5561
|
},
|
|
5562
5562
|
"decorators": [
|
|
5563
5563
|
{
|
|
@@ -5619,7 +5619,7 @@
|
|
|
5619
5619
|
"kindString": "Get signature",
|
|
5620
5620
|
"flags": {},
|
|
5621
5621
|
"comment": {
|
|
5622
|
-
"shortText": "
|
|
5622
|
+
"shortText": "The maximum number of text characters to display inline when users select the link\nto expand the full text. If the text exceeds this limit, then the component expands\nthe full text in a modal instead.",
|
|
5623
5623
|
"tags": [
|
|
5624
5624
|
{
|
|
5625
5625
|
"tag": "default",
|
|
@@ -5641,7 +5641,7 @@
|
|
|
5641
5641
|
"kindString": "Set signature",
|
|
5642
5642
|
"flags": {},
|
|
5643
5643
|
"comment": {
|
|
5644
|
-
"shortText": "
|
|
5644
|
+
"shortText": "The maximum number of text characters to display inline when users select the link\nto expand the full text. If the text exceeds this limit, then the component expands\nthe full text in a modal instead.",
|
|
5645
5645
|
"tags": [
|
|
5646
5646
|
{
|
|
5647
5647
|
"tag": "default",
|
|
@@ -5704,7 +5704,7 @@
|
|
|
5704
5704
|
"kindString": "Get signature",
|
|
5705
5705
|
"flags": {},
|
|
5706
5706
|
"comment": {
|
|
5707
|
-
"shortText": "
|
|
5707
|
+
"shortText": "The maximum number of newline characters to display inline when users select\nthe link to expand the full text. If the text exceeds this limit, then\nthe component expands the full text in a modal view instead.",
|
|
5708
5708
|
"tags": [
|
|
5709
5709
|
{
|
|
5710
5710
|
"tag": "default",
|
|
@@ -5726,7 +5726,7 @@
|
|
|
5726
5726
|
"kindString": "Set signature",
|
|
5727
5727
|
"flags": {},
|
|
5728
5728
|
"comment": {
|
|
5729
|
-
"shortText": "
|
|
5729
|
+
"shortText": "The maximum number of newline characters to display inline when users select\nthe link to expand the full text. If the text exceeds this limit, then\nthe component expands the full text in a modal view instead.",
|
|
5730
5730
|
"tags": [
|
|
5731
5731
|
{
|
|
5732
5732
|
"tag": "default",
|
|
@@ -5789,7 +5789,7 @@
|
|
|
5789
5789
|
"kindString": "Get signature",
|
|
5790
5790
|
"flags": {},
|
|
5791
5791
|
"comment": {
|
|
5792
|
-
"shortText": "
|
|
5792
|
+
"shortText": "The number of text characters to display before truncating the text.\nTo avoid truncating text in the middle of a word, the component looks for a space\nin the 10 characters before the last character.",
|
|
5793
5793
|
"tags": [
|
|
5794
5794
|
{
|
|
5795
5795
|
"tag": "default",
|
|
@@ -5811,7 +5811,7 @@
|
|
|
5811
5811
|
"kindString": "Set signature",
|
|
5812
5812
|
"flags": {},
|
|
5813
5813
|
"comment": {
|
|
5814
|
-
"shortText": "
|
|
5814
|
+
"shortText": "The number of text characters to display before truncating the text.\nTo avoid truncating text in the middle of a word, the component looks for a space\nin the 10 characters before the last character.",
|
|
5815
5815
|
"tags": [
|
|
5816
5816
|
{
|
|
5817
5817
|
"tag": "default",
|
|
@@ -5874,7 +5874,7 @@
|
|
|
5874
5874
|
"kindString": "Get signature",
|
|
5875
5875
|
"flags": {},
|
|
5876
5876
|
"comment": {
|
|
5877
|
-
"shortText": "
|
|
5877
|
+
"shortText": "The text to truncate."
|
|
5878
5878
|
},
|
|
5879
5879
|
"type": {
|
|
5880
5880
|
"type": "intrinsic",
|
|
@@ -5890,7 +5890,7 @@
|
|
|
5890
5890
|
"kindString": "Set signature",
|
|
5891
5891
|
"flags": {},
|
|
5892
5892
|
"comment": {
|
|
5893
|
-
"shortText": "
|
|
5893
|
+
"shortText": "The text to truncate."
|
|
5894
5894
|
},
|
|
5895
5895
|
"parameters": [
|
|
5896
5896
|
{
|
|
@@ -6394,7 +6394,7 @@
|
|
|
6394
6394
|
"isPublic": true
|
|
6395
6395
|
},
|
|
6396
6396
|
"comment": {
|
|
6397
|
-
"shortText": "
|
|
6397
|
+
"shortText": "The template for items in the list."
|
|
6398
6398
|
},
|
|
6399
6399
|
"decorators": [
|
|
6400
6400
|
{
|
|
@@ -6437,7 +6437,7 @@
|
|
|
6437
6437
|
"isPublic": true
|
|
6438
6438
|
},
|
|
6439
6439
|
"comment": {
|
|
6440
|
-
"shortText": "
|
|
6440
|
+
"shortText": "The style of bullet to use",
|
|
6441
6441
|
"tags": [
|
|
6442
6442
|
{
|
|
6443
6443
|
"tag": "default",
|
|
@@ -6527,7 +6527,7 @@
|
|
|
6527
6527
|
"kindString": "Get signature",
|
|
6528
6528
|
"flags": {},
|
|
6529
6529
|
"comment": {
|
|
6530
|
-
"shortText": "
|
|
6530
|
+
"shortText": "The data to truncate."
|
|
6531
6531
|
},
|
|
6532
6532
|
"type": {
|
|
6533
6533
|
"type": "array",
|
|
@@ -6546,7 +6546,7 @@
|
|
|
6546
6546
|
"kindString": "Set signature",
|
|
6547
6547
|
"flags": {},
|
|
6548
6548
|
"comment": {
|
|
6549
|
-
"shortText": "
|
|
6549
|
+
"shortText": "The data to truncate."
|
|
6550
6550
|
},
|
|
6551
6551
|
"parameters": [
|
|
6552
6552
|
{
|
|
@@ -6606,7 +6606,7 @@
|
|
|
6606
6606
|
"kindString": "Get signature",
|
|
6607
6607
|
"flags": {},
|
|
6608
6608
|
"comment": {
|
|
6609
|
-
"shortText": "
|
|
6609
|
+
"shortText": "The number of items to display before truncating the list. If not supplied, all items are shown."
|
|
6610
6610
|
},
|
|
6611
6611
|
"type": {
|
|
6612
6612
|
"type": "intrinsic",
|
|
@@ -6622,7 +6622,7 @@
|
|
|
6622
6622
|
"kindString": "Set signature",
|
|
6623
6623
|
"flags": {},
|
|
6624
6624
|
"comment": {
|
|
6625
|
-
"shortText": "
|
|
6625
|
+
"shortText": "The number of items to display before truncating the list. If not supplied, all items are shown."
|
|
6626
6626
|
},
|
|
6627
6627
|
"parameters": [
|
|
6628
6628
|
{
|
|
@@ -7136,7 +7136,7 @@
|
|
|
7136
7136
|
"isPublic": true
|
|
7137
7137
|
},
|
|
7138
7138
|
"comment": {
|
|
7139
|
-
"shortText": "
|
|
7139
|
+
"shortText": "The ARIA label for the box. This sets the box's `aria-label` attribute\n[to support accessibility](https://developer.blackbaud.com/skyux/learn/accessibility).\nIf the box includes a visible label, use `ariaLabelledBy` instead."
|
|
7140
7140
|
},
|
|
7141
7141
|
"decorators": [
|
|
7142
7142
|
{
|
|
@@ -7171,7 +7171,7 @@
|
|
|
7171
7171
|
"isPublic": true
|
|
7172
7172
|
},
|
|
7173
7173
|
"comment": {
|
|
7174
|
-
"shortText": "
|
|
7174
|
+
"shortText": "The HTML element ID (without the leading `#`) of the element that labels\nthe box. This sets the box's `aria-labelledby` attribute\n[to support accessibility](https://developer.blackbaud.com/skyux/learn/accessibility).\nIf the box does not include a visible label, use `ariaLabel` instead."
|
|
7175
7175
|
},
|
|
7176
7176
|
"decorators": [
|
|
7177
7177
|
{
|
|
@@ -7206,7 +7206,7 @@
|
|
|
7206
7206
|
"isPublic": true
|
|
7207
7207
|
},
|
|
7208
7208
|
"comment": {
|
|
7209
|
-
"shortText": "
|
|
7209
|
+
"shortText": "The ARIA role for the box\n[to support accessibility](https://developer.blackbaud.com/skyux/learn/accessibility)\nby indicating what the box contains. For information about\nhow an ARIA role indicates what an item represents on a web page,\nsee the [WAI-ARIA roles model](https://www.w3.org/WAI/PF/aria/roles)."
|
|
7210
7210
|
},
|
|
7211
7211
|
"decorators": [
|
|
7212
7212
|
{
|
|
@@ -7477,7 +7477,7 @@
|
|
|
7477
7477
|
"isPublic": true
|
|
7478
7478
|
},
|
|
7479
7479
|
"comment": {
|
|
7480
|
-
"shortText": "
|
|
7480
|
+
"shortText": "The icon from the\n[Font Awesome library](https://fontawesome.com/v4.7.0/).\nFor example, to display the `fa-filter` icon on the action button,\nset `iconType` to `filter`. SKY UX supports version 4.7.0 of Font Awesome.\nFor more information about icons in SKY UX, see the\n[icon component](https://developer.blackbaud.com/skyux/components/icon)."
|
|
7481
7481
|
},
|
|
7482
7482
|
"decorators": [
|
|
7483
7483
|
{
|
|
@@ -7711,7 +7711,7 @@
|
|
|
7711
7711
|
"kindString": "Set signature",
|
|
7712
7712
|
"flags": {},
|
|
7713
7713
|
"comment": {
|
|
7714
|
-
"shortText": "
|
|
7714
|
+
"shortText": "Configuration options for the back to top component."
|
|
7715
7715
|
},
|
|
7716
7716
|
"parameters": [
|
|
7717
7717
|
{
|
|
@@ -7778,7 +7778,7 @@
|
|
|
7778
7778
|
"kindString": "Set signature",
|
|
7779
7779
|
"flags": {},
|
|
7780
7780
|
"comment": {
|
|
7781
|
-
"shortText": "
|
|
7781
|
+
"shortText": "The observable to send commands to the back to top component.\nThe commands respect the `SkyBackToTopMessage` type."
|
|
7782
7782
|
},
|
|
7783
7783
|
"parameters": [
|
|
7784
7784
|
{
|
|
@@ -8207,7 +8207,7 @@
|
|
|
8207
8207
|
"isPublic": true
|
|
8208
8208
|
},
|
|
8209
8209
|
"comment": {
|
|
8210
|
-
"shortText": "
|
|
8210
|
+
"shortText": "Whether the deletion is pending.",
|
|
8211
8211
|
"tags": [
|
|
8212
8212
|
{
|
|
8213
8213
|
"tag": "default",
|
|
@@ -8429,7 +8429,7 @@
|
|
|
8429
8429
|
"isPublic": true
|
|
8430
8430
|
},
|
|
8431
8431
|
"comment": {
|
|
8432
|
-
"shortText": "
|
|
8432
|
+
"shortText": "Whether to display a checkbox to the right of the card title.\nUsers can select multiple checkboxes and perform actions on the selected cards.",
|
|
8433
8433
|
"tags": [
|
|
8434
8434
|
{
|
|
8435
8435
|
"tag": "default",
|
|
@@ -8471,7 +8471,7 @@
|
|
|
8471
8471
|
"isPublic": true
|
|
8472
8472
|
},
|
|
8473
8473
|
"comment": {
|
|
8474
|
-
"shortText": "
|
|
8474
|
+
"shortText": "Whether the card is selected. This only applies to card where\n`selectable` is set to `true`.",
|
|
8475
8475
|
"tags": [
|
|
8476
8476
|
{
|
|
8477
8477
|
"tag": "default",
|
|
@@ -8647,7 +8647,7 @@
|
|
|
8647
8647
|
"kindString": "Get signature",
|
|
8648
8648
|
"flags": {},
|
|
8649
8649
|
"comment": {
|
|
8650
|
-
"shortText": "
|
|
8650
|
+
"shortText": "The size of the card. The valid options are `\"large\"` and `\"small\"`.",
|
|
8651
8651
|
"tags": [
|
|
8652
8652
|
{
|
|
8653
8653
|
"tag": "default",
|
|
@@ -8669,7 +8669,7 @@
|
|
|
8669
8669
|
"kindString": "Set signature",
|
|
8670
8670
|
"flags": {},
|
|
8671
8671
|
"comment": {
|
|
8672
|
-
"shortText": "
|
|
8672
|
+
"shortText": "The size of the card. The valid options are `\"large\"` and `\"small\"`.",
|
|
8673
8673
|
"tags": [
|
|
8674
8674
|
{
|
|
8675
8675
|
"tag": "default",
|
|
@@ -8922,7 +8922,7 @@
|
|
|
8922
8922
|
"isOptional": true
|
|
8923
8923
|
},
|
|
8924
8924
|
"comment": {
|
|
8925
|
-
"shortText": "
|
|
8925
|
+
"shortText": "The Angular router link for the action button. This property accepts a\ncustom object with a `commands` property to specify router commands and an `extras`\nproperty to specify\n[Angular `NavigationExtras`](https://angular.io/api/router/NavigationExtras).\nThis property passes the following properties:\n- `permalink.route?.extras?.fragment` to\n[`fragment`](https://angular.io/api/router/NavigationExtras#fragment)\n- `permalink.route?.extras?.queryParams` to\n[`queryParams`](https://angular.io/api/router/NavigationExtras#queryParams)\n- `permalink.route?.extras?.queryParamsHandling` to\n[`queryParamsHandling`](https://angular.io/api/router/NavigationExtras#queryParamsHandling)\n- `permalink.route?.commands` to\n[`routerLink`](https://angular.io/api/router/RouterLink)"
|
|
8926
8926
|
},
|
|
8927
8927
|
"sources": [
|
|
8928
8928
|
{
|
|
@@ -9017,7 +9017,7 @@
|
|
|
9017
9017
|
"isOptional": true
|
|
9018
9018
|
},
|
|
9019
9019
|
"comment": {
|
|
9020
|
-
"shortText": "
|
|
9020
|
+
"shortText": "The direct link for the action button."
|
|
9021
9021
|
},
|
|
9022
9022
|
"sources": [
|
|
9023
9023
|
{
|
|
@@ -9069,7 +9069,7 @@
|
|
|
9069
9069
|
"isOptional": true
|
|
9070
9070
|
},
|
|
9071
9071
|
"comment": {
|
|
9072
|
-
"shortText": "
|
|
9072
|
+
"shortText": "The type of message to send."
|
|
9073
9073
|
},
|
|
9074
9074
|
"sources": [
|
|
9075
9075
|
{
|
|
@@ -9121,7 +9121,7 @@
|
|
|
9121
9121
|
"isOptional": true
|
|
9122
9122
|
},
|
|
9123
9123
|
"comment": {
|
|
9124
|
-
"shortText": "
|
|
9124
|
+
"shortText": "Whether to hide the back to top button.",
|
|
9125
9125
|
"tags": [
|
|
9126
9126
|
{
|
|
9127
9127
|
"tag": "default",
|
|
@@ -9193,7 +9193,7 @@
|
|
|
9193
9193
|
"kindString": "Type alias",
|
|
9194
9194
|
"flags": {},
|
|
9195
9195
|
"comment": {
|
|
9196
|
-
"shortText": "
|
|
9196
|
+
"shortText": "How to display the term-description pairs within a description list."
|
|
9197
9197
|
},
|
|
9198
9198
|
"sources": [
|
|
9199
9199
|
{
|
|
@@ -9455,7 +9455,7 @@
|
|
|
9455
9455
|
{
|
|
9456
9456
|
"fileName": "description-list-demo.component.ts",
|
|
9457
9457
|
"filePath": "/projects/layout/documentation/code-examples/description-list/horizontal/description-list-demo.component.ts",
|
|
9458
|
-
"rawContents": "import { Component } from '@angular/core';\n\n@Component({\n selector: 'app-description-list-demo',\n templateUrl: './description-list-demo.component.html',\n})\nexport class DescriptionListDemoComponent {\n public items: { term: string; description: string; showHelp?: boolean }[] = [\n {\n term: 'College',\n description: 'Humanities and Social Sciences',\n },\n {\n term: 'Department',\n description: 'Anthropology',\n },\n {\n term: 'Advisor',\n description: '
|
|
9458
|
+
"rawContents": "import { Component } from '@angular/core';\n\n@Component({\n selector: 'app-description-list-demo',\n templateUrl: './description-list-demo.component.html',\n})\nexport class DescriptionListDemoComponent {\n public items: { term: string; description: string; showHelp?: boolean }[] = [\n {\n term: 'College',\n description: 'Humanities and Social Sciences',\n },\n {\n term: 'Department',\n description: 'Anthropology',\n },\n {\n term: 'Advisor',\n description: 'Cathy Green',\n showHelp: true,\n },\n {\n term: 'Class year',\n description: '2024',\n },\n ];\n\n public onActionClick(): void {\n alert('Help inline button clicked!');\n }\n}\n"
|
|
9459
9459
|
},
|
|
9460
9460
|
{
|
|
9461
9461
|
"fileName": "description-list-demo.module.ts",
|
|
@@ -9470,7 +9470,7 @@
|
|
|
9470
9470
|
{
|
|
9471
9471
|
"fileName": "description-list-demo.component.ts",
|
|
9472
9472
|
"filePath": "/projects/layout/documentation/code-examples/description-list/inline-help/description-list-demo.component.ts",
|
|
9473
|
-
"rawContents": "import { Component } from '@angular/core';\n\n@Component({\n selector: 'app-description-list-demo',\n templateUrl: './description-list-demo.component.html',\n})\nexport class DescriptionListDemoComponent {\n public items: { term: string; description: string }[] = [\n {\n term: 'College',\n description: 'Humanities and Social Sciences',\n },\n {\n term: 'Department',\n description: 'Anthropology',\n },\n {\n term: 'Advisor',\n description: '
|
|
9473
|
+
"rawContents": "import { Component } from '@angular/core';\n\n@Component({\n selector: 'app-description-list-demo',\n templateUrl: './description-list-demo.component.html',\n})\nexport class DescriptionListDemoComponent {\n public items: { term: string; description: string }[] = [\n {\n term: 'College',\n description: 'Humanities and Social Sciences',\n },\n {\n term: 'Department',\n description: 'Anthropology',\n },\n {\n term: 'Advisor',\n description: 'Cathy Green',\n },\n {\n term: 'Class year',\n description: '2024',\n },\n ];\n\n public onActionClick(): void {\n alert('Help inline button clicked!');\n }\n}\n"
|
|
9474
9474
|
},
|
|
9475
9475
|
{
|
|
9476
9476
|
"fileName": "description-list-demo.module.ts",
|
|
@@ -9500,7 +9500,7 @@
|
|
|
9500
9500
|
{
|
|
9501
9501
|
"fileName": "description-list-demo.component.ts",
|
|
9502
9502
|
"filePath": "/projects/layout/documentation/code-examples/description-list/vertical/description-list-demo.component.ts",
|
|
9503
|
-
"rawContents": "import { Component } from '@angular/core';\n\n@Component({\n selector: 'app-description-list-demo',\n templateUrl: './description-list-demo.component.html',\n})\nexport class DescriptionListDemoComponent {\n public items: { term: string; description: string }[] = [\n {\n term: 'College',\n description: 'Humanities and Social Sciences',\n },\n {\n term: 'Department',\n description: 'Anthropology',\n },\n {\n term: 'Advisor',\n description: '
|
|
9503
|
+
"rawContents": "import { Component } from '@angular/core';\n\n@Component({\n selector: 'app-description-list-demo',\n templateUrl: './description-list-demo.component.html',\n})\nexport class DescriptionListDemoComponent {\n public items: { term: string; description: string }[] = [\n {\n term: 'College',\n description: 'Humanities and Social Sciences',\n },\n {\n term: 'Department',\n description: 'Anthropology',\n },\n {\n term: 'Advisor',\n description: 'Cathy Green',\n },\n {\n term: 'Class year',\n description: '2024',\n },\n ];\n}\n"
|
|
9504
9504
|
},
|
|
9505
9505
|
{
|
|
9506
9506
|
"fileName": "description-list-demo.module.ts",
|
|
@@ -9542,11 +9542,6 @@
|
|
|
9542
9542
|
"filePath": "/projects/layout/documentation/code-examples/format/format-demo.module.ts",
|
|
9543
9543
|
"rawContents": "import { CommonModule } from '@angular/common';\nimport { NgModule } from '@angular/core';\nimport { SkyFormatModule } from '@skyux/layout';\n\nimport { FormatDemoComponent } from './format-demo.component';\n\n@NgModule({\n imports: [CommonModule, SkyFormatModule],\n declarations: [FormatDemoComponent],\n exports: [FormatDemoComponent],\n})\nexport class FormatDemoModule {}\n"
|
|
9544
9544
|
},
|
|
9545
|
-
{
|
|
9546
|
-
"fileName": "inilne-delete-demo.component.ts",
|
|
9547
|
-
"filePath": "/projects/layout/documentation/code-examples/inline-delete/custom/inilne-delete-demo.component.ts",
|
|
9548
|
-
"rawContents": "import { Component } from '@angular/core';\n\n@Component({\n selector: 'app-inline-delete-demo',\n templateUrl: './inline-delete-demo.component.html',\n styleUrls: ['./inline-delete-demo.component.scss'],\n})\nexport class InlineDeleteDemoComponent {\n public deleting = false;\n\n public pending = false;\n\n public deleteItem(): void {\n this.deleting = true;\n }\n\n public onCancelTriggered(): void {\n this.deleting = false;\n }\n\n public onDeleteTriggered(): void {\n setTimeout(() => {\n this.pending = false;\n this.deleting = false;\n\n alert(\n 'Custom element deletion was triggered. In a real scenario the item would be removed. Item was not removed just for demo purposes.'\n );\n }, 3000);\n\n this.pending = true;\n }\n}\n"
|
|
9549
|
-
},
|
|
9550
9545
|
{
|
|
9551
9546
|
"fileName": "inline-delete-demo.component.html",
|
|
9552
9547
|
"filePath": "/projects/layout/documentation/code-examples/inline-delete/custom/inline-delete-demo.component.html",
|
|
@@ -9558,24 +9553,29 @@
|
|
|
9558
9553
|
"rawContents": "#inline-delete-container {\n padding: 15px;\n background-color: white;\n border: black solid 1px;\n height: 400px;\n width: 400px;\n position: relative;\n}\n\n#inline-delete-trigger {\n position: absolute;\n bottom: 10px;\n left: 0;\n width: 100%;\n}\n"
|
|
9559
9554
|
},
|
|
9560
9555
|
{
|
|
9561
|
-
"fileName": "inline-delete-demo.
|
|
9562
|
-
"filePath": "/projects/layout/documentation/code-examples/inline-delete/custom/inline-delete-demo.
|
|
9563
|
-
"rawContents": "import {
|
|
9556
|
+
"fileName": "inline-delete-demo.component.ts",
|
|
9557
|
+
"filePath": "/projects/layout/documentation/code-examples/inline-delete/custom/inline-delete-demo.component.ts",
|
|
9558
|
+
"rawContents": "import { Component } from '@angular/core';\n\n@Component({\n selector: 'app-inline-delete-demo',\n templateUrl: './inline-delete-demo.component.html',\n styleUrls: ['./inline-delete-demo.component.scss'],\n})\nexport class InlineDeleteDemoComponent {\n public deleting = false;\n\n public pending = false;\n\n public deleteItem(): void {\n this.deleting = true;\n }\n\n public onCancelTriggered(): void {\n this.deleting = false;\n }\n\n public onDeleteTriggered(): void {\n setTimeout(() => {\n this.pending = false;\n this.deleting = false;\n\n alert(\n 'Custom element deletion was triggered. In a real scenario the item would be removed. Item was not removed just for demo purposes.'\n );\n }, 3000);\n\n this.pending = true;\n }\n}\n"
|
|
9564
9559
|
},
|
|
9565
9560
|
{
|
|
9566
|
-
"fileName": "
|
|
9567
|
-
"filePath": "/projects/layout/documentation/code-examples/inline-delete/
|
|
9568
|
-
"rawContents": "import {
|
|
9561
|
+
"fileName": "inline-delete-demo.module.ts",
|
|
9562
|
+
"filePath": "/projects/layout/documentation/code-examples/inline-delete/custom/inline-delete-demo.module.ts",
|
|
9563
|
+
"rawContents": "import { CommonModule } from '@angular/common';\nimport { NgModule } from '@angular/core';\nimport { SkyIconModule } from '@skyux/indicators';\nimport { SkyInlineDeleteModule } from '@skyux/layout';\n\nimport { InlineDeleteDemoComponent } from './inline-delete-demo.component';\n\n@NgModule({\n imports: [CommonModule, SkyIconModule, SkyInlineDeleteModule],\n declarations: [InlineDeleteDemoComponent],\n exports: [InlineDeleteDemoComponent],\n})\nexport class InlineDeleteDemoModule {}\n"
|
|
9569
9564
|
},
|
|
9570
9565
|
{
|
|
9571
9566
|
"fileName": "inline-delete-repeater-demo.component.html",
|
|
9572
9567
|
"filePath": "/projects/layout/documentation/code-examples/inline-delete/repeater/inline-delete-repeater-demo.component.html",
|
|
9573
9568
|
"rawContents": "<sky-repeater style=\"width: 100%\">\n <sky-repeater-item *ngFor=\"let item of repeaterDemoItems\">\n <sky-repeater-item-context-menu>\n <sky-dropdown buttonType=\"context-menu\">\n <sky-dropdown-menu>\n <sky-dropdown-item>\n <button type=\"button\" (click)=\"showInlineDelete(item.title)\">\n Delete\n </button>\n </sky-dropdown-item>\n </sky-dropdown-menu>\n </sky-dropdown>\n </sky-repeater-item-context-menu>\n <sky-repeater-item-title class=\"sky-demo-inline-delete-flex\">\n <div>\n {{ item.title }}\n </div>\n <div>\n {{ item.cost }}\n </div>\n </sky-repeater-item-title>\n <sky-repeater-item-content>\n {{ item.description }}\n </sky-repeater-item-content>\n <sky-inline-delete\n *ngIf=\"repeaterDemoShownInlineDeletes.indexOf(item.title) >= 0\"\n (cancelTriggered)=\"cancelDeletion(item.title)\"\n (deleteTriggered)=\"deleteItem(item.title)\"\n ></sky-inline-delete>\n </sky-repeater-item>\n</sky-repeater>\n\n<button class=\"sky-btn sky-btn-primary\" type=\"button\" (click)=\"onResetClick()\">\n Reset Repeater\n</button>\n"
|
|
9574
9569
|
},
|
|
9570
|
+
{
|
|
9571
|
+
"fileName": "inline-delete-repeater-demo.component.ts",
|
|
9572
|
+
"filePath": "/projects/layout/documentation/code-examples/inline-delete/repeater/inline-delete-repeater-demo.component.ts",
|
|
9573
|
+
"rawContents": "import { Component } from '@angular/core';\n\ninterface InlineRepeaterDemoItem {\n title: string;\n cost: string;\n description: string;\n}\n\n@Component({\n selector: 'app-inline-delete-repeater-demo',\n templateUrl: './inline-delete-repeater-demo.component.html',\n})\nexport class InlineDeleteRepeaterDemoComponent {\n public originalRepeaterDemoItems: InlineRepeaterDemoItem[] = [\n {\n title: 'Individual',\n cost: '$75.00',\n description: '1 ticket',\n },\n {\n title: 'Foursome',\n cost: '$250.00',\n description: '4 tickets',\n },\n {\n title: 'Hole sponsor',\n cost: '$1,000.00',\n description: '8 tickets',\n },\n ];\n\n public repeaterDemoItems: InlineRepeaterDemoItem[] =\n this.originalRepeaterDemoItems;\n\n public repeaterDemoShownInlineDeletes: string[] = [];\n\n public showInlineDelete(title: string): void {\n this.repeaterDemoShownInlineDeletes.push(title);\n }\n\n public deleteItem(title: string): void {\n this.repeaterDemoItems = this.repeaterDemoItems.filter(\n (demoItem: InlineRepeaterDemoItem) => demoItem.title !== title\n );\n this.repeaterDemoShownInlineDeletes =\n this.repeaterDemoShownInlineDeletes.filter(\n (demoItem: string) => demoItem !== title\n );\n }\n\n public cancelDeletion(title: string): void {\n this.repeaterDemoShownInlineDeletes =\n this.repeaterDemoShownInlineDeletes.filter(\n (demoItem: string) => demoItem !== title\n );\n }\n\n public onResetClick(): void {\n this.repeaterDemoItems = this.originalRepeaterDemoItems;\n this.repeaterDemoShownInlineDeletes = [];\n }\n}\n"
|
|
9574
|
+
},
|
|
9575
9575
|
{
|
|
9576
9576
|
"fileName": "inline-delete-repeater-demo.module.ts",
|
|
9577
9577
|
"filePath": "/projects/layout/documentation/code-examples/inline-delete/repeater/inline-delete-repeater-demo.module.ts",
|
|
9578
|
-
"rawContents": "import { CommonModule } from '@angular/common';\nimport { NgModule } from '@angular/core';\nimport { SkyInlineDeleteModule } from '@skyux/layout';\nimport { SkyRepeaterModule } from '@skyux/lists';\nimport { SkyDropdownModule } from '@skyux/popovers';\n\nimport { InlineDeleteRepeaterDemoComponent } from './
|
|
9578
|
+
"rawContents": "import { CommonModule } from '@angular/common';\nimport { NgModule } from '@angular/core';\nimport { SkyInlineDeleteModule } from '@skyux/layout';\nimport { SkyRepeaterModule } from '@skyux/lists';\nimport { SkyDropdownModule } from '@skyux/popovers';\n\nimport { InlineDeleteRepeaterDemoComponent } from './inline-delete-repeater-demo.component';\n\n@NgModule({\n imports: [\n CommonModule,\n SkyDropdownModule,\n SkyInlineDeleteModule,\n SkyRepeaterModule,\n ],\n declarations: [InlineDeleteRepeaterDemoComponent],\n exports: [InlineDeleteRepeaterDemoComponent],\n})\nexport class InlineDeleteRepeaterDemoModule {}\n"
|
|
9579
9579
|
},
|
|
9580
9580
|
{
|
|
9581
9581
|
"fileName": "page-summary-demo.component.html",
|