@ni/spright-components 6.10.4 → 6.11.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.
@@ -49,134 +49,6 @@
49
49
  }
50
50
  ]
51
51
  },
52
- {
53
- "kind": "javascript-module",
54
- "path": "src/chat/conversation/index.ts",
55
- "declarations": [
56
- {
57
- "kind": "class",
58
- "description": "A Spright component for displaying a series of chat messages",
59
- "name": "ChatConversation",
60
- "members": [
61
- {
62
- "kind": "field",
63
- "name": "appearance",
64
- "privacy": "public"
65
- },
66
- {
67
- "kind": "method",
68
- "name": "slottedInputElementsChanged",
69
- "privacy": "public",
70
- "return": {
71
- "type": {
72
- "text": "void"
73
- }
74
- },
75
- "parameters": [
76
- {
77
- "name": "_prev",
78
- "type": {
79
- "text": "HTMLElement[] | undefined"
80
- }
81
- },
82
- {
83
- "name": "next",
84
- "type": {
85
- "text": "HTMLElement[] | undefined"
86
- }
87
- }
88
- ]
89
- },
90
- {
91
- "kind": "method",
92
- "name": "slottedToolbarElementsChanged",
93
- "privacy": "public",
94
- "return": {
95
- "type": {
96
- "text": "void"
97
- }
98
- },
99
- "parameters": [
100
- {
101
- "name": "_prev",
102
- "type": {
103
- "text": "HTMLElement[] | undefined"
104
- }
105
- },
106
- {
107
- "name": "next",
108
- "type": {
109
- "text": "HTMLElement[] | undefined"
110
- }
111
- }
112
- ]
113
- }
114
- ],
115
- "attributes": [
116
- {
117
- "name": "appearance",
118
- "fieldName": "appearance"
119
- }
120
- ],
121
- "superclass": {
122
- "name": "FoundationElement",
123
- "package": "@ni/fast-foundation"
124
- }
125
- },
126
- {
127
- "kind": "variable",
128
- "name": "chatConversationTag",
129
- "type": {
130
- "text": "string"
131
- },
132
- "default": "'spright-chat-conversation'"
133
- }
134
- ],
135
- "exports": [
136
- {
137
- "kind": "js",
138
- "name": "ChatConversation",
139
- "declaration": {
140
- "name": "ChatConversation",
141
- "module": "src/chat/conversation/index.ts"
142
- }
143
- },
144
- {
145
- "kind": "js",
146
- "name": "chatConversationTag",
147
- "declaration": {
148
- "name": "chatConversationTag",
149
- "module": "src/chat/conversation/index.ts"
150
- }
151
- }
152
- ]
153
- },
154
- {
155
- "kind": "javascript-module",
156
- "path": "src/chat/conversation/types.ts",
157
- "declarations": [
158
- {
159
- "kind": "variable",
160
- "name": "ChatConversationAppearance",
161
- "type": {
162
- "text": "{\n default: undefined,\n overlay: 'overlay'\n}"
163
- },
164
- "default": "{ default: undefined, overlay: 'overlay' }",
165
- "description": "Appearances of chat conversation.",
166
- "privacy": "public"
167
- }
168
- ],
169
- "exports": [
170
- {
171
- "kind": "js",
172
- "name": "ChatConversationAppearance",
173
- "declaration": {
174
- "name": "ChatConversationAppearance",
175
- "module": "src/chat/conversation/types.ts"
176
- }
177
- }
178
- ]
179
- },
180
52
  {
181
53
  "kind": "javascript-module",
182
54
  "path": "src/chat/input/index.ts",
@@ -245,6 +117,15 @@
245
117
  "privacy": "public",
246
118
  "default": "false"
247
119
  },
120
+ {
121
+ "kind": "field",
122
+ "name": "sendDisabled",
123
+ "type": {
124
+ "text": "boolean"
125
+ },
126
+ "privacy": "public",
127
+ "default": "false"
128
+ },
248
129
  {
249
130
  "kind": "field",
250
131
  "name": "resizeObserver",
@@ -365,6 +246,14 @@
365
246
  },
366
247
  "default": "false",
367
248
  "fieldName": "processing"
249
+ },
250
+ {
251
+ "name": "send-disabled",
252
+ "type": {
253
+ "text": "boolean"
254
+ },
255
+ "default": "false",
256
+ "fieldName": "sendDisabled"
368
257
  }
