@ni/nimble-components 35.8.0 → 35.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.
@@ -392,89 +392,6 @@
392
392
  }
393
393
  ]
394
394
  },
395
- {
396
- "kind": "javascript-module",
397
- "path": "src/anchor-tab/index.ts",
398
- "declarations": [
399
- {
400
- "kind": "class",
401
- "description": "A nimble-styled link tab",
402
- "name": "AnchorTab",
403
- "members": [
404
- {
405
- "kind": "field",
406
- "name": "disabled",
407
- "type": {
408
- "text": "boolean"
409
- },
410
- "privacy": "public",
411
- "default": "false",
412
- "description": "When true, the control will be immutable by user interaction. See https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/disabled | disabled HTML attribute for more information."
413
- },
414
- {
415
- "kind": "field",
416
- "name": "ariaSelected",
417
- "type": {
418
- "text": "string"
419
- },
420
- "privacy": "public",
421
- "default": "'false'",
422
- "description": "Indicates the current \"selected\" state of various widgets.\nhttps://www.w3.org/TR/wai-aria-1.1/#aria-selected"
423
- }
424
- ],
425
- "attributes": [
426
- {
427
- "name": "disabled",
428
- "type": {
429
- "text": "boolean"
430
- },
431
- "default": "false",
432
- "description": "When true, the control will be immutable by user interaction. See https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/disabled | disabled HTML attribute for more information.",
433
- "fieldName": "disabled"
434
- },
435
- {
436
- "name": "aria-selected",
437
- "type": {
438
- "text": "string"
439
- },
440
- "default": "'false'",
441
- "description": "Indicates the current \"selected\" state of various widgets.\nhttps://www.w3.org/TR/wai-aria-1.1/#aria-selected",
442
- "fieldName": "ariaSelected"
443
- }
444
- ],
445
- "superclass": {
446
- "name": "AnchorBase",
447
- "module": "/src/anchor-base"
448
- }
449
- },
450
- {
451
- "kind": "variable",
452
- "name": "anchorTabTag",
453
- "type": {
454
- "text": "string"
455
- },
456
- "default": "'nimble-anchor-tab'"
457
- }
458
- ],
459
- "exports": [
460
- {
461
- "kind": "js",
462
- "name": "AnchorTab",
463
- "declaration": {
464
- "name": "AnchorTab",
465
- "module": "src/anchor-tab/index.ts"
466
- }
467
- },
468
- {
469
- "kind": "js",
470
- "name": "anchorTabTag",
471
- "declaration": {
472
- "name": "anchorTabTag",
473
- "module": "src/anchor-tab/index.ts"
474
- }
475
- }
476
- ]
477
- },
478
395
  {
479
396
  "kind": "javascript-module",
480
397
  "path": "src/anchor-step/index.ts",
@@ -659,6 +576,89 @@
659
576
  }
660
577
  ]
661
578
  },
