@ni/ok-components 1.14.0 → 1.15.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.
@@ -67,124 +67,6 @@
67
67
  }
68
68
  ]
69
69
  },
70
- {
71
- "kind": "javascript-module",
72
- "path": "src/fv/accordion-item/index.ts",
73
- "declarations": [
74
- {
75
- "kind": "class",
76
- "description": "An accordion item component that can be expanded or collapsed to\nshow or hide its content.",
77
- "name": "FvAccordionItem",
78
- "members": [
79
- {
80
- "kind": "field",
81
- "name": "header",
82
- "type": {
83
- "text": "string"
84
- },
85
- "privacy": "public",
86
- "default": "''"
87
- },
88
- {
89
- "kind": "field",
90
- "name": "expanded",
91
- "type": {
92
- "text": "boolean"
93
- },
94
- "privacy": "public",
95
- "default": "false"
96
- },
97
- {
98
- "kind": "field",
99
- "name": "appearance",
100
- "type": {
101
- "text": "FvAccordionItemAppearance"
102
- },
103
- "privacy": "public"
104
- }
105
- ],
106
- "attributes": [
107
- {
108
- "name": "header",
109
- "type": {
110
- "text": "string"
111
- },
112
- "default": "''",
113
- "fieldName": "header"
114
- },
115
- {
116
- "name": "expanded",
117
- "type": {
118
- "text": "boolean"
119
- },
120
- "default": "false",
121
- "fieldName": "expanded"
122
- },
123
- {
124
- "name": "appearance",
125
- "type": {
126
- "text": "FvAccordionItemAppearance"
127
- },
128
- "fieldName": "appearance"
129
- }
130
- ],
131
- "superclass": {
132
- "name": "FoundationElement",
133
- "package": "@ni/fast-foundation"
134
- }
135
- },
136
- {
137
- "kind": "variable",
138
- "name": "fvAccordionItemTag",
139
- "type": {
140
- "text": "string"
141
- },
142
- "default": "'ok-fv-accordion-item'"
143
- }
144
- ],
145
- "exports": [
146
- {
147
- "kind": "js",
148
- "name": "FvAccordionItem",
149
- "declaration": {
150
- "name": "FvAccordionItem",
151
- "module": "src/fv/accordion-item/index.ts"
152
- }
153
- },
154
- {
155
- "kind": "js",
156
- "name": "fvAccordionItemTag",
157
- "declaration": {
158
- "name": "fvAccordionItemTag",
159
- "module": "src/fv/accordion-item/index.ts"
160
- }
161
- }
162
- ]
163
- },
164
- {
165
- "kind": "javascript-module",
166
- "path": "src/fv/accordion-item/types.ts",
167
- "declarations": [
168
- {
169
- "kind": "variable",
170
- "name": "FvAccordionItemAppearance",
171
- "type": {
172
- "text": "{\n outline: 'outline',\n ghost: 'ghost',\n block: 'block'\n}"
173
- },
174
- "default": "{ outline: 'outline', ghost: 'ghost', block: 'block' }"
175
- }
176
- ],
177
- "exports": [
178
- {
179
- "kind": "js",
180
- "name": "FvAccordionItemAppearance",
181
- "declaration": {
182
- "name": "FvAccordionItemAppearance",
183
- "module": "src/fv/accordion-item/types.ts"
184
- }
185
- }
186
- ]
187
- },
188
70
  {
189
71
  "kind": "javascript-module",
190
72
  "path": "src/fv/bulk-edit-field/index.ts",
@@ -692,6 +574,124 @@
692
574
  }
693
575
  ]
694
576
  },