369
258
  ],
370
259
  "mixins": [
@@ -412,6 +301,134 @@
412
301
  "declarations": [],
413
302
  "exports": []
414
303
  },
304
+ {
305
+ "kind": "javascript-module",
306
+ "path": "src/chat/conversation/index.ts",
307
+ "declarations": [
308
+ {
309
+ "kind": "class",
310
+ "description": "A Spright component for displaying a series of chat messages",
311
+ "name": "ChatConversation",
312
+ "members": [
313
+ {
314
+ "kind": "field",
315
+ "name": "appearance",
316
+ "privacy": "public"
317
+ },
318
+ {
319
+ "kind": "method",
320
+ "name": "slottedInputElementsChanged",
321
+ "privacy": "public",
322
+ "return": {
323
+ "type": {
324
+ "text": "void"
325
+ }
326
+ },
327
+ "parameters": [
328
+ {
329
+ "name": "_prev",
330
+ "type": {
331
+ "text": "HTMLElement[] | undefined"
332
+ }
333
+ },
334
+ {
335
+ "name": "next",
336
+ "type": {
337
+ "text": "HTMLElement[] | undefined"
338
+ }
339
+ }
340
+ ]
341
+ },
342
+ {
343
+ "kind": "method",
344
+ "name": "slottedToolbarElementsChanged",
345
+ "privacy": "public",
346
+ "return": {
347
+ "type": {
348
+ "text": "void"
349
+ }
350
+ },
351
+ "parameters": [
352
+ {
353
+ "name": "_prev",
354
+ "type": {
355
+ "text": "HTMLElement[] | undefined"
356
+ }
357
+ },
358
+ {
359
+ "name": "next",
360
+ "type": {
361
+ "text": "HTMLElement[] | undefined"
362
+ }
363
+ }
364
+ ]
365
+ }
366
+ ],
367
+ "attributes": [
368
+ {
369
+ "name": "appearance",
370
+ "fieldName": "appearance"
371
+ }
372
+ ],
373
+ "superclass": {
374
+ "name": "FoundationElement",
375
+ "package": "@ni/fast-foundation"
376
+ }
377
+ },
378
+ {
379
+ "kind": "variable",
380
+ "name": "chatConversationTag",
381
+ "type": {
382
+ "text": "string"
383
+ },
384
+ "default": "'spright-chat-conversation'"
385
+ }
386
+ ],
387
+ "exports": [
388
+ {
389
+ "kind": "js",
390
+ "name": "ChatConversation",
391
+ "declaration": {
392
+ "name": "ChatConversation",
393
+ "module": "src/chat/conversation/index.ts"
394
+ }
395
+ },
396
+ {
397
+ "kind": "js",
398
+ "name": "chatConversationTag",
399
+ "declaration": {
400
+ "name": "chatConversationTag",
401
+ "module": "src/chat/conversation/index.ts"
402
+ }
403
+ }
404
+ ]
405
+ },
406
+ {
407
+ "kind": "javascript-module",
408
+ "path": "src/chat/conversation/types.ts",
409
+ "declarations": [
410
+ {
411
+ "kind": "variable",
412
+ "name": "ChatConversationAppearance",
413
+ "type": {
414
+ "text": "{\n default: undefined,\n overlay: 'overlay'\n}"
415
+ },
416
+ "default": "{ default: undefined, overlay: 'overlay' }",
417
+ "description": "Appearances of chat conversation.",
418
+ "privacy": "public"
419
+ }
420
+ ],
421
+ "exports": [
422
+ {
423
+ "kind": "js",
424
+ "name": "ChatConversationAppearance",
425
+ "declaration": {
426
+ "name": "ChatConversationAppearance",
427
+ "module": "src/chat/conversation/types.ts"
428
+ }
429
+ }
430
+ ]
431
+ },
415
432
  {
416
433
  "kind": "javascript-module",
417
434
  "path": "src/chat/message/index.ts",
@@ -526,12 +543,38 @@
526
543
  },
