@ni/ok-components 1.8.3 → 1.9.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.
@@ -185,206 +185,6 @@
185
185
  }
186
186
  ]
187
187
  },
188
- {
189
- "kind": "javascript-module",
190
- "path": "src/fv/card/index.ts",
191
- "declarations": [
192
- {
193
- "kind": "class",
194
- "description": "An opinionated card component for FV layouts with optional media,\nbadges, footer metadata, and action content.",
195
- "name": "FvCard",
196
- "members": [
197
- {
198
- "kind": "field",
199
- "name": "title",
200
- "type": {
201
- "text": "string"
202
- },
203
- "privacy": "public",
204
- "default": "''"
205
- },
206
- {
207
- "kind": "field",
208
- "name": "subtitle",
209
- "type": {
210
- "text": "string"
211
- },
212
- "privacy": "public",
213
- "default": "''"
214
- },
215
- {
216
- "kind": "field",
217
- "name": "description",
218
- "type": {
219
- "text": "string"
220
- },
221
- "privacy": "public",
222
- "default": "''"
223
- },
224
- {
225
- "kind": "field",
226
- "name": "appearance",
227
- "type": {
228
- "text": "FvCardAppearanceType"
229
- },
230
- "privacy": "public"
231
- },
232
- {
233
- "kind": "field",
234
- "name": "interactionMode",
235
- "type": {
236
- "text": "FvCardInteractionModeType"
237
- },
238
- "privacy": "public"
239
- },
240
- {
241
- "kind": "field",
242
- "name": "disabled",
243
- "type": {
244
- "text": "boolean"
245
- },
246
- "privacy": "public",
247
- "default": "false"
248
- },
249
- {
250
- "kind": "field",
251
- "name": "initials",
252
- "type": {
253
- "text": "string"
254
- },
255
- "privacy": "public",
256
- "default": "''"
257
- }
258
- ],
259
- "attributes": [
260
- {
261
- "name": "card-title",
262
- "type": {
263
- "text": "string"
264
- },
265
- "default": "''",
266
- "fieldName": "title"
267
- },
268
- {
269
- "name": "subtitle",
270
- "type": {
271
- "text": "string"
272
- },
273
- "default": "''",
274
- "fieldName": "subtitle"
275
- },
276
- {
277
- "name": "description",
278
- "type": {
279
- "text": "string"
280
- },
281
- "default": "''",
282
- "fieldName": "description"
283
- },
284
- {
285
- "name": "appearance",
286
- "type": {
287
- "text": "FvCardAppearanceType"
288
- },
289
- "fieldName": "appearance"
290
- },
291
- {
292
- "name": "interaction-mode",
293
- "type": {
294
- "text": "FvCardInteractionModeType"
295
- },
296
- "fieldName": "interactionMode"
297
- },
298
- {
299
- "name": "disabled",
300
- "type": {
301
- "text": "boolean"
302
- },
303
- "default": "false",
304
- "fieldName": "disabled"
305
- },
306
- {
307
- "name": "initials",
308
- "type": {
309
- "text": "string"
310
- },
311
- "default": "''",
312
- "fieldName": "initials"
313
- }
314
- ],
315
- "superclass": {
316
- "name": "FoundationElement",
317
- "package": "@ni/fast-foundation"
318
- }
319
- },
320
- {
321
- "kind": "variable",
322
- "name": "fvCardTag",
323
- "type": {
324
- "text": "string"
325
- },
326
- "default": "'ok-fv-card'"
327
- }
328
- ],
329
- "exports": [
330
- {
331
- "kind": "js",
332
- "name": "FvCard",
333
- "declaration": {
334
- "name": "FvCard",
335
- "module": "src/fv/card/index.ts"
336
- }
337
- },
338
- {
339
- "kind": "js",
340
- "name": "fvCardTag",
341
- "declaration": {
342
- "name": "fvCardTag",
343
- "module": "src/fv/card/index.ts"
344
- }
345
- }
346
- ]
347
- },
348
- {
349
- "kind": "javascript-module",
350
- "path": "src/fv/card/types.ts",
351
- "declarations": [
352
- {
353
- "kind": "variable",
354
- "name": "FvCardAppearance",
355
- "type": {
356
- "text": "{\n outline: 'outline',\n block: 'block'\n}"
357
- },
358
- "default": "{ outline: 'outline', block: 'block' }"
359
- },
360
- {
361
- "kind": "variable",
362
- "name": "FvCardInteractionMode",
363
- "type": {
364
- "text": "{\n static: 'static',\n card: 'card'\n}"
365
- },
366
- "default": "{ static: 'static', card: 'card' }"
367
- }
368
- ],
369
- "exports": [
370
- {
371
- "kind": "js",
372
- "name": "FvCardAppearance",
373
- "declaration": {
374
- "name": "FvCardAppearance",
375
- "module": "src/fv/card/types.ts"
376
- }
377
- },
378
- {
379
- "kind": "js",
380
- "name": "FvCardInteractionMode",
381
- "declaration": {
382
- "name": "FvCardInteractionMode",
383
- "module": "src/fv/card/types.ts"
384
- }
385
- }
386
- ]
387
- },
388
188
  {
389
189
  "kind": "javascript-module",
390
190
  "path": "src/fv/chip-selector/index.ts",
@@ -685,16 +485,16 @@
685
485
  },