579
+ {
580
+ "kind": "javascript-module",
581
+ "path": "src/anchor-tab/index.ts",
582
+ "declarations": [
583
+ {
584
+ "kind": "class",
585
+ "description": "A nimble-styled link tab",
586
+ "name": "AnchorTab",
587
+ "members": [
588
+ {
589
+ "kind": "field",
590
+ "name": "disabled",
591
+ "type": {
592
+ "text": "boolean"
593
+ },
594
+ "privacy": "public",
595
+ "default": "false",
596
+ "description": "When true, the control will be immutable by user interaction. See https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/disabled | disabled HTML attribute for more information."
597
+ },
598
+ {
599
+ "kind": "field",
600
+ "name": "ariaSelected",
601
+ "type": {
602
+ "text": "string"
603
+ },
604
+ "privacy": "public",
605
+ "default": "'false'",
606
+ "description": "Indicates the current \"selected\" state of various widgets.\nhttps://www.w3.org/TR/wai-aria-1.1/#aria-selected"
607
+ }
608
+ ],
609
+ "attributes": [
610
+ {
611
+ "name": "disabled",
612
+ "type": {
613
+ "text": "boolean"
614
+ },
615
+ "default": "false",
616
+ "description": "When true, the control will be immutable by user interaction. See https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/disabled | disabled HTML attribute for more information.",
617
+ "fieldName": "disabled"
618
+ },
619
+ {
620
+ "name": "aria-selected",
621
+ "type": {
622
+ "text": "string"
623
+ },
624
+ "default": "'false'",
625
+ "description": "Indicates the current \"selected\" state of various widgets.\nhttps://www.w3.org/TR/wai-aria-1.1/#aria-selected",
626
+ "fieldName": "ariaSelected"
627
+ }
628
+ ],
629
+ "superclass": {
630
+ "name": "AnchorBase",
631
+ "module": "/src/anchor-base"
632
+ }
633
+ },
634
+ {
635
+ "kind": "variable",
636
+ "name": "anchorTabTag",
637
+ "type": {
638
+ "text": "string"
639
+ },
640
+ "default": "'nimble-anchor-tab'"
641
+ }
642
+ ],
643
+ "exports": [
644
+ {
645
+ "kind": "js",
646
+ "name": "AnchorTab",
647
+ "declaration": {
648
+ "name": "AnchorTab",
649
+ "module": "src/anchor-tab/index.ts"
650
+ }
651
+ },
652
+ {
653
+ "kind": "js",
654
+ "name": "anchorTabTag",
655
+ "declaration": {
656
+ "name": "anchorTabTag",
657
+ "module": "src/anchor-tab/index.ts"
658
+ }
659
+ }
660
+ ]
661
+ },
662
662
  {
663
663
  "kind": "javascript-module",
664
664
  "path": "src/anchor-tabs/index.ts",
@@ -1532,6 +1532,15 @@
1532
1532
  },
1533
1533
  "privacy": "public"
1534
1534
  },
1535
+ {
1536
+ "kind": "field",
1537
+ "name": "appearanceIndeterminate",
1538
+ "type": {
1539
+ "text": "boolean"
1540
+ },
1541
+ "privacy": "public",
1542
+ "default": "false"
1543
+ },
1535
1544
  {
1536
1545
  "kind": "field",
1537
1546
  "name": "errorText",
@@ -1579,6 +1588,14 @@
1579
1588
  "text": "number"
1580
1589
  },
1581
1590
  "fieldName": "tabIndex"
1591
+ },
1592
+ {
1593
+ "name": "appearance-indeterminate",
1594
+ "type": {
1595
+ "text": "boolean"
1596
+ },
1597
+ "default": "false",
1598
+ "fieldName": "appearanceIndeterminate"
1582
1599
  }
1583
1600
  ],
1584
1601
  "mixins": [
@@ -10912,160 +10929,6 @@
10912
10929
  "declarations": [],
10913
10930
  "exports": []
10914
10931
  },
