@salesforce/ui-bundle-template-feature-react-agentforce-conversation-client 1.121.0 → 1.122.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.
package/README.md
CHANGED
|
@@ -1,6 +1,8 @@
|
|
|
1
|
-
# Agentforce Conversation Client (
|
|
1
|
+
# Agentforce Conversation Client React (Beta)
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
> **Beta**: This package is currently in beta. APIs and behavior may change in future releases.
|
|
4
|
+
|
|
5
|
+
React component for embedding the Agentforce Conversation Client — the Salesforce agent chat UI for employee agents — into a UI Bundle. This is a wrapper around `@salesforce/agentforce-conversation-client` that handles authentication automatically and provides a declarative `<AgentforceConversationClient />` component.
|
|
4
6
|
|
|
5
7
|
Use this when a user expects to add an agent, chat widget, chatbot, conversation client, Agentforce chat, employee agent, service agent, or any Salesforce agent to their React app.
|
|
6
8
|
|
|
@@ -38,16 +40,18 @@ export default function AppLayout() {
|
|
|
38
40
|
|
|
39
41
|
### Props
|
|
40
42
|
|
|
41
|
-
| Prop | Type | Required | Description
|
|
42
|
-
| ------------------ | ------------------------ | -------- |
|
|
43
|
-
| `agentId` | `string` | Yes | Agent id to load (18-char Salesforce id, starts with `0Xx`).
|
|
44
|
-
| `
|
|
45
|
-
| `
|
|
46
|
-
| `
|
|
47
|
-
| `
|
|
48
|
-
| `
|
|
49
|
-
| `
|
|
50
|
-
| `
|
|
43
|
+
| Prop | Type | Required | Description |
|
|
44
|
+
| ------------------ | ------------------------ | -------- | ------------------------------------------------------------------------------------------------- |
|
|
45
|
+
| `agentId` | `string` | Yes | Agent id to load (18-char Salesforce id, starts with `0Xx`). |
|
|
46
|
+
| `agentLabel` | `string` | No | Optional display name shown in the chat header. |
|
|
47
|
+
| `inline` | `boolean` | No | If true renders inline; otherwise floating. |
|
|
48
|
+
| `headerEnabled` | `boolean` | No | Header visibility toggle (primarily for inline mode). Floating mode displays a header by default. |
|
|
49
|
+
| `showHeaderIcon` | `boolean` | No | Show/hide the icon in the header. |
|
|
50
|
+
| `width` | `number \| string` | No | Inline width (px number or CSS string). |
|
|
51
|
+
| `height` | `number \| string` | No | Inline height (px number or CSS string). |
|
|
52
|
+
| `styleTokens` | `Record<string, string>` | No | Theme tokens for chat UI styling. Merged with package defaults. |
|
|
53
|
+
| `salesforceOrigin` | `string` | No | Salesforce org origin URL. Resolved automatically if not provided. |
|
|
54
|
+
| `frontdoorUrl` | `string` | No | Frontdoor URL for authentication. Resolved automatically in dev if not provided. |
|
|
51
55
|
|
|
52
56
|
### Rendering Modes
|
|
53
57
|
|
|
@@ -72,7 +76,7 @@ The chat renders within the page layout at a specific size.
|
|
|
72
76
|
Pass `agentId` to load a specific agent (e.g. travel agent, HR agent). `agentId` is required.
|
|
73
77
|
|
|
74
78
|
```tsx
|
|
75
|
-
<AgentforceConversationClient agentId="
|
|
79
|
+
<AgentforceConversationClient agentId="0Xx000000000000AAA" />
|
|
76
80
|
```
|
|
77
81
|
|
|
78
82
|
### Theming with `styleTokens`
|
|
@@ -92,7 +96,7 @@ Use `styleTokens` to theme the Agentforce Conversation Client. Only override the
|
|
|
92
96
|
|
|
93
97
|
### Header visibility
|
|
94
98
|
|
|
95
|
-
Use `headerEnabled` to explicitly show or hide the chat header.
|
|
99
|
+
Use `headerEnabled` to explicitly show or hide the chat header. In this wrapper, floating mode shows a header by default; this prop is most useful for inline mode.
|
|
96
100
|
|
|
97
101
|
```tsx
|
|
98
102
|
<AgentforceConversationClient
|
|
@@ -104,6 +108,22 @@ Use `headerEnabled` to explicitly show or hide the chat header. It defaults to `
|
|
|
104
108
|
/>
|
|
105
109
|
```
|
|
106
110
|
|
|
111
|
+
### Header icon visibility
|
|
112
|
+
|
|
113
|
+
Use `showHeaderIcon` to explicitly show or hide the icon in the header.
|
|
114
|
+
|
|
115
|
+
```tsx
|
|
116
|
+
<AgentforceConversationClient agentId="0Xx000000000000AAA" showHeaderIcon={false} />
|
|
117
|
+
```
|
|
118
|
+
|
|
119
|
+
### Wrapper defaults and initialization behavior
|
|
120
|
+
|
|
121
|
+
This React wrapper applies a few defaults around the underlying SDK:
|
|
122
|
+
|
|
123
|
+
- `showAvatar` is set to `false`.
|
|
124
|
+
- A default style token set is applied, then your `styleTokens` overrides are merged on top.
|
|
125
|
+
- The embed is initialized once per browser window (singleton). If multiple instances mount, only the first successful initialization performs the embed.
|
|
126
|
+
|
|
107
127
|
#### Available Style Tokens
|
|
108
128
|
|
|
109
129
|
For the complete and always up-to-date list of all 60+ style tokens, see the underlying SDK documentation:
|
package/dist/CHANGELOG.md
CHANGED
|
@@ -3,6 +3,22 @@
|
|
|
3
3
|
All notable changes to this project will be documented in this file.
|
|
4
4
|
See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
|
|
5
5
|
|
|
6
|
+
## [1.122.1](https://github.com/salesforce-experience-platform-emu/webapps/compare/v1.122.0...v1.122.1) (2026-04-10)
|
|
7
|
+
|
|
8
|
+
**Note:** Version bump only for package @salesforce/ui-bundle-template-base-sfdx-project
|
|
9
|
+
|
|
10
|
+
|
|
11
|
+
|
|
12
|
+
|
|
13
|
+
|
|
14
|
+
# [1.122.0](https://github.com/salesforce-experience-platform-emu/webapps/compare/v1.121.0...v1.122.0) (2026-04-09)
|
|
15
|
+
|
|
16
|
+
**Note:** Version bump only for package @salesforce/ui-bundle-template-base-sfdx-project
|
|
17
|
+
|
|
18
|
+
|
|
19
|
+
|
|
20
|
+
|
|
21
|
+
|
|
6
22
|
# [1.121.0](https://github.com/salesforce-experience-platform-emu/webapps/compare/v1.120.7...v1.121.0) (2026-04-09)
|
|
7
23
|
|
|
8
24
|
**Note:** Version bump only for package @salesforce/ui-bundle-template-base-sfdx-project
|
|
@@ -18,8 +18,8 @@
|
|
|
18
18
|
"graphql:schema": "node scripts/get-graphql-schema.mjs"
|
|
19
19
|
},
|
|
20
20
|
"dependencies": {
|
|
21
|
-
"@salesforce/sdk-data": "^1.
|
|
22
|
-
"@salesforce/ui-bundle": "^1.
|
|
21
|
+
"@salesforce/sdk-data": "^1.122.1",
|
|
22
|
+
"@salesforce/ui-bundle": "^1.122.1",
|
|
23
23
|
"@tailwindcss/vite": "^4.1.17",
|
|
24
24
|
"class-variance-authority": "^0.7.1",
|
|
25
25
|
"clsx": "^2.1.1",
|
|
@@ -45,7 +45,7 @@
|
|
|
45
45
|
"@graphql-eslint/eslint-plugin": "^4.1.0",
|
|
46
46
|
"@graphql-tools/utils": "^11.0.0",
|
|
47
47
|
"@playwright/test": "^1.49.0",
|
|
48
|
-
"@salesforce/vite-plugin-ui-bundle": "^1.
|
|
48
|
+
"@salesforce/vite-plugin-ui-bundle": "^1.122.1",
|
|
49
49
|
"@testing-library/jest-dom": "^6.6.3",
|
|
50
50
|
"@testing-library/react": "^16.1.0",
|
|
51
51
|
"@testing-library/user-event": "^14.5.2",
|
package/dist/package-lock.json
CHANGED
|
@@ -1,12 +1,12 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@salesforce/webapp-template-base-sfdx-project-experimental",
|
|
3
|
-
"version": "1.
|
|
3
|
+
"version": "1.122.1",
|
|
4
4
|
"lockfileVersion": 3,
|
|
5
5
|
"requires": true,
|
|
6
6
|
"packages": {
|
|
7
7
|
"": {
|
|
8
8
|
"name": "@salesforce/webapp-template-base-sfdx-project-experimental",
|
|
9
|
-
"version": "1.
|
|
9
|
+
"version": "1.122.1",
|
|
10
10
|
"license": "SEE LICENSE IN LICENSE.txt",
|
|
11
11
|
"devDependencies": {
|
|
12
12
|
"@lwc/eslint-plugin-lwc": "^3.3.0",
|
package/dist/package.json
CHANGED
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@salesforce/ui-bundle-template-feature-react-agentforce-conversation-client",
|
|
3
|
-
"version": "1.
|
|
3
|
+
"version": "1.122.1",
|
|
4
4
|
"description": "Embedded Agentforce conversation client feature for UI Bundles",
|
|
5
5
|
"license": "SEE LICENSE IN LICENSE.txt",
|
|
6
6
|
"author": "",
|
|
@@ -26,7 +26,7 @@
|
|
|
26
26
|
"clean": "rm -rf dist"
|
|
27
27
|
},
|
|
28
28
|
"dependencies": {
|
|
29
|
-
"@salesforce/agentforce-conversation-client": "^1.
|
|
29
|
+
"@salesforce/agentforce-conversation-client": "^1.122.1"
|
|
30
30
|
},
|
|
31
31
|
"devDependencies": {
|
|
32
32
|
"@types/react": "^19.2.7",
|