@ni/nimble-components 35.15.0 → 35.15.1

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.
@@ -11065,160 +11065,6 @@
11065
11065
  "declarations": [],
11066
11066
  "exports": []
11067
11067
  },
11068
- {
11069
- "kind": "javascript-module",
11070
- "path": "src/rich-text/mention-listbox/index.ts",
11071
- "declarations": [
11072
- {
11073
- "kind": "class",
11074
- "description": "A rich text mention listbox which acts as a popup for \"@mention\" support in editor",
11075
- "name": "RichTextMentionListbox",
11076
- "members": [
11077
- {
11078
- "kind": "field",
11079
- "name": "anchorElement",
11080
- "type": {
11081
- "text": "HTMLElement | undefined"
11082
- },
11083
- "privacy": "private"
11084
- },
11085
- {
11086
- "kind": "field",
11087
- "name": "regionNotifier",
11088
- "type": {
11089
- "text": "Notifier | undefined"
11090
- },
11091
- "privacy": "private"
11092
- },
11093
- {
11094
- "kind": "field",
11095
- "name": "anchorElementIntersectionObserver",
11096
- "type": {
11097
- "text": "IntersectionObserver"
11098
- },
11099
- "privacy": "private",
11100
- "readonly": true,
11101
- "default": "new IntersectionObserver( entries => { if (!entries[0]?.isIntersecting) { this.setOpen(false); } }, { threshold: 1.0, root: document } )"
11102
- },
11103
- {
11104
- "kind": "method",
11105
- "name": "close",
11106
- "privacy": "public",
11107
- "return": {
11108
- "type": {
11109
- "text": "void"
11110
- }
11111
- }
11112
- },
11113
- {
11114
- "kind": "field",
11115
- "name": "options",
11116
- "type": {
11117
- "text": "ListboxOption[]"
11118
- },
11119
- "privacy": "public",
11120
- "description": "The list of options."
11121
- },
11122
- {
11123
- "kind": "method",
11124
- "name": "show",
11125
- "privacy": "public",
11126
- "return": {
11127
- "type": {
11128
- "text": "void"
11129
- }
11130
- },
11131
- "parameters": [
11132
- {
11133
- "name": "options",
11134
- "type": {
11135
- "text": "MentionListboxShowOptions"
11136
- }
11137
- }
11138
- ],
11139
- "description": "Triggers when the mention plugin is activated upon pressing the `key`"
11140
- },
11141
- {
11142
- "kind": "method",
11143
- "name": "keydownHandler",
11144
- "privacy": "public",
11145
- "return": {
11146
- "type": {
11147
- "text": "boolean"
11148
- }
11149
- },
11150
- "parameters": [
11151
- {
11152
- "name": "event",
11153
- "type": {
11154
- "text": "KeyboardEvent"
11155
- }
11156
- },
11157
- {
11158
- "description": "the keyboard event",
11159
- "name": "e"
11160
- }
11161
- ],
11162
- "description": "Handle keydown actions for listbox navigation and selection."
11163
- },
11164
- {
11165
- "kind": "method",
11166
- "name": "setOpen",
11167
- "privacy": "private",
11168
- "return": {
11169
- "type": {
11170
- "text": "void"
11171
- }
11172
- },
11173
- "parameters": [
11174
- {
11175
- "name": "value",
11176
- "type": {
11177
- "text": "boolean"
11178
- }
11179
- }
11180
- ]
11181
- }
11182
- ],
11183
- "superclass": {
11184
- "name": "FoundationListbox",
11185
- "package": "@ni/fast-foundation"
11186
- }
11187
- },
11188
- {
11189
- "kind": "variable",
11190
- "name": "richTextMentionListboxTag",
11191
- "type": {
11192
- "text": "string"
11193
- },
11194
- "default": "'nimble-rich-text-mention-listbox'"
11195
- }
11196
- ],
11197
- "exports": [
11198
- {
11199
- "kind": "js",
11200
- "name": "RichTextMentionListbox",
11201
- "declaration": {
11202
- "name": "RichTextMentionListbox",
11203
- "module": "src/rich-text/mention-listbox/index.ts"
11204
- }
11205
- },
11206
- {
11207
- "kind": "js",
11208
- "name": "richTextMentionListboxTag",
11209
- "declaration": {
11210
- "name": "richTextMentionListboxTag",
11211
- "module": "src/rich-text/mention-listbox/index.ts"
11212
- }
11213
- }
11214
- ]
11215
- },
11216
- {
11217
- "kind": "javascript-module",
11218
- "path": "src/rich-text/mention-listbox/types.ts",
11219
- "declarations": [],
11220
- "exports": []
11221
- },
11222
11068
  {
11223
11069
  "kind": "javascript-module",
11224
11070
  "path": "src/rich-text/editor/index.ts",
@@ -11944,6 +11790,160 @@
11944
11790
  }