527
544
  {
528
545
  "kind": "javascript-module",
529
- "path": "src/chat/message/outbound/index.ts",
546
+ "path": "src/chat/message/inbound/index.ts",
530
547
  "declarations": [
531
548
  {
532
549
  "kind": "class",
533
- "description": "A Spright component for displaying an outbound chat message",
534
- "name": "ChatMessageOutbound",
550
+ "description": "A Spright component for displaying a chat message",
551
+ "name": "ChatMessageInbound",
552
+ "members": [
553
+ {
554
+ "kind": "method",
555
+ "name": "slottedFooterActionsElementsChanged",
556
+ "privacy": "public",
557
+ "return": {
558
+ "type": {
559
+ "text": "void"
560
+ }
561
+ },
562
+ "parameters": [
563
+ {
564
+ "name": "_prev",
565
+ "type": {
566
+ "text": "HTMLElement[] | undefined"
567
+ }
568
+ },
569
+ {
570
+ "name": "next",
571
+ "type": {
572
+ "text": "HTMLElement[] | undefined"
573
+ }
574
+ }
575
+ ]
576
+ }
577
+ ],
535
578
  "superclass": {
536
579
  "name": "FoundationElement",
537
580
  "package": "@ni/fast-foundation"
@@ -539,40 +582,40 @@
539
582
  },
540
583
  {
541
584
  "kind": "variable",
542
- "name": "chatMessageOutboundTag",
585
+ "name": "chatMessageInboundTag",
543
586
  "type": {
544
587
  "text": "string"
545
588
  },
546
- "default": "'spright-chat-message-outbound'"
589
+ "default": "'spright-chat-message-inbound'"
547
590
  }
548
591
  ],
549
592
  "exports": [
550
593
  {
551
594
  "kind": "js",
552
- "name": "ChatMessageOutbound",
595
+ "name": "ChatMessageInbound",
553
596
  "declaration": {
554
- "name": "ChatMessageOutbound",
555
- "module": "src/chat/message/outbound/index.ts"
597
+ "name": "ChatMessageInbound",
598
+ "module": "src/chat/message/inbound/index.ts"
556
599
  }
557
600
  },
558
601
  {
559
602
  "kind": "js",
560
- "name": "chatMessageOutboundTag",
603
+ "name": "chatMessageInboundTag",
561
604
  "declaration": {
562
- "name": "chatMessageOutboundTag",
563
- "module": "src/chat/message/outbound/index.ts"
605
+ "name": "chatMessageInboundTag",
606
+ "module": "src/chat/message/inbound/index.ts"
564
607
  }
565
608
  }
566
609
  ]
567
610
  },
568
611
  {
569
612
  "kind": "javascript-module",
570
- "path": "src/chat/message/system/index.ts",
613
+ "path": "src/chat/message/outbound/index.ts",
571
614
  "declarations": [
572
615
  {
573
616
  "kind": "class",
574
- "description": "A Spright component for displaying an system chat message",
575
- "name": "ChatMessageSystem",
617
+ "description": "A Spright component for displaying an outbound chat message",
618
+ "name": "ChatMessageOutbound",
576
619
  "superclass": {
577
620
  "name": "FoundationElement",
578
621
  "package": "@ni/fast-foundation"
@@ -580,66 +623,40 @@
580
623
  },
581
624
  {
582
625
  "kind": "variable",
583
- "name": "chatMessageSystemTag",
626
+ "name": "chatMessageOutboundTag",
584
627
  "type": {
585
628
  "text": "string"
586
629
  },
587
- "default": "'spright-chat-message-system'"
630
+ "default": "'spright-chat-message-outbound'"
588
631
  }
589
632
  ],
590
633
  "exports": [
591
634
  {
592
635
  "kind": "js",
593
- "name": "ChatMessageSystem",
636
+ "name": "ChatMessageOutbound",
594
637
  "declaration": {
595
- "name": "ChatMessageSystem",
596
- "module": "src/chat/message/system/index.ts"
638
+ "name": "ChatMessageOutbound",
639
+ "module": "src/chat/message/outbound/index.ts"
597
640
  }
598
641
  },
599
642
  {
600
643
  "kind": "js",
601
- "name": "chatMessageSystemTag",
644
+ "name": "chatMessageOutboundTag",
602
645
  "declaration": {
603
- "name": "chatMessageSystemTag",
604
- "module": "src/chat/message/system/index.ts"
646
+ "name": "chatMessageOutboundTag",
647
+ "module": "src/chat/message/outbound/index.ts"
605
648
  }
606
649
  }
607
650
  ]
608
651
  },
609
652
  {
610
653
  "kind": "javascript-module",
611
- "path": "src/chat/message/inbound/index.ts",
654
+ "path": "src/chat/message/system/index.ts",
612
655
  "declarations": [
613
656
  {
614
657
  "kind": "class",
615
- "description": "A Spright component for displaying a chat message",
616
- "name": "ChatMessageInbound",
617
- "members": [
618
- {
619
- "kind": "method",
620
- "name": "slottedFooterActionsElementsChanged",
621
- "privacy": "public",
622
- "return": {
623
- "type": {
624
- "text": "void"
625
- }
626
- },
627
- "parameters": [
628
- {
629
- "name": "_prev",
630
- "type": {
631
- "text": "HTMLElement[] | undefined"
632
- }
633
- },
634
- {
635
- "name": "next",
636
- "type": {
637
- "text": "HTMLElement[] | undefined"
638
- }
639
- }
640
- ]
641
- }
642
- ],
658
+ "description": "A Spright component for displaying an system chat message",
659
+ "name": "ChatMessageSystem",
643
660
  "superclass": {
644
661
  "name": "FoundationElement",
645
662
  "package": "@ni/fast-foundation"
@@ -647,28 +664,28 @@
647
664
  },
648
665
  {
649
666
  "kind": "variable",
650
- "name": "chatMessageInboundTag",
667
+ "name": "chatMessageSystemTag",
651
668
  "type": {
652
669
  "text": "string"
653
670
  },
654
- "default": "'spright-chat-message-inbound'"
671
+ "default": "'spright-chat-message-system'"
655
672
  }
656
673
  ],
657
674
  "exports": [
658
675
  {
659
676
  "kind": "js",
660
- "name": "ChatMessageInbound",
677
+ "name": "ChatMessageSystem",
661
678
  "declaration": {
662
- "name": "ChatMessageInbound",
663
- "module": "src/chat/message/inbound/index.ts"
679
+ "name": "ChatMessageSystem",
680
+ "module": "src/chat/message/system/index.ts"
664
681
  }
665
682
  },
666
683
  {
667
684
  "kind": "js",
668
- "name": "chatMessageInboundTag",
685
+ "name": "chatMessageSystemTag",
669
686
  "declaration": {
670
- "name": "chatMessageInboundTag",
671
- "module": "src/chat/message/inbound/index.ts"
687
+ "name": "chatMessageSystemTag",
688
+ "module": "src/chat/message/system/index.ts"
672
689
  }
673
690
  }
674
691
  ]
@@ -8,35 +8,6 @@
8
8
 
9
9
  <hr/>
10
10
 
11
- ## class: `ChatConversation`
12
-
13
- ### Superclass
14
-
15
- | Name | Module | Package |
16
- | ------------------- | ------ | ------------------- |
17
- | `FoundationElement` | | @ni/fast-foundation |
18
-
19
- ### Fields
20
-
21
- | Name | Privacy | Type | Default | Description | Inherited From |
22
- | ------------ | ------- | ---- | ------- | ----------- | -------------- |
23
- | `appearance` | public | | | | |
24
-
25
- ### Methods
26
-
27
- | Name | Privacy | Description | Parameters | Return | Inherited From |
28
- | ------------------------------- | ------- | ----------- | --------------------------------------------------------------------- | ------ | -------------- |
29
- | `slottedInputElementsChanged` | public | | `_prev: HTMLElement[] \| undefined, next: HTMLElement[] \| undefined` | `void` | |
30
- | `slottedToolbarElementsChanged` | public | | `_prev: HTMLElement[] \| undefined, next: HTMLElement[] \| undefined` | `void` | |
31
-
32
- ### Attributes
33
-
34
- | Name | Field | Inherited From |
35
- | ------------ | ---------- | -------------- |
36
- | `appearance` | appearance | |
37
-
38
- <hr/>
39
-
40
11
  ## class: `ChatInput`
41
12
 
42
13
  ### Superclass
@@ -56,6 +27,7 @@
56
27
  | `tabIndex` | public | `number` | | | |
57
28
  | `maxLength` | public | `number \| undefined` | `-1` | | |
58
29
  | `processing` | public | `boolean` | `false` | | |
30
+ | `sendDisabled` | public | `boolean` | `false` | | |
59
31
 
60
32
  ### Attributes
61
33
 
@@ -68,6 +40,36 @@
68
40
  | `tabindex` | tabIndex | |
69
41
  | `maxlength` | maxLength | |
70
42
  | `processing` | processing | |
43
+ | `send-disabled` | sendDisabled | |
44
+
45
+ <hr/>
46
+
47
+ ## class: `ChatConversation`
48
+
49
+ ### Superclass
50
+
51
+ | Name | Module | Package |
52
+ | ------------------- | ------ | ------------------- |
53
+ | `FoundationElement` | | @ni/fast-foundation |
54
+
55
+ ### Fields
56
+
57
+ | Name | Privacy | Type | Default | Description | Inherited From |
58
+ | ------------ | ------- | ---- | ------- | ----------- | -------------- |
59
+ | `appearance` | public | | | | |
60
+
61
+ ### Methods
62
+
63
+ | Name | Privacy | Description | Parameters | Return | Inherited From |
64
+ | ------------------------------- | ------- | ----------- | --------------------------------------------------------------------- | ------ | -------------- |
65
+ | `slottedInputElementsChanged` | public | | `_prev: HTMLElement[] \| undefined, next: HTMLElement[] \| undefined` | `void` | |
66
+ | `slottedToolbarElementsChanged` | public | | `_prev: HTMLElement[] \| undefined, next: HTMLElement[] \| undefined` | `void` | |
67
+
68
+ ### Attributes
69
+
70
+ | Name | Field | Inherited From |
71
+ | ------------ | ---------- | -------------- |
72
+ | `appearance` | appearance | |
71
73
 
72
74
  <hr/>
73
75
 
@@ -99,7 +101,7 @@
99
101
 
100
102
  <hr/>
101
103
 
102
- ## class: `ChatMessageOutbound`
104
+ ## class: `ChatMessageInbound`
103
105
 
104
106
  ### Superclass
105
107
 
@@ -107,9 +109,15 @@
107
109
  | ------------------- | ------ | ------------------- |
108
110
  | `FoundationElement` | | @ni/fast-foundation |
109
111
 
112
+ ### Methods
113
+
114
+ | Name | Privacy | Description | Parameters | Return | Inherited From |
115
+ | ------------------------------------- | ------- | ----------- | --------------------------------------------------------------------- | ------ | -------------- |
116
+ | `slottedFooterActionsElementsChanged` | public | | `_prev: HTMLElement[] \| undefined, next: HTMLElement[] \| undefined` | `void` | |
117
+
110
118
  <hr/>
111
119
 
112
- ## class: `ChatMessageSystem`
120
+ ## class: `ChatMessageOutbound`
113
121
 
114
122
  ### Superclass
115
123
 
@@ -119,7 +127,7 @@
119
127
 
120
128
  <hr/>
121
129
 
122
- ## class: `ChatMessageInbound`
130
+ ## class: `ChatMessageSystem`
123
131
 
124
132
  ### Superclass
125
133
 
@@ -127,10 +135,4 @@
127
135
  | ------------------- | ------ | ------------------- |
128
136
  | `FoundationElement` | | @ni/fast-foundation |
129
137
 
130
- ### Methods
131
-
132
- | Name | Privacy | Description | Parameters | Return | Inherited From |
133
- | ------------------------------------- | ------- | ----------- | --------------------------------------------------------------------- | ------ | -------------- |
134
- | `slottedFooterActionsElementsChanged` | public | | `_prev: HTMLElement[] \| undefined, next: HTMLElement[] \| undefined` | `void` | |
135
-
136
138
  <hr/>
@@ -25,14 +25,16 @@ export declare class ChatInput extends ChatInput_base {
25
25
  tabIndex: number;
26
26
  maxLength?: number;
27
27
  processing: boolean;
28
+ sendDisabled: boolean;
28
29
  /**
29
30
  * @internal
30
31
  */
31
32
  textArea?: HTMLTextAreaElement;
32
33
  /**
34
+ * Tracks whether the send button should be disabled based on input value
33
35
  * @internal
34
36
  */
35
- disableSendButton: boolean;
37
+ isInputEmpty: boolean;
36
38
  /**
37
39
  * The width of the vertical scrollbar, if displayed.
38
40
  * @internal