@nlxai/touchpoint-ui 1.2.4-alpha.1 → 1.2.4-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.
- package/README.md +3 -1
- package/docs/@nlxai/namespaces/Icons.md +377 -0
- package/docs/@nlxai/namespaces/React/README.md +221390 -0
- package/docs/@nlxai/namespaces/React/namespaces/JSX.md +3050 -0
- package/docs/README.md +1143 -268
- package/lib/components/Messages.d.ts +1 -0
- package/lib/index.js +6024 -5994
- package/lib/index.umd.js +53 -53
- package/package.json +3 -3
- package/docs/.nojekyll +0 -1
- package/docs/interfaces/BidirectionalContext.md +0 -51
- package/docs/interfaces/BidirectionalCustomCommand.md +0 -79
- package/docs/interfaces/ChoiceMessage.md +0 -39
- package/docs/interfaces/CustomCardProps.md +0 -83
- package/docs/interfaces/CustomCardRowProps.md +0 -39
- package/docs/interfaces/DateInputProps.md +0 -41
- package/docs/interfaces/IconButtonProps.md +0 -71
- package/docs/interfaces/Icons.IconProps.md +0 -29
- package/docs/interfaces/InputField.md +0 -27
- package/docs/interfaces/InteractiveElementInfo.md +0 -21
- package/docs/interfaces/PageForms.md +0 -27
- package/docs/interfaces/PageState.md +0 -39
- package/docs/interfaces/TextButtonProps.md +0 -72
- package/docs/interfaces/Theme.md +0 -303
- package/docs/interfaces/TouchpointConfiguration.md +0 -209
- package/docs/interfaces/TouchpointInstance.md +0 -121
- package/docs/modules/Icons.md +0 -878
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@nlxai/touchpoint-ui",
|
|
3
|
-
"version": "1.2.4-alpha.
|
|
3
|
+
"version": "1.2.4-alpha.5",
|
|
4
4
|
"description": "Web UI for Touchpoint",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"main": "lib/index.js",
|
|
@@ -27,7 +27,7 @@
|
|
|
27
27
|
"update-readme": "npm run update-readme:docs && npm run update-readme:merge"
|
|
28
28
|
},
|
|
29
29
|
"dependencies": {
|
|
30
|
-
"@nlxai/core": "^1.2.4-alpha.
|
|
30
|
+
"@nlxai/core": "^1.2.4-alpha.5",
|
|
31
31
|
"@react-hookz/web": "^25.0.1",
|
|
32
32
|
"@react-input/mask": "^2.0.4",
|
|
33
33
|
"@rive-app/webgl2": "^2.31.5",
|
|
@@ -66,5 +66,5 @@
|
|
|
66
66
|
"publishConfig": {
|
|
67
67
|
"access": "public"
|
|
68
68
|
},
|
|
69
|
-
"gitHead": "
|
|
69
|
+
"gitHead": "41f7924241752b6f335c9a3ee1c3e6531e407ae4"
|
|
70
70
|
}
|
package/docs/.nojekyll
DELETED
|
@@ -1 +0,0 @@
|
|
|
1
|
-
TypeDoc added this file to prevent GitHub Pages from using Jekyll. You can turn off this behavior by setting the `githubPages` option to false.
|
|
@@ -1,51 +0,0 @@
|
|
|
1
|
-
# Interface: BidirectionalContext
|
|
2
|
-
|
|
3
|
-
Bidirectional context information that is sent to the LLM.
|
|
4
|
-
|
|
5
|
-
## Properties
|
|
6
|
-
|
|
7
|
-
### uri
|
|
8
|
-
|
|
9
|
-
• `Optional` **uri**: `string`
|
|
10
|
-
|
|
11
|
-
Identifier for which page you are currently on. This can be used to filter the relevant KB pages.
|
|
12
|
-
|
|
13
|
-
#### Defined in
|
|
14
|
-
|
|
15
|
-
[packages/touchpoint-ui/src/interface.ts:235](https://github.com/nlxai/sdk/blob/e13e2baae9abf0ee3add35f3a4b4c3fe47e8f43d/packages/touchpoint-ui/src/interface.ts#L235)
|
|
16
|
-
|
|
17
|
-
___
|
|
18
|
-
|
|
19
|
-
### fields
|
|
20
|
-
|
|
21
|
-
• `Optional` **fields**: [`InteractiveElementInfo`](InteractiveElementInfo.md)[]
|
|
22
|
-
|
|
23
|
-
The active form fields that can be filled in.
|
|
24
|
-
|
|
25
|
-
#### Defined in
|
|
26
|
-
|
|
27
|
-
[packages/touchpoint-ui/src/interface.ts:237](https://github.com/nlxai/sdk/blob/e13e2baae9abf0ee3add35f3a4b4c3fe47e8f43d/packages/touchpoint-ui/src/interface.ts#L237)
|
|
28
|
-
|
|
29
|
-
___
|
|
30
|
-
|
|
31
|
-
### destinations
|
|
32
|
-
|
|
33
|
-
• `Optional` **destinations**: `string`[]
|
|
34
|
-
|
|
35
|
-
Human readable location names that can be navigated to.
|
|
36
|
-
|
|
37
|
-
#### Defined in
|
|
38
|
-
|
|
39
|
-
[packages/touchpoint-ui/src/interface.ts:239](https://github.com/nlxai/sdk/blob/e13e2baae9abf0ee3add35f3a4b4c3fe47e8f43d/packages/touchpoint-ui/src/interface.ts#L239)
|
|
40
|
-
|
|
41
|
-
___
|
|
42
|
-
|
|
43
|
-
### actions
|
|
44
|
-
|
|
45
|
-
• `Optional` **actions**: \{ `action`: `string` ; `description?`: `string` ; `schema?`: `any` }[]
|
|
46
|
-
|
|
47
|
-
Custom actions that can be performed.
|
|
48
|
-
|
|
49
|
-
#### Defined in
|
|
50
|
-
|
|
51
|
-
[packages/touchpoint-ui/src/interface.ts:243](https://github.com/nlxai/sdk/blob/e13e2baae9abf0ee3add35f3a4b4c3fe47e8f43d/packages/touchpoint-ui/src/interface.ts#L243)
|
|
@@ -1,79 +0,0 @@
|
|
|
1
|
-
# Interface: BidirectionalCustomCommand
|
|
2
|
-
|
|
3
|
-
During a Voice+ bidirectional conversation, you can indicate to the application the availability of
|
|
4
|
-
custom commands that the user can invoke.
|
|
5
|
-
|
|
6
|
-
**`Type Param`**
|
|
7
|
-
|
|
8
|
-
Commands can take a single parameter which will be generated from this schema.
|
|
9
|
-
|
|
10
|
-
## Properties
|
|
11
|
-
|
|
12
|
-
### action
|
|
13
|
-
|
|
14
|
-
• **action**: `string`
|
|
15
|
-
|
|
16
|
-
The name of the command, used to invoke it. Should be unique and descriptive in the context of the LLM.
|
|
17
|
-
|
|
18
|
-
#### Defined in
|
|
19
|
-
|
|
20
|
-
[packages/touchpoint-ui/src/interface.ts:444](https://github.com/nlxai/sdk/blob/e13e2baae9abf0ee3add35f3a4b4c3fe47e8f43d/packages/touchpoint-ui/src/interface.ts#L444)
|
|
21
|
-
|
|
22
|
-
___
|
|
23
|
-
|
|
24
|
-
### description
|
|
25
|
-
|
|
26
|
-
• `Optional` **description**: `string`
|
|
27
|
-
|
|
28
|
-
A short description of the command, used to help the LLM understand its purpose.
|
|
29
|
-
|
|
30
|
-
If omitted, then the command will not be sent to the application and must be triggered
|
|
31
|
-
from the application side.
|
|
32
|
-
|
|
33
|
-
#### Defined in
|
|
34
|
-
|
|
35
|
-
[packages/touchpoint-ui/src/interface.ts:451](https://github.com/nlxai/sdk/blob/e13e2baae9abf0ee3add35f3a4b4c3fe47e8f43d/packages/touchpoint-ui/src/interface.ts#L451)
|
|
36
|
-
|
|
37
|
-
___
|
|
38
|
-
|
|
39
|
-
### schema
|
|
40
|
-
|
|
41
|
-
• `Optional` **schema**: `any`
|
|
42
|
-
|
|
43
|
-
A JSON Schema that defines the structure of the command's input.
|
|
44
|
-
|
|
45
|
-
Use descriptive names and `description` fields to give the underlying LLM plenty of context for
|
|
46
|
-
it to generate reasonable parameters. Note that the LLM output will be validated (and transformed)
|
|
47
|
-
with this schema, so you are guaranteed type safe inputs to your handler.
|
|
48
|
-
|
|
49
|
-
Should follow the JSONSchema specification.
|
|
50
|
-
|
|
51
|
-
#### Defined in
|
|
52
|
-
|
|
53
|
-
[packages/touchpoint-ui/src/interface.ts:462](https://github.com/nlxai/sdk/blob/e13e2baae9abf0ee3add35f3a4b4c3fe47e8f43d/packages/touchpoint-ui/src/interface.ts#L462)
|
|
54
|
-
|
|
55
|
-
___
|
|
56
|
-
|
|
57
|
-
### handler
|
|
58
|
-
|
|
59
|
-
• **handler**: (`value`: `any`) => `void`
|
|
60
|
-
|
|
61
|
-
A handler that will be called with an argument matching the schema when the command is invoked.
|
|
62
|
-
|
|
63
|
-
#### Type declaration
|
|
64
|
-
|
|
65
|
-
▸ (`value`): `void`
|
|
66
|
-
|
|
67
|
-
##### Parameters
|
|
68
|
-
|
|
69
|
-
| Name | Type |
|
|
70
|
-
| :------ | :------ |
|
|
71
|
-
| `value` | `any` |
|
|
72
|
-
|
|
73
|
-
##### Returns
|
|
74
|
-
|
|
75
|
-
`void`
|
|
76
|
-
|
|
77
|
-
#### Defined in
|
|
78
|
-
|
|
79
|
-
[packages/touchpoint-ui/src/interface.ts:466](https://github.com/nlxai/sdk/blob/e13e2baae9abf0ee3add35f3a4b4c3fe47e8f43d/packages/touchpoint-ui/src/interface.ts#L466)
|
|
@@ -1,39 +0,0 @@
|
|
|
1
|
-
# Interface: ChoiceMessage
|
|
2
|
-
|
|
3
|
-
Choice message with metadata
|
|
4
|
-
|
|
5
|
-
## Properties
|
|
6
|
-
|
|
7
|
-
### message
|
|
8
|
-
|
|
9
|
-
• **message**: `ApplicationMessage`
|
|
10
|
-
|
|
11
|
-
Message contents
|
|
12
|
-
|
|
13
|
-
#### Defined in
|
|
14
|
-
|
|
15
|
-
[packages/touchpoint-ui/src/interface.ts:27](https://github.com/nlxai/sdk/blob/e13e2baae9abf0ee3add35f3a4b4c3fe47e8f43d/packages/touchpoint-ui/src/interface.ts#L27)
|
|
16
|
-
|
|
17
|
-
___
|
|
18
|
-
|
|
19
|
-
### responseIndex
|
|
20
|
-
|
|
21
|
-
• **responseIndex**: `number`
|
|
22
|
-
|
|
23
|
-
Index in the response transcript history
|
|
24
|
-
|
|
25
|
-
#### Defined in
|
|
26
|
-
|
|
27
|
-
[packages/touchpoint-ui/src/interface.ts:31](https://github.com/nlxai/sdk/blob/e13e2baae9abf0ee3add35f3a4b4c3fe47e8f43d/packages/touchpoint-ui/src/interface.ts#L31)
|
|
28
|
-
|
|
29
|
-
___
|
|
30
|
-
|
|
31
|
-
### messageIndex
|
|
32
|
-
|
|
33
|
-
• **messageIndex**: `number`
|
|
34
|
-
|
|
35
|
-
Message index in the current response
|
|
36
|
-
|
|
37
|
-
#### Defined in
|
|
38
|
-
|
|
39
|
-
[packages/touchpoint-ui/src/interface.ts:35](https://github.com/nlxai/sdk/blob/e13e2baae9abf0ee3add35f3a4b4c3fe47e8f43d/packages/touchpoint-ui/src/interface.ts#L35)
|
|
@@ -1,83 +0,0 @@
|
|
|
1
|
-
# Interface: CustomCardProps
|
|
2
|
-
|
|
3
|
-
Props for the CustomCard component
|
|
4
|
-
|
|
5
|
-
## Properties
|
|
6
|
-
|
|
7
|
-
### className
|
|
8
|
-
|
|
9
|
-
• `Optional` **className**: `string`
|
|
10
|
-
|
|
11
|
-
Class name
|
|
12
|
-
|
|
13
|
-
#### Defined in
|
|
14
|
-
|
|
15
|
-
[packages/touchpoint-ui/src/components/ui/CustomCard.tsx:15](https://github.com/nlxai/sdk/blob/e13e2baae9abf0ee3add35f3a4b4c3fe47e8f43d/packages/touchpoint-ui/src/components/ui/CustomCard.tsx#L15)
|
|
16
|
-
|
|
17
|
-
___
|
|
18
|
-
|
|
19
|
-
### children
|
|
20
|
-
|
|
21
|
-
• **children**: `ReactNode`
|
|
22
|
-
|
|
23
|
-
Content to be rendered inside the card.
|
|
24
|
-
|
|
25
|
-
#### Defined in
|
|
26
|
-
|
|
27
|
-
[packages/touchpoint-ui/src/components/ui/CustomCard.tsx:19](https://github.com/nlxai/sdk/blob/e13e2baae9abf0ee3add35f3a4b4c3fe47e8f43d/packages/touchpoint-ui/src/components/ui/CustomCard.tsx#L19)
|
|
28
|
-
|
|
29
|
-
___
|
|
30
|
-
|
|
31
|
-
### selected
|
|
32
|
-
|
|
33
|
-
• `Optional` **selected**: `boolean`
|
|
34
|
-
|
|
35
|
-
Whether the card is in a selected state. Used to highlight the card.
|
|
36
|
-
|
|
37
|
-
#### Defined in
|
|
38
|
-
|
|
39
|
-
[packages/touchpoint-ui/src/components/ui/CustomCard.tsx:23](https://github.com/nlxai/sdk/blob/e13e2baae9abf0ee3add35f3a4b4c3fe47e8f43d/packages/touchpoint-ui/src/components/ui/CustomCard.tsx#L23)
|
|
40
|
-
|
|
41
|
-
___
|
|
42
|
-
|
|
43
|
-
### onClick
|
|
44
|
-
|
|
45
|
-
• `Optional` **onClick**: () => `void`
|
|
46
|
-
|
|
47
|
-
Handler function for when the card is clicked
|
|
48
|
-
|
|
49
|
-
#### Type declaration
|
|
50
|
-
|
|
51
|
-
▸ (): `void`
|
|
52
|
-
|
|
53
|
-
##### Returns
|
|
54
|
-
|
|
55
|
-
`void`
|
|
56
|
-
|
|
57
|
-
#### Defined in
|
|
58
|
-
|
|
59
|
-
[packages/touchpoint-ui/src/components/ui/CustomCard.tsx:27](https://github.com/nlxai/sdk/blob/e13e2baae9abf0ee3add35f3a4b4c3fe47e8f43d/packages/touchpoint-ui/src/components/ui/CustomCard.tsx#L27)
|
|
60
|
-
|
|
61
|
-
___
|
|
62
|
-
|
|
63
|
-
### href
|
|
64
|
-
|
|
65
|
-
• `Optional` **href**: `string`
|
|
66
|
-
|
|
67
|
-
Transform the card into an anchor tag with the href specified
|
|
68
|
-
|
|
69
|
-
#### Defined in
|
|
70
|
-
|
|
71
|
-
[packages/touchpoint-ui/src/components/ui/CustomCard.tsx:31](https://github.com/nlxai/sdk/blob/e13e2baae9abf0ee3add35f3a4b4c3fe47e8f43d/packages/touchpoint-ui/src/components/ui/CustomCard.tsx#L31)
|
|
72
|
-
|
|
73
|
-
___
|
|
74
|
-
|
|
75
|
-
### newTab
|
|
76
|
-
|
|
77
|
-
• `Optional` **newTab**: `boolean`
|
|
78
|
-
|
|
79
|
-
Specify whether the URL should take the user to a new tab
|
|
80
|
-
|
|
81
|
-
#### Defined in
|
|
82
|
-
|
|
83
|
-
[packages/touchpoint-ui/src/components/ui/CustomCard.tsx:35](https://github.com/nlxai/sdk/blob/e13e2baae9abf0ee3add35f3a4b4c3fe47e8f43d/packages/touchpoint-ui/src/components/ui/CustomCard.tsx#L35)
|
|
@@ -1,39 +0,0 @@
|
|
|
1
|
-
# Interface: CustomCardRowProps
|
|
2
|
-
|
|
3
|
-
Props for the CustomCardRow component
|
|
4
|
-
|
|
5
|
-
## Properties
|
|
6
|
-
|
|
7
|
-
### left
|
|
8
|
-
|
|
9
|
-
• **left**: `ReactNode`
|
|
10
|
-
|
|
11
|
-
Content to be displayed on the left side of the row
|
|
12
|
-
|
|
13
|
-
#### Defined in
|
|
14
|
-
|
|
15
|
-
[packages/touchpoint-ui/src/components/ui/CustomCard.tsx:110](https://github.com/nlxai/sdk/blob/e13e2baae9abf0ee3add35f3a4b4c3fe47e8f43d/packages/touchpoint-ui/src/components/ui/CustomCard.tsx#L110)
|
|
16
|
-
|
|
17
|
-
___
|
|
18
|
-
|
|
19
|
-
### right
|
|
20
|
-
|
|
21
|
-
• **right**: `ReactNode`
|
|
22
|
-
|
|
23
|
-
Content to be displayed on the right side of the row
|
|
24
|
-
|
|
25
|
-
#### Defined in
|
|
26
|
-
|
|
27
|
-
[packages/touchpoint-ui/src/components/ui/CustomCard.tsx:114](https://github.com/nlxai/sdk/blob/e13e2baae9abf0ee3add35f3a4b4c3fe47e8f43d/packages/touchpoint-ui/src/components/ui/CustomCard.tsx#L114)
|
|
28
|
-
|
|
29
|
-
___
|
|
30
|
-
|
|
31
|
-
### icon
|
|
32
|
-
|
|
33
|
-
• `Optional` **icon**: [`Icon`](../modules/Icons.md#icon)
|
|
34
|
-
|
|
35
|
-
Optional icon to be displayed in the center of the row
|
|
36
|
-
|
|
37
|
-
#### Defined in
|
|
38
|
-
|
|
39
|
-
[packages/touchpoint-ui/src/components/ui/CustomCard.tsx:118](https://github.com/nlxai/sdk/blob/e13e2baae9abf0ee3add35f3a4b4c3fe47e8f43d/packages/touchpoint-ui/src/components/ui/CustomCard.tsx#L118)
|
|
@@ -1,41 +0,0 @@
|
|
|
1
|
-
# Interface: DateInputProps
|
|
2
|
-
|
|
3
|
-
Props for the DateInput component
|
|
4
|
-
|
|
5
|
-
## Properties
|
|
6
|
-
|
|
7
|
-
### onSubmit
|
|
8
|
-
|
|
9
|
-
• `Optional` **onSubmit**: (`date`: `string`) => `void`
|
|
10
|
-
|
|
11
|
-
Handler function called when the date is submitted
|
|
12
|
-
|
|
13
|
-
#### Type declaration
|
|
14
|
-
|
|
15
|
-
▸ (`date`): `void`
|
|
16
|
-
|
|
17
|
-
##### Parameters
|
|
18
|
-
|
|
19
|
-
| Name | Type | Description |
|
|
20
|
-
| :------ | :------ | :------ |
|
|
21
|
-
| `date` | `string` | The submitted date in YYYY-MM-DD format |
|
|
22
|
-
|
|
23
|
-
##### Returns
|
|
24
|
-
|
|
25
|
-
`void`
|
|
26
|
-
|
|
27
|
-
#### Defined in
|
|
28
|
-
|
|
29
|
-
[packages/touchpoint-ui/src/components/ui/DateInput.tsx:16](https://github.com/nlxai/sdk/blob/e13e2baae9abf0ee3add35f3a4b4c3fe47e8f43d/packages/touchpoint-ui/src/components/ui/DateInput.tsx#L16)
|
|
30
|
-
|
|
31
|
-
___
|
|
32
|
-
|
|
33
|
-
### className
|
|
34
|
-
|
|
35
|
-
• `Optional` **className**: `string`
|
|
36
|
-
|
|
37
|
-
Class name
|
|
38
|
-
|
|
39
|
-
#### Defined in
|
|
40
|
-
|
|
41
|
-
[packages/touchpoint-ui/src/components/ui/DateInput.tsx:20](https://github.com/nlxai/sdk/blob/e13e2baae9abf0ee3add35f3a4b4c3fe47e8f43d/packages/touchpoint-ui/src/components/ui/DateInput.tsx#L20)
|
|
@@ -1,71 +0,0 @@
|
|
|
1
|
-
# Interface: IconButtonProps
|
|
2
|
-
|
|
3
|
-
Props for the IconButton component
|
|
4
|
-
|
|
5
|
-
## Properties
|
|
6
|
-
|
|
7
|
-
### onClick
|
|
8
|
-
|
|
9
|
-
• `Optional` **onClick**: () => `void`
|
|
10
|
-
|
|
11
|
-
Handler function called when the button is clicked
|
|
12
|
-
|
|
13
|
-
#### Type declaration
|
|
14
|
-
|
|
15
|
-
▸ (): `void`
|
|
16
|
-
|
|
17
|
-
##### Returns
|
|
18
|
-
|
|
19
|
-
`void`
|
|
20
|
-
|
|
21
|
-
#### Defined in
|
|
22
|
-
|
|
23
|
-
[packages/touchpoint-ui/src/components/ui/IconButton.tsx:31](https://github.com/nlxai/sdk/blob/e13e2baae9abf0ee3add35f3a4b4c3fe47e8f43d/packages/touchpoint-ui/src/components/ui/IconButton.tsx#L31)
|
|
24
|
-
|
|
25
|
-
___
|
|
26
|
-
|
|
27
|
-
### label
|
|
28
|
-
|
|
29
|
-
• **label**: `string`
|
|
30
|
-
|
|
31
|
-
Accessible label for the button
|
|
32
|
-
|
|
33
|
-
#### Defined in
|
|
34
|
-
|
|
35
|
-
[packages/touchpoint-ui/src/components/ui/IconButton.tsx:35](https://github.com/nlxai/sdk/blob/e13e2baae9abf0ee3add35f3a4b4c3fe47e8f43d/packages/touchpoint-ui/src/components/ui/IconButton.tsx#L35)
|
|
36
|
-
|
|
37
|
-
___
|
|
38
|
-
|
|
39
|
-
### className
|
|
40
|
-
|
|
41
|
-
• `Optional` **className**: `string`
|
|
42
|
-
|
|
43
|
-
Additional CSS classes to apply to the button
|
|
44
|
-
|
|
45
|
-
#### Defined in
|
|
46
|
-
|
|
47
|
-
[packages/touchpoint-ui/src/components/ui/IconButton.tsx:39](https://github.com/nlxai/sdk/blob/e13e2baae9abf0ee3add35f3a4b4c3fe47e8f43d/packages/touchpoint-ui/src/components/ui/IconButton.tsx#L39)
|
|
48
|
-
|
|
49
|
-
___
|
|
50
|
-
|
|
51
|
-
### type
|
|
52
|
-
|
|
53
|
-
• **type**: [`IconButtonType`](../README.md#iconbuttontype)
|
|
54
|
-
|
|
55
|
-
Visual style variant of the button. One of IconButtonType.
|
|
56
|
-
|
|
57
|
-
#### Defined in
|
|
58
|
-
|
|
59
|
-
[packages/touchpoint-ui/src/components/ui/IconButton.tsx:43](https://github.com/nlxai/sdk/blob/e13e2baae9abf0ee3add35f3a4b4c3fe47e8f43d/packages/touchpoint-ui/src/components/ui/IconButton.tsx#L43)
|
|
60
|
-
|
|
61
|
-
___
|
|
62
|
-
|
|
63
|
-
### Icon
|
|
64
|
-
|
|
65
|
-
• **Icon**: `FC`\<[`IconProps`](Icons.IconProps.md)\>
|
|
66
|
-
|
|
67
|
-
Icon component to display inside the button
|
|
68
|
-
|
|
69
|
-
#### Defined in
|
|
70
|
-
|
|
71
|
-
[packages/touchpoint-ui/src/components/ui/IconButton.tsx:47](https://github.com/nlxai/sdk/blob/e13e2baae9abf0ee3add35f3a4b4c3fe47e8f43d/packages/touchpoint-ui/src/components/ui/IconButton.tsx#L47)
|
|
@@ -1,29 +0,0 @@
|
|
|
1
|
-
# Interface: IconProps
|
|
2
|
-
|
|
3
|
-
[Icons](../modules/Icons.md).IconProps
|
|
4
|
-
|
|
5
|
-
Props for icon components
|
|
6
|
-
|
|
7
|
-
## Properties
|
|
8
|
-
|
|
9
|
-
### className
|
|
10
|
-
|
|
11
|
-
• `Optional` **className**: `string`
|
|
12
|
-
|
|
13
|
-
Additional CSS classes to apply to the icon
|
|
14
|
-
|
|
15
|
-
#### Defined in
|
|
16
|
-
|
|
17
|
-
[packages/touchpoint-ui/src/components/ui/Icons.tsx:11](https://github.com/nlxai/sdk/blob/e13e2baae9abf0ee3add35f3a4b4c3fe47e8f43d/packages/touchpoint-ui/src/components/ui/Icons.tsx#L11)
|
|
18
|
-
|
|
19
|
-
___
|
|
20
|
-
|
|
21
|
-
### size
|
|
22
|
-
|
|
23
|
-
• `Optional` **size**: `number`
|
|
24
|
-
|
|
25
|
-
Custom size in pixels for the icon
|
|
26
|
-
|
|
27
|
-
#### Defined in
|
|
28
|
-
|
|
29
|
-
[packages/touchpoint-ui/src/components/ui/Icons.tsx:15](https://github.com/nlxai/sdk/blob/e13e2baae9abf0ee3add35f3a4b4c3fe47e8f43d/packages/touchpoint-ui/src/components/ui/Icons.tsx#L15)
|
|
@@ -1,27 +0,0 @@
|
|
|
1
|
-
# Interface: InputField
|
|
2
|
-
|
|
3
|
-
Input field value
|
|
4
|
-
|
|
5
|
-
## Properties
|
|
6
|
-
|
|
7
|
-
### id
|
|
8
|
-
|
|
9
|
-
• **id**: `string`
|
|
10
|
-
|
|
11
|
-
Field ID
|
|
12
|
-
|
|
13
|
-
#### Defined in
|
|
14
|
-
|
|
15
|
-
[packages/touchpoint-ui/src/interface.ts:211](https://github.com/nlxai/sdk/blob/e13e2baae9abf0ee3add35f3a4b4c3fe47e8f43d/packages/touchpoint-ui/src/interface.ts#L211)
|
|
16
|
-
|
|
17
|
-
___
|
|
18
|
-
|
|
19
|
-
### value
|
|
20
|
-
|
|
21
|
-
• **value**: `string` \| `boolean`
|
|
22
|
-
|
|
23
|
-
Field value
|
|
24
|
-
|
|
25
|
-
#### Defined in
|
|
26
|
-
|
|
27
|
-
[packages/touchpoint-ui/src/interface.ts:215](https://github.com/nlxai/sdk/blob/e13e2baae9abf0ee3add35f3a4b4c3fe47e8f43d/packages/touchpoint-ui/src/interface.ts#L215)
|
|
@@ -1,21 +0,0 @@
|
|
|
1
|
-
# Interface: InteractiveElementInfo
|
|
2
|
-
|
|
3
|
-
Accessibility information with ID
|
|
4
|
-
|
|
5
|
-
## Hierarchy
|
|
6
|
-
|
|
7
|
-
- [`AccessibilityInformation`](../README.md#accessibilityinformation)
|
|
8
|
-
|
|
9
|
-
↳ **`InteractiveElementInfo`**
|
|
10
|
-
|
|
11
|
-
## Properties
|
|
12
|
-
|
|
13
|
-
### id
|
|
14
|
-
|
|
15
|
-
• **id**: `string`
|
|
16
|
-
|
|
17
|
-
Form element ID (assigned by the analysis logic, not necessarily equal to the DOM ID)
|
|
18
|
-
|
|
19
|
-
#### Defined in
|
|
20
|
-
|
|
21
|
-
[packages/touchpoint-ui/src/bidirectional/analyzePageForms.ts:18](https://github.com/nlxai/sdk/blob/e13e2baae9abf0ee3add35f3a4b4c3fe47e8f43d/packages/touchpoint-ui/src/bidirectional/analyzePageForms.ts#L18)
|
|
@@ -1,27 +0,0 @@
|
|
|
1
|
-
# Interface: PageForms
|
|
2
|
-
|
|
3
|
-
Page forms with elements
|
|
4
|
-
|
|
5
|
-
## Properties
|
|
6
|
-
|
|
7
|
-
### context
|
|
8
|
-
|
|
9
|
-
• **context**: [`InteractiveElementInfo`](InteractiveElementInfo.md)[]
|
|
10
|
-
|
|
11
|
-
Page context
|
|
12
|
-
|
|
13
|
-
#### Defined in
|
|
14
|
-
|
|
15
|
-
[packages/touchpoint-ui/src/bidirectional/analyzePageForms.ts:28](https://github.com/nlxai/sdk/blob/e13e2baae9abf0ee3add35f3a4b4c3fe47e8f43d/packages/touchpoint-ui/src/bidirectional/analyzePageForms.ts#L28)
|
|
16
|
-
|
|
17
|
-
___
|
|
18
|
-
|
|
19
|
-
### formElements
|
|
20
|
-
|
|
21
|
-
• **formElements**: `Record`\<`string`, `Element`\>
|
|
22
|
-
|
|
23
|
-
Form element references
|
|
24
|
-
|
|
25
|
-
#### Defined in
|
|
26
|
-
|
|
27
|
-
[packages/touchpoint-ui/src/bidirectional/analyzePageForms.ts:32](https://github.com/nlxai/sdk/blob/e13e2baae9abf0ee3add35f3a4b4c3fe47e8f43d/packages/touchpoint-ui/src/bidirectional/analyzePageForms.ts#L32)
|
|
@@ -1,39 +0,0 @@
|
|
|
1
|
-
# Interface: PageState
|
|
2
|
-
|
|
3
|
-
Internal state that the automatic context maintains.
|
|
4
|
-
|
|
5
|
-
## Properties
|
|
6
|
-
|
|
7
|
-
### formElements
|
|
8
|
-
|
|
9
|
-
• **formElements**: `Record`\<`string`, `Element`\>
|
|
10
|
-
|
|
11
|
-
Mapping from form element IDs to their DOM elements
|
|
12
|
-
|
|
13
|
-
#### Defined in
|
|
14
|
-
|
|
15
|
-
[packages/touchpoint-ui/src/interface.ts:223](https://github.com/nlxai/sdk/blob/e13e2baae9abf0ee3add35f3a4b4c3fe47e8f43d/packages/touchpoint-ui/src/interface.ts#L223)
|
|
16
|
-
|
|
17
|
-
___
|
|
18
|
-
|
|
19
|
-
### links
|
|
20
|
-
|
|
21
|
-
• **links**: `Record`\<`string`, `string`\>
|
|
22
|
-
|
|
23
|
-
Mapping from link element names to their URLs
|
|
24
|
-
|
|
25
|
-
#### Defined in
|
|
26
|
-
|
|
27
|
-
[packages/touchpoint-ui/src/interface.ts:225](https://github.com/nlxai/sdk/blob/e13e2baae9abf0ee3add35f3a4b4c3fe47e8f43d/packages/touchpoint-ui/src/interface.ts#L225)
|
|
28
|
-
|
|
29
|
-
___
|
|
30
|
-
|
|
31
|
-
### customCommands
|
|
32
|
-
|
|
33
|
-
• **customCommands**: `Map`\<`string`, (`arg`: `any`) => `void`\>
|
|
34
|
-
|
|
35
|
-
Mapping from custom commands to their handlers
|
|
36
|
-
|
|
37
|
-
#### Defined in
|
|
38
|
-
|
|
39
|
-
[packages/touchpoint-ui/src/interface.ts:227](https://github.com/nlxai/sdk/blob/e13e2baae9abf0ee3add35f3a4b4c3fe47e8f43d/packages/touchpoint-ui/src/interface.ts#L227)
|
|
@@ -1,72 +0,0 @@
|
|
|
1
|
-
# Interface: TextButtonProps
|
|
2
|
-
|
|
3
|
-
Props for the TextButton component
|
|
4
|
-
|
|
5
|
-
## Properties
|
|
6
|
-
|
|
7
|
-
### onClick
|
|
8
|
-
|
|
9
|
-
• `Optional` **onClick**: () => `void`
|
|
10
|
-
|
|
11
|
-
Handler function called when the button is clicked
|
|
12
|
-
|
|
13
|
-
#### Type declaration
|
|
14
|
-
|
|
15
|
-
▸ (): `void`
|
|
16
|
-
|
|
17
|
-
##### Returns
|
|
18
|
-
|
|
19
|
-
`void`
|
|
20
|
-
|
|
21
|
-
#### Defined in
|
|
22
|
-
|
|
23
|
-
[packages/touchpoint-ui/src/components/ui/TextButton.tsx:13](https://github.com/nlxai/sdk/blob/e13e2baae9abf0ee3add35f3a4b4c3fe47e8f43d/packages/touchpoint-ui/src/components/ui/TextButton.tsx#L13)
|
|
24
|
-
|
|
25
|
-
___
|
|
26
|
-
|
|
27
|
-
### label
|
|
28
|
-
|
|
29
|
-
• **label**: `string`
|
|
30
|
-
|
|
31
|
-
Text to display on the button
|
|
32
|
-
|
|
33
|
-
#### Defined in
|
|
34
|
-
|
|
35
|
-
[packages/touchpoint-ui/src/components/ui/TextButton.tsx:17](https://github.com/nlxai/sdk/blob/e13e2baae9abf0ee3add35f3a4b4c3fe47e8f43d/packages/touchpoint-ui/src/components/ui/TextButton.tsx#L17)
|
|
36
|
-
|
|
37
|
-
___
|
|
38
|
-
|
|
39
|
-
### className
|
|
40
|
-
|
|
41
|
-
• `Optional` **className**: `string`
|
|
42
|
-
|
|
43
|
-
Additional CSS classes to apply to the button
|
|
44
|
-
|
|
45
|
-
#### Defined in
|
|
46
|
-
|
|
47
|
-
[packages/touchpoint-ui/src/components/ui/TextButton.tsx:21](https://github.com/nlxai/sdk/blob/e13e2baae9abf0ee3add35f3a4b4c3fe47e8f43d/packages/touchpoint-ui/src/components/ui/TextButton.tsx#L21)
|
|
48
|
-
|
|
49
|
-
___
|
|
50
|
-
|
|
51
|
-
### type
|
|
52
|
-
|
|
53
|
-
• `Optional` **type**: ``"main"`` \| ``"ghost"``
|
|
54
|
-
|
|
55
|
-
Visual style variant of the button
|
|
56
|
-
Default value is "ghost"
|
|
57
|
-
|
|
58
|
-
#### Defined in
|
|
59
|
-
|
|
60
|
-
[packages/touchpoint-ui/src/components/ui/TextButton.tsx:26](https://github.com/nlxai/sdk/blob/e13e2baae9abf0ee3add35f3a4b4c3fe47e8f43d/packages/touchpoint-ui/src/components/ui/TextButton.tsx#L26)
|
|
61
|
-
|
|
62
|
-
___
|
|
63
|
-
|
|
64
|
-
### Icon
|
|
65
|
-
|
|
66
|
-
• **Icon**: `FC`\<[`IconProps`](Icons.IconProps.md)\>
|
|
67
|
-
|
|
68
|
-
Icon component to display inside the button.
|
|
69
|
-
|
|
70
|
-
#### Defined in
|
|
71
|
-
|
|
72
|
-
[packages/touchpoint-ui/src/components/ui/TextButton.tsx:30](https://github.com/nlxai/sdk/blob/e13e2baae9abf0ee3add35f3a4b4c3fe47e8f43d/packages/touchpoint-ui/src/components/ui/TextButton.tsx#L30)
|