11945
11791
  ]
11946
11792
  },
11793
+ {
11794
+ "kind": "javascript-module",
11795
+ "path": "src/rich-text/mention-listbox/index.ts",
11796
+ "declarations": [
11797
+ {
11798
+ "kind": "class",
11799
+ "description": "A rich text mention listbox which acts as a popup for \"@mention\" support in editor",
11800
+ "name": "RichTextMentionListbox",
11801
+ "members": [
11802
+ {
11803
+ "kind": "field",
11804
+ "name": "anchorElement",
11805
+ "type": {
11806
+ "text": "HTMLElement | undefined"
11807
+ },
11808
+ "privacy": "private"
11809
+ },
11810
+ {
11811
+ "kind": "field",
11812
+ "name": "regionNotifier",
11813
+ "type": {
11814
+ "text": "Notifier | undefined"
11815
+ },
11816
+ "privacy": "private"
11817
+ },
11818
+ {
11819
+ "kind": "field",
11820
+ "name": "anchorElementIntersectionObserver",
11821
+ "type": {
11822
+ "text": "IntersectionObserver"
11823
+ },
11824
+ "privacy": "private",
11825
+ "readonly": true,
11826
+ "default": "new IntersectionObserver( entries => { if (!entries[0]?.isIntersecting) { this.setOpen(false); } }, { threshold: 1.0, root: document } )"
11827
+ },
11828
+ {
11829
+ "kind": "method",
11830
+ "name": "close",
11831
+ "privacy": "public",
11832
+ "return": {
11833
+ "type": {
11834
+ "text": "void"
11835
+ }
11836
+ }
11837
+ },
11838
+ {
11839
+ "kind": "field",
11840
+ "name": "options",
11841
+ "type": {
11842
+ "text": "ListboxOption[]"
11843
+ },
11844
+ "privacy": "public",
11845
+ "description": "The list of options."
11846
+ },
11847
+ {
11848
+ "kind": "method",
11849
+ "name": "show",
11850
+ "privacy": "public",
11851
+ "return": {
11852
+ "type": {
11853
+ "text": "void"
11854
+ }
11855
+ },
11856
+ "parameters": [
11857
+ {
11858
+ "name": "options",
11859
+ "type": {
11860
+ "text": "MentionListboxShowOptions"
11861
+ }
11862
+ }
11863
+ ],
11864
+ "description": "Triggers when the mention plugin is activated upon pressing the `key`"
11865
+ },
11866
+ {
11867
+ "kind": "method",
11868
+ "name": "keydownHandler",
11869
+ "privacy": "public",
11870
+ "return": {
11871
+ "type": {
11872
+ "text": "boolean"
11873
+ }
11874
+ },
11875
+ "parameters": [
11876
+ {
11877
+ "name": "event",
11878
+ "type": {
11879
+ "text": "KeyboardEvent"
11880
+ }
11881
+ },
11882
+ {
11883
+ "description": "the keyboard event",
11884
+ "name": "e"
11885
+ }
11886
+ ],
11887
+ "description": "Handle keydown actions for listbox navigation and selection."
11888
+ },
11889
+ {
11890
+ "kind": "method",
11891
+ "name": "setOpen",
11892
+ "privacy": "private",
11893
+ "return": {
11894
+ "type": {
11895
+ "text": "void"
11896
+ }
11897
+ },
11898
+ "parameters": [
11899
+ {
11900
+ "name": "value",
11901
+ "type": {
11902
+ "text": "boolean"
11903
+ }
11904
+ }
11905
+ ]
11906
+ }
11907
+ ],
11908
+ "superclass": {
11909
+ "name": "FoundationListbox",
11910
+ "package": "@ni/fast-foundation"
11911
+ }
11912
+ },
11913
+ {
11914
+ "kind": "variable",
11915
+ "name": "richTextMentionListboxTag",
11916
+ "type": {
11917
+ "text": "string"
11918
+ },
11919
+ "default": "'nimble-rich-text-mention-listbox'"
11920
+ }
11921
+ ],
11922
+ "exports": [
11923
+ {
11924
+ "kind": "js",
11925
+ "name": "RichTextMentionListbox",
11926
+ "declaration": {
11927
+ "name": "RichTextMentionListbox",
11928
+ "module": "src/rich-text/mention-listbox/index.ts"
11929
+ }
11930
+ },
11931
+ {
11932
+ "kind": "js",
11933
+ "name": "richTextMentionListboxTag",
11934
+ "declaration": {
11935
+ "name": "richTextMentionListboxTag",
11936
+ "module": "src/rich-text/mention-listbox/index.ts"
11937
+ }
11938
+ }
11939
+ ]
11940
+ },
11941
+ {
11942
+ "kind": "javascript-module",
11943
+ "path": "src/rich-text/mention-listbox/types.ts",
11944
+ "declarations": [],
11945
+ "exports": []
11946
+ },
11947
11947
  {
11948
11948
  "kind": "javascript-module",
11949
11949
  "path": "src/rich-text/viewer/index.ts",
@@ -19077,6 +19077,102 @@
19077
19077
  }