577
+ {
578
+ "kind": "javascript-module",
579
+ "path": "src/fv/accordion-item/index.ts",
580
+ "declarations": [
581
+ {
582
+ "kind": "class",
583
+ "description": "An accordion item component that can be expanded or collapsed to\nshow or hide its content.",
584
+ "name": "FvAccordionItem",
585
+ "members": [
586
+ {
587
+ "kind": "field",
588
+ "name": "header",
589
+ "type": {
590
+ "text": "string"
591
+ },
592
+ "privacy": "public",
593
+ "default": "''"
594
+ },
595
+ {
596
+ "kind": "field",
597
+ "name": "expanded",
598
+ "type": {
599
+ "text": "boolean"
600
+ },
601
+ "privacy": "public",
602
+ "default": "false"
603
+ },
604
+ {
605
+ "kind": "field",
606
+ "name": "appearance",
607
+ "type": {
608
+ "text": "FvAccordionItemAppearance"
609
+ },
610
+ "privacy": "public"
611
+ }
612
+ ],
613
+ "attributes": [
614
+ {
615
+ "name": "header",
616
+ "type": {
617
+ "text": "string"
618
+ },
619
+ "default": "''",
620
+ "fieldName": "header"
621
+ },
622
+ {
623
+ "name": "expanded",
624
+ "type": {
625
+ "text": "boolean"
626
+ },
627
+ "default": "false",
628
+ "fieldName": "expanded"
629
+ },
630
+ {
631
+ "name": "appearance",
632
+ "type": {
633
+ "text": "FvAccordionItemAppearance"
634
+ },
635
+ "fieldName": "appearance"
636
+ }
637
+ ],
638
+ "superclass": {
639
+ "name": "FoundationElement",
640
+ "package": "@ni/fast-foundation"
641
+ }
642
+ },
643
+ {
644
+ "kind": "variable",
645
+ "name": "fvAccordionItemTag",
646
+ "type": {
647
+ "text": "string"
648
+ },
649
+ "default": "'ok-fv-accordion-item'"
650
+ }
651
+ ],
652
+ "exports": [
653
+ {
654
+ "kind": "js",
655
+ "name": "FvAccordionItem",
656
+ "declaration": {
657
+ "name": "FvAccordionItem",
658
+ "module": "src/fv/accordion-item/index.ts"
659
+ }
660
+ },
661
+ {
662
+ "kind": "js",
663
+ "name": "fvAccordionItemTag",
664
+ "declaration": {
665
+ "name": "fvAccordionItemTag",
666
+ "module": "src/fv/accordion-item/index.ts"
667
+ }
668
+ }
669
+ ]
670
+ },
671
+ {
672
+ "kind": "javascript-module",
673
+ "path": "src/fv/accordion-item/types.ts",
674
+ "declarations": [
675
+ {
676
+ "kind": "variable",
677
+ "name": "FvAccordionItemAppearance",
678
+ "type": {
679
+ "text": "{\n outline: 'outline',\n ghost: 'ghost',\n block: 'block'\n}"
680
+ },
681
+ "default": "{ outline: 'outline', ghost: 'ghost', block: 'block' }"
682
+ }
683
+ ],
684
+ "exports": [
685
+ {
686
+ "kind": "js",
687
+ "name": "FvAccordionItemAppearance",
688
+ "declaration": {
689
+ "name": "FvAccordionItemAppearance",
690
+ "module": "src/fv/accordion-item/types.ts"
691
+ }
692
+ }
693
+ ]
694
+ },
695
695
  {
696
696
  "kind": "javascript-module",
697
697
  "path": "src/fv/card/index.ts",
@@ -3315,40 +3315,68 @@
3315
3315
  },
