@nlxai/touchpoint-ui 1.0.5-alpha.2 → 1.0.5-alpha.5

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.
@@ -1,303 +0,0 @@
1
- # Interface: Theme
2
-
3
- The full theme expressed as CSS custom properties
4
-
5
- ## Properties
6
-
7
- ### fontFamily
8
-
9
- • **fontFamily**: `string`
10
-
11
- Font family
12
-
13
- #### Defined in
14
-
15
- [packages/touchpoint-ui/src/types.ts:61](https://github.com/nlxai/sdk/blob/8b853457d427626d7c75ba959ddb9dd0754725af/packages/touchpoint-ui/src/types.ts#L61)
16
-
17
- ___
18
-
19
- ### primary80
20
-
21
- • **primary80**: `string`
22
-
23
- Primary color with 80% opacity
24
-
25
- #### Defined in
26
-
27
- [packages/touchpoint-ui/src/types.ts:66](https://github.com/nlxai/sdk/blob/8b853457d427626d7c75ba959ddb9dd0754725af/packages/touchpoint-ui/src/types.ts#L66)
28
-
29
- ___
30
-
31
- ### primary60
32
-
33
- • **primary60**: `string`
34
-
35
- Primary color with 60% opacity
36
-
37
- #### Defined in
38
-
39
- [packages/touchpoint-ui/src/types.ts:70](https://github.com/nlxai/sdk/blob/8b853457d427626d7c75ba959ddb9dd0754725af/packages/touchpoint-ui/src/types.ts#L70)
40
-
41
- ___
42
-
43
- ### primary40
44
-
45
- • **primary40**: `string`
46
-
47
- Primary color with 40% opacity
48
-
49
- #### Defined in
50
-
51
- [packages/touchpoint-ui/src/types.ts:74](https://github.com/nlxai/sdk/blob/8b853457d427626d7c75ba959ddb9dd0754725af/packages/touchpoint-ui/src/types.ts#L74)
52
-
53
- ___
54
-
55
- ### primary20
56
-
57
- • **primary20**: `string`
58
-
59
- Primary color with 20% opacity
60
-
61
- #### Defined in
62
-
63
- [packages/touchpoint-ui/src/types.ts:78](https://github.com/nlxai/sdk/blob/8b853457d427626d7c75ba959ddb9dd0754725af/packages/touchpoint-ui/src/types.ts#L78)
64
-
65
- ___
66
-
67
- ### primary10
68
-
69
- • **primary10**: `string`
70
-
71
- Primary color with 10% opacity
72
-
73
- #### Defined in
74
-
75
- [packages/touchpoint-ui/src/types.ts:82](https://github.com/nlxai/sdk/blob/8b853457d427626d7c75ba959ddb9dd0754725af/packages/touchpoint-ui/src/types.ts#L82)
76
-
77
- ___
78
-
79
- ### primary5
80
-
81
- • **primary5**: `string`
82
-
83
- Primary color with 5% opacity
84
-
85
- #### Defined in
86
-
87
- [packages/touchpoint-ui/src/types.ts:86](https://github.com/nlxai/sdk/blob/8b853457d427626d7c75ba959ddb9dd0754725af/packages/touchpoint-ui/src/types.ts#L86)
88
-
89
- ___
90
-
91
- ### primary1
92
-
93
- • **primary1**: `string`
94
-
95
- Primary color with 1% opacity
96
-
97
- #### Defined in
98
-
99
- [packages/touchpoint-ui/src/types.ts:90](https://github.com/nlxai/sdk/blob/8b853457d427626d7c75ba959ddb9dd0754725af/packages/touchpoint-ui/src/types.ts#L90)
100
-
101
- ___
102
-
103
- ### secondary80
104
-
105
- • **secondary80**: `string`
106
-
107
- Secondary color with 80% opacity
108
-
109
- #### Defined in
110
-
111
- [packages/touchpoint-ui/src/types.ts:95](https://github.com/nlxai/sdk/blob/8b853457d427626d7c75ba959ddb9dd0754725af/packages/touchpoint-ui/src/types.ts#L95)
112
-
113
- ___
114
-
115
- ### secondary60
116
-
117
- • **secondary60**: `string`
118
-
119
- Secondary color with 60% opacity
120
-
121
- #### Defined in
122
-
123
- [packages/touchpoint-ui/src/types.ts:99](https://github.com/nlxai/sdk/blob/8b853457d427626d7c75ba959ddb9dd0754725af/packages/touchpoint-ui/src/types.ts#L99)
124
-
125
- ___
126
-
127
- ### secondary40
128
-
129
- • **secondary40**: `string`
130
-
131
- Secondary color with 40% opacity
132
-
133
- #### Defined in
134
-
135
- [packages/touchpoint-ui/src/types.ts:103](https://github.com/nlxai/sdk/blob/8b853457d427626d7c75ba959ddb9dd0754725af/packages/touchpoint-ui/src/types.ts#L103)
136
-
137
- ___
138
-
139
- ### secondary20
140
-
141
- • **secondary20**: `string`
142
-
143
- Secondary color with 20% opacity
144
-
145
- #### Defined in
146
-
147
- [packages/touchpoint-ui/src/types.ts:107](https://github.com/nlxai/sdk/blob/8b853457d427626d7c75ba959ddb9dd0754725af/packages/touchpoint-ui/src/types.ts#L107)
148
-
149
- ___
150
-
151
- ### secondary10
152
-
153
- • **secondary10**: `string`
154
-
155
- Secondary color with 10% opacity
156
-
157
- #### Defined in
158
-
159
- [packages/touchpoint-ui/src/types.ts:111](https://github.com/nlxai/sdk/blob/8b853457d427626d7c75ba959ddb9dd0754725af/packages/touchpoint-ui/src/types.ts#L111)
160
-
161
- ___
162
-
163
- ### secondary5
164
-
165
- • **secondary5**: `string`
166
-
167
- Secondary color with 5% opacity
168
-
169
- #### Defined in
170
-
171
- [packages/touchpoint-ui/src/types.ts:115](https://github.com/nlxai/sdk/blob/8b853457d427626d7c75ba959ddb9dd0754725af/packages/touchpoint-ui/src/types.ts#L115)
172
-
173
- ___
174
-
175
- ### secondary1
176
-
177
- • **secondary1**: `string`
178
-
179
- Secondary color with 1% opacity
180
-
181
- #### Defined in
182
-
183
- [packages/touchpoint-ui/src/types.ts:119](https://github.com/nlxai/sdk/blob/8b853457d427626d7c75ba959ddb9dd0754725af/packages/touchpoint-ui/src/types.ts#L119)
184
-
185
- ___
186
-
187
- ### accent
188
-
189
- • **accent**: `string`
190
-
191
- Accent color used e.g. for prominent buttons, the loader animation as well as selected card outlines
192
-
193
- #### Defined in
194
-
195
- [packages/touchpoint-ui/src/types.ts:124](https://github.com/nlxai/sdk/blob/8b853457d427626d7c75ba959ddb9dd0754725af/packages/touchpoint-ui/src/types.ts#L124)
196
-
197
- ___
198
-
199
- ### accent20
200
-
201
- • **accent20**: `string`
202
-
203
- Accent color with 20% opacity
204
-
205
- #### Defined in
206
-
207
- [packages/touchpoint-ui/src/types.ts:128](https://github.com/nlxai/sdk/blob/8b853457d427626d7c75ba959ddb9dd0754725af/packages/touchpoint-ui/src/types.ts#L128)
208
-
209
- ___
210
-
211
- ### background
212
-
213
- • **background**: `string`
214
-
215
- The background color of the main Touchpoint interface
216
-
217
- #### Defined in
218
-
219
- [packages/touchpoint-ui/src/types.ts:132](https://github.com/nlxai/sdk/blob/8b853457d427626d7c75ba959ddb9dd0754725af/packages/touchpoint-ui/src/types.ts#L132)
220
-
221
- ___
222
-
223
- ### overlay
224
-
225
- • **overlay**: `string`
226
-
227
- The color of the overlay covering the visible portion of the website when the Touchpoint interface does not cover the full screen
228
-
229
- #### Defined in
230
-
231
- [packages/touchpoint-ui/src/types.ts:136](https://github.com/nlxai/sdk/blob/8b853457d427626d7c75ba959ddb9dd0754725af/packages/touchpoint-ui/src/types.ts#L136)
232
-
233
- ___
234
-
235
- ### warningPrimary
236
-
237
- • **warningPrimary**: `string`
238
-
239
- Primary warning color
240
-
241
- #### Defined in
242
-
243
- [packages/touchpoint-ui/src/types.ts:141](https://github.com/nlxai/sdk/blob/8b853457d427626d7c75ba959ddb9dd0754725af/packages/touchpoint-ui/src/types.ts#L141)
244
-
245
- ___
246
-
247
- ### warningSecondary
248
-
249
- • **warningSecondary**: `string`
250
-
251
- Secondary warning color
252
-
253
- #### Defined in
254
-
255
- [packages/touchpoint-ui/src/types.ts:145](https://github.com/nlxai/sdk/blob/8b853457d427626d7c75ba959ddb9dd0754725af/packages/touchpoint-ui/src/types.ts#L145)
256
-
257
- ___
258
-
259
- ### errorPrimary
260
-
261
- • **errorPrimary**: `string`
262
-
263
- Primary error color
264
-
265
- #### Defined in
266
-
267
- [packages/touchpoint-ui/src/types.ts:149](https://github.com/nlxai/sdk/blob/8b853457d427626d7c75ba959ddb9dd0754725af/packages/touchpoint-ui/src/types.ts#L149)
268
-
269
- ___
270
-
271
- ### errorSecondary
272
-
273
- • **errorSecondary**: `string`
274
-
275
- Secondary error color
276
-
277
- #### Defined in
278
-
279
- [packages/touchpoint-ui/src/types.ts:153](https://github.com/nlxai/sdk/blob/8b853457d427626d7c75ba959ddb9dd0754725af/packages/touchpoint-ui/src/types.ts#L153)
280
-
281
- ___
282
-
283
- ### innerBorderRadius
284
-
285
- • **innerBorderRadius**: `string`
286
-
287
- Inner border radius: used for most buttons
288
-
289
- #### Defined in
290
-
291
- [packages/touchpoint-ui/src/types.ts:158](https://github.com/nlxai/sdk/blob/8b853457d427626d7c75ba959ddb9dd0754725af/packages/touchpoint-ui/src/types.ts#L158)
292
-
293
- ___
294
-
295
- ### outerBorderRadius
296
-
297
- • **outerBorderRadius**: `string`
298
-
299
- Outer border radius: generally used for elements that contain buttons that have inner border radius. Also used by the launch button.
300
-
301
- #### Defined in
302
-
303
- [packages/touchpoint-ui/src/types.ts:162](https://github.com/nlxai/sdk/blob/8b853457d427626d7c75ba959ddb9dd0754725af/packages/touchpoint-ui/src/types.ts#L162)
@@ -1,89 +0,0 @@
1
- # Interface: TouchpointConfiguration
2
-
3
- Main Touchpoint creation properties object
4
-
5
- ## Properties
6
-
7
- ### config
8
-
9
- • **config**: `Config`
10
-
11
- Connection information for the @nlxai/chat-core conversation handler
12
-
13
- #### Defined in
14
-
15
- [packages/touchpoint-ui/src/types.ts:172](https://github.com/nlxai/sdk/blob/8b853457d427626d7c75ba959ddb9dd0754725af/packages/touchpoint-ui/src/types.ts#L172)
16
-
17
- ___
18
-
19
- ### windowSize
20
-
21
- • `Optional` **windowSize**: [`WindowSize`](../README.md#windowsize)
22
-
23
- Optional window size for the chat window, defaults to `half`
24
-
25
- #### Defined in
26
-
27
- [packages/touchpoint-ui/src/types.ts:176](https://github.com/nlxai/sdk/blob/8b853457d427626d7c75ba959ddb9dd0754725af/packages/touchpoint-ui/src/types.ts#L176)
28
-
29
- ___
30
-
31
- ### colorMode
32
-
33
- • `Optional` **colorMode**: [`ColorMode`](../README.md#colormode)
34
-
35
- Optional color mode for the chat window, defaults to `dark`
36
-
37
- #### Defined in
38
-
39
- [packages/touchpoint-ui/src/types.ts:180](https://github.com/nlxai/sdk/blob/8b853457d427626d7c75ba959ddb9dd0754725af/packages/touchpoint-ui/src/types.ts#L180)
40
-
41
- ___
42
-
43
- ### brandIcon
44
-
45
- • `Optional` **brandIcon**: `string`
46
-
47
- URL of icon used to display the brand in the chat header
48
-
49
- #### Defined in
50
-
51
- [packages/touchpoint-ui/src/types.ts:184](https://github.com/nlxai/sdk/blob/8b853457d427626d7c75ba959ddb9dd0754725af/packages/touchpoint-ui/src/types.ts#L184)
52
-
53
- ___
54
-
55
- ### launchIcon
56
-
57
- • `Optional` **launchIcon**: `string` \| `boolean`
58
-
59
- URL of icon used on the launch icon in the bottom right when the experience is collapsed.
60
-
61
- When set to `false`, no launch button is shown at all. When not set or set to `true`, the default launch icon is rendered.
62
-
63
- #### Defined in
64
-
65
- [packages/touchpoint-ui/src/types.ts:190](https://github.com/nlxai/sdk/blob/8b853457d427626d7c75ba959ddb9dd0754725af/packages/touchpoint-ui/src/types.ts#L190)
66
-
67
- ___
68
-
69
- ### theme
70
-
71
- • `Optional` **theme**: `Partial`\<[`Theme`](Theme.md)\>
72
-
73
- Optional theme object to override default theme values
74
-
75
- #### Defined in
76
-
77
- [packages/touchpoint-ui/src/types.ts:194](https://github.com/nlxai/sdk/blob/8b853457d427626d7c75ba959ddb9dd0754725af/packages/touchpoint-ui/src/types.ts#L194)
78
-
79
- ___
80
-
81
- ### customModalities
82
-
83
- • `Optional` **customModalities**: `Record`\<`string`, [`CustomModalityComponent`](../README.md#custommodalitycomponent)\<`any`\>\>
84
-
85
- Optional custom modality components to render in Touchpoint
86
-
87
- #### Defined in
88
-
89
- [packages/touchpoint-ui/src/types.ts:198](https://github.com/nlxai/sdk/blob/8b853457d427626d7c75ba959ddb9dd0754725af/packages/touchpoint-ui/src/types.ts#L198)
@@ -1,47 +0,0 @@
1
- # Interface: TouchpointInstance
2
-
3
- Instance of a Touchpoint UI component
4
-
5
- ## Properties
6
-
7
- ### expanded
8
-
9
- • **expanded**: `boolean`
10
-
11
- Controls whether the Touchpoint UI is expanded or collapsed
12
-
13
- #### Defined in
14
-
15
- [packages/touchpoint-ui/src/index.tsx:179](https://github.com/nlxai/sdk/blob/8b853457d427626d7c75ba959ddb9dd0754725af/packages/touchpoint-ui/src/index.tsx#L179)
16
-
17
- ___
18
-
19
- ### conversationHandler
20
-
21
- • **conversationHandler**: `ConversationHandler`
22
-
23
- The conversation handler instance for interacting with the application
24
-
25
- #### Defined in
26
-
27
- [packages/touchpoint-ui/src/index.tsx:183](https://github.com/nlxai/sdk/blob/8b853457d427626d7c75ba959ddb9dd0754725af/packages/touchpoint-ui/src/index.tsx#L183)
28
-
29
- ___
30
-
31
- ### teardown
32
-
33
- • **teardown**: () => `void`
34
-
35
- Method to remove the Touchpoint UI from the DOM
36
-
37
- #### Type declaration
38
-
39
- ▸ (): `void`
40
-
41
- ##### Returns
42
-
43
- `void`
44
-
45
- #### Defined in
46
-
47
- [packages/touchpoint-ui/src/index.tsx:187](https://github.com/nlxai/sdk/blob/8b853457d427626d7c75ba959ddb9dd0754725af/packages/touchpoint-ui/src/index.tsx#L187)