10915
- {
10916
- "kind": "javascript-module",
10917
- "path": "src/rich-text/mention-listbox/index.ts",
10918
- "declarations": [
10919
- {
10920
- "kind": "class",
10921
- "description": "A rich text mention listbox which acts as a popup for \"@mention\" support in editor",
10922
- "name": "RichTextMentionListbox",
10923
- "members": [
10924
- {
10925
- "kind": "field",
10926
- "name": "anchorElement",
10927
- "type": {
10928
- "text": "HTMLElement | undefined"
10929
- },
10930
- "privacy": "private"
10931
- },
10932
- {
10933
- "kind": "field",
10934
- "name": "regionNotifier",
10935
- "type": {
10936
- "text": "Notifier | undefined"
10937
- },
10938
- "privacy": "private"
10939
- },
10940
- {
10941
- "kind": "field",
10942
- "name": "anchorElementIntersectionObserver",
10943
- "type": {
10944
- "text": "IntersectionObserver"
10945
- },
10946
- "privacy": "private",
10947
- "readonly": true,
10948
- "default": "new IntersectionObserver( entries => { if (!entries[0]?.isIntersecting) { this.setOpen(false); } }, { threshold: 1.0, root: document } )"
10949
- },
10950
- {
10951
- "kind": "method",
10952
- "name": "close",
10953
- "privacy": "public",
10954
- "return": {
10955
- "type": {
10956
- "text": "void"
10957
- }
10958
- }
10959
- },
10960
- {
10961
- "kind": "field",
10962
- "name": "options",
10963
- "type": {
10964
- "text": "ListboxOption[]"
10965
- },
10966
- "privacy": "public",
10967
- "description": "The list of options."
10968
- },
10969
- {
10970
- "kind": "method",
10971
- "name": "show",
10972
- "privacy": "public",
10973
- "return": {
10974
- "type": {
10975
- "text": "void"
10976
- }
10977
- },
10978
- "parameters": [
10979
- {
10980
- "name": "options",
10981
- "type": {
10982
- "text": "MentionListboxShowOptions"
10983
- }
10984
- }
10985
- ],
10986
- "description": "Triggers when the mention plugin is activated upon pressing the `key`"
10987
- },
10988
- {
10989
- "kind": "method",
10990
- "name": "keydownHandler",
10991
- "privacy": "public",
10992
- "return": {
10993
- "type": {
10994
- "text": "boolean"
10995
- }
10996
- },
10997
- "parameters": [
10998
- {
10999
- "name": "event",
11000
- "type": {
11001
- "text": "KeyboardEvent"
11002
- }
11003
- },
11004
- {
11005
- "description": "the keyboard event",
11006
- "name": "e"
11007
- }
11008
- ],
11009
- "description": "Handle keydown actions for listbox navigation and selection."
11010
- },
11011
- {
11012
- "kind": "method",
11013
- "name": "setOpen",
11014
- "privacy": "private",
11015
- "return": {
11016
- "type": {
11017
- "text": "void"
11018
- }
11019
- },
11020
- "parameters": [
11021
- {
11022
- "name": "value",
11023
- "type": {
11024
- "text": "boolean"
11025
- }
11026
- }
11027
- ]
11028
- }
11029
- ],
11030
- "superclass": {
11031
- "name": "FoundationListbox",
11032
- "package": "@ni/fast-foundation"
11033
- }
11034
- },
11035
- {
11036
- "kind": "variable",
11037
- "name": "richTextMentionListboxTag",
11038
- "type": {
11039
- "text": "string"
11040
- },
11041
- "default": "'nimble-rich-text-mention-listbox'"
11042
- }
11043
- ],
11044
- "exports": [
11045
- {
11046
- "kind": "js",
11047
- "name": "RichTextMentionListbox",
11048
- "declaration": {
11049
- "name": "RichTextMentionListbox",
11050
- "module": "src/rich-text/mention-listbox/index.ts"
11051
- }
11052
- },
11053
- {
11054
- "kind": "js",
11055
- "name": "richTextMentionListboxTag",
11056
- "declaration": {
11057
- "name": "richTextMentionListboxTag",
11058
- "module": "src/rich-text/mention-listbox/index.ts"
11059
- }
11060
- }
11061
- ]
11062
- },
11063
- {
11064
- "kind": "javascript-module",
11065
- "path": "src/rich-text/mention-listbox/types.ts",
11066
- "declarations": [],
11067
- "exports": []
11068
- },
11069
10932
  {
11070
10933
  "kind": "javascript-module",
11071
10934
  "path": "src/rich-text/editor/index.ts",
@@ -11791,6 +11654,160 @@
11791
11654
  }
11792
11655
  ]
11793
11656
  },