3316
3316
  {
3317
3317
  "kind": "javascript-module",
3318
- "path": "src/fv/sticky-header/index.ts",
3318
+ "path": "src/fv/summary-panel-tile/index.ts",
3319
3319
  "declarations": [
3320
3320
  {
3321
3321
  "kind": "class",
3322
- "description": "Displays an alternate header in a sticky overlay after the primary header leaves the viewport.",
3323
- "name": "FvStickyHeader",
3322
+ "description": "A clickable summary tile for displaying a large value with a compact label.",
3323
+ "name": "FvSummaryPanelTile",
3324
3324
  "members": [
3325
3325
  {
3326
3326
  "kind": "field",
3327
- "name": "headerVisibility",
3328
- "privacy": "private",
3329
- "readonly": true,
3330
- "default": "new Map<Element, boolean>()"
3327
+ "name": "count",
3328
+ "type": {
3329
+ "text": "string"
3330
+ },
3331
+ "privacy": "public",
3332
+ "default": "''"
3331
3333
  },
3332
3334
  {
3333
3335
  "kind": "field",
3334
- "name": "headerIntersectionObserver",
3335
- "privacy": "private",
3336
- "readonly": true,
3337
- "default": "new IntersectionObserver(entries => { this.handleHeaderIntersection(entries); })"
3336
+ "name": "label",
3337
+ "type": {
3338
+ "text": "string"
3339
+ },
3340
+ "privacy": "public",
3341
+ "default": "''"
3338
3342
  },
3339
3343
  {
3340
- "kind": "method",
3341
- "name": "observeHeader",
3342
- "privacy": "private",
3343
- "return": {
3344
- "type": {
3345
- "text": "void"
3346
- }
3347
- }
3344
+ "kind": "field",
3345
+ "name": "legacyStyle",
3346
+ "type": {
3347
+ "text": "boolean"
3348
+ },
3349
+ "privacy": "public",
3350
+ "default": "false"
3351
+ },
3352
+ {
3353
+ "kind": "field",
3354
+ "name": "size",
3355
+ "type": {
3356
+ "text": "FvSummaryPanelSizeType"
3357
+ },
3358
+ "privacy": "public"
3359
+ },
3360
+ {
3361
+ "kind": "field",
3362
+ "name": "selected",
3363
+ "type": {
3364
+ "text": "boolean"
3365
+ },
3366
+ "privacy": "public",
3367
+ "default": "false"
3368
+ },
3369
+ {
3370
+ "kind": "field",
3371
+ "name": "textPosition",
3372
+ "type": {
3373
+ "text": "FvSummaryPanelTileTextPositionType"
3374
+ },
3375
+ "privacy": "public"
3348
3376
  },
3349
3377
  {
3350
3378
  "kind": "method",
3351
- "name": "updateStickyHeaderContent",
3379
+ "name": "syncLegacyStyleAttribute",
3352
3380
  "privacy": "private",
3353
3381
  "return": {
3354
3382
  "type": {
@@ -3357,6 +3385,54 @@
3357
3385
  }
3358
3386
  }
3359
3387
  ],
3388
+ "attributes": [
3389
+ {
3390
+ "name": "count",
3391
+ "type": {
3392
+ "text": "string"
3393
+ },
3394
+ "default": "''",
3395
+ "fieldName": "count"
3396
+ },
3397
+ {
3398
+ "name": "label",
3399
+ "type": {
3400
+ "text": "string"
3401
+ },
3402
+ "default": "''",
3403
+ "fieldName": "label"
3404
+ },
3405
+ {
3406
+ "name": "legacy-style",
3407
+ "type": {
3408
+ "text": "boolean"
3409
+ },
3410
+ "default": "false",
3411
+ "fieldName": "legacyStyle"
3412
+ },
3413
+ {
3414
+ "name": "size",
3415
+ "type": {
3416
+ "text": "FvSummaryPanelSizeType"
3417
+ },
3418
+ "fieldName": "size"
3419
+ },
3420
+ {
3421
+ "name": "selected",
3422
+ "type": {
3423
+ "text": "boolean"
3424
+ },
3425
+ "default": "false",
3426
+ "fieldName": "selected"
3427
+ },
3428
+ {
3429
+ "name": "text-position",
3430
+ "type": {
3431
+ "text": "FvSummaryPanelTileTextPositionType"
3432
+ },
3433
+ "fieldName": "textPosition"
3434
+ }
3435
+ ],
3360
3436
  "superclass": {
3361
3437
  "name": "FoundationElement",
3362
3438
  "package": "@ni/fast-foundation"
@@ -3364,28 +3440,52 @@
3364
3440
  },
3365
3441
  {
3366
3442
  "kind": "variable",
3367
- "name": "fvStickyHeaderTag",
3443
+ "name": "fvSummaryPanelTileTag",
3368
3444
  "type": {
3369
3445
  "text": "string"
3370
3446
  },
3371
- "default": "'ok-fv-sticky-header'"
3447
+ "default": "'ok-fv-summary-panel-tile'"
3372
3448
  }
3373
3449
  ],
3374
3450
  "exports": [
3375
3451
  {
3376
3452
  "kind": "js",
3377
- "name": "FvStickyHeader",
3453
+ "name": "FvSummaryPanelTile",
3378
3454
  "declaration": {
3379
- "name": "FvStickyHeader",
3380
- "module": "src/fv/sticky-header/index.ts"
3455
+ "name": "FvSummaryPanelTile",
3456
+ "module": "src/fv/summary-panel-tile/index.ts"
3381
3457
  }
3382
3458
  },
3383
3459
  {
3384
3460
  "kind": "js",
3385
- "name": "fvStickyHeaderTag",
3461
+ "name": "fvSummaryPanelTileTag",
3386
3462
  "declaration": {
3387
- "name": "fvStickyHeaderTag",
3388
- "module": "src/fv/sticky-header/index.ts"
3463
+ "name": "fvSummaryPanelTileTag",
3464
+ "module": "src/fv/summary-panel-tile/index.ts"
3465
+ }
3466
+ }
3467
+ ]
3468
+ },
3469
+ {
3470
+ "kind": "javascript-module",
3471
+ "path": "src/fv/summary-panel-tile/types.ts",
3472
+ "declarations": [
3473
+ {
3474
+ "kind": "variable",
3475
+ "name": "FvSummaryPanelTileTextPosition",
3476
+ "type": {
3477
+ "text": "{\n beside: 'beside',\n under: 'under'\n}"
3478
+ },
3479
+ "default": "{ beside: 'beside', under: 'under' }"
3480
+ }
3481
+ ],
3482
+ "exports": [
3483
+ {
3484
+ "kind": "js",
3485
+ "name": "FvSummaryPanelTileTextPosition",
3486
+ "declaration": {
3487
+ "name": "FvSummaryPanelTileTextPosition",
3488
+ "module": "src/fv/summary-panel-tile/types.ts"
3389
3489
  }
3390
3490
  }
3391
3491
  ]
@@ -3583,122 +3683,46 @@
3583
3683
  },
3584
3684
  {
3585
3685
  "kind": "javascript-module",
3586
- "path": "src/fv/summary-panel-tile/index.ts",
3686
+ "path": "src/fv/sticky-header/index.ts",
3587
3687
  "declarations": [
3588
3688
  {
3589
3689
  "kind": "class",
3590
- "description": "A clickable summary tile for displaying a large value with a compact label.",
3591
- "name": "FvSummaryPanelTile",
3690
+ "description": "Displays an alternate header in a sticky overlay after the primary header leaves the viewport.",
3691
+ "name": "FvStickyHeader",
3592
3692
  "members": [
3593
3693
  {
3594
3694
  "kind": "field",
3595
- "name": "count",
3596
- "type": {
3597
- "text": "string"
3598
- },
3599
- "privacy": "public",
3600
- "default": "''"
3601
- },
3602
- {
3603
- "kind": "field",
3604
- "name": "label",
3605
- "type": {
3606
- "text": "string"
3607
- },
3608
- "privacy": "public",
3609
- "default": "''"
3610
- },
3611
- {
3612
- "kind": "field",
3613
- "name": "legacyStyle",
3614
- "type": {
3615
- "text": "boolean"
3616
- },
3617
- "privacy": "public",
3618
- "default": "false"
3619
- },
3620
- {
3621
- "kind": "field",
3622
- "name": "size",
3623
- "type": {
3624
- "text": "FvSummaryPanelSizeType"
3625
- },
3626
- "privacy": "public"
3627
- },
3628
- {
3629
- "kind": "field",
3630
- "name": "selected",
3631
- "type": {
3632
- "text": "boolean"
3633
- },
3634
- "privacy": "public",
3635
- "default": "false"
3695
+ "name": "headerVisibility",
3696
+ "privacy": "private",
3697
+ "readonly": true,
3698
+ "default": "new Map<Element, boolean>()"
3636
3699
  },
3637
3700
  {
3638
3701
  "kind": "field",
3639
- "name": "textPosition",
3640
- "type": {
3641
- "text": "FvSummaryPanelTileTextPositionType"
3642
- },
3643
- "privacy": "public"
3702
+ "name": "headerIntersectionObserver",
3703
+ "privacy": "private",
3704
+ "readonly": true,
3705
+ "default": "new IntersectionObserver(entries => { this.handleHeaderIntersection(entries); })"
3644
3706
  },
3645
3707
  {
3646
3708
  "kind": "method",
3647
- "name": "syncLegacyStyleAttribute",
3709
+ "name": "observeHeader",
3648
3710
  "privacy": "private",
3649
3711
  "return": {
3650
3712
  "type": {
3651
3713
  "text": "void"
3652
3714
  }
3653
3715
  }
3654
- }
3655
- ],
3656
- "attributes": [
3657
- {
3658
- "name": "count",
3659
- "type": {
3660
- "text": "string"
3661
- },
3662
- "default": "''",
3663
- "fieldName": "count"
3664
- },
3665
- {
3666
- "name": "label",
3667
- "type": {
3668
- "text": "string"
3669
- },
3670
- "default": "''",
3671
- "fieldName": "label"
3672
- },
3673
- {
3674
- "name": "legacy-style",
3675
- "type": {
3676
- "text": "boolean"
3677
- },
3678
- "default": "false",
3679
- "fieldName": "legacyStyle"
3680
3716
  },
3681
3717
  {
3682
- "name": "size",
3683
- "type": {
3684
- "text": "FvSummaryPanelSizeType"
3685
- },
3686
- "fieldName": "size"
3687
- },
3688
- {
3689
- "name": "selected",
3690
- "type": {
3691
- "text": "boolean"
3692
- },
3693
- "default": "false",
3694
- "fieldName": "selected"
3695
- },
3696
- {
3697
- "name": "text-position",
3698
- "type": {
3699
- "text": "FvSummaryPanelTileTextPositionType"
3700
- },
3701
- "fieldName": "textPosition"
3718
+ "kind": "method",
3719
+ "name": "updateStickyHeaderContent",
3720
+ "privacy": "private",
3721
+ "return": {
3722
+ "type": {
3723
+ "text": "void"
3724
+ }
3725
+ }
3702
3726
  }
3703
3727
  ],
3704
3728
  "superclass": {
@@ -3708,52 +3732,28 @@
3708
3732
  },
3709
3733
  {
3710
3734
  "kind": "variable",
3711
- "name": "fvSummaryPanelTileTag",
3735
+ "name": "fvStickyHeaderTag",
3712
3736
  "type": {
3713
3737
  "text": "string"
3714
3738
  },
3715
- "default": "'ok-fv-summary-panel-tile'"
3739
+ "default": "'ok-fv-sticky-header'"
3716
3740
  }
3717
3741
  ],
3718
3742
  "exports": [
3719
3743
  {
3720
3744
  "kind": "js",
3721
- "name": "FvSummaryPanelTile",
3745
+ "name": "FvStickyHeader",
3722
3746
  "declaration": {
3723
- "name": "FvSummaryPanelTile",
3724
- "module": "src/fv/summary-panel-tile/index.ts"
3747
+ "name": "FvStickyHeader",
3748
+ "module": "src/fv/sticky-header/index.ts"
3725
3749
  }
3726
3750
  },
3727
3751
  {
3728
3752
  "kind": "js",
3729
- "name": "fvSummaryPanelTileTag",
3730
- "declaration": {
3731
- "name": "fvSummaryPanelTileTag",
3732
- "module": "src/fv/summary-panel-tile/index.ts"
3733
- }
3734
- }
3735
- ]
3736
- },
3737
- {
3738
- "kind": "javascript-module",
3739
- "path": "src/fv/summary-panel-tile/types.ts",
3740
- "declarations": [
3741
- {
3742
- "kind": "variable",
3743
- "name": "FvSummaryPanelTileTextPosition",
3744
- "type": {
3745
- "text": "{\n beside: 'beside',\n under: 'under'\n}"
3746
- },
3747
- "default": "{ beside: 'beside', under: 'under' }"
3748
- }
3749
- ],
3750
- "exports": [
3751
- {
3752
- "kind": "js",
3753
- "name": "FvSummaryPanelTileTextPosition",
3753
+ "name": "fvStickyHeaderTag",
3754
3754
  "declaration": {
3755
- "name": "FvSummaryPanelTileTextPosition",
3756
- "module": "src/fv/summary-panel-tile/types.ts"
3755
+ "name": "fvStickyHeaderTag",
3756
+ "module": "src/fv/sticky-header/index.ts"
3757
3757
  }
3758
3758
  }
3759
3759
  ]