686
486
  {
687
487
  "kind": "javascript-module",
688
- "path": "src/fv/context-help/index.ts",
488
+ "path": "src/fv/card/index.ts",
689
489
  "declarations": [
690
490
  {
691
491
  "kind": "class",
692
- "description": "An info trigger with an attached tooltip for lightweight contextual guidance.",
693
- "name": "FvContextHelp",
492
+ "description": "An opinionated card component for FV layouts with optional media,\nbadges, footer metadata, and action content.",
493
+ "name": "FvCard",
694
494
  "members": [
695
495
  {
696
496
  "kind": "field",
697
- "name": "text",
497
+ "name": "title",
698
498
  "type": {
699
499
  "text": "string"
700
500
  },
@@ -703,50 +503,250 @@
703
503
  },
704
504
  {
705
505
  "kind": "field",
706
- "name": "triggerLabel",
506
+ "name": "subtitle",
707
507
  "type": {
708
508
  "text": "string"
709
509
  },
710
510
  "privacy": "public",
711
- "default": "'Show help'"
511
+ "default": "''"
712
512
  },
713
513
  {
714
514
  "kind": "field",
715
- "name": "severity",
515
+ "name": "description",
716
516
  "type": {
717
- "text": "FvContextHelpSeverity"
517
+ "text": "string"
518
+ },
519
+ "privacy": "public",
520
+ "default": "''"
521
+ },
522
+ {
523
+ "kind": "field",
524
+ "name": "appearance",
525
+ "type": {
526
+ "text": "FvCardAppearanceType"
718
527
  },
719
528
  "privacy": "public"
720
529
  },
721
530
  {
722
531
  "kind": "field",
723
- "name": "iconVisible",
532
+ "name": "interactionMode",
533
+ "type": {
534
+ "text": "FvCardInteractionModeType"
535
+ },
536
+ "privacy": "public"
537
+ },
538
+ {
539
+ "kind": "field",
540
+ "name": "disabled",
724
541
  "type": {
725
542
  "text": "boolean"
726
543
  },
727
544
  "privacy": "public",
728
545
  "default": "false"
546
+ },
547
+ {
548
+ "kind": "field",
549
+ "name": "initials",
550
+ "type": {
551
+ "text": "string"
552
+ },
553
+ "privacy": "public",
554
+ "default": "''"
729
555
  }
730
556
  ],
731
557
  "attributes": [
732
558
  {
733
- "name": "text",
559
+ "name": "card-title",
734
560
  "type": {
735
561
  "text": "string"
736
562
  },
737
563
  "default": "''",
738
- "fieldName": "text"
564
+ "fieldName": "title"
739
565
  },
740
566
  {
741
- "name": "trigger-label",
567
+ "name": "subtitle",
742
568
  "type": {
743
569
  "text": "string"
744
570
  },
745
- "default": "'Show help'",
746
- "fieldName": "triggerLabel"
571
+ "default": "''",
572
+ "fieldName": "subtitle"
747
573
  },
748
574
  {
749
- "name": "severity",
575
+ "name": "description",
576
+ "type": {
577
+ "text": "string"
578
+ },
579
+ "default": "''",
580
+ "fieldName": "description"
581
+ },
582
+ {
583
+ "name": "appearance",
584
+ "type": {
585
+ "text": "FvCardAppearanceType"
586
+ },
587
+ "fieldName": "appearance"
588
+ },
589
+ {
590
+ "name": "interaction-mode",
591
+ "type": {
592
+ "text": "FvCardInteractionModeType"
593
+ },
594
+ "fieldName": "interactionMode"
595
+ },
596
+ {
597
+ "name": "disabled",
598
+ "type": {
599
+ "text": "boolean"
600
+ },
601
+ "default": "false",
602
+ "fieldName": "disabled"
603
+ },
604
+ {
605
+ "name": "initials",
606
+ "type": {
607
+ "text": "string"
608
+ },
609
+ "default": "''",
610
+ "fieldName": "initials"
611
+ }
612
+ ],
613
+ "superclass": {
614
+ "name": "FoundationElement",
615
+ "package": "@ni/fast-foundation"
616
+ }
617
+ },
618
+ {
619
+ "kind": "variable",
620
+ "name": "fvCardTag",
621
+ "type": {
622
+ "text": "string"
623
+ },
624
+ "default": "'ok-fv-card'"
625
+ }
626
+ ],
627
+ "exports": [
628
+ {
629
+ "kind": "js",
630
+ "name": "FvCard",
631
+ "declaration": {
632
+ "name": "FvCard",
633
+ "module": "src/fv/card/index.ts"
634
+ }
635
+ },
636
+ {
637
+ "kind": "js",
638
+ "name": "fvCardTag",
639
+ "declaration": {
640
+ "name": "fvCardTag",
641
+ "module": "src/fv/card/index.ts"
642
+ }
643
+ }
644
+ ]
645
+ },
646
+ {
647
+ "kind": "javascript-module",
648
+ "path": "src/fv/card/types.ts",
649
+ "declarations": [
650
+ {
651
+ "kind": "variable",
652
+ "name": "FvCardAppearance",
653
+ "type": {
654
+ "text": "{\n outline: 'outline',\n block: 'block'\n}"
655
+ },
656
+ "default": "{ outline: 'outline', block: 'block' }"
657
+ },
658
+ {
659
+ "kind": "variable",
660
+ "name": "FvCardInteractionMode",
661
+ "type": {
662
+ "text": "{\n static: 'static',\n card: 'card'\n}"
663
+ },
664
+ "default": "{ static: 'static', card: 'card' }"
665
+ }
666
+ ],
667
+ "exports": [
668
+ {
669
+ "kind": "js",
670
+ "name": "FvCardAppearance",
671
+ "declaration": {
672
+ "name": "FvCardAppearance",
673
+ "module": "src/fv/card/types.ts"
674
+ }
675
+ },
676
+ {
677
+ "kind": "js",
678
+ "name": "FvCardInteractionMode",
679
+ "declaration": {
680
+ "name": "FvCardInteractionMode",
681
+ "module": "src/fv/card/types.ts"
682
+ }
683
+ }
684
+ ]
685
+ },
686
+ {
687
+ "kind": "javascript-module",
688
+ "path": "src/fv/context-help/index.ts",
689
+ "declarations": [
690
+ {
691
+ "kind": "class",
692
+ "description": "An info trigger with an attached tooltip for lightweight contextual guidance.",
693
+ "name": "FvContextHelp",
694
+ "members": [
695
+ {
696
+ "kind": "field",
697
+ "name": "text",
698
+ "type": {
699
+ "text": "string"
700
+ },
701
+ "privacy": "public",
702
+ "default": "''"
703
+ },
704
+ {
705
+ "kind": "field",
706
+ "name": "triggerLabel",
707
+ "type": {
708
+ "text": "string"
709
+ },
710
+ "privacy": "public",
711
+ "default": "'Show help'"
712
+ },
713
+ {
714
+ "kind": "field",
715
+ "name": "severity",
716
+ "type": {
717
+ "text": "FvContextHelpSeverity"
718
+ },
719
+ "privacy": "public"
720
+ },
721
+ {
722
+ "kind": "field",
723
+ "name": "iconVisible",
724
+ "type": {
725
+ "text": "boolean"
726
+ },
727
+ "privacy": "public",
728
+ "default": "false"
729
+ }
730
+ ],
731
+ "attributes": [
732
+ {
733
+ "name": "text",
734
+ "type": {
735
+ "text": "string"
736
+ },
737
+ "default": "''",
738
+ "fieldName": "text"
739
+ },
740
+ {
741
+ "name": "trigger-label",
742
+ "type": {
743
+ "text": "string"
744
+ },
745
+ "default": "'Show help'",
746
+ "fieldName": "triggerLabel"
747
+ },
748
+ {
749
+ "name": "severity",
750
750
  "type": {
751
751
  "text": "FvContextHelpSeverity"
752
752
  },
@@ -1723,6 +1723,371 @@
1723
1723
  }
1724
1724
  ]
1725
1725
  },
1726
+ {
1727
+ "kind": "javascript-module",
1728
+ "path": "src/fv/splitter/index.ts",
1729
+ "declarations": [
1730
+ {
1731
+ "kind": "class",
1732
+ "description": "A vertical separator that enables pointer and keyboard resizing between two panes.",
1733
+ "name": "FvSplitter",
1734
+ "members": [
1735
+ {
1736
+ "kind": "field",
1737
+ "name": "ariaLabel",
1738
+ "type": {
1739
+ "text": "string"
1740
+ },
1741
+ "privacy": "public",
1742
+ "default": "'Resize panes'",
1743
+ "description": "The accessible name for the separator."
1744
+ },
1745
+ {
1746
+ "kind": "field",
1747
+ "name": "ariaLabelledby",
1748
+ "type": {
1749
+ "text": "string | undefined"
1750
+ },
1751
+ "privacy": "public",
1752
+ "description": "Identifies the element that labels the separator."
1753
+ },
1754
+ {
1755
+ "kind": "field",
1756
+ "name": "ariaControls",
1757
+ "type": {
1758
+ "text": "string | undefined"
1759
+ },
1760
+ "privacy": "public",
1761
+ "description": "Identifies the primary pane controlled by the separator."
1762
+ },
1763
+ {
1764
+ "kind": "field",
1765
+ "name": "position",
1766
+ "type": {
1767
+ "text": "number"
1768
+ },
1769
+ "privacy": "public",
1770
+ "default": "60",
1771
+ "description": "The splitter position as a percentage of the containing layout's width."
1772
+ },
1773
+ {
1774
+ "kind": "field",
1775
+ "name": "min",
1776
+ "type": {
1777
+ "text": "number"
1778
+ },
1779
+ "privacy": "public",
1780
+ "default": "0",
1781
+ "description": "The minimum allowed position."
1782
+ },
1783
+ {
1784
+ "kind": "field",
1785
+ "name": "max",
1786
+ "type": {
1787
+ "text": "number"
1788
+ },
1789
+ "privacy": "public",
1790
+ "default": "100",
1791
+ "description": "The maximum allowed position."
1792
+ },
1793
+ {
1794
+ "kind": "field",
1795
+ "name": "step",
1796
+ "type": {
1797
+ "text": "number"
1798
+ },
1799
+ "privacy": "public",
1800
+ "default": "1",
1801
+ "description": "The percentage-point increment used for keyboard resizing."
1802
+ },
1803
+ {
1804
+ "kind": "field",
1805
+ "name": "pointerId",
1806
+ "type": {
1807
+ "text": "number | undefined"
1808
+ },
1809
+ "privacy": "private"
1810
+ },
1811
+ {
1812
+ "kind": "field",
1813
+ "name": "pointerStartPosition",
1814
+ "type": {
1815
+ "text": "number"
1816
+ },
1817
+ "privacy": "private",
1818
+ "default": "0"
1819
+ },
1820
+ {
1821
+ "kind": "field",
1822
+ "name": "requestedPosition",
1823
+ "privacy": "private"
1824
+ },
1825
+ {
1826
+ "kind": "field",
1827
+ "name": "applyingConstrainedPosition",
1828
+ "type": {
1829
+ "text": "boolean"
1830
+ },
1831
+ "privacy": "private",
1832
+ "default": "false"
1833
+ },
1834
+ {
1835
+ "kind": "field",
1836
+ "name": "requestedPositionResetScheduled",
1837
+ "type": {
1838
+ "text": "boolean"
1839
+ },
1840
+ "privacy": "private",
1841
+ "default": "false"
1842
+ },
1843
+ {
1844
+ "kind": "field",
1845
+ "name": "positionChangeCallbackVersion",
1846
+ "type": {
1847
+ "text": "number"
1848
+ },
1849
+ "privacy": "private",
1850
+ "default": "0"
1851
+ },
1852
+ {
1853
+ "kind": "field",
1854
+ "name": "validMin",
1855
+ "type": {
1856
+ "text": "number"
1857
+ },
1858
+ "privacy": "private",
1859
+ "readonly": true
1860
+ },
1861
+ {
1862
+ "kind": "field",
1863
+ "name": "validMax",
1864
+ "type": {
1865
+ "text": "number"
1866
+ },
1867
+ "privacy": "private",
1868
+ "readonly": true
1869
+ },
1870
+ {
1871
+ "kind": "field",
1872
+ "name": "validStep",
1873
+ "type": {
1874
+ "text": "number"
1875
+ },
1876
+ "privacy": "private",
1877
+ "readonly": true
1878
+ },
1879
+ {
1880
+ "kind": "field",
1881
+ "name": "isRtl",
1882
+ "type": {
1883
+ "text": "boolean"
1884
+ },
1885
+ "privacy": "private",
1886
+ "readonly": true
1887
+ },
1888
+ {
1889
+ "kind": "field",
1890
+ "name": "keydownHandler",
1891
+ "privacy": "private",
1892
+ "readonly": true
1893
+ },
1894
+ {
1895
+ "kind": "method",
1896
+ "name": "constrain",
1897
+ "privacy": "private",
1898
+ "return": {
1899
+ "type": {
1900
+ "text": "number"
1901
+ }
1902
+ },
1903
+ "parameters": [
1904
+ {
1905
+ "name": "position",
1906
+ "type": {
1907
+ "text": "number"
1908
+ }
1909
+ }
1910
+ ]
1911
+ },
1912
+ {
1913
+ "kind": "method",
1914
+ "name": "updatePosition",
1915
+ "privacy": "private",
1916
+ "return": {
1917
+ "type": {
1918
+ "text": "void"
1919
+ }
1920
+ },
1921
+ "parameters": [
1922
+ {
1923
+ "name": "position",
1924
+ "type": {
1925
+ "text": "number"
1926
+ }
1927
+ }
1928
+ ]
1929
+ },
1930
+ {
1931
+ "kind": "method",
1932
+ "name": "applyConstrainedPosition",
1933
+ "privacy": "private",
1934
+ "return": {
1935
+ "type": {
1936
+ "text": "void"
1937
+ }
1938
+ }
1939
+ },
1940
+ {
1941
+ "kind": "method",
1942
+ "name": "resetRequestedPositionAfterSynchronousUpdates",
1943
+ "privacy": "private",
1944
+ "return": {
1945
+ "type": {
1946
+ "text": "void"
1947
+ }
1948
+ }
1949
+ },
1950
+ {
1951
+ "kind": "method",
1952
+ "name": "finishResize",
1953
+ "privacy": "private",
1954
+ "return": {
1955
+ "type": {
1956
+ "text": "void"
1957
+ }
1958
+ }
1959
+ },
1960
+ {
1961
+ "kind": "method",
1962
+ "name": "syncAriaValueAttributesIfConnected",
1963
+ "privacy": "private",
1964
+ "return": {
1965
+ "type": {
1966
+ "text": "void"
1967
+ }
1968
+ }
1969
+ },
1970
+ {
1971
+ "kind": "method",
1972
+ "name": "syncAriaValueAttributes",
1973
+ "privacy": "private",
1974
+ "return": {
1975
+ "type": {
1976
+ "text": "void"
1977
+ }
1978
+ }
1979
+ }
1980
+ ],
1981
+ "events": [
1982
+ {
1983
+ "name": "change",
1984
+ "type": {
1985
+ "text": "Event"
1986
+ }
1987
+ },
1988
+ {
1989
+ "name": "input",
1990
+ "type": {
1991
+ "text": "Event"
1992
+ }
1993
+ }
1994
+ ],
1995
+ "attributes": [
1996
+ {
1997
+ "name": "aria-label",
1998
+ "type": {
1999
+ "text": "string"
2000
+ },
2001
+ "default": "'Resize panes'",
2002
+ "description": "The accessible name for the separator.",
2003
+ "fieldName": "ariaLabel"
2004
+ },
2005
+ {
2006
+ "name": "aria-labelledby",
2007
+ "type": {
2008
+ "text": "string | undefined"
2009
+ },
2010
+ "description": "Identifies the element that labels the separator.",
2011
+ "fieldName": "ariaLabelledby"
2012
+ },
2013
+ {
2014
+ "name": "aria-controls",
2015
+ "type": {
2016
+ "text": "string | undefined"
2017
+ },
2018
+ "description": "Identifies the primary pane controlled by the separator.",
2019
+ "fieldName": "ariaControls"
2020
+ },
2021
+ {
2022
+ "name": "position",
2023
+ "type": {
2024
+ "text": "number"
2025
+ },
2026
+ "default": "60",
2027
+ "description": "The splitter position as a percentage of the containing layout's width.",
2028
+ "fieldName": "position"
2029
+ },
2030
+ {
2031
+ "name": "min",
2032
+ "type": {
2033
+ "text": "number"
2034
+ },
2035
+ "default": "0",
2036
+ "description": "The minimum allowed position.",
2037
+ "fieldName": "min"
2038
+ },
2039
+ {
2040
+ "name": "max",
2041
+ "type": {
2042
+ "text": "number"
2043
+ },
2044
+ "default": "100",
2045
+ "description": "The maximum allowed position.",
2046
+ "fieldName": "max"
2047
+ },
2048
+ {
2049
+ "name": "step",
2050
+ "type": {
2051
+ "text": "number"
2052
+ },
2053
+ "default": "1",
2054
+ "description": "The percentage-point increment used for keyboard resizing.",
2055
+ "fieldName": "step"
2056
+ }
2057
+ ],
2058
+ "superclass": {
2059
+ "name": "FoundationElement",
2060
+ "package": "@ni/fast-foundation"
2061
+ }
2062
+ },
2063
+ {
2064
+ "kind": "variable",
2065
+ "name": "fvSplitterTag",
2066
+ "type": {
2067
+ "text": "string"
2068
+ },
2069
+ "default": "'ok-fv-splitter'"
2070
+ }
2071
+ ],
2072
+ "exports": [
2073
+ {
2074
+ "kind": "js",
2075
+ "name": "FvSplitter",
2076
+ "declaration": {
2077
+ "name": "FvSplitter",
2078
+ "module": "src/fv/splitter/index.ts"
2079
+ }
2080
+ },
2081
+ {
2082
+ "kind": "js",
2083
+ "name": "fvSplitterTag",
2084
+ "declaration": {
2085
+ "name": "fvSplitterTag",
2086
+ "module": "src/fv/splitter/index.ts"
2087
+ }
2088
+ }
2089
+ ]
2090
+ },
1726
2091
  {
1727
2092
  "kind": "javascript-module",
1728
2093
  "path": "src/fv/sticky-header/index.ts",