11657
+ {
11658
+ "kind": "javascript-module",
11659
+ "path": "src/rich-text/mention-listbox/index.ts",
11660
+ "declarations": [
11661
+ {
11662
+ "kind": "class",
11663
+ "description": "A rich text mention listbox which acts as a popup for \"@mention\" support in editor",
11664
+ "name": "RichTextMentionListbox",
11665
+ "members": [
11666
+ {
11667
+ "kind": "field",
11668
+ "name": "anchorElement",
11669
+ "type": {
11670
+ "text": "HTMLElement | undefined"
11671
+ },
11672
+ "privacy": "private"
11673
+ },
11674
+ {
11675
+ "kind": "field",
11676
+ "name": "regionNotifier",
11677
+ "type": {
11678
+ "text": "Notifier | undefined"
11679
+ },
11680
+ "privacy": "private"
11681
+ },
11682
+ {
11683
+ "kind": "field",
11684
+ "name": "anchorElementIntersectionObserver",
11685
+ "type": {
11686
+ "text": "IntersectionObserver"
11687
+ },
11688
+ "privacy": "private",
11689
+ "readonly": true,
11690
+ "default": "new IntersectionObserver( entries => { if (!entries[0]?.isIntersecting) { this.setOpen(false); } }, { threshold: 1.0, root: document } )"
11691
+ },
11692
+ {
11693
+ "kind": "method",
11694
+ "name": "close",
11695
+ "privacy": "public",
11696
+ "return": {
11697
+ "type": {
11698
+ "text": "void"
11699
+ }
11700
+ }
11701
+ },
11702
+ {
11703
+ "kind": "field",
11704
+ "name": "options",
11705
+ "type": {
11706
+ "text": "ListboxOption[]"
11707
+ },
11708
+ "privacy": "public",
11709
+ "description": "The list of options."
11710
+ },
11711
+ {
11712
+ "kind": "method",
11713
+ "name": "show",
11714
+ "privacy": "public",
11715
+ "return": {
11716
+ "type": {
11717
+ "text": "void"
11718
+ }
11719
+ },
11720
+ "parameters": [
11721
+ {
11722
+ "name": "options",
11723
+ "type": {
11724
+ "text": "MentionListboxShowOptions"
11725
+ }
11726
+ }
11727
+ ],
11728
+ "description": "Triggers when the mention plugin is activated upon pressing the `key`"
11729
+ },
11730
+ {
11731
+ "kind": "method",
11732
+ "name": "keydownHandler",
11733
+ "privacy": "public",
11734
+ "return": {
11735
+ "type": {
11736
+ "text": "boolean"
11737
+ }
11738
+ },
11739
+ "parameters": [
11740
+ {
11741
+ "name": "event",
11742
+ "type": {
11743
+ "text": "KeyboardEvent"
11744
+ }
11745
+ },
11746
+ {
11747
+ "description": "the keyboard event",
11748
+ "name": "e"
11749
+ }
11750
+ ],
11751
+ "description": "Handle keydown actions for listbox navigation and selection."
11752
+ },
11753
+ {
11754
+ "kind": "method",
11755
+ "name": "setOpen",
11756
+ "privacy": "private",
11757
+ "return": {
11758
+ "type": {
11759
+ "text": "void"
11760
+ }
11761
+ },
11762
+ "parameters": [
11763
+ {
11764
+ "name": "value",
11765
+ "type": {
11766
+ "text": "boolean"
11767
+ }
11768
+ }
11769
+ ]
11770
+ }
11771
+ ],
11772
+ "superclass": {
11773
+ "name": "FoundationListbox",
11774
+ "package": "@ni/fast-foundation"
11775
+ }
11776
+ },
11777
+ {
11778
+ "kind": "variable",
11779
+ "name": "richTextMentionListboxTag",
11780
+ "type": {
11781
+ "text": "string"
11782
+ },
11783
+ "default": "'nimble-rich-text-mention-listbox'"
11784
+ }
11785
+ ],
11786
+ "exports": [
11787
+ {
11788
+ "kind": "js",
11789
+ "name": "RichTextMentionListbox",
11790
+ "declaration": {
11791
+ "name": "RichTextMentionListbox",
11792
+ "module": "src/rich-text/mention-listbox/index.ts"
11793
+ }
11794
+ },
11795
+ {
11796
+ "kind": "js",
11797
+ "name": "richTextMentionListboxTag",
11798
+ "declaration": {
11799
+ "name": "richTextMentionListboxTag",
11800
+ "module": "src/rich-text/mention-listbox/index.ts"
11801
+ }
11802
+ }
11803
+ ]
11804
+ },
11805
+ {
11806
+ "kind": "javascript-module",
11807
+ "path": "src/rich-text/mention-listbox/types.ts",
11808
+ "declarations": [],
11809
+ "exports": []
11810
+ },
11794
11811
  {
11795
11812
  "kind": "javascript-module",
11796
11813
  "path": "src/rich-text/viewer/index.ts",
@@ -93,30 +93,6 @@
93
93
 
94
94
  <hr/>
95
95
 
96
- ## class: `AnchorTab`
97
-
98
- ### Superclass
99
-
100
- | Name | Module | Package |
101
- | ------------ | ---------------- | ------- |
102
- | `AnchorBase` | /src/anchor-base | |
103
-
104
- ### Fields
105
-
106
- | Name | Privacy | Type | Default | Description | Inherited From |
107
- | -------------- | ------- | --------- | --------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------- |
108
- | `disabled` | public | `boolean` | `false` | When true, the control will be immutable by user interaction. See https\://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/disabled \| disabled HTML attribute for more information. | |
109
- | `ariaSelected` | public | `string` | `'false'` | Indicates the current "selected" state of various widgets.&#xA;https\://www\.w3.org/TR/wai-aria-1.1/#aria-selected | |
110
-
111
- ### Attributes
112
-
113
- | Name | Field | Inherited From |
114
- | --------------- | ------------ | -------------- |
115
- | `disabled` | disabled | |
116
- | `aria-selected` | ariaSelected | |
117
-
118
- <hr/>
119
-
120
96
  ## class: `AnchorStep`
121
97
 
122
98
  ### Superclass
@@ -149,6 +125,30 @@
149
125
 
150
126
  <hr/>
151
127
 
128
+ ## class: `AnchorTab`
129
+
130
+ ### Superclass
131
+
132
+ | Name | Module | Package |
133
+ | ------------ | ---------------- | ------- |
134
+ | `AnchorBase` | /src/anchor-base | |
135
+
136
+ ### Fields
137
+
138
+ | Name | Privacy | Type | Default | Description | Inherited From |
139
+ | -------------- | ------- | --------- | --------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------- |
140
+ | `disabled` | public | `boolean` | `false` | When true, the control will be immutable by user interaction. See https\://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/disabled \| disabled HTML attribute for more information. | |
141
+ | `ariaSelected` | public | `string` | `'false'` | Indicates the current "selected" state of various widgets.&#xA;https\://www\.w3.org/TR/wai-aria-1.1/#aria-selected | |
142
+
143
+ ### Attributes
144
+
145
+ | Name | Field | Inherited From |
146
+ | --------------- | ------------ | -------------- |
147
+ | `disabled` | disabled | |
148
+ | `aria-selected` | ariaSelected | |
149
+
150
+ <hr/>
151
+
152
152
  ## class: `AnchorTabs`
153
153
 
154
154
  ### Superclass
@@ -343,18 +343,20 @@
343
343
 
344
344
  ### Fields
345
345
 
346
- | Name | Privacy | Type | Default | Description | Inherited From |
347
- | ------------------ | ------- | --------------------- | ------- | --------------------------------------------------------------------------------- | ----------------- |
348
- | `tabIndex` | public | `number` | | | |
349
- | `errorText` | public | `string \| undefined` | | The error text that will be displayed when a component is in the error appearance | mixinErrorPattern |
350
- | `errorVisible` | public | `boolean` | `false` | | mixinErrorPattern |
351
- | `errorHasOverflow` | public | `boolean` | `false` | | mixinErrorPattern |
346
+ | Name | Privacy | Type | Default | Description | Inherited From |
347
+ | ------------------------- | ------- | --------------------- | ------- | --------------------------------------------------------------------------------- | ----------------- |
348
+ | `tabIndex` | public | `number` | | | |
349
+ | `appearanceIndeterminate` | public | `boolean` | `false` | | |
350
+ | `errorText` | public | `string \| undefined` | | The error text that will be displayed when a component is in the error appearance | mixinErrorPattern |
351
+ | `errorVisible` | public | `boolean` | `false` | | mixinErrorPattern |
352
+ | `errorHasOverflow` | public | `boolean` | `false` | | mixinErrorPattern |
352
353
 
353
354
  ### Attributes
354
355
 
355
- | Name | Field | Inherited From |
356
- | ---------- | -------- | -------------- |
357
- | `tabindex` | tabIndex | |
356
+ | Name | Field | Inherited From |
357
+ | -------------------------- | ----------------------- | -------------- |
358
+ | `tabindex` | tabIndex | |
359
+ | `appearance-indeterminate` | appearanceIndeterminate | |
358
360
 
359
361
  <hr/>
360
362
 
@@ -1569,30 +1571,6 @@
1569
1571
 
1570
1572
  <hr/>
1571
1573
 
1572
- ## class: `RichTextMentionListbox`
1573
-
1574
- ### Superclass
1575
-
1576
- | Name | Module | Package |
1577
- | ------------------- | ------ | ------------------- |
1578
- | `FoundationListbox` | | @ni/fast-foundation |
1579
-
1580
- ### Fields
1581
-
1582
- | Name | Privacy | Type | Default | Description | Inherited From |
1583
- | --------- | ------- | ----------------- | ------- | -------------------- | -------------- |
1584
- | `options` | public | `ListboxOption[]` | | The list of options. | |
1585
-
1586
- ### Methods
1587
-
1588
- | Name | Privacy | Description | Parameters | Return | Inherited From |
1589
- | ---------------- | ------- | ----------------------------------------------------------------------- | ------------------------------------ | --------- | -------------- |
1590
- | `close` | public | | | `void` | |
1591
- | `show` | public | Triggers when the mention plugin is activated upon pressing the \`key\` | `options: MentionListboxShowOptions` | `void` | |
1592
- | `keydownHandler` | public | Handle keydown actions for listbox navigation and selection. | `event: KeyboardEvent, e` | `boolean` | |
1593
-
1594
- <hr/>
1595
-
1596
1574
  ## class: `RichTextEditor`
1597
1575
 
1598
1576
  ### Superclass
@@ -1639,6 +1617,30 @@
1639
1617
 
1640
1618
  <hr/>
1641
1619
 
1620
+ ## class: `RichTextMentionListbox`
1621
+
1622
+ ### Superclass
1623
+
1624
+ | Name | Module | Package |
1625
+ | ------------------- | ------ | ------------------- |
1626
+ | `FoundationListbox` | | @ni/fast-foundation |
1627
+
1628
+ ### Fields
1629
+
1630
+ | Name | Privacy | Type | Default | Description | Inherited From |
1631
+ | --------- | ------- | ----------------- | ------- | -------------------- | -------------- |
1632
+ | `options` | public | `ListboxOption[]` | | The list of options. | |
1633
+
1634
+ ### Methods
1635
+
1636
+ | Name | Privacy | Description | Parameters | Return | Inherited From |
1637
+ | ---------------- | ------- | ----------------------------------------------------------------------- | ------------------------------------ | --------- | -------------- |
1638
+ | `close` | public | | | `void` | |
1639
+ | `show` | public | Triggers when the mention plugin is activated upon pressing the \`key\` | `options: MentionListboxShowOptions` | `void` | |
1640
+ | `keydownHandler` | public | Handle keydown actions for listbox navigation and selection. | `event: KeyboardEvent, e` | `boolean` | |
1641
+
1642
+ <hr/>
1643
+
1642
1644
  ## class: `RichTextViewer`
1643
1645
 
1644
1646
  ### Superclass