19078
19078
  ]
19079
19079
  },
19080
+ {
19081
+ "kind": "javascript-module",
19082
+ "path": "src/table-column/base/cell-view/index.ts",
19083
+ "declarations": [
19084
+ {
19085
+ "kind": "class",
19086
+ "description": "Base class for table cell views, which are used within the nimble-table-cell.\nEach TableColumn type has a corresponding TableCellView type (linked via TableColumn.cellViewTag).",
19087
+ "name": "TableCellView",
19088
+ "members": [
19089
+ {
19090
+ "kind": "field",
19091
+ "name": "cellRecord",
19092
+ "type": {
19093
+ "text": "TCellRecord | undefined"
19094
+ },
19095
+ "privacy": "public"
19096
+ },
19097
+ {
19098
+ "kind": "field",
19099
+ "name": "columnConfig",
19100
+ "type": {
19101
+ "text": "TColumnConfig | undefined"
19102
+ },
19103
+ "privacy": "public"
19104
+ },
19105
+ {
19106
+ "kind": "field",
19107
+ "name": "column",
19108
+ "type": {
19109
+ "text": "TableColumn<TColumnConfig> | undefined"
19110
+ },
19111
+ "privacy": "public"
19112
+ },
19113
+ {
19114
+ "kind": "field",
19115
+ "name": "recordId",
19116
+ "type": {
19117
+ "text": "string | undefined"
19118
+ },
19119
+ "privacy": "public"
19120
+ },
19121
+ {
19122
+ "kind": "field",
19123
+ "name": "tabbableChildren",
19124
+ "type": {
19125
+ "text": "HTMLElement[]"
19126
+ },
19127
+ "privacy": "public",
19128
+ "description": "Gets the child elements in this cell view that should be able to be reached via Tab/ Shift-Tab,\nif any.",
19129
+ "readonly": true
19130
+ },
19131
+ {
19132
+ "kind": "field",
19133
+ "name": "delegatedEvents",
19134
+ "type": {
19135
+ "text": "readonly string[]"
19136
+ },
19137
+ "privacy": "private",
19138
+ "default": "[]"
19139
+ },
19140
+ {
19141
+ "kind": "method",
19142
+ "name": "columnChanged",
19143
+ "privacy": "public",
19144
+ "return": {
19145
+ "type": {
19146
+ "text": "void"
19147
+ }
19148
+ }
19149
+ },
19150
+ {
19151
+ "kind": "field",
19152
+ "name": "delegatedEventHandler",
19153
+ "type": {
19154
+ "text": "(event: Event) => void"
19155
+ },
19156
+ "privacy": "private"
19157
+ }
19158
+ ],
19159
+ "superclass": {
19160
+ "name": "FoundationElement",
19161
+ "package": "@ni/fast-foundation"
19162
+ }
19163
+ }
19164
+ ],
19165
+ "exports": [
19166
+ {
19167
+ "kind": "js",
19168
+ "name": "TableCellView",
19169
+ "declaration": {
19170
+ "name": "TableCellView",
19171
+ "module": "src/table-column/base/cell-view/index.ts"
19172
+ }
19173
+ }
19174
+ ]
19175
+ },
19080
19176
  {
19081
19177
  "kind": "javascript-module",
19082
19178
  "path": "src/table-column/anchor/cell-view/index.ts",
@@ -19230,102 +19326,6 @@
19230
19326
  }
19231
19327
  ]
19232
19328
  },
19233
- {
19234
- "kind": "javascript-module",
19235
- "path": "src/table-column/base/cell-view/index.ts",
19236
- "declarations": [
19237
- {
19238
- "kind": "class",
19239
- "description": "Base class for table cell views, which are used within the nimble-table-cell.\nEach TableColumn type has a corresponding TableCellView type (linked via TableColumn.cellViewTag).",
19240
- "name": "TableCellView",
19241
- "members": [
19242
- {
19243
- "kind": "field",
19244
- "name": "cellRecord",
19245
- "type": {
19246
- "text": "TCellRecord | undefined"
19247
- },
19248
- "privacy": "public"
19249
- },
19250
- {
19251
- "kind": "field",
19252
- "name": "columnConfig",
19253
- "type": {
19254
- "text": "TColumnConfig | undefined"
19255
- },
19256
- "privacy": "public"
19257
- },
19258
- {
19259
- "kind": "field",
19260
- "name": "column",
19261
- "type": {
19262
- "text": "TableColumn<TColumnConfig> | undefined"
19263
- },
19264
- "privacy": "public"
19265
- },
19266
- {
19267
- "kind": "field",
19268
- "name": "recordId",
19269
- "type": {
19270
- "text": "string | undefined"
19271
- },
19272
- "privacy": "public"
19273
- },
19274
- {
19275
- "kind": "field",
19276
- "name": "tabbableChildren",
19277
- "type": {
19278
- "text": "HTMLElement[]"
19279
- },
19280
- "privacy": "public",
19281
- "description": "Gets the child elements in this cell view that should be able to be reached via Tab/ Shift-Tab,\nif any.",
19282
- "readonly": true
19283
- },
19284
- {
19285
- "kind": "field",
19286
- "name": "delegatedEvents",
19287
- "type": {
19288
- "text": "readonly string[]"
19289
- },
19290
- "privacy": "private",
19291
- "default": "[]"
19292
- },
19293
- {
19294
- "kind": "method",
19295
- "name": "columnChanged",
19296
- "privacy": "public",
19297
- "return": {
19298
- "type": {
19299
- "text": "void"
19300
- }
19301
- }
19302
- },
19303
- {
19304
- "kind": "field",
19305
- "name": "delegatedEventHandler",
19306
- "type": {
19307
- "text": "(event: Event) => void"
19308
- },
19309
- "privacy": "private"
19310
- }
19311
- ],
19312
- "superclass": {
19313
- "name": "FoundationElement",
19314
- "package": "@ni/fast-foundation"
19315
- }
19316
- }
19317
- ],
19318
- "exports": [
19319
- {
19320
- "kind": "js",
19321
- "name": "TableCellView",
19322
- "declaration": {
19323
- "name": "TableCellView",
19324
- "module": "src/table-column/base/cell-view/index.ts"
19325
- }
19326
- }
19327
- ]
19328
- },
19329
19329
  {
19330
19330
  "kind": "javascript-module",
19331
19331
  "path": "src/table-column/base/group-header-view/index.ts",
@@ -1573,30 +1573,6 @@
1573
1573
 
1574
1574
  <hr/>
1575
1575
 
1576
- ## class: `RichTextMentionListbox`
1577
-
1578
- ### Superclass
1579
-
1580
- | Name | Module | Package |
1581
- | ------------------- | ------ | ------------------- |
1582
- | `FoundationListbox` | | @ni/fast-foundation |
1583
-
1584
- ### Fields
1585
-
1586
- | Name | Privacy | Type | Default | Description | Inherited From |
1587
- | --------- | ------- | ----------------- | ------- | -------------------- | -------------- |
1588
- | `options` | public | `ListboxOption[]` | | The list of options. | |
1589
-
1590
- ### Methods
1591
-
1592
- | Name | Privacy | Description | Parameters | Return | Inherited From |
1593
- | ---------------- | ------- | ----------------------------------------------------------------------- | ------------------------------------ | --------- | -------------- |
1594
- | `close` | public | | | `void` | |
1595
- | `show` | public | Triggers when the mention plugin is activated upon pressing the \`key\` | `options: MentionListboxShowOptions` | `void` | |
1596
- | `keydownHandler` | public | Handle keydown actions for listbox navigation and selection. | `event: KeyboardEvent, e` | `boolean` | |
1597
-
1598
- <hr/>
1599
-
1600
1576
  ## class: `RichTextEditor`
1601
1577
 
1602
1578
  ### Superclass
@@ -1643,6 +1619,30 @@
1643
1619
 
1644
1620
  <hr/>
1645
1621
 
1622
+ ## class: `RichTextMentionListbox`
1623
+
1624
+ ### Superclass
1625
+
1626
+ | Name | Module | Package |
1627
+ | ------------------- | ------ | ------------------- |
1628
+ | `FoundationListbox` | | @ni/fast-foundation |
1629
+
1630
+ ### Fields
1631
+
1632
+ | Name | Privacy | Type | Default | Description | Inherited From |
1633
+ | --------- | ------- | ----------------- | ------- | -------------------- | -------------- |
1634
+ | `options` | public | `ListboxOption[]` | | The list of options. | |
1635
+
1636
+ ### Methods
1637
+
1638
+ | Name | Privacy | Description | Parameters | Return | Inherited From |
1639
+ | ---------------- | ------- | ----------------------------------------------------------------------- | ------------------------------------ | --------- | -------------- |
1640
+ | `close` | public | | | `void` | |
1641
+ | `show` | public | Triggers when the mention plugin is activated upon pressing the \`key\` | `options: MentionListboxShowOptions` | `void` | |
1642
+ | `keydownHandler` | public | Handle keydown actions for listbox navigation and selection. | `event: KeyboardEvent, e` | `boolean` | |
1643
+
1644
+ <hr/>
1645
+
1646
1646
  ## class: `RichTextViewer`
1647
1647
 
1648
1648
  ### Superclass
@@ -2546,56 +2546,56 @@
2546
2546
 
2547
2547
  <hr/>
2548
2548
 
2549
- ## class: `TableColumnAnchorCellView`
2549
+ ## class: `TableCellView`
2550
2550
 
2551
2551
  ### Superclass
2552
2552
 
2553
- | Name | Module | Package |
2554
- | --------------- | -------------------------------- | ------- |
2555
- | `TableCellView` | /src/table-column/base/cell-view | |
2553
+ | Name | Module | Package |
2554
+ | ------------------- | ------ | ------------------- |
2555
+ | `FoundationElement` | | @ni/fast-foundation |
2556
2556
 
2557
2557
  ### Fields
2558
2558
 
2559
2559
  | Name | Privacy | Type | Default | Description | Inherited From |
2560
2560
  | ------------------ | ------- | ----------------------------------------- | ------- | ----------------------------------------------------------------------------------------------------------- | -------------- |
2561
- | `text` | public | `string` | | | |
2562
- | `tabbableChildren` | public | `HTMLElement[]` | | Gets the child elements in this cell view that should be able to be reached via Tab/ Shift-Tab,&#xA;if any. | TableCellView |
2563
- | `cellRecord` | public | `TCellRecord \| undefined` | | | TableCellView |
2564
- | `columnConfig` | public | `TColumnConfig \| undefined` | | | TableCellView |
2565
- | `column` | public | `TableColumn<TColumnConfig> \| undefined` | | | TableCellView |
2566
- | `recordId` | public | `string \| undefined` | | | TableCellView |
2561
+ | `cellRecord` | public | `TCellRecord \| undefined` | | | |
2562
+ | `columnConfig` | public | `TColumnConfig \| undefined` | | | |
2563
+ | `column` | public | `TableColumn<TColumnConfig> \| undefined` | | | |
2564
+ | `recordId` | public | `string \| undefined` | | | |
2565
+ | `tabbableChildren` | public | `HTMLElement[]` | | Gets the child elements in this cell view that should be able to be reached via Tab/ Shift-Tab,&#xA;if any. | |
2567
2566
 
2568
2567
  ### Methods
2569
2568
 
2570
2569
  | Name | Privacy | Description | Parameters | Return | Inherited From |
2571
2570
  | --------------- | ------- | ----------- | ---------- | ------ | -------------- |
2572
- | `columnChanged` | public | | | `void` | TableCellView |
2571
+ | `columnChanged` | public | | | `void` | |
2573
2572
 
2574
2573
  <hr/>
2575
2574
 
2576
- ## class: `TableCellView`
2575
+ ## class: `TableColumnAnchorCellView`
2577
2576
 
2578
2577
  ### Superclass
2579
2578
 
2580
- | Name | Module | Package |
2581
- | ------------------- | ------ | ------------------- |
2582
- | `FoundationElement` | | @ni/fast-foundation |
2579
+ | Name | Module | Package |
2580
+ | --------------- | -------------------------------- | ------- |
2581
+ | `TableCellView` | /src/table-column/base/cell-view | |
2583
2582
 
2584
2583
  ### Fields
2585
2584
 
2586
2585
  | Name | Privacy | Type | Default | Description | Inherited From |
2587
2586
  | ------------------ | ------- | ----------------------------------------- | ------- | ----------------------------------------------------------------------------------------------------------- | -------------- |
2588
- | `cellRecord` | public | `TCellRecord \| undefined` | | | |
2589
- | `columnConfig` | public | `TColumnConfig \| undefined` | | | |
2590
- | `column` | public | `TableColumn<TColumnConfig> \| undefined` | | | |
2591
- | `recordId` | public | `string \| undefined` | | | |
2592
- | `tabbableChildren` | public | `HTMLElement[]` | | Gets the child elements in this cell view that should be able to be reached via Tab/ Shift-Tab,&#xA;if any. | |
2587
+ | `text` | public | `string` | | | |
2588
+ | `tabbableChildren` | public | `HTMLElement[]` | | Gets the child elements in this cell view that should be able to be reached via Tab/ Shift-Tab,&#xA;if any. | TableCellView |
2589
+ | `cellRecord` | public | `TCellRecord \| undefined` | | | TableCellView |
2590
+ | `columnConfig` | public | `TColumnConfig \| undefined` | | | TableCellView |
2591
+ | `column` | public | `TableColumn<TColumnConfig> \| undefined` | | | TableCellView |
2592
+ | `recordId` | public | `string \| undefined` | | | TableCellView |
2593
2593
 
2594
2594
  ### Methods
2595
2595
 
2596
2596
  | Name | Privacy | Description | Parameters | Return | Inherited From |
2597
2597
  | --------------- | ------- | ----------- | ---------- | ------ | -------------- |
2598
- | `columnChanged` | public | | | `void` | |
2598
+ | `columnChanged` | public | | | `void` | TableCellView |
2599
2599
 
2600
2600
  <hr/>
2601
2601